Sequelize(TS)のモデルをJSONに変換!

Sequelize(TS)のモデルを入力するとサンプルJSONを作ります!Sequelize, sequelize-typescript 対応。API ドキュメントやテスト用のリクエストボディ(sample JSON)に。
Sequelize (TS)
結果
 

Sequelize(TS)のモデルをJSONに変換!

sequelize-typescript で書いた @Table のモデルクラスを渡すと、インスタンスの toJSON() の出力と同じ形の例の JSON を作ります。クラスで宣言していなくても Sequelize が追加する id、createdAt、updatedAt、deletedAt の属性も含まれます。

JS 版のページと違い、ここでは値を DataType の引数ではなく各プロパティの TypeScript の型から取ります。amount: string と宣言した @Column(DataType.DECIMAL) は文字列になります。

使い方

  1. @Table クラスを含むファイルを Sequelize (TS) 欄に貼り付けます。@HasMany などで関連付けたモデルも加えると、ネストした値が得られます。
  2. 結果 欄で、自動で追加された属性を含む JSON を確認します。
  3. timestamps や paranoid などの @Table のオプションを切り替えると、日付のフィールドがどう変わるかがすぐにわかります。

例

入力 (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
出力 (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

クラスに主キーがないので先頭に id が追加され、paranoid: true によって deletedAt: null が加わります。status はユニオンの最初のリテラル "draft" を取り、amount は string と宣言されているので空文字列です。

対応機能

  • @PrimaryKey、@Column({ primaryKey: true })、id プロパティのいずれもない場合は、ルートでも関連モデルでも先頭に id: 0 を挿入します。
  • @Table で timestamps: false を設定していない限り createdAt と updatedAt を追加します。createdAt: "created_on" のような改名、updatedAt: false、paranoid: true(deletedAt: null)もモデルごとに反映します。
  • @HasMany の Post[] は配列に、@BelongsTo と @HasOne はネストしたオブジェクトになります。
  • "draft" | "sent" のようなリテラルのユニオンは最初の値を使い、extends Model で継承したものはすべて無視します。
  • { theme: string } のようにオブジェクト型を付けた DataType.JSON のカラムは、その形で埋めます。

利用シーン

Express ハンドラーのドキュメント化

res.json(await Invoice.findByPk(id)) を返すエンドポイントなら、自動で追加される属性も含めて、キーが実態と一致したレスポンス例が得られます。

論理削除を有効にする前と後

paranoid をオンにすると、すべてのレスポンスに deletedAt が加わります。オプションのオン・オフで出力を比べれば、API の利用者に何が変わるのかを正確に伝えられます。

注意点と制限

  • ルートの中にネストした関連モデルは、自身の @Table オプションに従って独自の id とタイムスタンプを持ちますが、Sequelize が暗黙に追加する外部キー(@ForeignKey カラムのない @HasMany の対象にある invoiceId など)を勝手に作ることはしません。
  • JSON のキーはプロパティ名なので、allowNull や @Column({ field: ... }) によるカラム名の変更は無視します。@Default("x") と @Column({...}) 内のリテラルの defaultValue はサンプル値として使います。
  • underscored: true が変えるのはデータベースのカラム名だけで、toJSON() は引き続き属性名を使うので、出力の createdAt で正しいです。
  • 値は TypeScript の型から作るので、デコレーターでしか型を指定していないプロパティ(型注釈のない @Column(DataType.INTEGER) count;)は null になります。

よくある質問

DECIMAL のカラムは number と string のどちらで型を付けるべきですか?

MySQL と PostgreSQL では、Sequelize は既定で DECIMAL の値を文字列で返します。amount: string と型を付けておけば型が実態と一致し、ここでの例も文字列で表示されます。

declare のフィールドや CreationOptional を使えますか?

使えます。declare id: CreationOptional<number> は number として読み、NonAttribute<...> や ForeignKey<...> も同じように中身を取り出します。InferAttributes のように、これら以外のヘルパー型は展開しません。

このページは JavaScript で書いた sequelize.define のモデルも扱えますか?

扱えません。このページが読むのはクラスと TypeScript の型です。define や Model.init のモデルには、DataTypes を読み取る Sequelize (JS) → JSON のページを使ってください。