Converta JSON para esquema Sequelize (TypeScript)!

Introduza JSON e converta-o para esquema Sequelize (TypeScript)! Compatível com sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Resultado
 

Converta JSON para esquema Sequelize (TypeScript)!

Converte JSON num model baseado em decorators para a biblioteca sequelize-typescript: uma classe que estende Model com @Table e @Column({ type: DataType.*, allowNull }), tipos de propriedade TypeScript e decorators do class-validator para validação.

O alvo é o sequelize-typescript (a biblioteca por trás do @nestjs/sequelize do NestJS) e não o sequelize puro, então o caminho de import e a grafia DataType (sem s no final) diferem da versão JavaScript.

Como usar

  1. Cole um objeto JSON de uma linha da tabela, ou um array de linhas.
  2. Informe o nome da classe em Nome do modelo (padrão MyModel); ele também vira o tableName em upper snake case no @Table.
  3. Salve o resultado como invoice.model.ts e registre com new Sequelize({ ..., models: [Invoice] }) ou com o SequelizeModule.forFeature([Invoice]) do NestJS.

Exemplo

Entrada (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Saída (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 é uma string vazia: não é NULL, então a coluna mantém allowNull: false, mas recebe @IsOptional() em vez de @IsNotEmpty(). amount vira DataType.DOUBLE, e due_date vira DataType.DATEONLY tipado como string, porque o Sequelize devolve valores só de data como texto.

Recursos suportados

  • Importa { Table, Column, Model, DataType } de sequelize-typescript e declara a classe como extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), igual ao gerador JavaScript, então não se pressupõem colunas createdAt/updatedAt.
  • Todo @Column declara type e allowNull; colunas nullable são tipadas como string | null e assim por diante.
  • Pares de tipos: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> ou um array tipado como string[].
  • As propriedades ficam em camelCase com field: 'invoice_no' apontando para a coluna original; uma chave id no JSON é usada como primary key em vez de ser duplicada.
  • Campos com valor não vazio em todas as linhas recebem @IsNotEmpty(); os outros recebem @IsOptional().

Casos de uso

Models para NestJS com `@nestjs/sequelize`

Quando você precisa persistir dados que um sistema externo de faturamento ou de liquidação manda como JSON, monte a classe de model a partir desse payload e use via @InjectModel(Invoice).

Transformar models Sequelize em JavaScript em código tipado

Exporte os dados de uma tabela existente como JSON e cole para obter um rascunho de model tipado, em vez de reescrever à mão um objeto define() como classe.

Observações e limitações

  • Para dinheiro e outros decimais exatos, DataType.DECIMAL(12, 2) é mais seguro que DataType.DOUBLE.
  • experimentalDecorators e emitDecoratorMetadata precisam estar ativados no tsconfig para os decorators funcionarem.
  • Com useDefineForClassFields (o padrão para target ES2022 em diante), declarações simples de propriedade fazem sombra aos getters do Sequelize. Desligue essa opção ou coloque declare antes das propriedades.

Perguntas frequentes

Não deveria ser Model<InvoiceAttributes, InvoiceCreationAttributes> em vez de Model<Invoice>?

O sequelize-typescript v2 aceita dois generics; o código gerado só passa a própria classe. Se você quer que Invoice.create({...}) seja checado sem campos gerados automaticamente como id, declare uma interface de creation attributes e passe como segundo generic.

Por que DataType e não DataTypes?

DataType é o nome que o sequelize-typescript exporta. Importar DataTypes do sequelize funciona igual, mas manter um nome só por arquivo fica mais legível.

Os decorators do class-validator são checados automaticamente no model?

Não. A validação só acontece quando você mesmo chama validate(invoice) ou quando os decorators estão num DTO tratado pelo ValidationPipe do NestJS. Para validação no nível do Sequelize, use @Column({ validate: { notEmpty: true } }) ou decorators do sequelize-typescript como @NotEmpty.