sync-types

Files (1)

• SKILL.md

SKILL.md (first lines)

## Propósito

Mantener sincronizados los tipos entre `myquota-backend` y `myquota-app`.

---

## Mapeo de Tipos

| Modelo Backend (`myquota-backend/src/modules/*/model.ts`) | Tipo Frontend (`src/shared/types/`) |
|-----------------------------------------------------------|-------------------------------------|
| `CreditCard` | `creditCard.ts` → `CreditCard` |
| `Transaction` | `transaction.ts` → `Transaction` |
| `Quota` | `quota.ts` → `Quota` |
| `BillingPeriod` | `billingPeriod.ts` → `BillingPeriod` |
| `User` | `user.ts` → `UserInfo` |
| `Category` | `category.ts` → `Category` |

---

## Regla Principal

> Cuando se agrega, renombra o elimina un campo en una entidad del backend, 
> **TAMBIÉN** se debe actualizar la interface correspondiente en `src/shared/types/`.

---

## Diferencias Backend ↔ Frontend

| Aspecto | Backend (model.ts) | Frontend (types/) |
|---------|-------------------|-------------------|
| Sintaxis | `class` con `!:` | `interface` |
| Fechas | `Date` | `string` (ISO 8601) |
| IBaseEntity | `implements` | Copiar campos |

### Conversión de Fechas

La API serializa `Date` a ISO strings:

```typescript
// Backend
createdAt!: Date;

// Frontend
createdAt: string;  // "2025-03-15T00:00:00.000Z"
```

---

## Ejemplo: Agregar Campo

### 1. Backend modifica modelo

```typescript
// myquota-backend/src/modules/creditCard/creditCard.model.ts
export class CreditCard implements IBaseEntity {
  id!: string;
  createdAt!: Date;
  updatedAt!: Date;
  deletedAt?: Date | null;

  name!: string;
  lastFourDigits!: string;
  color!: string;
  newField!: string;  // ← NUEVO
}
```

### 2. Frontend actualiza interface

```typescript
// myquota-app/src/shared/types/creditCard.ts
export interface CreditCard {
  id: string;
  createdAt: string;
  updatedAt: string;
  deletedAt?: string | null;

  name: string;
  lastFourDigits: string;
  color: string;
  newField: string;  // ← SINCRONIZAR
}
```

---

## Template de Interface

```typescript
// src/shared/types/myEntity.ts

export interface MyEntity {
  // Campos de IBaseEntity (siempre presentes)
  id: string;
  createdAt: string;
  updatedAt: string;
  deletedAt?: string | null;

  // Campos específicos de la entidad
  name: string;
  // ...
}

// DTO para crear
export interface CreateMyEntityDto {
  name: string;
  // Campos requeridos para crear (sin id, sin fechas)
}

// DTO para actualizar
export type UpdateMyEntityDto = Partial<CreateMyEntityDto>;
```

---

## Campos de IBaseEntity

Todos los modelos del backend tienen estos campos base:

From cabrerojas/myquota-app, MIT.

More from cabrerojas/myquota-app