TypeORM এন্টিটি কে JSON-এ রূপান্তর করুন!

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

TypeORM এন্টিটি কে JSON-এ রূপান্তর করুন!

TypeORM entity ক্লাস পেস্ট করুন এবং সেই entity API থেকে ফেরত দিলে যে JSON আকৃতি তৈরি হয় তা placeholder ভ্যালু দিয়ে পূরণ করা অবস্থায় পান। এটি সেইসব NestJS বা Express প্রজেক্টের জন্য, যেগুলো response-এ সরাসরি entity ফেরত পাঠায় এবং Swagger উদাহরণ বা ফ্রন্টএন্ডের সাথে একমত হওয়ার মতো request/response নমুনা দরকার।

ভ্যালু আসে @Column অপশন থেকে নয়, প্রতিটি প্রপার্টির TypeScript type থেকে। তাই price: number-সহ @Column({ type: "decimal" }) হিসেবে ডিক্লেয়ার করা কলাম সংখ্যা 0 হিসেবে আসে।

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

  1. TypeORM বক্সে entity ফাইলটি পেস্ট করুন। সম্পর্কিত entity আর enum-ও দিন, যাতে nested অবজেক্ট পূরণ করা যায়।
  2. টাইপ করার সাথে সাথে ফলাফল বক্স আপডেট হয়। অন্য কোনো entity reference করে না এমন entity top-level JSON অবজেক্ট হয়; কয়েকটি সম্পর্কহীন entity থাকলে প্রত্যেকটি তার ক্লাসের নামের অধীনে দেখায়।
  3. ফলাফলের উপরের ডানদিকের কপি বাটন দিয়ে JSON নিন, অথবা Ctrl/⌘+Enter চাপুন।

উদাহরণ

ইনপুট (TypeORM)
enum Genre { Novel = "novel", Essay = "essay" }

@Entity()
export class Author {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;
}

@Entity()
export class Book {
  @PrimaryGeneratedColumn("uuid")
  id: string;

  @Column({ type: "enum", enum: Genre })
  genre: Genre;

  @Column({ type: "decimal", nullable: true })
  price: number | null;

  @ManyToOne(() => Author)
  author: Author;

  @Exclude()
  @Column()
  internalCode: string;
}
আউটপুট (JSON)
{
  "id": "",
  "genre": "novel",
  "price": 0,
  "author": {
    "id": 0,
    "name": ""
  }
}

Book Author-কে reference করে, তাই Book রুট আর author তার ভেতরে nested। @Exclude()-এর কারণে internalCode বাদ পড়ে, আর number | null type-এর price প্রথম non-null type অনুসরণ করে 0 হয়। uuid primary key-এর type string, তাই এটি একটি ফাঁকা স্ট্রিং।

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

  • @ManyToOne আর @OneToOne relation nested অবজেক্ট হয়; @OneToMany বা @ManyToMany-এর Post[] এক element-এর array হয়।
  • Lazy relation (Promise<Post[]>) আর ESM-এর Relation<User> wrapper খুলে ভেতরের type নেওয়া হয়।
  • TypeScript enum প্রথম member-এর ভ্যালু ব্যবহার করে: string enum-এর জন্য স্ট্রিং, numeric enum-এর জন্য সংখ্যা।
  • class-transformer-এর @Exclude() দেওয়া ফিল্ড, static ফিল্ড, মেথড আর getter বাদ যায়।
  • Date প্রপার্টি (@CreateDateColumn ইত্যাদি থেকে) 1970-01-01T00:00:00.000Z-এর মতো ISO স্ট্রিং হয়।
  • jsonb কলামে প্রচলিত type, যেমন Record<string, number>, {"key": 0} হিসেবে দেখানো হয়।
  • Entity-গুলো একে অপরকে reference করলে দ্বিতীয়বার যাওয়ার সময় null বা ফাঁকা array দিয়ে কেটে দেওয়া হয়, ফলে nesting সীমিত থাকে।

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

NestJS controller-এ Swagger উদাহরণ

সরাসরি entity ফেরত দেওয়া controller-এরও @ApiResponse-এর জন্য উদাহরণ payload দরকার। Entity ফাইল পেস্ট করে ফলাফলের placeholder ভ্যালুগুলো বাস্তবসম্মত ভ্যালু দিয়ে বদলান।

লোড করা relation আগে দেখে নেওয়া

relations: ["author"] দিয়ে কোয়েরি করলে ফ্রন্টএন্ড জানতে চায় response কত গভীরে nested। আউটপুট স্পষ্ট করে দেয় কোন relation ফিল্ড অবজেক্ট আর কোনগুলো array।

e2e টেস্টের fixture

supertest-এর POST কলের request body-র কাঠামো হিসেবে আউটপুট ব্যবহার করুন। id আর timestamp-এর মতো জেনারেট হওয়া ফিল্ড মুছে বাকিগুলো পূরণ করুন।

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

  • nullable, default বা length-এর মতো @Column অপশন পড়া হয় না; ভ্যালু আসে প্রপার্টির type বা literal initializer (status = "draft") থেকে। কোনো কলাম null হতে পারলে সেই ভ্যালু নিজে null-এ বদলান।
  • একে অপরকে reference করে না এমন কয়েকটি @Entity ক্লাস সবই কনভার্ট হয়, ক্লাসের নাম অনুযায়ী key করে ({ "Book": {...}, "Author": {...} })। একে অপরকে reference করা entity তবুও একটি nested রুটই তৈরি করে।
  • পেস্ট না করে import করা ক্লাস টুলের কাছে অজানা, তাই null হিসেবে দেখায়।
  • ClassSerializerInterceptor-এর সাথে ব্যবহৃত @Expose, serialization group আর @Transform প্রয়োগ হয় না।

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

আমার @PrimaryGeneratedColumn("uuid") কেন ফাঁকা স্ট্রিং?

শুধু প্রপার্টির type-ই ভ্যালু নির্ধারণ করে। id: string দেয় ""; decorator-এর "uuid" আর্গুমেন্ট পড়া হয় না। ডকুমেন্টেশনের জন্য পরে UUID আকৃতির একটি ভ্যালু বসিয়ে দিন।

Entity পাঠালে আমার API কি সত্যিই এটাই ফেরত দেয়?

এটি পুরোপুরি লোড করা entity-র JSON.stringify-এর সাথে মেলে। relations দিয়ে লোড না করা relation আসল response-এ থাকেই না, তাই আউটপুটের relation ফিল্ডগুলোকে লোড করা অবস্থা হিসেবে ধরুন।

Decimal কলাম সংখ্যা দেখায়, কিন্তু আমার API স্ট্রিং ফেরত দেয়। কেন?

Precision হারানো এড়াতে PostgreSQL আর MySQL driver decimal ভ্যালু স্ট্রিং হিসেবে ফেরত দেয়। Entity-তে প্রপার্টিটি price: string হিসেবে ডিক্লেয়ার করুন, তাহলে আপনার আসল ডেটার মতো আউটপুটও স্ট্রিং হবে।