@picadeck/mongoose-parser

Mongoose schema parser for Picadeck Schema Visualizer. Converts Mongoose models into UniversalSchema for interactive visualization.

Installation

npm install @picadeck/mongoose-parser @picadeck/core

Peer dependency: mongoose 7.x or 8.x

Usage

import express from "express";
import { schemaVisualizer } from "@picadeck/core";
import { parseMongooseModels } from "@picadeck/mongoose-parser";
import { User, Post, Comment } from "./models";

const app = express();

app.use(
  "/schema",
  schemaVisualizer({
    parser: parseMongooseModels,
    models: [User, Post, Comment],
    theme: "dark",
  })
);

API

parseMongooseModels(models)

Parses an array of Mongoose model classes into a UniversalSchema.

import { parseMongooseModels } from "@picadeck/mongoose-parser";

const schema = parseMongooseModels([User, Post]);

parseMongooseConnection(connection)

Parses all registered models from a Mongoose connection instance. Useful with NestJS dependency injection.

import { parseMongooseConnection } from "@picadeck/mongoose-parser";
import mongoose from "mongoose";

const schema = parseMongooseConnection(mongoose.connection);

NestJS Compatibility

@nestjs/mongoose decorators (@Schema(), @Prop()) compile to standard mongoose.Schema at runtime. This parser works as-is with NestJS -- no additional adapter needed. Use parseMongooseConnection(connection) with the injected Mongoose connection.

License

MIT