Convertissez JSON en schéma Mongoose (TypeScript) !

Entrez JSON et convertissez-le en schéma Mongoose (TypeScript) ! Compatible avec NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Résultat
 

Convertissez JSON en schéma Mongoose (TypeScript) !

Transforme du JSON en classe de schéma NestJS @nestjs/mongoose : une classe @Schema() avec @Prop() sur chaque champ, le schéma construit avec SchemaFactory.createForClass() et un type ProductDocument, le tout dans un seul fichier. Chaque champ porte aussi @IsNotEmpty() ou @IsOptional() de class-validator.

À utiliser quand un module NestJS a besoin d'un schéma à enregistrer avec MongooseModule.forFeature(), que vous avez déjà un exemple du document à stocker et qu'écrire chaque décorateur à la main est la partie la plus lente.

Mode d'emploi

  1. Collez un document d'exemple dans la zone de saisie. Si certains champs ne sont présents que parfois, collez plusieurs documents sous forme de tableau pour que les champs optionnels soient détectés.
  2. Saisissez le nom de la classe dans Nom du modèle (par défaut MyModel). Taper product produit Product, ProductDocument et ProductSchema.
  3. Enregistrez le résultat sous product.schema.ts et déclarez-le avec MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).

Exemple

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

L'exemple est un document unique entièrement rempli : chaque champ reçoit donc required: true et @IsNotEmpty(). restocked_at est une chaîne au format date, typée Date, et la propriété garde le nom de clé stocké restocked_at.

Fonctionnalités prises en charge

  • Les types Mongoose sont explicites, par exemple @Prop({ type: MongooseSchema.Types.String, required: true }). Le Schema de Mongoose est importé sous le nom MongooseSchema pour ne pas entrer en conflit avec le décorateur Schema.
  • Types TypeScript : number, boolean, Date pour les chaînes de date ISO 8601, string pour tout le reste, y compris les chaînes uniquement numériques comme "0042".
  • Les objets imbriqués sont déclarés avec MongooseSchema.Types.Mixed et typés Record<string, unknown> ; les tableaux d'un seul type simple deviennent par exemple [MongooseSchema.Types.String] avec string[].
  • Les noms de propriétés sont les clés JSON inchangées, entre guillemets si nécessaire ('home-url': string), pour que la classe corresponde aux documents déjà présents dans la collection.
  • Les champs ayant une valeur non vide dans chaque document reçoivent required: true et @IsNotEmpty() ; les autres seulement @IsOptional(). Une clé _id dans l'entrée est ignorée, car _id: MongooseSchema.Types.ObjectId est déjà déclaré.
  • export type ProductDocument = Product & Document est généré pour une injection du type @InjectModel(Product.name) model: Model<ProductDocument>.

Cas d'utilisation

Ajouter une collection à un service NestJS

Injectez un payload d'événement qu'une autre équipe vous a envoyé, ou le JSON d'un scraper, pour obtenir la classe de schéma, puis injectez-la avec @InjectModel et appelez create ou find tout de suite.

Migrer un modèle Mongoose Express vers NestJS

Exportez quelques documents enregistrés par l'ancien modèle new Schema({...}) et collez-les ici pour le réécrire en classe à décorateurs, sans perdre de champs en les recopiant à la main.

Remarques et limites

  • @IsNotEmpty() et @IsOptional() sont sur la classe de schéma, mais ValidationPipe valide les DTO des contrôleurs. Pour valider les requêtes, déplacez ces décorateurs dans une classe DTO ou créez-en une.
  • @Schema() n'a pas d'options : le nom de la collection suit la règle de Mongoose qui met le nom du modèle en minuscules et au pluriel, soit products. Indiquez @Schema({ collection: 'product' }) s'il vous faut un nom précis.
  • Les champs optionnels sortent quand même sans ? (par exemple memo: string). Avec strictNullChecks, les passer en memo?: string est plus sûr.
  • Les sous-documents sont stockés en Mixed plutôt qu'en schémas typés. Pour valider leur contenu, définissez une classe @Schema() séparée et utilisez @Prop({ type: SubSchema }).

FAQ

Pourquoi & Document au lieu d'étendre Document ?

C'est le modèle par défaut de la doc NestJS : la classe de schéma reste une simple définition de champs et ProductDocument ne sert que là où les méthodes de document Mongoose comme save() sont nécessaires. Sur Mongoose 7+, HydratedDocument<Product> est une alternative directe.

Et si mon projet n'utilise pas class-validator ?

Supprimez la ligne import { IsNotEmpty, IsOptional } from 'class-validator' et les deux décorateurs de chaque champ. Le comportement du schéma est piloté uniquement par required dans @Prop().

Dois-je préciser type dans @Prop() ?

Avec emitDecoratorMetadata, les types simples peuvent être inférés, mais l'inférence échoue pour les tableaux et les unions comme Date | null. Le code généré indique type d'emblée pour que le comportement reste identique si vous changez plus tard le type TypeScript d'une propriété.