Konversi JSON ke Mongoose (TypeScript)!

Masukkan JSON dan konversikan ke Mongoose (TypeScript)! Mendukung NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Hasil
 

Konversi JSON ke Mongoose (TypeScript)!

Mengubah JSON menjadi class schema NestJS @nestjs/mongoose: class @Schema() dengan @Prop() di setiap field, schema yang dibangun dengan SchemaFactory.createForClass(), dan tipe ProductDocument, semuanya dalam satu file. Setiap field juga diberi @IsNotEmpty() atau @IsOptional() dari class-validator.

Gunakan ketika sebuah module NestJS butuh schema untuk didaftarkan dengan MongooseModule.forFeature(), Anda sudah punya contoh dokumen yang akan disimpan, dan menulis setiap decorator secara manual adalah bagian yang lambat.

Cara menggunakan

  1. Tempel contoh dokumen ke input. Jika ada field yang hanya kadang muncul, tempel beberapa dokumen sebagai array agar field opsional terdeteksi.
  2. Isi nama class di Nama model (default MyModel). Mengetik product menghasilkan Product, ProductDocument dan ProductSchema.
  3. Simpan hasilnya sebagai product.schema.ts dan daftarkan dengan MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).

Contoh

Input (JSON)
{
  "sku": "KB-87-RED",
  "title": "Mechanical keyboard",
  "price": 89.5,
  "stock": 42,
  "discontinued": false,
  "restocked_at": "2024-03-18"
}
Output (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);

Contohnya adalah satu dokumen yang terisi penuh, jadi setiap field mendapat required: true dan @IsNotEmpty(). restocked_at adalah string berformat tanggal, jadi bertipe Date, dan propertinya mempertahankan nama key tersimpan restocked_at.

Fitur yang didukung

  • Tipe Mongoose ditulis eksplisit, misalnya @Prop({ type: MongooseSchema.Types.String, required: true }). Schema milik Mongoose di-import sebagai MongooseSchema agar tidak bentrok dengan decorator Schema.
  • Tipe TypeScript: number, boolean, Date untuk string tanggal ISO 8601, string untuk lainnya termasuk string berisi angka saja seperti "0042".
  • Objek bersarang dideklarasikan dengan MongooseSchema.Types.Mixed dan bertipe Record<string, unknown>; array berisi satu tipe sederhana menjadi misalnya [MongooseSchema.Types.String] dengan string[].
  • Nama properti adalah key JSON tanpa perubahan, diberi tanda kutip bila perlu ('home-url': string), jadi class cocok dengan dokumen yang sudah ada di collection.
  • Field yang memiliki nilai tidak kosong di setiap dokumen mendapat required: true ditambah @IsNotEmpty(); sisanya hanya mendapat @IsOptional(). Key _id di input dilewati karena _id: MongooseSchema.Types.ObjectId sudah dideklarasikan.
  • export type ProductDocument = Product & Document dibuat untuk injeksi seperti @InjectModel(Product.name) model: Model<ProductDocument>.

Kasus penggunaan

Menambahkan collection ke service NestJS

Masukkan payload event yang dikirim tim lain, atau JSON dari scraper, untuk mendapatkan class schema, lalu inject dengan @InjectModel dan langsung panggil create atau find.

Memindahkan model Mongoose Express ke NestJS

Ekspor beberapa dokumen yang disimpan oleh model lama new Schema({...}) dan tempel di sini untuk menulis ulang menjadi class berbasis decorator tanpa ada field yang terlewat seperti saat menyalinnya manual.

Catatan dan batasan

  • @IsNotEmpty() dan @IsOptional() berada di class schema, tetapi ValidationPipe memvalidasi DTO controller. Untuk memvalidasi request, pindahkan decorator ini ke class DTO atau buat DTO baru.
  • @Schema() tidak memiliki opsi, jadi nama collection mengikuti aturan Mongoose yang menjadikan nama model huruf kecil dan jamak: products. Atur @Schema({ collection: 'product' }) jika Anda butuh nama tertentu.
  • Field opsional tetap keluar tanpa ? (misalnya memo: string). Dengan strictNullChecks, mengubahnya menjadi memo?: string lebih aman.
  • Sub-dokumen disimpan sebagai Mixed, bukan schema bertipe. Untuk validasi di dalamnya, definisikan class @Schema() terpisah dan gunakan @Prop({ type: SubSchema }).

FAQ

Mengapa & Document dan bukan meng-extend Document?

Ini mengikuti pola default dokumentasi NestJS: class schema tetap berupa definisi field biasa dan ProductDocument hanya dipakai di tempat yang butuh method dokumen Mongoose seperti save(). Di Mongoose 7+, HydratedDocument<Product> bisa langsung menggantikannya.

Bagaimana jika proyek saya tidak memakai class-validator?

Hapus baris import { IsNotEmpty, IsOptional } from 'class-validator' dan kedua decorator di setiap field. Perilaku schema dikendalikan oleh required di @Prop() saja.

Apakah saya harus menentukan type di @Prop()?

Dengan emitDecoratorMetadata, tipe sederhana bisa disimpulkan, tetapi penyimpulan gagal untuk array dan union seperti Date | null. Kode yang dihasilkan menyebutkan type sejak awal agar perilakunya tetap sama ketika nanti Anda mengubah tipe TypeScript sebuah properti.