Преобразуйте JSON в схему Mongoose (TypeScript)!

Введите JSON и преобразуйте его в схему Mongoose (TypeScript)! Поддержка: NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Результат
 

Преобразуйте JSON в схему Mongoose (TypeScript)!

Превращает JSON в класс схемы NestJS для @nestjs/mongoose: класс с @Schema() и @Prop() на каждом поле, схему, построенную через SchemaFactory.createForClass(), и тип ProductDocument — всё в одном файле. Каждое поле также получает @IsNotEmpty() или @IsOptional() из class-validator.

Используйте, когда модулю NestJS нужна схема для регистрации через MongooseModule.forFeature(), пример хранимого документа у вас уже есть, а расставлять все декораторы вручную — самая медленная часть.

Как пользоваться

  1. Вставьте пример документа в поле ввода. Если некоторые поля присутствуют не всегда, вставьте несколько документов массивом, чтобы необязательные поля были распознаны.
  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 — строка в формате даты, поэтому её тип Date, а свойство сохраняет хранимое имя ключа restocked_at.

Возможности

  • Типы Mongoose указываются явно, например @Prop({ type: MongooseSchema.Types.String, required: true }). Schema из Mongoose импортируется как MongooseSchema, чтобы не конфликтовать с декоратором Schema.
  • Типы TypeScript: number, boolean, Date для строк с датами ISO 8601, string для всего остального, включая строки из одних цифр вроде "0042".
  • Вложенные объекты объявляются через MongooseSchema.Types.Mixed с типом Record<string, unknown>; массивы одного простого типа становятся, например, [MongooseSchema.Types.String] с string[].
  • Имена свойств — неизменённые ключи JSON, при необходимости в кавычках ('home-url': string), так что класс совпадает с документами, уже лежащими в коллекции.
  • Поля с непустым значением во всех документах получают required: true и @IsNotEmpty(); остальные — только @IsOptional(). Ключ _id во вводе пропускается, потому что _id: MongooseSchema.Types.ObjectId уже объявлен.
  • Генерируется export type ProductDocument = Product & Document для внедрения вида @InjectModel(Product.name) model: Model<ProductDocument>.

Сценарии использования

Добавление коллекции в сервис NestJS

Подайте на вход payload события, присланный другой командой, или JSON от скрейпера, получите класс схемы, затем внедрите его через @InjectModel и сразу вызывайте create или find.

Перенос модели Mongoose из Express в NestJS

Выгрузите несколько документов, сохранённых старой моделью new Schema({...}), и вставьте их сюда, чтобы переписать её как класс на декораторах, не потеряв поля при ручном переносе.

Примечания и ограничения

  • @IsNotEmpty() и @IsOptional() стоят на классе схемы, а ValidationPipe валидирует DTO контроллеров. Чтобы валидировать запросы, перенесите эти декораторы в класс DTO или создайте его.
  • У @Schema() нет опций, поэтому имя коллекции следует правилу Mongoose — имя модели в нижнем регистре и во множественном числе: products. Если нужно конкретное имя, задайте @Schema({ collection: 'product' }).
  • Необязательные поля всё равно выводятся без ? (например, memo: string). Со strictNullChecks надёжнее поменять их на memo?: string.
  • Поддокументы хранятся как Mixed, а не как типизированные схемы. Для валидации внутри них определите отдельный класс @Schema() и используйте @Prop({ type: SubSchema }).

Частые вопросы

Почему & Document, а не наследование от Document?

Это следует стандартному шаблону из документации NestJS: класс схемы остаётся простым определением полей, а ProductDocument используется только там, где нужны методы документа Mongoose вроде save(). В Mongoose 7+ равноценной заменой служит HydratedDocument<Product>.

Что если в проекте нет class-validator?

Удалите строку import { IsNotEmpty, IsOptional } from 'class-validator' и оба декоратора на каждом поле. Поведение схемы определяется одним только required в @Prop().

Обязательно ли указывать type в @Prop()?

С emitDecoratorMetadata простые типы могут выводиться автоматически, но для массивов и объединений вроде Date | null вывод не срабатывает. Сгенерированный код указывает type сразу, так что поведение не изменится, если потом поменять TypeScript-тип свойства.