Mongoose (TS) স্কিমা কে JSON-এ রূপান্তর করুন!

Mongoose (TS) স্কিমা দিন এবং উদাহরণ JSON তৈরি করুন! Mongoose, NestJS @Prop সমর্থিত। API ডকুমেন্টেশন ও টেস্ট request body (sample JSON)-এর জন্য উপযোগী।
Mongoose (TS)
ফলাফল
 

Mongoose (TS) স্কিমা কে JSON-এ রূপান্তর করুন!

NestJS-এর @nestjs/mongoose দিয়ে লেখা @Schema() ক্লাস, বা সাধারণ TypeScript interface দিন, এটি toJSON() যেভাবে export করত সেভাবে ডকুমেন্টের একটি উদাহরণ তৈরি করে। ক্লাসে ডিক্লেয়ার না থাকলেও Mongoose-এর নিজস্ব নিয়ম মেনে _id, __v আর timestamp ফিল্ড যোগ হয়।

NestJS সার্ভিসে response DTO নিশ্চিত করতে, অথবা কোনো কালেকশনের টেস্ট ডকুমেন্ট কেমন হবে তা নিয়ে টিমের সাথে একমত হতে এটি ব্যবহার করুন। JS পেজের মতো নয়, এখানে ভ্যালু আসে @Prop() অপশন থেকে নয়, TypeScript প্রপার্টির type থেকে।

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

  1. Mongoose (TS) বক্সে schema ক্লাসের ফাইলটি পেস্ট করুন, subdocument হিসেবে ব্যবহৃত ক্লাসগুলোসহ, যাতে array আর nested অবজেক্ট পূরণ হয়।
  2. যে ক্লাসকে অন্য কেউ reference করে না সেটি রুট হয়; আউটপুটে আপনার মূল ডকুমেন্ট ক্লাসটিই আছে কি না নিশ্চিত হোন।
  3. @Schema({ timestamps: true, versionKey: false })-এর মতো অপশন বদলে দেখুন ফলাফলে createdAt আর __v কীভাবে আপডেট হয়।

উদাহরণ

ইনপুট (NestJS · @nestjs/mongoose)
@Schema({ _id: false })
export class Attachment {
  @Prop() url: string;
  @Prop() size: number;
}

@Schema({ timestamps: true, versionKey: false })
export class Message {
  @Prop({ type: Types.ObjectId, ref: "Room", required: true })
  roomId: Types.ObjectId;

  @Prop({ required: true })
  text: string;

  @Prop({ type: [Attachment], default: [] })
  attachments: Attachment[];

  @Prop()
  readAt?: Date;
}

export const MessageSchema = SchemaFactory.createForClass(Message);
আউটপুট (JSON)
{
  "_id": "507f1f77bcf86cd799439011",
  "roomId": "507f1f77bcf86cd799439011",
  "text": "",
  "attachments": [
    {
      "url": "",
      "size": 0
    }
  ],
  "readAt": "1970-01-01T00:00:00.000Z",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z"
}

Message Attachment-কে reference করে, তাই Message রুট। শুরুতে _id যোগ হয়, timestamps: true দুটি তারিখের ফিল্ড যোগ করে, আর versionKey: false __v সরিয়ে দেয়। Types.ObjectId type-এর roomId একটি নমুনা ObjectId স্ট্রিং হয়।

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

  • রুট ডকুমেন্ট _id (নমুনা ObjectId 507f1f77bcf86cd799439011) পায়, আর versionKey: false না থাকলে __v: 0; স্ট্রিং versionKey এর নাম বদলে দেয়।
  • @Schema({ timestamps: true }) ISO স্ট্রিং হিসেবে createdAt আর updatedAt যোগ করে।
  • Types.ObjectId আর MongooseSchema.Types.ObjectId ObjectId স্ট্রিং হয়; Types.Decimal128 আর অন্যান্য সংখ্যার type হয় 0।
  • Attachment[]-এর মতো অন্য ক্লাসের array সেই ক্লাস থেকে পূরণ করা এক element-এর array হয়।
  • রুট বাছাইয়ের সময় type UserDocument = HydratedDocument<User>-এর মতো type alias উপেক্ষা করা হয়, তাই আসল schema ক্লাসটিই বেছে নেওয়া হয়।
  • @Schema ছাড়া সাধারণ interface ডিক্লারেশনও কাজ করে, তাই IUser-এর মতো মডেল interface যেমন আছে তেমনই পেস্ট করা যায়।

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

NestJS response আর Swagger

কোনো সার্ভিস সরাসরি this.model.find().lean() ফেরত দিলে এটি দেখায় ক্লায়েন্ট ঠিক কোন key-গুলো পায়, response-এ ফাঁস হয়ে যাওয়া _id আর __v-সহ।

mongosh-এর জন্য টেস্ট ডকুমেন্ট

আউটপুট একটু বদলে db.messages.insertOne()-এ দিন, লোকাল ডাটাবেসে দ্রুত ডেটা বসানো যাবে। তখন ObjectId স্ট্রিংগুলো ObjectId("...")-এ মুড়ে দিন।

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

  • @Schema() decorator দেওয়া nested ক্লাস subdocument হিসেবে গণ্য হয়: সেগুলো নিজস্ব _id (যদি না @Schema({ _id: false })) আর timestamp পায়, কিন্তু কখনো __v পায় না। @Schema ছাড়া nested ক্লাস সাধারণ অবজেক্ট থাকে।
  • Literal @Prop({ default: ... }) নমুনা ভ্যালু হিসেবে ব্যবহৃত হয়; required আর enum অপশন পড়া হয় না। নির্দিষ্ট কিছু ভ্যালুর জন্য TypeScript literal union ডিক্লেয়ার করুন, তার প্রথম ভ্যালু ব্যবহৃত হবে।
  • @Prop({ type: Object }) দিয়ে ডিক্লেয়ার করা Record<string, any> {"key": null} হিসেবে দেখায়।
  • Virtual, toJSON transform আর select: false প্রয়োগ হয় না।

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

আমার API _id-কে id-তে বদলায়, কিন্তু আউটপুটে _id দেখায়।

আউটপুট Mongoose-এর ডিফল্ট toJSON() মানে। আপনার schema toJSON: { virtuals: true } বা কোনো transform দিয়ে id যোগ করলে ফলাফলে key-এর নাম বদলে নিন।

Type যদি শুধু অপশনে থাকে, যেমন @Prop({ type: [String] })?

ভ্যালু আসে প্রপার্টির ডিক্লেয়ার করা type থেকে। tags: string[] থাকলে পাবেন [""]; কোনো TypeScript type না থাকলে ভ্যালু অজানা, তাই null হয়।

এখানে কি JavaScript-এর new Schema({...}) কনভার্ট করা যায়?

JavaScript schema অবজেক্টের জন্য Mongoose (JS) থেকে JSON পেজ ব্যবহার করুন। সেটি { type: String, enum: [...] }-এর মতো schema অপশন সরাসরি পড়ে।