TypeORM entity کلاسز پیسٹ کریں اور placeholder values سے بھری وہ JSON شکل حاصل کریں جو یہ entities API سے لوٹائے جانے پر بناتی ہیں۔ یہ ان NestJS یا Express پروجیکٹس کے لیے ہے جو entities کو سیدھا responses میں واپس بھیجتے ہیں اور جنہیں Swagger مثالیں یا فرنٹ اینڈ کے ساتھ طے کرنے کے لیے request/response نمونے چاہئیں۔
values، @Column options سے نہیں بلکہ ہر property کی TypeScript type سے آتی ہیں۔ اس لیے price: number کے ساتھ @Column({ type: "decimal" }) ڈکلیئر کیا گیا کالم نمبر 0 کی صورت میں آتا ہے۔
TypeORM باکس میں پیسٹ کریں۔ متعلقہ entities اور enums بھی شامل کریں تاکہ nested objects بھرے جا سکیں۔نتیجہ باکس تازہ ہوتا جاتا ہے۔ جس entity کا کوئی دوسری entity حوالہ نہیں دیتی وہ سب سے اوپر کا JSON آبجیکٹ بنتی ہے؛ اگر کئی غیر متعلقہ entities ہوں تو ہر ایک اپنے کلاس نام کے نیچے آتی ہے۔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;
}{
"id": "",
"genre": "novel",
"price": 0,
"author": {
"id": 0,
"name": ""
}
}Book، Author کا حوالہ دیتا ہے، اس لیے Book root ہے اور author اس کے اندر nested ہے۔ @Exclude() کی وجہ سے internalCode ہٹا دیا جاتا ہے، اور number | null type والا price پہلی غیر null type کے مطابق 0 بنتا ہے۔ uuid primary key کی type string ہے، اس لیے یہ خالی string ہے۔
@ManyToOne اور @OneToOne relations، nested objects بنتے ہیں؛ @OneToMany یا @ManyToMany سے Post[] ایک عنصر والی array بنتا ہے۔Promise<Post[]>) اور ESM کا Relation<User> wrapper کھول کر اندرونی type تک پہنچا جاتا ہے۔@Exclude() والے فیلڈز، static فیلڈز، methods اور getters چھوڑ دیے جاتے ہیں۔Date properties (@CreateDateColumn وغیرہ سے) 1970-01-01T00:00:00.000Z جیسی ISO strings بنتی ہیں۔Record<string, number>، {"key": 0} کی صورت میں دکھائی جاتی ہیں۔null یا خالی array سے کاٹ دیا جاتا ہے تاکہ nesting محدود رہے۔جو controllers سیدھا entities لوٹاتے ہیں انہیں بھی @ApiResponse کے لیے مثالی payload چاہیے۔ entity فائل پیسٹ کریں اور نتیجے میں placeholder values کو حقیقت سے قریب values سے بدلیں۔
جب آپ relations: ["author"] کے ساتھ query کرتے ہیں تو فرنٹ اینڈ جاننا چاہتا ہے کہ response کتنا گہرا nested ہے۔ آؤٹ پٹ واضح کر دیتا ہے کہ کون سے relation فیلڈز objects ہیں اور کون سے arrays۔
آؤٹ پٹ کو supertest کی POST calls کے لیے request body کے ڈھانچے کے طور پر استعمال کریں۔ id اور timestamps جیسے بنائے گئے فیلڈز مٹائیں، پھر باقی بھریں۔
nullable، default یا length جیسے @Column options نہیں پڑھے جاتے؛ value، property type یا literal initializer (status = "draft") سے آتی ہے۔ اگر کوئی کالم null ہو سکتا ہے تو وہ value خود null کر دیں۔@Entity کلاسز سب تبدیل ہوتی ہیں، کلاس نام کو key بنا کر ({ "Book": {...}, "Author": {...} })۔ ایک دوسرے کا حوالہ دینے والی entities پھر بھی ایک nested root بناتی ہیں۔null کی صورت میں آتی ہیں۔ClassSerializerInterceptor کے ساتھ استعمال ہونے والے @Expose، serialization groups اور @Transform لاگو نہیں ہوتے۔@PrimaryGeneratedColumn("uuid") خالی string کیوں ہے؟value صرف property type طے کرتی ہے۔ id: string سے "" ملتا ہے؛ decorator میں "uuid" argument نہیں پڑھا جاتا۔ documentation کے لیے بعد میں UUID جیسی value ڈال دیں۔
یہ پوری طرح لوڈ شدہ entity کے JSON.stringify سے میل کھاتا ہے۔ جو relations آپ نے relations سے لوڈ نہیں کیے وہ اصل response میں ہوتے ہی نہیں، اس لیے آؤٹ پٹ کے relation فیلڈز کو لوڈ ہونے والی صورت سمجھیں۔
PostgreSQL اور MySQL drivers درستگی کے نقصان سے بچنے کے لیے decimal values کو strings کی صورت میں لوٹاتے ہیں۔ entity میں property کو price: string ڈکلیئر کریں تو آؤٹ پٹ بھی، آپ کے اصل ڈیٹا کی طرح، string ہوگا۔