Convertissez JSON en schéma Sequelize (TypeScript) !

Entrez JSON et convertissez-le en schéma Sequelize (TypeScript) ! Compatible avec sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Résultat
 

Convertissez JSON en schéma Sequelize (TypeScript) !

Convertit du JSON en modèle à décorateurs pour la bibliothèque sequelize-typescript : une classe qui étend Model avec @Table et @Column({ type: DataType.*, allowNull }), des types de propriétés TypeScript et des décorateurs class-validator pour la validation.

Il cible sequelize-typescript (la bibliothèque derrière @nestjs/sequelize de NestJS) plutôt que sequelize seul : le chemin d'import et l'orthographe DataType (sans s final) diffèrent donc de la version JavaScript.

Mode d'emploi

  1. Collez un objet JSON correspondant à une ligne de table, ou un tableau de lignes.
  2. Saisissez le nom de la classe dans Nom du modèle (par défaut MyModel) ; il devient aussi le tableName en upper snake case dans @Table.
  3. Enregistrez le résultat sous invoice.model.ts et déclarez-le avec new Sequelize({ ..., models: [Invoice] }) ou SequelizeModule.forFeature([Invoice]) de NestJS.

Exemple

Entrée (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Sortie (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 est une chaîne vide : ce n'est pas NULL, la colonne garde donc allowNull: false, mais elle reçoit @IsOptional() plutôt que @IsNotEmpty(). amount devient DataType.DOUBLE, et due_date devient DataType.DATEONLY typé string, car Sequelize renvoie les valeurs de date seule sous forme de texte.

Fonctionnalités prises en charge

  • Importe { Table, Column, Model, DataType } depuis sequelize-typescript et déclare la classe avec extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), comme le générateur JavaScript : aucune colonne createdAt/updatedAt n'est supposée.
  • Chaque @Column indique type et allowNull ; les colonnes nullables sont typées string | null et ainsi de suite.
  • Paires de types : INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> ou un tableau typé comme string[].
  • Les propriétés sont en camelCase avec field: 'invoice_no' pointant vers la colonne d'origine ; une clé id dans le JSON sert de clé primaire au lieu d'être dupliquée.
  • Les champs ayant une valeur non vide dans chaque ligne reçoivent @IsNotEmpty() ; les autres @IsOptional().

Cas d'utilisation

Modèles pour NestJS avec `@nestjs/sequelize`

Quand vous devez persister des données qu'un système externe de facturation ou de règlement envoie en JSON, construisez la classe de modèle à partir de ce payload et utilisez-la via @InjectModel(Invoice).

Passer des modèles Sequelize JavaScript à du code typé

Exportez en JSON les données d'une table existante et collez-les pour obtenir une ébauche de modèle typé, au lieu de réécrire à la main un objet define() en classe.

Remarques et limites

  • Pour les montants et autres décimaux exacts, DataType.DECIMAL(12, 2) est plus sûr que DataType.DOUBLE.
  • experimentalDecorators et emitDecoratorMetadata doivent être activés dans le tsconfig pour que les décorateurs fonctionnent.
  • Avec useDefineForClassFields (par défaut pour un target ES2022 ou ultérieur), les simples déclarations de propriétés masquent les getters de Sequelize. Désactivez cette option ou préfixez les propriétés par declare.

FAQ

Ne devrait-on pas avoir Model<InvoiceAttributes, InvoiceCreationAttributes> au lieu de Model<Invoice> ?

sequelize-typescript v2 accepte deux génériques ; le code généré passe simplement la classe elle-même. Si vous voulez que Invoice.create({...}) soit vérifié sans les champs auto-générés comme id, déclarez une interface d'attributs de création et passez-la comme second générique.

Pourquoi DataType et pas DataTypes ?

DataType est le nom exporté par sequelize-typescript. Importer DataTypes depuis sequelize fonctionne de la même façon, mais s'en tenir à un seul nom par fichier se lit mieux.

Les décorateurs class-validator sont-ils vérifiés automatiquement sur le modèle ?

Non. La validation n'a lieu que si vous appelez vous-même validate(invoice) ou si les décorateurs se trouvent sur un DTO traité par le ValidationPipe de NestJS. Pour une validation au niveau Sequelize, utilisez @Column({ validate: { notEmpty: true } }) ou des décorateurs sequelize-typescript comme @NotEmpty.