@picadeck/sequelize-parser

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

Installation

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

Peer dependency: sequelize 6.x or 7.x

Usage

import express from "express";
import { schemaVisualizer } from "@picadeck/core";
import { parseSequelizeInstance } from "@picadeck/sequelize-parser";
import { sequelize } from "./database";

const app = express();

app.use(
  "/schema",
  schemaVisualizer({
    parser: () => parseSequelizeInstance(sequelize),
    models: [],
    theme: "light",
  })
);

app.listen(3000);

API

parseSequelizeInstance(sequelize)

Parses all models registered on a Sequelize instance.

import { parseSequelizeInstance } from "@picadeck/sequelize-parser";

const schema = parseSequelizeInstance(sequelize);

parseSequelizeModels(models, database?)

Parses an array of Sequelize model classes directly.

import { parseSequelizeModels } from "@picadeck/sequelize-parser";
import { User, Post } from "./models";

const schema = parseSequelizeModels([User, Post], "mysql");

The optional database parameter ('postgresql' | 'mysql' | 'sqlite' | 'mssql') improves type normalization accuracy. If omitted, it is inferred from the model's Sequelize instance when possible.

NestJS Compatibility

@nestjs/sequelize registers a Sequelize instance in the NestJS DI container. Inject it and pass it to parseSequelizeInstance() directly.

License

MIT