JSON を NestJS の @nestjs/mongoose スキーマクラスに変換します。すべてのフィールドに @Prop() を付けた @Schema() クラス、SchemaFactory.createForClass() で作るスキーマ、ProductDocument 型を1つのファイルにまとめて出力します。各フィールドには class-validator の @IsNotEmpty() か @IsOptional() も付きます。
NestJS のモジュールで MongooseModule.forFeature() に登録するスキーマが必要で、保存するドキュメントのサンプルは手元にあり、デコレーターをすべて手で書くのが面倒なときに使ってください。
モデル名 にクラス名を入力します(既定は MyModel)。product と入力すると Product、ProductDocument、ProductSchema が作られます。product.schema.ts として保存し、MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]) で登録します。{
"sku": "KB-87-RED",
"title": "Mechanical keyboard",
"price": 89.5,
"stock": 42,
"discontinued": false,
"restocked_at": "2024-03-18"
}import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
import { IsNotEmpty, IsOptional } from 'class-validator';
export type ProductDocument = Product & Document;
@Schema()
export class Product {
_id: MongooseSchema.Types.ObjectId;
@Prop({ type: MongooseSchema.Types.String, required: true })
@IsNotEmpty()
sku: string;
@Prop({ type: MongooseSchema.Types.String, required: true })
@IsNotEmpty()
title: string;
@Prop({ type: MongooseSchema.Types.Number, required: true })
@IsNotEmpty()
price: number;
@Prop({ type: MongooseSchema.Types.Number, required: true })
@IsNotEmpty()
stock: number;
@Prop({ type: MongooseSchema.Types.Boolean, required: true })
@IsNotEmpty()
discontinued: boolean;
@Prop({ type: MongooseSchema.Types.Date, required: true })
@IsNotEmpty()
restocked_at: Date;
}
export const ProductSchema = SchemaFactory.createForClass(Product);サンプルはすべて埋まったドキュメント1つなので、すべてのフィールドに required: true と @IsNotEmpty() が付きます。restocked_at は日付形式の文字列なので Date 型になり、プロパティは保存されているキー名 restocked_at のままです。
@Prop({ type: MongooseSchema.Types.String, required: true }))。Mongoose の Schema は、Schema デコレーターと衝突しないよう MongooseSchema として import します。number、boolean、ISO 8601 の日付文字列は Date、"0042" のような数字だけの文字列を含むそれ以外はすべて string。MongooseSchema.Types.Mixed で宣言して Record<string, unknown> 型にし、単純な型1種類の配列は string[] と [MongooseSchema.Types.String] のようになります。'home-url': string)ので、クラスはコレクションにすでにあるドキュメントと一致します。required: true と @IsNotEmpty() が、それ以外には @IsOptional() だけが付きます。入力の _id キーは、_id: MongooseSchema.Types.ObjectId がすでに宣言されているので飛ばします。@InjectModel(Product.name) model: Model<ProductDocument> のように注入できるよう、export type ProductDocument = Product & Document を生成します。他のチームから送られてきたイベントのペイロードや、スクレイパーが出力した JSON を入力してスキーマクラスを得れば、@InjectModel で注入してすぐに create や find を呼べます。
古い new Schema({...}) モデルで保存されたドキュメントをいくつかエクスポートしてここに貼り付ければ、手で写す途中でフィールドを落とすことなく、デコレーターベースのクラスに書き直せます。
@IsNotEmpty() と @IsOptional() はスキーマクラスに付いていますが、ValidationPipe が検証するのはコントローラーの DTO です。リクエストを検証するなら、これらのデコレーターを DTO クラスに移すか、DTO を作ってください。@Schema() にオプションがないため、コレクション名はモデル名を小文字・複数形にする Mongoose のルールに従って products になります。特定の名前が必要なら @Schema({ collection: 'product' }) を設定してください。? なしで出力されます(例: memo: string)。strictNullChecks を使っているなら memo?: string に変えるほうが安全です。Mixed として保存されます。その中まで検証したい場合は、別の @Schema() クラスを定義して @Prop({ type: SubSchema }) を使ってください。Document を継承せずに & Document にしているのはなぜですか?NestJS ドキュメントの基本パターンに従っています。スキーマクラスは純粋なフィールド定義のままにし、save() のような Mongoose のドキュメントメソッドが必要な場所でだけ ProductDocument を使います。Mongoose 7 以降なら HydratedDocument<Product> でそのまま置き換えられます。
import { IsNotEmpty, IsOptional } from 'class-validator' の行と、各フィールドの2つのデコレーターを削除してください。スキーマの挙動は @Prop() の required だけで決まります。
@Prop() に type を指定する必要はありますか?emitDecoratorMetadata があれば単純な型は推論できますが、配列や Date | null のようなユニオンでは推論に失敗します。あとでプロパティの TypeScript の型を変えても挙動が変わらないよう、生成コードでは最初から type を明示しています。