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 মডিউলের MongooseModule.forFeature()-এ রেজিস্টার করার জন্য schema দরকার, রাখার মতো ডকুমেন্টের একটি নমুনা আপনার কাছে আছে, আর প্রতিটি decorator হাতে লেখাটাই সময়সাপেক্ষ, তখন এটি ব্যবহার করুন।

কীভাবে ব্যবহার করবেন

  1. ইনপুটে একটি নমুনা ডকুমেন্ট পেস্ট করুন। কিছু ফিল্ড মাঝে মাঝে থাকলে ঐচ্ছিক ফিল্ড শনাক্ত করার জন্য কয়েকটি ডকুমেন্ট 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);

নমুনাটি একটিমাত্র, পুরোপুরি ভরা ডকুমেন্ট, তাই প্রতিটি ফিল্ড required: true আর @IsNotEmpty() পায়। restocked_at তারিখ-ফরম্যাটের স্ট্রিং, তাই এর type Date, আর প্রপার্টিটি সংরক্ষিত key-এর নাম restocked_at-ই রাখে।

সমর্থিত বৈশিষ্ট্য

  • Mongoose type স্পষ্টভাবে লেখা থাকে, যেমন @Prop({ type: MongooseSchema.Types.String, required: true })। Mongoose-এর Schema MongooseSchema নামে import হয়, যাতে Schema decorator-এর সাথে নামের সংঘাত না হয়।
  • TypeScript type: number, boolean, ISO 8601 তারিখ স্ট্রিংয়ের জন্য Date, আর "0042"-এর মতো শুধু সংখ্যার স্ট্রিংসহ বাকি সবকিছুর জন্য string।
  • Nested অবজেক্ট MongooseSchema.Types.Mixed দিয়ে ডিক্লেয়ার হয় এবং type হয় Record<string, unknown>; একই সাধারণ type-এর array হয় যেমন string[]-সহ [MongooseSchema.Types.String]।
  • প্রপার্টির নাম অপরিবর্তিত JSON key, দরকার হলে কোটসহ ('home-url': string), তাই ক্লাসটি কালেকশনে আগে থেকে থাকা ডকুমেন্টের সাথে মেলে।
  • প্রতিটি ডকুমেন্টে ফাঁকা নয় এমন ভ্যালু থাকা ফিল্ড required: true আর @IsNotEmpty() পায়; বাকিগুলো শুধু @IsOptional() পায়। ইনপুটের _id key এড়িয়ে যাওয়া হয়, কারণ _id: MongooseSchema.Types.ObjectId আগে থেকেই ডিক্লেয়ার করা।
  • @InjectModel(Product.name) model: Model<ProductDocument>-এর মতো injection-এর জন্য export type ProductDocument = Product & Document তৈরি হয়।

ব্যবহারের ক্ষেত্র

NestJS সার্ভিসে একটি কালেকশন যোগ করা

অন্য টিমের পাঠানো ইভেন্ট payload বা scraper থেকে পাওয়া JSON দিয়ে schema ক্লাস পান, তারপর @InjectModel দিয়ে inject করে সাথে সাথেই create বা find কল করুন।

Express-এর Mongoose মডেল NestJS-এ সরানো

পুরোনো new Schema({...}) মডেলে সেভ হওয়া কয়েকটি ডকুমেন্ট export করে এখানে পেস্ট করুন, যাতে হাতে কপি করার সময় কোনো ফিল্ড বাদ না দিয়েই সেটিকে decorator-ভিত্তিক ক্লাস হিসেবে নতুন করে লেখা যায়।

নোট ও সীমাবদ্ধতা

  • @IsNotEmpty() আর @IsOptional() schema ক্লাসে বসে, কিন্তু ValidationPipe controller-এর DTO validate করে। Request validate করতে এই decorator-গুলো একটি DTO ক্লাসে সরান বা নতুন একটি তৈরি করুন।
  • @Schema()-এ কোনো অপশন নেই, তাই কালেকশনের নাম মডেলের নামকে ছোট হাতের ও বহুবচন করার Mongoose নিয়ম মানে: products। নির্দিষ্ট নাম দরকার হলে @Schema({ collection: 'product' }) সেট করুন।
  • ঐচ্ছিক ফিল্ডও ? ছাড়াই আসে (যেমন memo: string)। strictNullChecks চালু থাকলে সেগুলো memo?: string-এ বদলানো বেশি নিরাপদ।
  • Sub-document টাইপড schema-র বদলে Mixed হিসেবে সংরক্ষিত হয়। সেগুলোর ভেতরে validation চাইলে আলাদা একটি @Schema() ক্লাস ডিফাইন করে @Prop({ type: SubSchema }) ব্যবহার করুন।

সাধারণ প্রশ্ন

Document extend না করে কেন & Document?

এটি NestJS ডকুমেন্টেশনের ডিফল্ট প্যাটার্ন অনুসরণ করে: schema ক্লাসটি সাধারণ ফিল্ড ডেফিনিশন থাকে, আর ProductDocument ব্যবহার হয় শুধু যেখানে save()-এর মতো Mongoose ডকুমেন্ট মেথড দরকার। Mongoose 7+ এ HydratedDocument<Product> সরাসরি বিকল্প হিসেবে ব্যবহার করা যায়।

আমার প্রজেক্ট class-validator ব্যবহার না করলে?

import { IsNotEmpty, IsOptional } from 'class-validator' লাইন আর প্রতিটি ফিল্ডের দুটি decorator মুছে দিন। Schema-র আচরণ শুধু @Prop()-এর required দিয়েই নিয়ন্ত্রিত হয়।

@Prop()-এ কি type উল্লেখ করতেই হবে?

emitDecoratorMetadata থাকলে সাধারণ type অনুমান করা যায়, কিন্তু array আর Date | null-এর মতো union-এ অনুমান ব্যর্থ হয়। জেনারেট হওয়া কোড শুরু থেকেই type উল্লেখ করে, যাতে পরে কোনো প্রপার্টির TypeScript type বদলালেও আচরণ একই থাকে।