@picadeck/typeorm-parser

TypeORM parser for Picadeck Schema Visualizer. Converts a TypeORM DataSource into UniversalSchema for interactive visualization.

Installation

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

Peer dependency: typeorm 0.3.x

Usage

import express from "express";
import { schemaVisualizer } from "@picadeck/core";
import { parseTypeormDataSource } from "@picadeck/typeorm-parser";
import { AppDataSource } from "./data-source";

const app = express();

AppDataSource.initialize().then(() => {
  app.use(
    "/schema",
    schemaVisualizer({
      parser: () => parseTypeormDataSource(AppDataSource),
      models: [],
      theme: "light",
    })
  );

  app.listen(3000);
});

API

parseTypeormDataSource(dataSource)

Parses all entity metadata from an initialized TypeORM DataSource.

import { parseTypeormDataSource } from "@picadeck/typeorm-parser";

const schema = parseTypeormDataSource(dataSource);

parseTypeormEntities(entities)

Parses an array of TypeORM entity classes directly.

import { parseTypeormEntities } from "@picadeck/typeorm-parser";
import { User, Post } from "./entities";

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

NestJS Compatibility

@nestjs/typeorm is a thin DI wrapper around TypeORM. Entities use the same typeorm decorators, so this parser works as-is. Inject the DataSource using @InjectDataSource() and pass it to parseTypeormDataSource().

License

MIT