Transforma JSON numa classe de schema @nestjs/mongoose do NestJS: uma classe @Schema() com @Prop() em cada campo, o schema montado com SchemaFactory.createForClass() e um tipo ProductDocument, tudo num arquivo só. Cada campo também leva o @IsNotEmpty() ou o @IsOptional() do class-validator.
Use quando um módulo NestJS precisa de um schema para registrar com MongooseModule.forFeature(), você já tem um exemplo do documento a guardar e escrever cada decorator à mão é a parte demorada.
Nome do modelo (padrão MyModel). Digitar product gera Product, ProductDocument e ProductSchema.product.schema.ts e registre com 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);O exemplo é um único documento todo preenchido, então todo campo recebe required: true e @IsNotEmpty(). restocked_at é uma string em formato de data, então é tipado como Date, e a propriedade mantém o nome da chave armazenada, restocked_at.
@Prop({ type: MongooseSchema.Types.String, required: true }). O Schema do Mongoose é importado como MongooseSchema para não conflitar com o decorator Schema.number, boolean, Date para strings de data ISO 8601, string para todo o resto, incluindo strings só de dígitos como "0042".MongooseSchema.Types.Mixed e tipados como Record<string, unknown>; arrays de um só tipo simples viram, por exemplo, [MongooseSchema.Types.String] com string[].'home-url': string), então a classe bate com os documentos que já estão na collection.required: true mais @IsNotEmpty(); o resto recebe só @IsOptional(). Uma chave _id na entrada é pulada porque _id: MongooseSchema.Types.ObjectId já está declarado.export type ProductDocument = Product & Document para injeção do tipo @InjectModel(Product.name) model: Model<ProductDocument>.Passe um payload de evento que outro time mandou para você, ou o JSON de um scraper, para obter a classe de schema; depois injete com @InjectModel e chame create ou find na hora.
Exporte alguns documentos salvos pelo model antigo new Schema({...}) e cole aqui para reescrevê-lo como classe baseada em decorators, sem perder campos copiando tudo à mão.
@IsNotEmpty() e @IsOptional() ficam na classe de schema, mas o ValidationPipe valida os DTOs do controller. Para validar requests, mova esses decorators para uma classe DTO ou crie uma.@Schema() não tem opções, então o nome da collection segue a regra do Mongoose de passar o nome do model para minúscula e para o plural: products. Defina @Schema({ collection: 'product' }) se precisar de um nome específico.? (por exemplo memo: string). Com strictNullChecks, trocar para memo?: string é mais seguro.Mixed em vez de schemas tipados. Para validar dentro deles, defina uma classe @Schema() separada e use @Prop({ type: SubSchema }).& Document em vez de estender Document?Segue o padrão da documentação do NestJS: a classe de schema continua uma definição simples de campos e o ProductDocument só é usado onde são necessários métodos de documento do Mongoose como save(). No Mongoose 7+, HydratedDocument<Product> é uma alternativa direta.
Apague a linha import { IsNotEmpty, IsOptional } from 'class-validator' e os dois decorators de cada campo. O comportamento do schema é controlado só pelo required no @Prop().
type no @Prop()?Com emitDecoratorMetadata, tipos simples podem ser inferidos, mas a inferência falha para arrays e unions como Date | null. O código gerado declara o type logo de cara para o comportamento continuar o mesmo quando você mudar depois o tipo TypeScript de uma propriedade.