Convertir JSON en un schéma TypeORM !

Entrez JSON et convertissez-le en schéma TypeORM ! Compatible avec TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Résultat
 

Convertir JSON en un schéma TypeORM !

Convertit des données JSON en classe d'entité TypeORM : une classe @Entity() avec une clé primaire, et chaque autre clé sous forme de propriété @Column() avec un type TypeScript, une nullabilité et un décorateur class-validator.

Utilisez-le pour créer la première entité de TypeOrmModule.forFeature([...]) dans une application NestJS + TypeORM, ou quand vous ajoutez un DataSource TypeORM à un projet Express et avez besoin d'entités correspondant à des données existantes.

Mode d'emploi

  1. Collez l'enregistrement à stocker sous forme d'objet, ou plusieurs enregistrements sous forme de tableau. Les champs absents de certains enregistrements deviennent des colonnes nullables.
  2. Saisissez le nom de la classe d'entité dans Nom du modèle (par défaut MyModel) ; support ticket devient SupportTicket.
  3. Enregistrez-la sous support-ticket.entity.ts et ajoutez-la au tableau entities de votre DataSource ou à TypeOrmModule.forFeature([SupportTicket]) dans un module NestJS.

Exemple

Entrée (JSON)
[
  { "subject": "Login fails on Safari", "priority": 2, "assignee": "jdoe", "closed": false, "opened_at": "2024-06-03T08:12:00Z" },
  { "subject": "Export CSV is empty", "priority": 1, "closed": true, "opened_at": "2024-06-04T14:40:00Z" }
]
Sortie (TypeORM)
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Entity()
export class SupportTicket {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  @IsNotEmpty()
  subject: string;

  @Column()
  @IsNotEmpty()
  priority: number;

  @Column({ nullable: true })
  @IsOptional()
  assignee: string | null;

  @Column()
  @IsNotEmpty()
  closed: boolean;

  @Column({ name: 'opened_at' })
  @IsNotEmpty()
  openedAt: Date;
}

Le deuxième ticket n'a pas d'assignee : cette colonne est donc @Column({ nullable: true }) avec le type string | null. opened_at est devenu la propriété openedAt typée Date, avec name: 'opened_at' qui conserve le nom de colonne d'origine.

Fonctionnalités prises en charge

  • Clé primaire tirée de vos données : pas de clé id ou un id entier → @PrimaryGeneratedColumn() id: number ; un id au-delà de la plage 32 bits → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string ; un id chaîne comme un UUID → @PrimaryColumn() id: string.
  • Types de colonnes : les entiers utilisent le @Column() par défaut, les décimaux reçoivent type: 'double precision' pour que les fractions ne soient pas tronquées, les colonnes bigint et date (date seule) sont typées string (TypeORM les renvoie en texte), les dates-heures sont Date.
  • Objets et tableaux deviennent des colonnes simple-json typées Record<string, unknown> ou un tableau typé comme string[].
  • Les chiffres entre guillemets comme "007" restent des colonnes string.
  • Les propriétés sont en camelCase ; @Column({ name: 'opened_at' }) est ajouté chaque fois que la clé JSON diffère.
  • Les champs qui valaient null ou manquaient reçoivent nullable: true, | null et @IsOptional() ; les autres @IsNotEmpty().

Cas d'utilisation

Compléter une entité juste après `nest g resource`

Remplacez le ticket.entity.ts vide créé par nest g resource tickets par cette sortie : l'entité correspond alors aux données fictives qu'utilisait déjà le frontend, et Repository<SupportTicket> est prêt à l'emploi.

Un point de départ pour les migrations générées

Une fois l'entité créée, typeorm migration:generate la compare à la base et écrit la migration CREATE TABLE, noms de colonnes et nullabilité compris.

Remarques et limites

  • simple-json stocke le JSON sous forme de texte : impossible de filtrer sur les valeurs qu'il contient. Passez à type: 'jsonb' sur PostgreSQL, ou type: 'json' sur MySQL, si vous devez les interroger.
  • double precision est un type flottant ; pour les prix, utilisez @Column('decimal', { precision: 10, scale: 2 }), que TypeORM renvoie sous forme de chaîne.
  • Les relations ne sont pas inférées. Les objets imbriqués qui sont en réalité d'autres entités devraient devenir des relations @ManyToOne ou @OneToMany.

FAQ

Sur quel nom de table l'entité est-elle mappée ?

@Entity() n'a pas de nom : le nommage par défaut de TypeORM transforme donc le nom de classe en snake_case, soit support_ticket. Pour une table existante, passez le nom, par exemple @Entity('tickets').

Et si emitDecoratorMetadata est désactivé ?

Un @Column() sans option lit son type dans les métadonnées de réflexion : TypeORM échoue alors avec une erreur de type de données. Activez-le dans le tsconfig ou précisez chaque type, par exemple @Column('varchar').

Quel type de base reçoit une propriété Date ?

datetime sur MySQL et timestamp without time zone sur PostgreSQL. Si les fuseaux horaires comptent sur PostgreSQL, passez à @Column('timestamptz').