Converta JSON para esquema TypeORM!

Introduza JSON e converta-o para esquema TypeORM! Compatível com TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Resultado
 

Converta JSON para esquema TypeORM!

Converte dados JSON numa classe de entity do TypeORM: uma classe @Entity() com primary key, e cada uma das outras chaves como propriedade @Column() com tipo TypeScript, nulabilidade e um decorator do class-validator.

Use para criar a primeira entity do TypeOrmModule.forFeature([...]) num app NestJS + TypeORM, ou ao adicionar um DataSource do TypeORM a um projeto Express quando você precisa de entities que batam com os dados que já tem.

Como usar

  1. Cole o registro a guardar como objeto, ou vários registros como array. Campos que faltam em alguns registros viram colunas nullable.
  2. Informe o nome da classe da entity em Nome do modelo (padrão MyModel); support ticket vira SupportTicket.
  3. Salve como support-ticket.entity.ts e adicione ao array entities do seu DataSource ou ao TypeOrmModule.forFeature([SupportTicket]) num módulo NestJS.

Exemplo

Entrada (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" }
]
Saída (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;
}

O segundo ticket não tem assignee, então essa coluna é @Column({ nullable: true }) com o tipo string | null. opened_at virou a propriedade openedAt tipada como Date, com name: 'opened_at' mantendo o nome original da coluna.

Recursos suportados

  • Primary key a partir dos seus dados: sem chave id ou com id inteiro → @PrimaryGeneratedColumn() id: number; um id acima do intervalo de 32 bits → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; um id string, como um UUID → @PrimaryColumn() id: string.
  • Tipos de coluna: inteiros usam o @Column() padrão, decimais recebem type: 'double precision' para as frações não serem truncadas, colunas bigint e date só de data são tipadas como string (o TypeORM as devolve como texto), data e hora são Date.
  • Objetos e arrays viram colunas simple-json tipadas como Record<string, unknown> ou um array tipado como string[].
  • Dígitos entre aspas como "007" continuam colunas string.
  • As propriedades ficam em camelCase; @Column({ name: 'opened_at' }) é adicionado sempre que a chave JSON difere.
  • Campos que eram null ou estavam ausentes recebem nullable: true, | null e @IsOptional(); o resto recebe @IsNotEmpty().

Casos de uso

Preencher uma entity logo depois do `nest g resource`

Troque o ticket.entity.ts vazio criado pelo nest g resource tickets por esta saída; a entity passa a bater com os dados mock que o frontend já usava, e o Repository<SupportTicket> fica pronto para uso.

Um ponto de partida para migrations geradas

Depois de criar a entity, o typeorm migration:generate a compara com o banco e escreve a migration CREATE TABLE, com nomes de coluna e nulabilidade incluídos.

Observações e limitações

  • O simple-json guarda o JSON como texto, então não dá para filtrar por valores dentro dele. Troque para type: 'jsonb' no PostgreSQL ou para type: 'json' no MySQL se precisar fazer queries neles.
  • double precision é um tipo de ponto flutuante; para preços use @Column('decimal', { precision: 10, scale: 2 }), que o TypeORM devolve como string.
  • Relações não são inferidas. Objetos aninhados que na verdade são outras entities devem virar relações @ManyToOne ou @OneToMany.

Perguntas frequentes

Para qual nome de tabela a entity é mapeada?

O @Entity() não tem nome, então a nomenclatura padrão do TypeORM transforma o nome da classe em snake_case: support_ticket. Para uma tabela existente, passe o nome, por exemplo @Entity('tickets').

E se o emitDecoratorMetadata estiver desligado?

Um @Column() sem opções lê o tipo dos metadados de reflection, então o TypeORM falha com um erro de data type. Ative no tsconfig ou declare cada tipo, por exemplo @Column('varchar').

Que tipo de banco uma propriedade Date recebe?

datetime no MySQL e timestamp without time zone no PostgreSQL. Se fuso horário importa no PostgreSQL, troque para @Column('timestamptz').