¡Convierte JSON a esquema de Sequelize (TypeScript)!

¡Introduce JSON y conviértelo a esquema de Sequelize (TypeScript)! Compatible con sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Resultado
 

¡Convierte JSON a esquema de Sequelize (TypeScript)!

Convierte JSON en un modelo basado en decoradores para la librería sequelize-typescript: una clase que extiende Model con @Table y @Column({ type: DataType.*, allowNull }), tipos de propiedad TypeScript y decoradores de class-validator para la validación.

Apunta a sequelize-typescript (la librería que hay detrás de @nestjs/sequelize de NestJS) y no a sequelize a secas, así que la ruta de import y la forma de escribir DataType (sin s final) difieren de la versión JavaScript.

Cómo usar

  1. Pega un objeto JSON que represente una fila de la tabla, o un array de filas.
  2. Escribe el nombre de la clase en Nombre del modelo (por defecto MyModel); también se convierte en el tableName en snake case en mayúsculas de @Table.
  3. Guarda el resultado como invoice.model.ts y regístralo con new Sequelize({ ..., models: [Invoice] }) o con SequelizeModule.forFeature([Invoice]) de NestJS.

Ejemplo

Entrada (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Salida (sequelize-typescript)
import { Table, Column, Model, DataType } from 'sequelize-typescript';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Table({ tableName: 'INVOICE', timestamps: false })
export class Invoice extends Model<Invoice> {
  @Column({ type: DataType.INTEGER, primaryKey: true, autoIncrement: true })
  id: number;

  @Column({ type: DataType.STRING, allowNull: false, field: 'invoice_no' })
  @IsNotEmpty()
  invoiceNo: string;

  @Column({ type: DataType.DOUBLE, allowNull: false })
  @IsNotEmpty()
  amount: number;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsNotEmpty()
  currency: string;

  @Column({ type: DataType.BOOLEAN, allowNull: false })
  @IsNotEmpty()
  paid: boolean;

  @Column({ type: DataType.DATEONLY, allowNull: false, field: 'due_date' })
  @IsNotEmpty()
  dueDate: string;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsOptional()
  memo: string;
}

memo es una cadena vacía: no es NULL, así que la columna mantiene allowNull: false, pero recibe @IsOptional() en lugar de @IsNotEmpty(). amount pasa a DataType.DOUBLE, y due_date pasa a DataType.DATEONLY con tipo string, porque Sequelize devuelve los valores de solo fecha como texto.

Funciones compatibles

  • Importa { Table, Column, Model, DataType } desde sequelize-typescript y declara la clase como extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), igual que el generador de JavaScript, así que no se suponen columnas createdAt/updatedAt.
  • Cada @Column indica type y allowNull; las columnas nullable se tipan como string | null, etc.
  • Pares de tipos: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> o un array tipado como string[].
  • Las propiedades van en camelCase con field: 'invoice_no' apuntando a la columna original; una clave id en el JSON se usa como clave primaria en lugar de duplicarse.
  • Los campos con valor no vacío en todas las filas reciben @IsNotEmpty(); los demás reciben @IsOptional().

Casos de uso

Modelos para NestJS con `@nestjs/sequelize`

Cuando necesitas persistir datos que un sistema externo de facturación o liquidación envía como JSON, construye la clase del modelo a partir de ese payload y úsala mediante @InjectModel(Invoice).

Pasar modelos Sequelize de JavaScript a código tipado

Exporta como JSON los datos de una tabla existente y pégalos para obtener un borrador de modelo tipado, en lugar de reescribir a mano un objeto define() como clase.

Notas y limitaciones

  • Para dinero y otros decimales exactos, DataType.DECIMAL(12, 2) es más seguro que DataType.DOUBLE.
  • experimentalDecorators y emitDecoratorMetadata deben estar activados en el tsconfig para que funcionen los decoradores.
  • Con useDefineForClassFields (el valor por defecto para target ES2022 y posteriores), las declaraciones de propiedades simples ocultan los getters de Sequelize. Desactiva esa opción o antepón declare a las propiedades.

Preguntas frecuentes

¿No debería ser Model<InvoiceAttributes, InvoiceCreationAttributes> en lugar de Model<Invoice>?

sequelize-typescript v2 acepta dos genéricos; el código generado simplemente pasa la propia clase. Si quieres que Invoice.create({...}) se compruebe por tipos sin los campos autogenerados como id, declara una interfaz de atributos de creación y pásala como segundo genérico.

¿Por qué DataType y no DataTypes?

DataType es el nombre que exporta sequelize-typescript. Importar DataTypes desde sequelize funciona igual, pero se lee mejor si usas un solo nombre por archivo.

¿Los decoradores de class-validator se comprueban automáticamente en el modelo?

No. La validación solo ocurre cuando llamas tú a validate(invoice) o cuando los decoradores están en un DTO que procesa el ValidationPipe de NestJS. Para validación a nivel de Sequelize, usa @Column({ validate: { notEmpty: true } }) o decoradores de sequelize-typescript como @NotEmpty.