Преобразуйте JSON в схему Sequelize (TypeScript)!

Введите JSON и преобразуйте его в схему Sequelize (TypeScript)! Поддержка: sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Результат
 

Преобразуйте JSON в схему Sequelize (TypeScript)!

Преобразует JSON в модель на декораторах для библиотеки sequelize-typescript: класс, наследующий Model, с @Table и @Column({ type: DataType.*, allowNull }), типами свойств TypeScript и декораторами class-validator для валидации.

Рассчитан на sequelize-typescript (библиотеку, на которой построен @nestjs/sequelize в NestJS), а не на обычный sequelize, поэтому путь импорта и написание DataType (без s на конце) отличаются от JavaScript-версии.

Как пользоваться

  1. Вставьте JSON-объект одной строки таблицы или массив строк.
  2. Введите имя класса в Имя модели (по умолчанию MyModel); оно же становится tableName в верхнем snake case в @Table.
  3. Сохраните результат как invoice.model.ts и зарегистрируйте через new Sequelize({ ..., models: [Invoice] }) или SequelizeModule.forFeature([Invoice]) в NestJS.

Пример

Вход (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Результат (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 — пустая строка: это не NULL, поэтому колонка сохраняет allowNull: false, но получает @IsOptional(), а не @IsNotEmpty(). amount становится DataType.DOUBLE, а due_date — DataType.DATEONLY с типом string, потому что Sequelize возвращает значения только с датой в виде текста.

Возможности

  • Импортирует { Table, Column, Model, DataType } из sequelize-typescript и объявляет класс как extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), как и в генераторе для JavaScript, так что колонки createdAt/updatedAt не предполагаются.
  • Каждый @Column указывает type и allowNull; nullable-колонки получают типы вроде string | null.
  • Пары типов: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> или типизированный массив вроде string[].
  • Свойства в camelCase с field: 'invoice_no', указывающим на исходную колонку; ключ id в JSON используется как первичный ключ, а не дублируется.
  • Поля с непустым значением во всех строках получают @IsNotEmpty(), остальные — @IsOptional().

Сценарии использования

Модели для NestJS с `@nestjs/sequelize`

Когда нужно сохранять данные, которые внешняя система биллинга или взаиморасчётов присылает в JSON, постройте класс модели по этому payload и используйте его через @InjectModel(Invoice).

Перевод моделей Sequelize на JavaScript в типизированный код

Выгрузите данные существующей таблицы в JSON и вставьте их, чтобы получить черновик типизированной модели вместо ручного переписывания объекта define() в класс.

Примечания и ограничения

  • Для денег и других точных десятичных значений DataType.DECIMAL(12, 2) надёжнее, чем DataType.DOUBLE.
  • Чтобы декораторы работали, в tsconfig должны быть включены experimentalDecorators и emitDecoratorMetadata.
  • С useDefineForClassFields (по умолчанию для target ES2022 и новее) простые объявления свойств перекрывают геттеры Sequelize. Отключите эту опцию или добавьте к свойствам префикс declare.

Частые вопросы

Разве не должно быть Model<InvoiceAttributes, InvoiceCreationAttributes> вместо Model<Invoice>?

sequelize-typescript v2 принимает два дженерика; сгенерированный код просто передаёт сам класс. Если хотите, чтобы Invoice.create({...}) проверялся по типам без автогенерируемых полей вроде id, объявите интерфейс атрибутов создания и передайте его вторым дженериком.

Почему DataType, а не DataTypes?

DataType — имя, которое экспортирует sequelize-typescript. Импорт DataTypes из sequelize работает так же, но одно имя на файл читается лучше.

Проверяются ли декораторы class-validator на модели автоматически?

Нет. Валидация происходит, только когда вы сами вызываете validate(invoice) или когда декораторы стоят на DTO, который обрабатывает ValidationPipe в NestJS. Для валидации на уровне Sequelize используйте @Column({ validate: { notEmpty: true } }) или декораторы sequelize-typescript вроде @NotEmpty.