JSON کو Mongoose (TypeScript) منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے Mongoose (TypeScript) منصوبے میں تبدیل کریں! NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB سپورٹ۔
JSON
نتیجہ
 

JSON کو Mongoose (TypeScript) منصوبے میں تبدیل کریں!

JSON کو NestJS کی @nestjs/mongoose schema کلاس میں بدلتا ہے: ہر فیلڈ پر @Prop() والی @Schema() کلاس، SchemaFactory.createForClass() سے بنایا گیا schema، اور ProductDocument type، سب ایک فائل میں۔ ہر فیلڈ پر class-validator کا @IsNotEmpty() یا @IsOptional() بھی ہوتا ہے۔

اسے تب استعمال کریں جب کسی NestJS module کو MongooseModule.forFeature() میں رجسٹر کرنے کے لیے schema چاہیے، آپ کے پاس محفوظ کرنے والے document کا نمونہ پہلے سے ہو، اور ہر decorator ہاتھ سے لکھنا ہی سست حصہ ہو۔

استعمال کا طریقہ

  1. ان پٹ میں نمونہ document پیسٹ کریں۔ اگر کچھ فیلڈز صرف کبھی کبھار ہوتے ہیں تو کئی documents array کی صورت میں پیسٹ کریں تاکہ اختیاری فیلڈز پہچانے جائیں۔
  2. ماڈل کا نام میں کلاس کا نام لکھیں (ڈیفالٹ MyModel)۔ product لکھنے سے Product، ProductDocument اور ProductSchema بنتے ہیں۔
  3. نتیجہ product.schema.ts کے طور پر محفوظ کریں اور اسے MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]) سے رجسٹر کریں۔

مثال

ان پٹ (JSON)
{
  "sku": "KB-87-RED",
  "title": "Mechanical keyboard",
  "price": 89.5,
  "stock": 42,
  "discontinued": false,
  "restocked_at": "2024-03-18"
}
آؤٹ پٹ (NestJS @nestjs/mongoose)
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);

نمونہ ایک ہی، پوری طرح بھرا ہوا document ہے، اس لیے ہر فیلڈ کو required: true اور @IsNotEmpty() ملتا ہے۔ restocked_at تاریخ کی شکل والی string ہے، اس لیے اس کی type Date ہے، اور property محفوظ key کا نام restocked_at ہی رکھتی ہے۔

معاون خصوصیات

  • Mongoose types واضح لکھی جاتی ہیں، مثلاً @Prop({ type: MongooseSchema.Types.String, required: true })۔ Mongoose کا Schema، MongooseSchema کے نام سے import ہوتا ہے تاکہ Schema decorator سے نہ ٹکرائے۔
  • TypeScript types: number، boolean، ISO 8601 تاریخ والی strings کے لیے Date، باقی سب کے لیے string، "0042" جیسی صرف ہندسوں والی strings سمیت۔
  • nested objects، MongooseSchema.Types.Mixed سے ڈکلیئر ہوتے ہیں اور ان کی type Record<string, unknown> ہوتی ہے؛ ایک ہی سادہ type کی arrays، string[] کے ساتھ مثلاً [MongooseSchema.Types.String] بنتی ہیں۔
  • property نام بغیر تبدیلی کے JSON keys ہوتے ہیں، ضرورت ہو تو quotes میں ('home-url': string)، اس لیے کلاس collection میں پہلے سے موجود documents سے میل کھاتی ہے۔
  • ہر document میں غیر خالی value والے فیلڈز کو required: true اور @IsNotEmpty() ملتا ہے؛ باقی کو صرف @IsOptional()۔ ان پٹ میں _id key چھوڑ دی جاتی ہے کیونکہ _id: MongooseSchema.Types.ObjectId پہلے سے ڈکلیئر ہے۔
  • @InjectModel(Product.name) model: Model<ProductDocument> جیسی injection کے لیے export type ProductDocument = Product & Document بنایا جاتا ہے۔

استعمال کے کیس

NestJS سروس میں collection شامل کرنا

کسی دوسری ٹیم کا بھیجا ہوا event payload، یا scraper کا JSON دیں اور schema کلاس حاصل کریں، پھر اسے @InjectModel سے inject کر کے فوراً create یا find کال کریں۔

Express کے Mongoose ماڈل کو NestJS میں منتقل کرنا

پرانے new Schema({...}) ماڈل سے محفوظ چند documents export کر کے یہاں پیسٹ کریں اور ہاتھ سے کاپی کرتے ہوئے فیلڈز چھوٹنے کے بغیر اسے decorator پر مبنی کلاس میں دوبارہ لکھیں۔

نوٹس اور حدود

  • @IsNotEmpty() اور @IsOptional()، schema کلاس پر ہیں، لیکن ValidationPipe controller کے DTOs کو validate کرتا ہے۔ requests validate کرنے کے لیے یہ decorators کسی DTO کلاس میں منتقل کریں یا نئی بنائیں۔
  • @Schema() میں کوئی options نہیں، اس لیے collection کا نام Mongoose کے اصول کے مطابق ماڈل نام کو چھوٹا اور جمع کر کے بنتا ہے: products۔ خاص نام چاہیے تو @Schema({ collection: 'product' }) سیٹ کریں۔
  • اختیاری فیلڈز بھی ? کے بغیر آتے ہیں (مثلاً memo: string)۔ strictNullChecks کے ساتھ انہیں memo?: string کر دینا زیادہ محفوظ ہے۔
  • sub-documents، typed schemas کے بجائے Mixed کے طور پر محفوظ ہوتے ہیں۔ ان کے اندر validation کے لیے الگ @Schema() کلاس بنائیں اور @Prop({ type: SubSchema }) استعمال کریں۔

عام سوالات

Document کو extend کرنے کے بجائے & Document کیوں؟

یہ NestJS docs کے ڈیفالٹ pattern پر چلتا ہے: schema کلاس سادہ فیلڈ definition رہتی ہے اور ProductDocument صرف وہاں استعمال ہوتا ہے جہاں save() جیسے Mongoose document methods چاہئیں۔ Mongoose 7+ پر HydratedDocument<Product> براہ راست متبادل ہے۔

اگر میرا پروجیکٹ class-validator استعمال نہیں کرتا تو؟

import { IsNotEmpty, IsOptional } from 'class-validator' والی لائن اور ہر فیلڈ پر موجود دونوں decorators مٹا دیں۔ schema کا رویہ صرف @Prop() کے required سے طے ہوتا ہے۔

کیا @Prop() میں type بتانا ضروری ہے؟

emitDecoratorMetadata کے ساتھ سادہ types کا اندازہ لگ سکتا ہے، لیکن arrays اور Date | null جیسے unions کے لیے اندازہ ناکام ہوتا ہے۔ بنایا گیا کوڈ type شروع ہی میں لکھ دیتا ہے تاکہ بعد میں property کی TypeScript type بدلنے پر بھی رویہ وہی رہے۔