Converta modelos Sequelize (TS) em JSON!

Insira modelos Sequelize (TS) para gerar JSON de exemplo! Compatível com Sequelize, sequelize-typescript. Útil para documentar APIs e corpos de requisição de teste (mock request body).
Sequelize (TS)
Resultado
 

Converta modelos Sequelize (TS) em JSON!

Passe classes de model @Table escritas com sequelize-typescript e ele monta um JSON de exemplo no formato da saída do toJSON() da instância. Isso inclui os atributos id, createdAt, updatedAt e deletedAt que o Sequelize adiciona mesmo quando não estão declarados na classe.

Diferente da página JS, aqui os valores vêm do tipo TypeScript de cada propriedade, e não do argumento DataType. Um @Column(DataType.DECIMAL) declarado como amount: string gera uma string.

Como usar

  1. Cole um arquivo com classes @Table na caixa Sequelize (TS). Adicione os models associados (via @HasMany e afins) para obter valores aninhados.
  2. Confira na caixa Resultado o JSON com os atributos adicionados automaticamente.
  3. Alterne opções do @Table como timestamps ou paranoid para ver na hora como os campos de data mudam.

Exemplo

Entrada (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
Saída (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

A classe não tem primary key, então id é adicionado primeiro, e paranoid: true adiciona deletedAt: null. status usa o primeiro literal da sua union, "draft", e amount é uma string vazia porque está declarado como string.

Recursos suportados

  • Sem @PrimaryKey, @Column({ primaryKey: true }) ou uma propriedade id, id: 0 é inserido no topo, tanto na raiz quanto nos models associados.
  • A menos que o @Table defina timestamps: false, createdAt e updatedAt são adicionados no final; renomeações como createdAt: "created_on", updatedAt: false e paranoid: true (deletedAt: null) são respeitadas por model.
  • Post[] de um @HasMany vira um array; @BelongsTo e @HasOne viram objetos aninhados.
  • Unions de literais como "draft" | "sent" usam o primeiro valor, e tudo o que é herdado via extends Model é ignorado.
  • Uma coluna DataType.JSON tipada como objeto, por exemplo { theme: string }, é preenchida nesse formato.

Casos de uso

Documentar handlers do Express

Para endpoints que fazem res.json(await Invoice.findByPk(id)), a saída dá um exemplo de resposta com chaves que batem com a realidade, incluindo os atributos adicionados automaticamente.

Antes e depois de ativar o soft delete

Ligar o paranoid adiciona deletedAt a todas as respostas. Compare a saída com a opção ligada e desligada para dizer a quem consome a API exatamente o que vai mudar.

Observações e limitações

  • Models associados aninhados dentro da raiz recebem o seu próprio id e timestamps a partir das próprias opções de @Table, mas foreign keys que o Sequelize adiciona implicitamente (como invoiceId num alvo de @HasMany sem coluna @ForeignKey) não são inventadas.
  • allowNull e renomeações de coluna via @Column({ field: ... }) são ignorados, já que as chaves JSON são os nomes das propriedades. @Default("x") e um defaultValue literal em @Column({...}) são usados como valores de exemplo.
  • underscored: true só muda os nomes das colunas do banco; o toJSON() continua usando os nomes dos atributos, então o createdAt na saída está correto.
  • Os valores vêm dos tipos TypeScript, então uma propriedade tipada só pelo decorator (@Column(DataType.INTEGER) count; sem anotação) vira null.

Perguntas frequentes

Uma coluna DECIMAL deve ser tipada como number ou string?

Com MySQL e PostgreSQL, o Sequelize devolve valores DECIMAL como string por padrão. Tipar como amount: string mantém o tipo fiel, e o exemplo aqui também vai mostrar uma string.

Posso usar campos declare ou CreationOptional?

Sim. declare id: CreationOptional<number> é lido como number, e o mesmo desembrulho vale para NonAttribute<...> e ForeignKey<...>. Tipos auxiliares além desses, como InferAttributes, não são expandidos.

Esta página trata models sequelize.define escritos em JavaScript?

Não. Esta página lê classes e tipos TypeScript. Para models com define e Model.init, use a página Sequelize (JS) para JSON, que lê os DataTypes.