JSONをSequelize(TypeScript)スキーマに変換!

JSONを入力してSequelize(TypeScript)スキーマに変換します!sequelize-typescript @Table, @Column, Model, class-validator 対応。
JSON
結果
 

JSONをSequelize(TypeScript)スキーマに変換!

JSON を、sequelize-typescript ライブラリ向けのデコレーターベースのモデルに変換します。@Table と @Column({ type: DataType.*, allowNull }) を持ち Model を継承するクラス、TypeScript のプロパティ型、検証用の class-validator のデコレーターを出力します。

対象は素の sequelize ではなく sequelize-typescript(NestJS の @nestjs/sequelize の土台となっているライブラリ)なので、import のパスや DataType の綴り(末尾に s がない)が JavaScript 版とは異なります。

使い方

  1. テーブル1行分の JSON オブジェクト、または行の配列を貼り付けます。
  2. モデル名 にクラス名を入力します(既定は MyModel)。この名前は大文字のスネークケースにして @Table の tableName にも使われます。
  3. 結果を invoice.model.ts として保存し、new Sequelize({ ..., models: [Invoice] }) か NestJS の SequelizeModule.forFeature([Invoice]) で登録します。

例

入力 (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 のままですが、@IsNotEmpty() ではなく @IsOptional() が付きます。amount は DataType.DOUBLE に、due_date は DataType.DATEONLY で string 型になります。Sequelize は日付だけの値をテキストで返すためです。

対応機能

  • sequelize-typescript から { Table, Column, Model, DataType } を import し、クラスを extends Model<Invoice> として宣言します。
  • JavaScript 版のジェネレーターと同じく @Table({ tableName: 'INVOICE', timestamps: false }) を付けるので、createdAt/updatedAt カラムは前提になりません。
  • すべての @Column に type と allowNull を明記し、NULL を許可するカラムは string | null のような型になります。
  • 型の対応: INTEGER/BIGINT/DOUBLE → number、BOOLEAN → boolean、DATE → Date、DATEONLY → string、JSON → Record<string, unknown> または string[] のような型付き配列。
  • プロパティは camelCase で、field: 'invoice_no' が元のカラムを指します。JSON の id キーは重複させずに主キーとして使います。
  • すべての行に空でない値があるフィールドには @IsNotEmpty() が、それ以外には @IsOptional() が付きます。

利用シーン

`@nestjs/sequelize` を使う NestJS のモデル

外部の請求・精算システムから JSON で届くデータを永続化する必要があるとき、そのペイロードからモデルクラスを作り、@InjectModel(Invoice) を通して使えます。

JavaScript の Sequelize モデルを型付きのコードにする

define() のオブジェクトを手でクラスに書き直す代わりに、既存のテーブルデータを JSON でエクスポートして貼り付ければ、型付きのモデルの下書きが得られます。

注意点と制限

  • 金額などの正確な小数には、DataType.DOUBLE より DataType.DECIMAL(12, 2) のほうが安全です。
  • デコレーターが動くには、tsconfig で experimentalDecorators と emitDecoratorMetadata を有効にする必要があります。
  • useDefineForClassFields(target が ES2022 以降のときの既定)が有効だと、普通のプロパティ宣言が Sequelize の getter を覆い隠してしまいます。このオプションをオフにするか、プロパティに declare を付けてください。

よくある質問

Model<Invoice> ではなく Model<InvoiceAttributes, InvoiceCreationAttributes> にすべきでは?

sequelize-typescript v2 はジェネリクスを2つ受け取れますが、生成コードではクラス自体を渡すだけにしています。id のような自動生成フィールドを除いて Invoice.create({...}) を型チェックしたいなら、作成用の属性インターフェースを宣言して2つ目のジェネリクスに渡してください。

DataTypes ではなく DataType なのはなぜですか?

DataType は sequelize-typescript が export している名前です。sequelize から DataTypes を import しても同じように動きますが、1つのファイル内では名前を1つに統一したほうが読みやすくなります。

class-validator のデコレーターはモデル上で自動的にチェックされますか?

されません。検証が行われるのは、自分で validate(invoice) を呼んだときか、NestJS の ValidationPipe が扱う DTO にデコレーターがあるときだけです。Sequelize レベルで検証するなら、@Column({ validate: { notEmpty: true } }) や @NotEmpty のような sequelize-typescript のデコレーターを使ってください。