¡Convierte modelos de Sequelize (TS) en JSON!

¡Introduce modelos de Sequelize (TS) para generar JSON de ejemplo! Compatible con Sequelize, sequelize-typescript. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
Sequelize (TS)
Resultado
 

¡Convierte modelos de Sequelize (TS) en JSON!

Pásale clases de modelo @Table escritas con sequelize-typescript y construye un JSON de ejemplo con la forma de la salida de toJSON() de la instancia. Eso incluye los atributos id, createdAt, updatedAt y deletedAt que Sequelize añade aunque no estén declarados en la clase.

A diferencia de la página de JS, aquí los valores salen del tipo TypeScript de cada propiedad y no del argumento DataType. Un @Column(DataType.DECIMAL) declarado como amount: string produce una cadena.

Cómo usar

  1. Pega un archivo con clases @Table en el cuadro Sequelize (TS). Añade los modelos asociados (mediante @HasMany y similares) para obtener valores anidados.
  2. Revisa en el cuadro Resultado el JSON con los atributos añadidos automáticamente.
  3. Cambia opciones de @Table como timestamps o paranoid para ver al momento cómo cambian los campos de fecha.

Ejemplo

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;
}
Salida (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
}

La clase no tiene clave primaria, así que se añade id al principio, y paranoid: true añade deletedAt: null. status toma el primer literal de su unión, "draft", y amount es una cadena vacía porque está declarado como string.

Funciones compatibles

  • Sin @PrimaryKey, @Column({ primaryKey: true }) ni una propiedad id, se inserta id: 0 arriba del todo, tanto en la raíz como en los modelos asociados.
  • Salvo que @Table configure timestamps: false, se añaden createdAt y updatedAt; los renombrados como createdAt: "created_on", updatedAt: false y paranoid: true (deletedAt: null) se respetan en cada modelo.
  • Post[] de @HasMany pasa a un array; @BelongsTo y @HasOne pasan a objetos anidados.
  • Las uniones de literales como "draft" | "sent" usan el primer valor, y todo lo heredado mediante extends Model se ignora.
  • Una columna DataType.JSON tipada como objeto, p. ej. { theme: string }, se rellena con esa forma.

Casos de uso

Documentar handlers de Express

Para endpoints que hacen res.json(await Invoice.findByPk(id)), la salida da un ejemplo de respuesta cuyas claves coinciden con la realidad, incluidos los atributos añadidos automáticamente.

Antes y después de activar el soft delete

Activar paranoid añade deletedAt a todas las respuestas. Compara la salida con la opción activada y desactivada para decir a los consumidores de la API exactamente qué va a cambiar.

Notas y limitaciones

  • Los modelos asociados anidados dentro de la raíz reciben su propio id y timestamps según sus propias opciones de @Table, pero no se inventan las claves foráneas que Sequelize añade implícitamente (como invoiceId en el destino de un @HasMany sin columna @ForeignKey).
  • Se ignoran allowNull y los renombrados de columna mediante @Column({ field: ... }), ya que las claves JSON son los nombres de las propiedades. @Default("x") y un defaultValue literal en @Column({...}) se usan como valores de ejemplo.
  • underscored: true solo cambia los nombres de columna de la base de datos; toJSON() sigue usando los nombres de atributo, así que el createdAt de la salida es correcto.
  • Los valores salen de los tipos TypeScript, así que una propiedad tipada solo a través del decorador (@Column(DataType.INTEGER) count; sin anotación) pasa a null.

Preguntas frecuentes

¿Una columna DECIMAL debería tiparse como number o como string?

Con MySQL y PostgreSQL, Sequelize devuelve por defecto los valores DECIMAL como cadenas. Tiparla como amount: string mantiene el tipo fiel a la realidad, y el ejemplo de aquí también mostrará una cadena.

¿Puedo usar campos declare o CreationOptional?

Sí. declare id: CreationOptional<number> se lee como number, y el mismo desenvolvimiento se aplica a NonAttribute<...> y ForeignKey<...>. Otros tipos auxiliares, como InferAttributes, no se expanden.

¿Esta página maneja modelos sequelize.define escritos en JavaScript?

No. Esta página lee clases y tipos de TypeScript. Usa la página Sequelize (JS) a JSON para los modelos define y Model.init, que lee DataTypes en su lugar.