¡Convierte JSON a esquema de TypeORM!

¡Introduce JSON y conviértelo en esquema de TypeORM! Compatible con TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Resultado
 

¡Convierte JSON a esquema de TypeORM!

Convierte datos JSON en una clase de entidad de TypeORM: una clase @Entity() con clave primaria, y cada una de las demás claves como una propiedad @Column() con tipo TypeScript, nulabilidad y un decorador de class-validator.

Úsalo para crear la primera entidad para TypeOrmModule.forFeature([...]) en una app NestJS + TypeORM, o cuando añades un DataSource de TypeORM a un proyecto Express y necesitas entidades que coincidan con datos que ya tienes.

Cómo usar

  1. Pega el registro que vas a guardar como objeto, o varios registros como array. Los campos que faltan en algunos registros pasan a columnas nullable.
  2. Escribe el nombre de la clase de entidad en Nombre del modelo (por defecto MyModel); support ticket pasa a SupportTicket.
  3. Guárdalo como support-ticket.entity.ts y añádelo al array entities de tu DataSource o a TypeOrmModule.forFeature([SupportTicket]) en un módulo de NestJS.

Ejemplo

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

El segundo ticket no tiene assignee, así que esa columna es @Column({ nullable: true }) con el tipo string | null. opened_at pasó a ser la propiedad openedAt de tipo Date, y name: 'opened_at' conserva el nombre de columna original.

Funciones compatibles

  • Clave primaria a partir de tus datos: sin clave id o con un id entero → @PrimaryGeneratedColumn() id: number; un id por encima del rango de 32 bits → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; un id de cadena como un UUID → @PrimaryColumn() id: string.
  • Tipos de columna: los enteros usan el @Column() por defecto, los decimales reciben type: 'double precision' para que no se trunquen las fracciones, las columnas bigint y las de solo fecha date se tipan como string (TypeORM las devuelve como texto), y las fechas con hora son Date.
  • Los objetos y arrays pasan a columnas simple-json tipadas como Record<string, unknown> o como un array tipado como string[].
  • Los dígitos entre comillas como "007" se quedan como columnas string.
  • Las propiedades van en camelCase; se añade @Column({ name: 'opened_at' }) siempre que la clave JSON difiere.
  • Los campos que eran null o faltaban reciben nullable: true, | null e @IsOptional(); el resto recibe @IsNotEmpty().

Casos de uso

Completar una entidad justo después de `nest g resource`

Sustituye el ticket.entity.ts vacío que crea nest g resource tickets por esta salida; la entidad coincide entonces con los datos mock que el frontend ya estaba usando, y Repository<SupportTicket> queda listo para usar.

Un punto de partida para migraciones generadas

Después de crear la entidad, typeorm migration:generate la compara con la base de datos y escribe la migración CREATE TABLE, incluidos los nombres de columna y la nulabilidad.

Notas y limitaciones

  • simple-json guarda el JSON como texto, así que no puedes filtrar por valores dentro de él. En PostgreSQL cambia a type: 'jsonb', y en MySQL a type: 'json', si necesitas consultarlos.
  • double precision es un tipo de coma flotante; para precios usa @Column('decimal', { precision: 10, scale: 2 }), que TypeORM devuelve como cadena.
  • No se infieren relaciones. Los objetos anidados que en realidad son otras entidades deberían convertirse en relaciones @ManyToOne o @OneToMany.

Preguntas frecuentes

¿A qué nombre de tabla se mapea la entidad?

@Entity() no tiene nombre, así que la nomenclatura por defecto de TypeORM convierte el nombre de la clase a snake_case: support_ticket. Para una tabla existente, pasa el nombre, p. ej. @Entity('tickets').

¿Y si emitDecoratorMetadata está desactivado?

Un @Column() sin opciones lee su tipo de los metadatos de reflexión, así que TypeORM falla con un error de tipo de datos. Actívalo en el tsconfig o indica cada tipo, p. ej. @Column('varchar').

¿Qué tipo de base de datos recibe una propiedad Date?

datetime en MySQL y timestamp without time zone en PostgreSQL. Si en PostgreSQL importan las zonas horarias, cambia a @Column('timestamptz').