mikro-orm-markdown 0.1.0-alpha.1

package/dist/index.js

@@ -0,0 +1,461 @@
+// src/docs/jsdoc.ts
+import { Project } from "ts-morph";
+function loadJsDoc(srcGlobs) {
+  const entities = /* @__PURE__ */ new Map();
+  const props = /* @__PURE__ */ new Map();
+  if (srcGlobs.length === 0) return { entities, props };
+  const project = new Project({
+    skipAddingFilesFromTsConfig: true,
+    skipLoadingLibFiles: true,
+    compilerOptions: {
+      experimentalDecorators: true,
+      skipLibCheck: true
+    }
+  });
+  project.addSourceFilesAtPaths(srcGlobs);
+  for (const sourceFile of project.getSourceFiles()) {
+    for (const cls of sourceFile.getClasses()) {
+      const className = cls.getName();
+      if (!className) continue;
+      const classDocs = cls.getJsDocs();
+      if (classDocs.length > 0) {
+        entities.set(className, parseEntityJsDoc(classDocs));
+      }
+      const propMap = /* @__PURE__ */ new Map();
+      for (const prop of cls.getProperties()) {
+        const propDocs = prop.getJsDocs();
+        if (propDocs.length === 0) continue;
+        const desc = extractDescription(propDocs);
+        if (desc !== void 0) {
+          propMap.set(prop.getName(), { description: desc });
+        }
+      }
+      if (propMap.size > 0) {
+        props.set(className, propMap);
+      }
+    }
+  }
+  return { entities, props };
+}
+function parseEntityJsDoc(jsDocs) {
+  const namespaces = [];
+  const erdNamespaces = [];
+  const describeNamespaces = [];
+  let hidden = false;
+  let description;
+  for (const doc of jsDocs) {
+    const desc = doc.getDescription().trim();
+    if (desc && description === void 0) description = desc;
+    for (const tag of doc.getTags()) {
+      const tagName = tag.getTagName();
+      const comment = tag.getCommentText()?.trim();
+      if (tagName === "namespace" && comment) namespaces.push(comment);
+      else if (tagName === "erd" && comment) erdNamespaces.push(comment);
+      else if (tagName === "describe" && comment) describeNamespaces.push(comment);
+      else if (tagName === "hidden") hidden = true;
+    }
+  }
+  return {
+    ...description !== void 0 && { description },
+    namespaces,
+    erdNamespaces,
+    describeNamespaces,
+    hidden
+  };
+}
+function extractDescription(jsDocs) {
+  for (const doc of jsDocs) {
+    const desc = doc.getDescription().trim();
+    if (desc) return desc;
+  }
+  return void 0;
+}
+
+// src/metadata/load.ts
+import { MikroORM } from "@mikro-orm/core";
+var MetadataLoadError = class extends Error {
+  constructor(message, cause) {
+    super(message);
+    this.cause = cause;
+    this.name = "MetadataLoadError";
+  }
+};
+async function loadEntityMetadata(options) {
+  let orm;
+  try {
+    orm = await MikroORM.init({
+      ...options,
+      debug: false
+    });
+  } catch (cause) {
+    throw new MetadataLoadError(
+      "Failed to initialize MikroORM and run entity discovery. Make sure your config is valid and all entity files are accessible.",
+      cause
+    );
+  }
+  try {
+    const all = Object.values(orm.getMetadata().getAll());
+    if (all.length === 0) {
+      throw new MetadataLoadError(
+        "No entities were discovered. Check that your config specifies at least one entity path or class."
+      );
+    }
+    return all;
+  } finally {
+    await orm.close(true);
+  }
+}
+
+// src/render/mermaid.ts
+import { ReferenceKind } from "@mikro-orm/core";
+var FORMULA_DUMMY_TABLE = {
+  alias: "e0",
+  name: "",
+  qualifiedName: "",
+  toString: () => "e0"
+};
+function buildDiagramModel(metas) {
+  const metaByClass = new Map(metas.map((m) => [m.className, m]));
+  const entities = metas.filter((meta) => !meta.pivotTable && !meta.embeddable).map((meta) => buildEntityModel(meta, metaByClass));
+  const relations = buildRelationEdges(metas);
+  return { entities, relations };
+}
+function buildEntityModel(meta, metaByClass) {
+  const isStiRoot = meta.discriminatorColumn !== void 0 && !meta.discriminatorValue;
+  const isStiChild = Boolean(meta.extends) && meta.discriminatorValue !== void 0;
+  const columns = [];
+  for (const prop of Object.values(meta.properties)) {
+    if (isStiRoot && prop.inherited === true) continue;
+    const col = buildColumn(prop, metaByClass, meta);
+    if (col !== null) columns.push(col);
+  }
+  return {
+    className: meta.className,
+    tableName: meta.tableName,
+    columns,
+    isPivot: false,
+    isEmbeddable: meta.embeddable === true,
+    ...isStiRoot && { discriminatorColumn: meta.discriminatorColumn },
+    ...isStiChild && { extendsEntity: meta.extends },
+    constraints: buildConstraints(meta)
+  };
+}
+function buildColumn(prop, metaByClass, owningMeta) {
+  if (prop.kind === ReferenceKind.EMBEDDED) return null;
+  if (prop.kind === ReferenceKind.SCALAR) {
+    const formulaExpr = prop.formula !== void 0 ? resolveFormulaExpr(prop.formula) : void 0;
+    let embeddedIn;
+    if (prop.embedded !== void 0) {
+      const parentPropName = prop.embedded[0];
+      embeddedIn = owningMeta.properties[parentPropName]?.type;
+    }
+    const isDiscriminator = owningMeta.discriminatorColumn !== void 0 && prop.name === owningMeta.discriminatorColumn;
+    return {
+      propName: prop.name,
+      fieldName: prop.fieldNames?.[0] ?? prop.name,
+      type: normalizeType(prop.type),
+      isPrimary: prop.primary === true,
+      isForeignKey: false,
+      isUnique: prop.unique === true,
+      isNullable: prop.nullable === true,
+      ...formulaExpr !== void 0 && { formula: formulaExpr },
+      ...embeddedIn !== void 0 && { embeddedIn },
+      ...isDiscriminator && { isDiscriminator: true }
+    };
+  }
+  if (prop.kind === ReferenceKind.MANY_TO_ONE || prop.kind === ReferenceKind.ONE_TO_ONE && prop.owner === true) {
+    const fkType = resolveFkType(prop.type, metaByClass);
+    return {
+      propName: prop.name,
+      fieldName: prop.fieldNames?.[0] ?? `${prop.name}_id`,
+      type: fkType,
+      isPrimary: false,
+      isForeignKey: true,
+      isUnique: prop.unique === true,
+      isNullable: prop.nullable === true
+    };
+  }
+  return null;
+}
+function resolveFormulaExpr(cb) {
+  try {
+    const cols = new Proxy({}, {
+      get: (_target, key) => typeof key === "string" ? key : ""
+    });
+    return cb(FORMULA_DUMMY_TABLE, cols);
+  } catch {
+    return "";
+  }
+}
+function resolveFkType(referencedClassName, metaByClass) {
+  const refMeta = metaByClass.get(referencedClassName);
+  if (!refMeta) return "integer";
+  const pkProp = Object.values(refMeta.properties).find((p) => p.primary === true);
+  return pkProp ? normalizeType(pkProp.type) : "integer";
+}
+function buildConstraints(meta) {
+  const result = [];
+  for (const idx of meta.indexes ?? []) {
+    const props = idx.properties;
+    result.push({
+      type: "index",
+      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],
+      ...idx.name !== void 0 && { name: idx.name }
+    });
+  }
+  for (const uniq of meta.uniques ?? []) {
+    const props = uniq.properties;
+    result.push({
+      type: "unique",
+      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],
+      ...uniq.name !== void 0 && { name: uniq.name }
+    });
+  }
+  for (const check of meta.checks ?? []) {
+    if (typeof check.expression !== "string") continue;
+    result.push({
+      type: "check",
+      properties: [],
+      expression: check.expression,
+      ...check.name !== void 0 && { name: check.name }
+    });
+  }
+  return result;
+}
+function buildRelationEdges(metas) {
+  const edges = [];
+  for (const meta of metas) {
+    if (meta.pivotTable || meta.embeddable) continue;
+    for (const prop of Object.values(meta.properties)) {
+      const edge = buildEdge(meta.className, prop);
+      if (edge !== null) edges.push(edge);
+    }
+  }
+  return edges;
+}
+function buildEdge(fromEntity, prop) {
+  const isNullable = prop.nullable === true;
+  if (prop.kind === ReferenceKind.MANY_TO_ONE) {
+    return {
+      fromEntity,
+      toEntity: prop.type,
+      fromCardinality: "}o",
+      toCardinality: isNullable ? "o|" : "||",
+      label: prop.name
+    };
+  }
+  if (prop.kind === ReferenceKind.ONE_TO_ONE && prop.owner === true) {
+    return {
+      fromEntity,
+      toEntity: prop.type,
+      fromCardinality: "||",
+      toCardinality: isNullable ? "o|" : "||",
+      label: prop.name
+    };
+  }
+  if (prop.kind === ReferenceKind.MANY_TO_MANY && prop.owner === true) {
+    return {
+      fromEntity,
+      toEntity: prop.type,
+      fromCardinality: "}o",
+      toCardinality: "o{",
+      label: prop.name
+    };
+  }
+  return null;
+}
+function renderErDiagram(model) {
+  const lines = ["erDiagram"];
+  for (const entity of model.entities) {
+    lines.push(`  ${entity.className} {`);
+    for (const col of entity.columns) {
+      lines.push(`    ${renderColumnLine(col)}`);
+    }
+    lines.push("  }");
+  }
+  for (const rel of model.relations) {
+    lines.push(
+      `  ${rel.fromEntity} ${rel.fromCardinality}--${rel.toCardinality} ${rel.toEntity} : "${rel.label}"`
+    );
+  }
+  return lines.join("\n");
+}
+function renderColumnLine(col) {
+  let qualifier = "";
+  if (col.isPrimary) qualifier = " PK";
+  else if (col.isForeignKey) qualifier = " FK";
+  else if (col.isUnique) qualifier = " UK";
+  let comment;
+  if (col.formula !== void 0) {
+    comment = col.formula ? `formula: ${col.formula}` : "formula";
+  } else if (col.isDiscriminator) {
+    comment = "discriminator";
+  } else if (col.embeddedIn !== void 0) {
+    comment = `[${col.embeddedIn}]`;
+  } else if (col.fieldName !== col.propName) {
+    comment = col.propName;
+  }
+  const commentStr = comment !== void 0 ? ` "${comment}"` : "";
+  return `${col.type} ${col.fieldName}${qualifier}${commentStr}`;
+}
+function normalizeType(type) {
+  return type.replace(/[^a-zA-Z0-9_]/g, "_");
+}
+
+// src/model/build.ts
+function buildDocumentModel(metas, jsDocResult, title, description) {
+  const { entities: diagramEntities, relations: allRelations } = buildDiagramModel(metas);
+  const enrichedByClass = /* @__PURE__ */ new Map();
+  for (const model of diagramEntities) {
+    const jsDoc = jsDocResult.entities.get(model.className);
+    if (jsDoc?.hidden) continue;
+    const propDocs = jsDocResult.props.get(model.className) ?? /* @__PURE__ */ new Map();
+    enrichedByClass.set(model.className, { model, jsDoc, propDocs });
+  }
+  const groupNames = /* @__PURE__ */ new Set();
+  let anyUntagged = false;
+  for (const { jsDoc } of enrichedByClass.values()) {
+    const allNs = [
+      ...jsDoc?.namespaces ?? [],
+      ...jsDoc?.erdNamespaces ?? [],
+      ...jsDoc?.describeNamespaces ?? []
+    ];
+    if (allNs.length === 0) {
+      anyUntagged = true;
+    } else {
+      for (const ns of allNs) groupNames.add(ns);
+    }
+  }
+  if (anyUntagged) groupNames.add("default");
+  const groups = [];
+  for (const groupName of groupNames) {
+    const isDefault = groupName === "default";
+    const erdEntities = [...enrichedByClass.values()].filter(
+      ({ jsDoc }) => belongsToGroupForErd(jsDoc, groupName, isDefault)
+    );
+    const textEntities = [...enrichedByClass.values()].filter(
+      ({ jsDoc }) => belongsToGroupForText(jsDoc, groupName, isDefault)
+    );
+    const erdClassNames = new Set(erdEntities.map((e) => e.model.className));
+    const erdRelations = allRelations.filter(
+      (r) => erdClassNames.has(r.fromEntity) && erdClassNames.has(r.toEntity)
+    );
+    groups.push({ name: groupName, erdEntities, textEntities, erdRelations });
+  }
+  groups.sort((a, b) => {
+    if (a.name === "default") return 1;
+    if (b.name === "default") return -1;
+    return a.name.localeCompare(b.name);
+  });
+  return { title, groups, ...description !== void 0 && { description } };
+}
+function hasNoNamespaceTags(jsDoc) {
+  if (!jsDoc) return true;
+  return jsDoc.namespaces.length === 0 && jsDoc.erdNamespaces.length === 0 && jsDoc.describeNamespaces.length === 0;
+}
+function belongsToGroupForErd(jsDoc, groupName, isDefault) {
+  if (isDefault) return hasNoNamespaceTags(jsDoc);
+  if (!jsDoc) return false;
+  return jsDoc.namespaces.includes(groupName) || jsDoc.erdNamespaces.includes(groupName);
+}
+function belongsToGroupForText(jsDoc, groupName, isDefault) {
+  if (isDefault) return hasNoNamespaceTags(jsDoc);
+  if (!jsDoc) return false;
+  return jsDoc.namespaces.includes(groupName) || jsDoc.describeNamespaces.includes(groupName);
+}
+
+// src/render/markdown.ts
+function renderMarkdown(docModel) {
+  const sections = [`# ${docModel.title}`];
+  if (docModel.description) {
+    sections.push(docModel.description);
+  }
+  for (const group of docModel.groups) {
+    sections.push(renderGroupSection(group));
+  }
+  return sections.join("\n\n");
+}
+function renderGroupSection(group) {
+  const parts = [`## ${group.name}`];
+  if (group.erdEntities.length > 0) {
+    const diagramModel = {
+      entities: group.erdEntities.map((e) => e.model),
+      relations: group.erdRelations
+    };
+    parts.push("```mermaid\n" + renderErDiagram(diagramModel) + "\n```");
+  }
+  for (const entity of group.textEntities) {
+    parts.push(renderEntitySection(entity));
+  }
+  return parts.join("\n\n");
+}
+function renderEntitySection(entity) {
+  const parts = [`### ${entity.model.className}`];
+  if (entity.jsDoc?.description) {
+    parts.push(`> ${entity.jsDoc.description}`);
+  }
+  if (entity.model.discriminatorColumn) {
+    parts.push(
+      `*STI root \u2014 discriminator column: \`${entity.model.discriminatorColumn}\`*`
+    );
+  } else if (entity.model.extendsEntity) {
+    parts.push(`*Extends \`${entity.model.extendsEntity}\` (Single Table Inheritance)*`);
+  }
+  if (entity.model.columns.length > 0) {
+    parts.push(renderColumnTable(entity));
+  }
+  if (entity.model.constraints.length > 0) {
+    parts.push(renderConstraints(entity.model.constraints));
+  }
+  return parts.join("\n\n");
+}
+function renderColumnTable(entity) {
+  const header = "| Column | Type | Key | Nullable | Description |";
+  const sep = "|--------|------|-----|----------|-------------|";
+  const rows = entity.model.columns.map((col) => {
+    const key = resolveColumnKey(col);
+    const nullable = col.isNullable && !col.isPrimary ? "Y" : "";
+    const desc = entity.propDocs.get(col.propName)?.description ?? "";
+    return `| ${col.fieldName} | ${col.type} | ${key} | ${nullable} | ${desc} |`;
+  });
+  return [header, sep, ...rows].join("\n");
+}
+function resolveColumnKey(col) {
+  if (col.isPrimary) return "PK";
+  if (col.isForeignKey) {
+    return col.fieldName !== col.propName ? `FK (${col.propName})` : "FK";
+  }
+  if (col.isUnique) return "UK";
+  if (col.formula !== void 0) return `formula: ${col.formula}`;
+  if (col.isDiscriminator) return "discriminator";
+  if (col.embeddedIn !== void 0) return `[${col.embeddedIn}]`;
+  return "";
+}
+function renderConstraints(constraints) {
+  const lines = ["**Constraints:**", ""];
+  for (const c of constraints) {
+    const name = c.name ? ` \`${c.name}\`` : "";
+    if (c.type === "index") {
+      lines.push(`- Index${name}: (${c.properties.join(", ")})`);
+    } else if (c.type === "unique") {
+      lines.push(`- Unique${name}: (${c.properties.join(", ")})`);
+    } else if (c.type === "check") {
+      lines.push(`- Check${name}: \`${c.expression ?? ""}\``);
+    }
+  }
+  return lines.join("\n");
+}
+
+// src/index.ts
+async function generateMarkdown(options) {
+  const { orm, title = "Database Schema", description, src = [] } = options;
+  const metas = await loadEntityMetadata(orm);
+  const jsDocResult = loadJsDoc(src);
+  const docModel = buildDocumentModel(metas, jsDocResult, title, description);
+  return renderMarkdown(docModel);
+}
+export {
+  MetadataLoadError,
+  generateMarkdown
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/docs/jsdoc.ts","../src/metadata/load.ts","../src/render/mermaid.ts","../src/model/build.ts","../src/render/markdown.ts","../src/index.ts"],"sourcesContent":["import type { JSDoc } from 'ts-morph';\nimport { Project } from 'ts-morph';\n\n/** JSDoc information extracted from an entity class. */\nexport interface EntityJsDocInfo {\n  /** Class-level description (text before any @tags). */\n  description?: string;\n  /** Namespaces from @namespace tags — appears in both ERD and text table. */\n  namespaces: string[];\n  /** Namespaces from @erd tags — appears in ERD only. */\n  erdNamespaces: string[];\n  /** Namespaces from @describe tags — appears in text table only. */\n  describeNamespaces: string[];\n  /** True when @hidden tag is present — entity is excluded from all output. */\n  hidden: boolean;\n}\n\n/** JSDoc information extracted from a single entity property. */\nexport interface PropJsDocInfo {\n  /** Property description text. */\n  description?: string;\n}\n\n/** Keyed by entity class name. */\nexport type EntityJsDocMap = Map<string, EntityJsDocInfo>;\n\n/** Outer key: entity class name. Inner key: property name. */\nexport type PropJsDocMap = Map<string, Map<string, PropJsDocInfo>>;\n\nexport interface JsDocResult {\n  entities: EntityJsDocMap;\n  props: PropJsDocMap;\n}\n\n/**\n * Parses TypeScript source files matched by the provided globs and extracts\n * JSDoc descriptions and custom tags (@namespace, @erd, @describe, @hidden)\n * from entity classes and their properties.\n *\n * Returns empty maps if no source files are matched or no JSDoc is found.\n * Never throws — errors are silently ignored so missing docs don't block generation.\n */\nexport function loadJsDoc(srcGlobs: string[]): JsDocResult {\n  const entities: EntityJsDocMap = new Map();\n  const props: PropJsDocMap = new Map();\n\n  if (srcGlobs.length === 0) return { entities, props };\n\n  const project = new Project({\n    skipAddingFilesFromTsConfig: true,\n    skipLoadingLibFiles: true,\n    compilerOptions: {\n      experimentalDecorators: true,\n      skipLibCheck: true,\n    },\n  });\n\n  project.addSourceFilesAtPaths(srcGlobs);\n\n  for (const sourceFile of project.getSourceFiles()) {\n    for (const cls of sourceFile.getClasses()) {\n      const className = cls.getName();\n      if (!className) continue;\n\n      const classDocs = cls.getJsDocs();\n      if (classDocs.length > 0) {\n        entities.set(className, parseEntityJsDoc(classDocs));\n      }\n\n      const propMap = new Map<string, PropJsDocInfo>();\n      for (const prop of cls.getProperties()) {\n        const propDocs = prop.getJsDocs();\n        if (propDocs.length === 0) continue;\n        const desc = extractDescription(propDocs);\n        if (desc !== undefined) {\n          propMap.set(prop.getName(), { description: desc });\n        }\n      }\n      if (propMap.size > 0) {\n        props.set(className, propMap);\n      }\n    }\n  }\n\n  return { entities, props };\n}\n\nfunction parseEntityJsDoc(jsDocs: JSDoc[]): EntityJsDocInfo {\n  const namespaces: string[] = [];\n  const erdNamespaces: string[] = [];\n  const describeNamespaces: string[] = [];\n  let hidden = false;\n  let description: string | undefined;\n\n  for (const doc of jsDocs) {\n    const desc = doc.getDescription().trim();\n    if (desc && description === undefined) description = desc;\n\n    for (const tag of doc.getTags()) {\n      const tagName = tag.getTagName();\n      const comment = tag.getCommentText()?.trim();\n\n      if (tagName === 'namespace' && comment) namespaces.push(comment);\n      else if (tagName === 'erd' && comment) erdNamespaces.push(comment);\n      else if (tagName === 'describe' && comment) describeNamespaces.push(comment);\n      else if (tagName === 'hidden') hidden = true;\n    }\n  }\n\n  return {\n    ...(description !== undefined && { description }),\n    namespaces,\n    erdNamespaces,\n    describeNamespaces,\n    hidden,\n  };\n}\n\nfunction extractDescription(jsDocs: JSDoc[]): string | undefined {\n  for (const doc of jsDocs) {\n    const desc = doc.getDescription().trim();\n    if (desc) return desc;\n  }\n  return undefined;\n}\n","import { MikroORM } from '@mikro-orm/core';\nimport type { EntityMetadata, Options } from '@mikro-orm/core';\n\n/** Errors thrown during metadata loading */\nexport class MetadataLoadError extends Error {\n  constructor(\n    message: string,\n    public override readonly cause?: unknown,\n  ) {\n    super(message);\n    this.name = 'MetadataLoadError';\n  }\n}\n\n/**\n * Runs MikroORM entity discovery without connecting to the database,\n * and returns all discovered EntityMetadata objects.\n *\n * The caller is responsible for filtering (e.g. excluding abstract,\n * embeddable, or pivot entities) based on rendering needs.\n */\nexport async function loadEntityMetadata(options: Options): Promise<EntityMetadata[]> {\n  let orm: MikroORM | undefined;\n\n  try {\n    orm = await MikroORM.init({\n      ...options,\n      debug: false,\n    });\n  } catch (cause) {\n    throw new MetadataLoadError(\n      'Failed to initialize MikroORM and run entity discovery. ' +\n        'Make sure your config is valid and all entity files are accessible.',\n      cause,\n    );\n  }\n\n  try {\n    const all = Object.values(orm.getMetadata().getAll());\n\n    if (all.length === 0) {\n      throw new MetadataLoadError(\n        'No entities were discovered. ' +\n          'Check that your config specifies at least one entity path or class.',\n      );\n    }\n\n    return all;\n  } finally {\n    await orm.close(true);\n  }\n}\n","import { ReferenceKind } from '@mikro-orm/core';\nimport type { EntityMetadata, EntityProperty, FormulaTable } from '@mikro-orm/core';\nimport type {\n  ColumnModel,\n  ConstraintModel,\n  DiagramModel,\n  EntityModel,\n  RelationEdge,\n} from '../model/types.js';\n\n// Dummy table descriptor used when resolving formula expressions for documentation.\n// String-based formulas ignore both arguments; function-based formulas use the alias.\nconst FORMULA_DUMMY_TABLE: FormulaTable = {\n  alias: 'e0',\n  name: '',\n  qualifiedName: '',\n  toString: () => 'e0',\n};\n\n/**\n * Converts raw MikroORM EntityMetadata array into a DiagramModel.\n *\n * Excluded from entity boxes:\n *  - Pivot tables (auto-generated M:N join tables) — represented as edges\n *  - @Embeddable classes — their columns appear inline inside the owning entity\n */\nexport function buildDiagramModel(metas: EntityMetadata[]): DiagramModel {\n  const metaByClass = new Map(metas.map((m) => [m.className, m]));\n\n  const entities: EntityModel[] = metas\n    .filter((meta) => !meta.pivotTable && !meta.embeddable)\n    .map((meta) => buildEntityModel(meta, metaByClass));\n\n  const relations: RelationEdge[] = buildRelationEdges(metas);\n\n  return { entities, relations };\n}\n\nfunction buildEntityModel(\n  meta: EntityMetadata,\n  metaByClass: Map<string, EntityMetadata>,\n): EntityModel {\n  // STI root: has discriminatorColumn, no discriminatorValue of its own.\n  // Its properties list includes all child-only columns (marked inherited=true) — filter them out.\n  const isStiRoot = meta.discriminatorColumn !== undefined && !meta.discriminatorValue;\n  const isStiChild = Boolean(meta.extends) && meta.discriminatorValue !== undefined;\n\n  const columns: ColumnModel[] = [];\n  for (const prop of Object.values(meta.properties)) {\n    if (isStiRoot && prop.inherited === true) continue;\n    const col = buildColumn(prop, metaByClass, meta);\n    if (col !== null) columns.push(col);\n  }\n\n  return {\n    className: meta.className,\n    tableName: meta.tableName,\n    columns,\n    isPivot: false,\n    isEmbeddable: meta.embeddable === true,\n    ...(isStiRoot && { discriminatorColumn: meta.discriminatorColumn as string }),\n    ...(isStiChild && { extendsEntity: meta.extends }),\n    constraints: buildConstraints(meta),\n  };\n}\n\n/** Returns a ColumnModel for renderable properties, or null to skip. */\nfunction buildColumn(\n  prop: EntityProperty,\n  metaByClass: Map<string, EntityMetadata>,\n  owningMeta: EntityMetadata,\n): ColumnModel | null {\n  // Skip the EMBEDDED group reference — individual flat columns appear as SCALAR entries\n  if (prop.kind === ReferenceKind.EMBEDDED) return null;\n\n  if (prop.kind === ReferenceKind.SCALAR) {\n    // For @Formula columns, formula is set on a SCALAR-kinded property\n    const formulaExpr: string | undefined = prop.formula !== undefined\n      ? resolveFormulaExpr(prop.formula as (table: FormulaTable, cols: Record<string, string>) => string)\n      : undefined;\n\n    // Flat embedded columns carry `embedded: [ownerPropName, embeddedPropName]`\n    let embeddedIn: string | undefined;\n    if (prop.embedded !== undefined) {\n      const parentPropName = prop.embedded[0];\n      embeddedIn = owningMeta.properties[parentPropName]?.type;\n    }\n\n    const isDiscriminator =\n      owningMeta.discriminatorColumn !== undefined &&\n      prop.name === owningMeta.discriminatorColumn;\n\n    return {\n      propName: prop.name,\n      fieldName: prop.fieldNames?.[0] ?? prop.name,\n      type: normalizeType(prop.type),\n      isPrimary: prop.primary === true,\n      isForeignKey: false,\n      isUnique: prop.unique === true,\n      isNullable: prop.nullable === true,\n      ...(formulaExpr !== undefined && { formula: formulaExpr }),\n      ...(embeddedIn !== undefined && { embeddedIn }),\n      ...(isDiscriminator && { isDiscriminator: true }),\n    };\n  }\n\n  // FK columns: m:1 always owns the FK; 1:1 only when owner === true\n  if (\n    prop.kind === ReferenceKind.MANY_TO_ONE ||\n    (prop.kind === ReferenceKind.ONE_TO_ONE && prop.owner === true)\n  ) {\n    const fkType = resolveFkType(prop.type, metaByClass);\n    return {\n      propName: prop.name,\n      fieldName: prop.fieldNames?.[0] ?? `${prop.name}_id`,\n      type: fkType,\n      isPrimary: false,\n      isForeignKey: true,\n      isUnique: prop.unique === true,\n      isNullable: prop.nullable === true,\n    };\n  }\n\n  // ONE_TO_MANY, MANY_TO_MANY (both owner and inverse) → no physical column\n  return null;\n}\n\n/**\n * Calls the FormulaCallback with a dummy table and column proxy to extract the SQL expression.\n * String-based formulas (most common) ignore their arguments and return the literal string.\n * Function-based formulas use the alias/column names from the dummy objects.\n * Returns empty string on unexpected errors.\n */\nfunction resolveFormulaExpr(\n  cb: (table: FormulaTable, cols: Record<string, string>) => string,\n): string {\n  try {\n    const cols = new Proxy({}, {\n      get: (_target, key: string | symbol) => (typeof key === 'string' ? key : ''),\n    });\n    return cb(FORMULA_DUMMY_TABLE, cols);\n  } catch {\n    return '';\n  }\n}\n\n/** Looks up the PK type of the referenced entity to use as FK column type. */\nfunction resolveFkType(\n  referencedClassName: string,\n  metaByClass: Map<string, EntityMetadata>,\n): string {\n  const refMeta = metaByClass.get(referencedClassName);\n  if (!refMeta) return 'integer';\n  const pkProp = Object.values(refMeta.properties).find((p) => p.primary === true);\n  return pkProp ? normalizeType(pkProp.type) : 'integer';\n}\n\n/** Collects indexes, unique constraints, and check constraints from entity-level metadata. */\nfunction buildConstraints(meta: EntityMetadata): ConstraintModel[] {\n  const result: ConstraintModel[] = [];\n\n  for (const idx of meta.indexes ?? []) {\n    const props = idx.properties;\n    result.push({\n      type: 'index',\n      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],\n      ...(idx.name !== undefined && { name: idx.name }),\n    });\n  }\n\n  for (const uniq of meta.uniques ?? []) {\n    const props = uniq.properties;\n    result.push({\n      type: 'unique',\n      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],\n      ...(uniq.name !== undefined && { name: uniq.name }),\n    });\n  }\n\n  for (const check of meta.checks ?? []) {\n    // Skip function-based check expressions (they require column reference objects at runtime)\n    if (typeof check.expression !== 'string') continue;\n    result.push({\n      type: 'check',\n      properties: [],\n      expression: check.expression,\n      ...(check.name !== undefined && { name: check.name }),\n    });\n  }\n\n  return result;\n}\n\n/** Builds edges only from owning sides to avoid duplicate arrows. Includes STI inheritance. */\nfunction buildRelationEdges(metas: EntityMetadata[]): RelationEdge[] {\n  const edges: RelationEdge[] = [];\n\n  for (const meta of metas) {\n    if (meta.pivotTable || meta.embeddable) continue;\n\n    for (const prop of Object.values(meta.properties)) {\n      const edge = buildEdge(meta.className, prop);\n      if (edge !== null) edges.push(edge);\n    }\n\n  }\n\n  return edges;\n}\n\nfunction buildEdge(fromEntity: string, prop: EntityProperty): RelationEdge | null {\n  const isNullable = prop.nullable === true;\n\n  if (prop.kind === ReferenceKind.MANY_TO_ONE) {\n    return {\n      fromEntity,\n      toEntity: prop.type,\n      fromCardinality: '}o',\n      toCardinality: isNullable ? 'o|' : '||',\n      label: prop.name,\n    };\n  }\n\n  if (prop.kind === ReferenceKind.ONE_TO_ONE && prop.owner === true) {\n    return {\n      fromEntity,\n      toEntity: prop.type,\n      fromCardinality: '||',\n      toCardinality: isNullable ? 'o|' : '||',\n      label: prop.name,\n    };\n  }\n\n  if (prop.kind === ReferenceKind.MANY_TO_MANY && prop.owner === true) {\n    return {\n      fromEntity,\n      toEntity: prop.type,\n      fromCardinality: '}o',\n      toCardinality: 'o{',\n      label: prop.name,\n    };\n  }\n\n  return null;\n}\n\n/**\n * Renders a DiagramModel as a Mermaid erDiagram block string.\n * The returned string starts with \"erDiagram\" and is ready to embed in a\n * markdown code fence.\n */\nexport function renderErDiagram(model: DiagramModel): string {\n  const lines: string[] = ['erDiagram'];\n\n  for (const entity of model.entities) {\n    lines.push(`  ${entity.className} {`);\n    for (const col of entity.columns) {\n      lines.push(`    ${renderColumnLine(col)}`);\n    }\n    lines.push('  }');\n  }\n\n  for (const rel of model.relations) {\n    lines.push(\n      `  ${rel.fromEntity} ${rel.fromCardinality}--${rel.toCardinality} ${rel.toEntity} : \"${rel.label}\"`,\n    );\n  }\n\n  return lines.join('\\n');\n}\n\nfunction renderColumnLine(col: ColumnModel): string {\n  // Priority: PK > FK > UK\n  let qualifier = '';\n  if (col.isPrimary) qualifier = ' PK';\n  else if (col.isForeignKey) qualifier = ' FK';\n  else if (col.isUnique) qualifier = ' UK';\n\n  // Comment priority (v1 differentiators over prisma-markdown):\n  //   1. @Formula SQL expression  — \"formula: LENGTH(name)\"\n  //   2. STI discriminator column — \"discriminator\"\n  //   3. Embedded source type     — \"[Address]\"\n  //   4. DB/TS name mismatch      — \"<tsPropName>\"\n  let comment: string | undefined;\n  if (col.formula !== undefined) {\n    comment = col.formula ? `formula: ${col.formula}` : 'formula';\n  } else if (col.isDiscriminator) {\n    comment = 'discriminator';\n  } else if (col.embeddedIn !== undefined) {\n    comment = `[${col.embeddedIn}]`;\n  } else if (col.fieldName !== col.propName) {\n    comment = col.propName;\n  }\n\n  const commentStr = comment !== undefined ? ` \"${comment}\"` : '';\n  return `${col.type} ${col.fieldName}${qualifier}${commentStr}`;\n}\n\n/** Strips characters that are invalid in Mermaid type identifiers. */\nfunction normalizeType(type: string): string {\n  return type.replace(/[^a-zA-Z0-9_]/g, '_');\n}\n","import type { EntityMetadata } from '@mikro-orm/core';\nimport type { EntityJsDocInfo, JsDocResult, PropJsDocInfo } from '../docs/jsdoc.js';\nimport type { EntityModel, RelationEdge } from './types.js';\nimport { buildDiagramModel } from '../render/mermaid.js';\n\n/** An entity with its structural model and JSDoc info merged together. */\nexport interface EnrichedEntity {\n  model: EntityModel;\n  /** Undefined if the entity has no class-level JSDoc. */\n  jsDoc: EntityJsDocInfo | undefined;\n  /** Per-property description map (empty map if no property JSDoc). */\n  propDocs: Map<string, PropJsDocInfo>;\n}\n\n/**\n * A single namespace group, ready to render as one section of the document.\n *\n * - `erdEntities`: shown in the Mermaid ERD block (@namespace + @erd)\n * - `textEntities`: shown in the column-table sections (@namespace + @describe)\n * - `erdRelations`: relation edges where both endpoints are in `erdEntities`\n */\nexport interface NamespaceGroup {\n  name: string;\n  erdEntities: EnrichedEntity[];\n  textEntities: EnrichedEntity[];\n  erdRelations: RelationEdge[];\n}\n\n/** Complete document model — input to the markdown renderer. */\nexport interface DocumentModel {\n  title: string;\n  /** Optional paragraph rendered below the H1 heading. */\n  description?: string;\n  groups: NamespaceGroup[];\n}\n\n/**\n * Merges MikroORM structural metadata with JSDoc information and organises the\n * result into namespace groups for rendering.\n *\n * Entities with @hidden are excluded.\n * Entities with no namespace tags fall into the \"default\" group.\n * Groups are ordered alphabetically, with \"default\" always last.\n */\nexport function buildDocumentModel(\n  metas: EntityMetadata[],\n  jsDocResult: JsDocResult,\n  title: string,\n  description?: string,\n): DocumentModel {\n  const { entities: diagramEntities, relations: allRelations } = buildDiagramModel(metas);\n\n  // Build enriched entity map, filtering out @hidden entities.\n  const enrichedByClass = new Map<string, EnrichedEntity>();\n  for (const model of diagramEntities) {\n    const jsDoc = jsDocResult.entities.get(model.className);\n    if (jsDoc?.hidden) continue;\n    const propDocs = jsDocResult.props.get(model.className) ?? new Map<string, PropJsDocInfo>();\n    enrichedByClass.set(model.className, { model, jsDoc, propDocs });\n  }\n\n  // Collect all unique namespace names referenced by any entity.\n  const groupNames = new Set<string>();\n  let anyUntagged = false;\n  for (const { jsDoc } of enrichedByClass.values()) {\n    const allNs = [\n      ...(jsDoc?.namespaces ?? []),\n      ...(jsDoc?.erdNamespaces ?? []),\n      ...(jsDoc?.describeNamespaces ?? []),\n    ];\n    if (allNs.length === 0) {\n      anyUntagged = true;\n    } else {\n      for (const ns of allNs) groupNames.add(ns);\n    }\n  }\n  if (anyUntagged) groupNames.add('default');\n\n  const groups: NamespaceGroup[] = [];\n  for (const groupName of groupNames) {\n    const isDefault = groupName === 'default';\n\n    const erdEntities = [...enrichedByClass.values()].filter(({ jsDoc }) =>\n      belongsToGroupForErd(jsDoc, groupName, isDefault),\n    );\n\n    const textEntities = [...enrichedByClass.values()].filter(({ jsDoc }) =>\n      belongsToGroupForText(jsDoc, groupName, isDefault),\n    );\n\n    const erdClassNames = new Set(erdEntities.map((e) => e.model.className));\n    const erdRelations = allRelations.filter(\n      (r) => erdClassNames.has(r.fromEntity) && erdClassNames.has(r.toEntity),\n    );\n\n    groups.push({ name: groupName, erdEntities, textEntities, erdRelations });\n  }\n\n  // Sort alphabetically; \"default\" is always last.\n  groups.sort((a, b) => {\n    if (a.name === 'default') return 1;\n    if (b.name === 'default') return -1;\n    return a.name.localeCompare(b.name);\n  });\n\n  return { title, groups, ...(description !== undefined && { description }) };\n}\n\nfunction hasNoNamespaceTags(jsDoc: EntityJsDocInfo | undefined): boolean {\n  if (!jsDoc) return true;\n  return (\n    jsDoc.namespaces.length === 0 &&\n    jsDoc.erdNamespaces.length === 0 &&\n    jsDoc.describeNamespaces.length === 0\n  );\n}\n\nfunction belongsToGroupForErd(\n  jsDoc: EntityJsDocInfo | undefined,\n  groupName: string,\n  isDefault: boolean,\n): boolean {\n  if (isDefault) return hasNoNamespaceTags(jsDoc);\n  if (!jsDoc) return false;\n  return jsDoc.namespaces.includes(groupName) || jsDoc.erdNamespaces.includes(groupName);\n}\n\nfunction belongsToGroupForText(\n  jsDoc: EntityJsDocInfo | undefined,\n  groupName: string,\n  isDefault: boolean,\n): boolean {\n  if (isDefault) return hasNoNamespaceTags(jsDoc);\n  if (!jsDoc) return false;\n  return jsDoc.namespaces.includes(groupName) || jsDoc.describeNamespaces.includes(groupName);\n}\n","import type { EnrichedEntity, DocumentModel, NamespaceGroup } from '../model/build.js';\nimport type { ColumnModel, ConstraintModel, DiagramModel } from '../model/types.js';\nimport { renderErDiagram } from './mermaid.js';\n\n/**\n * Renders a DocumentModel as a markdown string.\n * Each namespace group becomes a level-2 section with a Mermaid ERD block\n * followed by per-entity column tables.\n */\nexport function renderMarkdown(docModel: DocumentModel): string {\n  const sections: string[] = [`# ${docModel.title}`];\n\n  if (docModel.description) {\n    sections.push(docModel.description);\n  }\n\n  for (const group of docModel.groups) {\n    sections.push(renderGroupSection(group));\n  }\n\n  return sections.join('\\n\\n');\n}\n\nfunction renderGroupSection(group: NamespaceGroup): string {\n  const parts: string[] = [`## ${group.name}`];\n\n  if (group.erdEntities.length > 0) {\n    const diagramModel: DiagramModel = {\n      entities: group.erdEntities.map((e) => e.model),\n      relations: group.erdRelations,\n    };\n    parts.push('```mermaid\\n' + renderErDiagram(diagramModel) + '\\n```');\n  }\n\n  for (const entity of group.textEntities) {\n    parts.push(renderEntitySection(entity));\n  }\n\n  return parts.join('\\n\\n');\n}\n\nfunction renderEntitySection(entity: EnrichedEntity): string {\n  const parts: string[] = [`### ${entity.model.className}`];\n\n  if (entity.jsDoc?.description) {\n    parts.push(`> ${entity.jsDoc.description}`);\n  }\n\n  // STI metadata note\n  if (entity.model.discriminatorColumn) {\n    parts.push(\n      `*STI root — discriminator column: \\`${entity.model.discriminatorColumn}\\`*`,\n    );\n  } else if (entity.model.extendsEntity) {\n    parts.push(`*Extends \\`${entity.model.extendsEntity}\\` (Single Table Inheritance)*`);\n  }\n\n  if (entity.model.columns.length > 0) {\n    parts.push(renderColumnTable(entity));\n  }\n\n  if (entity.model.constraints.length > 0) {\n    parts.push(renderConstraints(entity.model.constraints));\n  }\n\n  return parts.join('\\n\\n');\n}\n\nfunction renderColumnTable(entity: EnrichedEntity): string {\n  const header = '| Column | Type | Key | Nullable | Description |';\n  const sep = '|--------|------|-----|----------|-------------|';\n  const rows = entity.model.columns.map((col) => {\n    const key = resolveColumnKey(col);\n    const nullable = col.isNullable && !col.isPrimary ? 'Y' : '';\n    const desc = entity.propDocs.get(col.propName)?.description ?? '';\n    return `| ${col.fieldName} | ${col.type} | ${key} | ${nullable} | ${desc} |`;\n  });\n  return [header, sep, ...rows].join('\\n');\n}\n\n/** Returns the \"Key\" cell value for the column table. */\nfunction resolveColumnKey(col: ColumnModel): string {\n  if (col.isPrimary) return 'PK';\n  if (col.isForeignKey) {\n    // Show TS property name in parentheses if it differs from the DB column name\n    return col.fieldName !== col.propName ? `FK (${col.propName})` : 'FK';\n  }\n  if (col.isUnique) return 'UK';\n  if (col.formula !== undefined) return `formula: ${col.formula}`;\n  if (col.isDiscriminator) return 'discriminator';\n  if (col.embeddedIn !== undefined) return `[${col.embeddedIn}]`;\n  return '';\n}\n\n\nfunction renderConstraints(constraints: ConstraintModel[]): string {\n  const lines = ['**Constraints:**', ''];\n  for (const c of constraints) {\n    const name = c.name ? ` \\`${c.name}\\`` : '';\n    if (c.type === 'index') {\n      lines.push(`- Index${name}: (${c.properties.join(', ')})`);\n    } else if (c.type === 'unique') {\n      lines.push(`- Unique${name}: (${c.properties.join(', ')})`);\n    } else if (c.type === 'check') {\n      lines.push(`- Check${name}: \\`${c.expression ?? ''}\\``);\n    }\n  }\n  return lines.join('\\n');\n}\n","import type { Options } from '@mikro-orm/core';\nimport { loadJsDoc } from './docs/jsdoc.js';\nimport { loadEntityMetadata } from './metadata/load.js';\nimport { buildDocumentModel } from './model/build.js';\nimport { renderMarkdown } from './render/markdown.js';\n\nexport type { GenerateOptions } from './model/types.js';\nexport { MetadataLoadError } from './metadata/load.js';\n\n/** Options for the programmatic API. */\nexport interface GenerateMarkdownOptions {\n  /** MikroORM configuration (driver, entities, dbName, …). */\n  orm: Options;\n  /** Title shown as the H1 heading in the generated document. */\n  title?: string;\n  /** Optional description paragraph rendered below the H1 heading. */\n  description?: string;\n  /**\n   * Glob patterns for TypeScript entity source files.\n   * Used for JSDoc extraction (@namespace, @hidden, descriptions).\n   * Omit to skip JSDoc parsing — all entities go into the \"default\" section.\n   */\n  src?: string[];\n}\n\n/**\n * Generates a Mermaid ERD + markdown documentation document from MikroORM\n * entity metadata.\n *\n * @example\n * ```ts\n * import { generateMarkdown } from 'mikro-orm-markdown';\n * import ormConfig from './mikro-orm.config.js';\n *\n * const markdown = await generateMarkdown({\n *   orm: ormConfig,\n *   title: 'My Database',\n *   src: ['src/entities/*.ts'],\n * });\n * ```\n */\nexport async function generateMarkdown(options: GenerateMarkdownOptions): Promise<string> {\n  const { orm, title = 'Database Schema', description, src = [] } = options;\n\n  const metas = await loadEntityMetadata(orm);\n  const jsDocResult = loadJsDoc(src);\n  const docModel = buildDocumentModel(metas, jsDocResult, title, description);\n  return renderMarkdown(docModel);\n}\n"],"mappings":";AACA,SAAS,eAAe;AAyCjB,SAAS,UAAU,UAAiC;AACzD,QAAM,WAA2B,oBAAI,IAAI;AACzC,QAAM,QAAsB,oBAAI,IAAI;AAEpC,MAAI,SAAS,WAAW,EAAG,QAAO,EAAE,UAAU,MAAM;AAEpD,QAAM,UAAU,IAAI,QAAQ;AAAA,IAC1B,6BAA6B;AAAA,IAC7B,qBAAqB;AAAA,IACrB,iBAAiB;AAAA,MACf,wBAAwB;AAAA,MACxB,cAAc;AAAA,IAChB;AAAA,EACF,CAAC;AAED,UAAQ,sBAAsB,QAAQ;AAEtC,aAAW,cAAc,QAAQ,eAAe,GAAG;AACjD,eAAW,OAAO,WAAW,WAAW,GAAG;AACzC,YAAM,YAAY,IAAI,QAAQ;AAC9B,UAAI,CAAC,UAAW;AAEhB,YAAM,YAAY,IAAI,UAAU;AAChC,UAAI,UAAU,SAAS,GAAG;AACxB,iBAAS,IAAI,WAAW,iBAAiB,SAAS,CAAC;AAAA,MACrD;AAEA,YAAM,UAAU,oBAAI,IAA2B;AAC/C,iBAAW,QAAQ,IAAI,cAAc,GAAG;AACtC,cAAM,WAAW,KAAK,UAAU;AAChC,YAAI,SAAS,WAAW,EAAG;AAC3B,cAAM,OAAO,mBAAmB,QAAQ;AACxC,YAAI,SAAS,QAAW;AACtB,kBAAQ,IAAI,KAAK,QAAQ,GAAG,EAAE,aAAa,KAAK,CAAC;AAAA,QACnD;AAAA,MACF;AACA,UAAI,QAAQ,OAAO,GAAG;AACpB,cAAM,IAAI,WAAW,OAAO;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AAEA,SAAO,EAAE,UAAU,MAAM;AAC3B;AAEA,SAAS,iBAAiB,QAAkC;AAC1D,QAAM,aAAuB,CAAC;AAC9B,QAAM,gBAA0B,CAAC;AACjC,QAAM,qBAA+B,CAAC;AACtC,MAAI,SAAS;AACb,MAAI;AAEJ,aAAW,OAAO,QAAQ;AACxB,UAAM,OAAO,IAAI,eAAe,EAAE,KAAK;AACvC,QAAI,QAAQ,gBAAgB,OAAW,eAAc;AAErD,eAAW,OAAO,IAAI,QAAQ,GAAG;AAC/B,YAAM,UAAU,IAAI,WAAW;AAC/B,YAAM,UAAU,IAAI,eAAe,GAAG,KAAK;AAE3C,UAAI,YAAY,eAAe,QAAS,YAAW,KAAK,OAAO;AAAA,eACtD,YAAY,SAAS,QAAS,eAAc,KAAK,OAAO;AAAA,eACxD,YAAY,cAAc,QAAS,oBAAmB,KAAK,OAAO;AAAA,eAClE,YAAY,SAAU,UAAS;AAAA,IAC1C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,GAAI,gBAAgB,UAAa,EAAE,YAAY;AAAA,IAC/C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,mBAAmB,QAAqC;AAC/D,aAAW,OAAO,QAAQ;AACxB,UAAM,OAAO,IAAI,eAAe,EAAE,KAAK;AACvC,QAAI,KAAM,QAAO;AAAA,EACnB;AACA,SAAO;AACT;;;AC5HA,SAAS,gBAAgB;AAIlB,IAAM,oBAAN,cAAgC,MAAM;AAAA,EAC3C,YACE,SACyB,OACzB;AACA,UAAM,OAAO;AAFY;AAGzB,SAAK,OAAO;AAAA,EACd;AACF;AASA,eAAsB,mBAAmB,SAA6C;AACpF,MAAI;AAEJ,MAAI;AACF,UAAM,MAAM,SAAS,KAAK;AAAA,MACxB,GAAG;AAAA,MACH,OAAO;AAAA,IACT,CAAC;AAAA,EACH,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR;AAAA,MAEA;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,UAAM,MAAM,OAAO,OAAO,IAAI,YAAY,EAAE,OAAO,CAAC;AAEpD,QAAI,IAAI,WAAW,GAAG;AACpB,YAAM,IAAI;AAAA,QACR;AAAA,MAEF;AAAA,IACF;AAEA,WAAO;AAAA,EACT,UAAE;AACA,UAAM,IAAI,MAAM,IAAI;AAAA,EACtB;AACF;;;ACnDA,SAAS,qBAAqB;AAY9B,IAAM,sBAAoC;AAAA,EACxC,OAAO;AAAA,EACP,MAAM;AAAA,EACN,eAAe;AAAA,EACf,UAAU,MAAM;AAClB;AASO,SAAS,kBAAkB,OAAuC;AACvE,QAAM,cAAc,IAAI,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;AAE9D,QAAM,WAA0B,MAC7B,OAAO,CAAC,SAAS,CAAC,KAAK,cAAc,CAAC,KAAK,UAAU,EACrD,IAAI,CAAC,SAAS,iBAAiB,MAAM,WAAW,CAAC;AAEpD,QAAM,YAA4B,mBAAmB,KAAK;AAE1D,SAAO,EAAE,UAAU,UAAU;AAC/B;AAEA,SAAS,iBACP,MACA,aACa;AAGb,QAAM,YAAY,KAAK,wBAAwB,UAAa,CAAC,KAAK;AAClE,QAAM,aAAa,QAAQ,KAAK,OAAO,KAAK,KAAK,uBAAuB;AAExE,QAAM,UAAyB,CAAC;AAChC,aAAW,QAAQ,OAAO,OAAO,KAAK,UAAU,GAAG;AACjD,QAAI,aAAa,KAAK,cAAc,KAAM;AAC1C,UAAM,MAAM,YAAY,MAAM,aAAa,IAAI;AAC/C,QAAI,QAAQ,KAAM,SAAQ,KAAK,GAAG;AAAA,EACpC;AAEA,SAAO;AAAA,IACL,WAAW,KAAK;AAAA,IAChB,WAAW,KAAK;AAAA,IAChB;AAAA,IACA,SAAS;AAAA,IACT,cAAc,KAAK,eAAe;AAAA,IAClC,GAAI,aAAa,EAAE,qBAAqB,KAAK,oBAA8B;AAAA,IAC3E,GAAI,cAAc,EAAE,eAAe,KAAK,QAAQ;AAAA,IAChD,aAAa,iBAAiB,IAAI;AAAA,EACpC;AACF;AAGA,SAAS,YACP,MACA,aACA,YACoB;AAEpB,MAAI,KAAK,SAAS,cAAc,SAAU,QAAO;AAEjD,MAAI,KAAK,SAAS,cAAc,QAAQ;AAEtC,UAAM,cAAkC,KAAK,YAAY,SACrD,mBAAmB,KAAK,OAAwE,IAChG;AAGJ,QAAI;AACJ,QAAI,KAAK,aAAa,QAAW;AAC/B,YAAM,iBAAiB,KAAK,SAAS,CAAC;AACtC,mBAAa,WAAW,WAAW,cAAc,GAAG;AAAA,IACtD;AAEA,UAAM,kBACJ,WAAW,wBAAwB,UACnC,KAAK,SAAS,WAAW;AAE3B,WAAO;AAAA,MACL,UAAU,KAAK;AAAA,MACf,WAAW,KAAK,aAAa,CAAC,KAAK,KAAK;AAAA,MACxC,MAAM,cAAc,KAAK,IAAI;AAAA,MAC7B,WAAW,KAAK,YAAY;AAAA,MAC5B,cAAc;AAAA,MACd,UAAU,KAAK,WAAW;AAAA,MAC1B,YAAY,KAAK,aAAa;AAAA,MAC9B,GAAI,gBAAgB,UAAa,EAAE,SAAS,YAAY;AAAA,MACxD,GAAI,eAAe,UAAa,EAAE,WAAW;AAAA,MAC7C,GAAI,mBAAmB,EAAE,iBAAiB,KAAK;AAAA,IACjD;AAAA,EACF;AAGA,MACE,KAAK,SAAS,cAAc,eAC3B,KAAK,SAAS,cAAc,cAAc,KAAK,UAAU,MAC1D;AACA,UAAM,SAAS,cAAc,KAAK,MAAM,WAAW;AACnD,WAAO;AAAA,MACL,UAAU,KAAK;AAAA,MACf,WAAW,KAAK,aAAa,CAAC,KAAK,GAAG,KAAK,IAAI;AAAA,MAC/C,MAAM;AAAA,MACN,WAAW;AAAA,MACX,cAAc;AAAA,MACd,UAAU,KAAK,WAAW;AAAA,MAC1B,YAAY,KAAK,aAAa;AAAA,IAChC;AAAA,EACF;AAGA,SAAO;AACT;AAQA,SAAS,mBACP,IACQ;AACR,MAAI;AACF,UAAM,OAAO,IAAI,MAAM,CAAC,GAAG;AAAA,MACzB,KAAK,CAAC,SAAS,QAA0B,OAAO,QAAQ,WAAW,MAAM;AAAA,IAC3E,CAAC;AACD,WAAO,GAAG,qBAAqB,IAAI;AAAA,EACrC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAGA,SAAS,cACP,qBACA,aACQ;AACR,QAAM,UAAU,YAAY,IAAI,mBAAmB;AACnD,MAAI,CAAC,QAAS,QAAO;AACrB,QAAM,SAAS,OAAO,OAAO,QAAQ,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,YAAY,IAAI;AAC/E,SAAO,SAAS,cAAc,OAAO,IAAI,IAAI;AAC/C;AAGA,SAAS,iBAAiB,MAAyC;AACjE,QAAM,SAA4B,CAAC;AAEnC,aAAW,OAAO,KAAK,WAAW,CAAC,GAAG;AACpC,UAAM,QAAQ,IAAI;AAClB,WAAO,KAAK;AAAA,MACV,MAAM;AAAA,MACN,YAAY,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,QAAQ,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC;AAAA,MAClF,GAAI,IAAI,SAAS,UAAa,EAAE,MAAM,IAAI,KAAK;AAAA,IACjD,CAAC;AAAA,EACH;AAEA,aAAW,QAAQ,KAAK,WAAW,CAAC,GAAG;AACrC,UAAM,QAAQ,KAAK;AACnB,WAAO,KAAK;AAAA,MACV,MAAM;AAAA,MACN,YAAY,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,QAAQ,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC;AAAA,MAClF,GAAI,KAAK,SAAS,UAAa,EAAE,MAAM,KAAK,KAAK;AAAA,IACnD,CAAC;AAAA,EACH;AAEA,aAAW,SAAS,KAAK,UAAU,CAAC,GAAG;AAErC,QAAI,OAAO,MAAM,eAAe,SAAU;AAC1C,WAAO,KAAK;AAAA,MACV,MAAM;AAAA,MACN,YAAY,CAAC;AAAA,MACb,YAAY,MAAM;AAAA,MAClB,GAAI,MAAM,SAAS,UAAa,EAAE,MAAM,MAAM,KAAK;AAAA,IACrD,CAAC;AAAA,EACH;AAEA,SAAO;AACT;AAGA,SAAS,mBAAmB,OAAyC;AACnE,QAAM,QAAwB,CAAC;AAE/B,aAAW,QAAQ,OAAO;AACxB,QAAI,KAAK,cAAc,KAAK,WAAY;AAExC,eAAW,QAAQ,OAAO,OAAO,KAAK,UAAU,GAAG;AACjD,YAAM,OAAO,UAAU,KAAK,WAAW,IAAI;AAC3C,UAAI,SAAS,KAAM,OAAM,KAAK,IAAI;AAAA,IACpC;AAAA,EAEF;AAEA,SAAO;AACT;AAEA,SAAS,UAAU,YAAoB,MAA2C;AAChF,QAAM,aAAa,KAAK,aAAa;AAErC,MAAI,KAAK,SAAS,cAAc,aAAa;AAC3C,WAAO;AAAA,MACL;AAAA,MACA,UAAU,KAAK;AAAA,MACf,iBAAiB;AAAA,MACjB,eAAe,aAAa,OAAO;AAAA,MACnC,OAAO,KAAK;AAAA,IACd;AAAA,EACF;AAEA,MAAI,KAAK,SAAS,cAAc,cAAc,KAAK,UAAU,MAAM;AACjE,WAAO;AAAA,MACL;AAAA,MACA,UAAU,KAAK;AAAA,MACf,iBAAiB;AAAA,MACjB,eAAe,aAAa,OAAO;AAAA,MACnC,OAAO,KAAK;AAAA,IACd;AAAA,EACF;AAEA,MAAI,KAAK,SAAS,cAAc,gBAAgB,KAAK,UAAU,MAAM;AACnE,WAAO;AAAA,MACL;AAAA,MACA,UAAU,KAAK;AAAA,MACf,iBAAiB;AAAA,MACjB,eAAe;AAAA,MACf,OAAO,KAAK;AAAA,IACd;AAAA,EACF;AAEA,SAAO;AACT;AAOO,SAAS,gBAAgB,OAA6B;AAC3D,QAAM,QAAkB,CAAC,WAAW;AAEpC,aAAW,UAAU,MAAM,UAAU;AACnC,UAAM,KAAK,KAAK,OAAO,SAAS,IAAI;AACpC,eAAW,OAAO,OAAO,SAAS;AAChC,YAAM,KAAK,OAAO,iBAAiB,GAAG,CAAC,EAAE;AAAA,IAC3C;AACA,UAAM,KAAK,KAAK;AAAA,EAClB;AAEA,aAAW,OAAO,MAAM,WAAW;AACjC,UAAM;AAAA,MACJ,KAAK,IAAI,UAAU,IAAI,IAAI,eAAe,KAAK,IAAI,aAAa,IAAI,IAAI,QAAQ,OAAO,IAAI,KAAK;AAAA,IAClG;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;AAEA,SAAS,iBAAiB,KAA0B;AAElD,MAAI,YAAY;AAChB,MAAI,IAAI,UAAW,aAAY;AAAA,WACtB,IAAI,aAAc,aAAY;AAAA,WAC9B,IAAI,SAAU,aAAY;AAOnC,MAAI;AACJ,MAAI,IAAI,YAAY,QAAW;AAC7B,cAAU,IAAI,UAAU,YAAY,IAAI,OAAO,KAAK;AAAA,EACtD,WAAW,IAAI,iBAAiB;AAC9B,cAAU;AAAA,EACZ,WAAW,IAAI,eAAe,QAAW;AACvC,cAAU,IAAI,IAAI,UAAU;AAAA,EAC9B,WAAW,IAAI,cAAc,IAAI,UAAU;AACzC,cAAU,IAAI;AAAA,EAChB;AAEA,QAAM,aAAa,YAAY,SAAY,KAAK,OAAO,MAAM;AAC7D,SAAO,GAAG,IAAI,IAAI,IAAI,IAAI,SAAS,GAAG,SAAS,GAAG,UAAU;AAC9D;AAGA,SAAS,cAAc,MAAsB;AAC3C,SAAO,KAAK,QAAQ,kBAAkB,GAAG;AAC3C;;;ACjQO,SAAS,mBACd,OACA,aACA,OACA,aACe;AACf,QAAM,EAAE,UAAU,iBAAiB,WAAW,aAAa,IAAI,kBAAkB,KAAK;AAGtF,QAAM,kBAAkB,oBAAI,IAA4B;AACxD,aAAW,SAAS,iBAAiB;AACnC,UAAM,QAAQ,YAAY,SAAS,IAAI,MAAM,SAAS;AACtD,QAAI,OAAO,OAAQ;AACnB,UAAM,WAAW,YAAY,MAAM,IAAI,MAAM,SAAS,KAAK,oBAAI,IAA2B;AAC1F,oBAAgB,IAAI,MAAM,WAAW,EAAE,OAAO,OAAO,SAAS,CAAC;AAAA,EACjE;AAGA,QAAM,aAAa,oBAAI,IAAY;AACnC,MAAI,cAAc;AAClB,aAAW,EAAE,MAAM,KAAK,gBAAgB,OAAO,GAAG;AAChD,UAAM,QAAQ;AAAA,MACZ,GAAI,OAAO,cAAc,CAAC;AAAA,MAC1B,GAAI,OAAO,iBAAiB,CAAC;AAAA,MAC7B,GAAI,OAAO,sBAAsB,CAAC;AAAA,IACpC;AACA,QAAI,MAAM,WAAW,GAAG;AACtB,oBAAc;AAAA,IAChB,OAAO;AACL,iBAAW,MAAM,MAAO,YAAW,IAAI,EAAE;AAAA,IAC3C;AAAA,EACF;AACA,MAAI,YAAa,YAAW,IAAI,SAAS;AAEzC,QAAM,SAA2B,CAAC;AAClC,aAAW,aAAa,YAAY;AAClC,UAAM,YAAY,cAAc;AAEhC,UAAM,cAAc,CAAC,GAAG,gBAAgB,OAAO,CAAC,EAAE;AAAA,MAAO,CAAC,EAAE,MAAM,MAChE,qBAAqB,OAAO,WAAW,SAAS;AAAA,IAClD;AAEA,UAAM,eAAe,CAAC,GAAG,gBAAgB,OAAO,CAAC,EAAE;AAAA,MAAO,CAAC,EAAE,MAAM,MACjE,sBAAsB,OAAO,WAAW,SAAS;AAAA,IACnD;AAEA,UAAM,gBAAgB,IAAI,IAAI,YAAY,IAAI,CAAC,MAAM,EAAE,MAAM,SAAS,CAAC;AACvE,UAAM,eAAe,aAAa;AAAA,MAChC,CAAC,MAAM,cAAc,IAAI,EAAE,UAAU,KAAK,cAAc,IAAI,EAAE,QAAQ;AAAA,IACxE;AAEA,WAAO,KAAK,EAAE,MAAM,WAAW,aAAa,cAAc,aAAa,CAAC;AAAA,EAC1E;AAGA,SAAO,KAAK,CAAC,GAAG,MAAM;AACpB,QAAI,EAAE,SAAS,UAAW,QAAO;AACjC,QAAI,EAAE,SAAS,UAAW,QAAO;AACjC,WAAO,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,EACpC,CAAC;AAED,SAAO,EAAE,OAAO,QAAQ,GAAI,gBAAgB,UAAa,EAAE,YAAY,EAAG;AAC5E;AAEA,SAAS,mBAAmB,OAA6C;AACvE,MAAI,CAAC,MAAO,QAAO;AACnB,SACE,MAAM,WAAW,WAAW,KAC5B,MAAM,cAAc,WAAW,KAC/B,MAAM,mBAAmB,WAAW;AAExC;AAEA,SAAS,qBACP,OACA,WACA,WACS;AACT,MAAI,UAAW,QAAO,mBAAmB,KAAK;AAC9C,MAAI,CAAC,MAAO,QAAO;AACnB,SAAO,MAAM,WAAW,SAAS,SAAS,KAAK,MAAM,cAAc,SAAS,SAAS;AACvF;AAEA,SAAS,sBACP,OACA,WACA,WACS;AACT,MAAI,UAAW,QAAO,mBAAmB,KAAK;AAC9C,MAAI,CAAC,MAAO,QAAO;AACnB,SAAO,MAAM,WAAW,SAAS,SAAS,KAAK,MAAM,mBAAmB,SAAS,SAAS;AAC5F;;;AC9HO,SAAS,eAAe,UAAiC;AAC9D,QAAM,WAAqB,CAAC,KAAK,SAAS,KAAK,EAAE;AAEjD,MAAI,SAAS,aAAa;AACxB,aAAS,KAAK,SAAS,WAAW;AAAA,EACpC;AAEA,aAAW,SAAS,SAAS,QAAQ;AACnC,aAAS,KAAK,mBAAmB,KAAK,CAAC;AAAA,EACzC;AAEA,SAAO,SAAS,KAAK,MAAM;AAC7B;AAEA,SAAS,mBAAmB,OAA+B;AACzD,QAAM,QAAkB,CAAC,MAAM,MAAM,IAAI,EAAE;AAE3C,MAAI,MAAM,YAAY,SAAS,GAAG;AAChC,UAAM,eAA6B;AAAA,MACjC,UAAU,MAAM,YAAY,IAAI,CAAC,MAAM,EAAE,KAAK;AAAA,MAC9C,WAAW,MAAM;AAAA,IACnB;AACA,UAAM,KAAK,iBAAiB,gBAAgB,YAAY,IAAI,OAAO;AAAA,EACrE;AAEA,aAAW,UAAU,MAAM,cAAc;AACvC,UAAM,KAAK,oBAAoB,MAAM,CAAC;AAAA,EACxC;AAEA,SAAO,MAAM,KAAK,MAAM;AAC1B;AAEA,SAAS,oBAAoB,QAAgC;AAC3D,QAAM,QAAkB,CAAC,OAAO,OAAO,MAAM,SAAS,EAAE;AAExD,MAAI,OAAO,OAAO,aAAa;AAC7B,UAAM,KAAK,KAAK,OAAO,MAAM,WAAW,EAAE;AAAA,EAC5C;AAGA,MAAI,OAAO,MAAM,qBAAqB;AACpC,UAAM;AAAA,MACJ,4CAAuC,OAAO,MAAM,mBAAmB;AAAA,IACzE;AAAA,EACF,WAAW,OAAO,MAAM,eAAe;AACrC,UAAM,KAAK,cAAc,OAAO,MAAM,aAAa,gCAAgC;AAAA,EACrF;AAEA,MAAI,OAAO,MAAM,QAAQ,SAAS,GAAG;AACnC,UAAM,KAAK,kBAAkB,MAAM,CAAC;AAAA,EACtC;AAEA,MAAI,OAAO,MAAM,YAAY,SAAS,GAAG;AACvC,UAAM,KAAK,kBAAkB,OAAO,MAAM,WAAW,CAAC;AAAA,EACxD;AAEA,SAAO,MAAM,KAAK,MAAM;AAC1B;AAEA,SAAS,kBAAkB,QAAgC;AACzD,QAAM,SAAS;AACf,QAAM,MAAM;AACZ,QAAM,OAAO,OAAO,MAAM,QAAQ,IAAI,CAAC,QAAQ;AAC7C,UAAM,MAAM,iBAAiB,GAAG;AAChC,UAAM,WAAW,IAAI,cAAc,CAAC,IAAI,YAAY,MAAM;AAC1D,UAAM,OAAO,OAAO,SAAS,IAAI,IAAI,QAAQ,GAAG,eAAe;AAC/D,WAAO,KAAK,IAAI,SAAS,MAAM,IAAI,IAAI,MAAM,GAAG,MAAM,QAAQ,MAAM,IAAI;AAAA,EAC1E,CAAC;AACD,SAAO,CAAC,QAAQ,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI;AACzC;AAGA,SAAS,iBAAiB,KAA0B;AAClD,MAAI,IAAI,UAAW,QAAO;AAC1B,MAAI,IAAI,cAAc;AAEpB,WAAO,IAAI,cAAc,IAAI,WAAW,OAAO,IAAI,QAAQ,MAAM;AAAA,EACnE;AACA,MAAI,IAAI,SAAU,QAAO;AACzB,MAAI,IAAI,YAAY,OAAW,QAAO,YAAY,IAAI,OAAO;AAC7D,MAAI,IAAI,gBAAiB,QAAO;AAChC,MAAI,IAAI,eAAe,OAAW,QAAO,IAAI,IAAI,UAAU;AAC3D,SAAO;AACT;AAGA,SAAS,kBAAkB,aAAwC;AACjE,QAAM,QAAQ,CAAC,oBAAoB,EAAE;AACrC,aAAW,KAAK,aAAa;AAC3B,UAAM,OAAO,EAAE,OAAO,MAAM,EAAE,IAAI,OAAO;AACzC,QAAI,EAAE,SAAS,SAAS;AACtB,YAAM,KAAK,UAAU,IAAI,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,GAAG;AAAA,IAC3D,WAAW,EAAE,SAAS,UAAU;AAC9B,YAAM,KAAK,WAAW,IAAI,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,GAAG;AAAA,IAC5D,WAAW,EAAE,SAAS,SAAS;AAC7B,YAAM,KAAK,UAAU,IAAI,OAAO,EAAE,cAAc,EAAE,IAAI;AAAA,IACxD;AAAA,EACF;AACA,SAAO,MAAM,KAAK,IAAI;AACxB;;;ACnEA,eAAsB,iBAAiB,SAAmD;AACxF,QAAM,EAAE,KAAK,QAAQ,mBAAmB,aAAa,MAAM,CAAC,EAAE,IAAI;AAElE,QAAM,QAAQ,MAAM,mBAAmB,GAAG;AAC1C,QAAM,cAAc,UAAU,GAAG;AACjC,QAAM,WAAW,mBAAmB,OAAO,aAAa,OAAO,WAAW;AAC1E,SAAO,eAAe,QAAQ;AAChC;","names":[]}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "mikro-orm-markdown",
+  "version": "0.1.0-alpha.1",
+  "description": "Generate Mermaid ERD and Markdown documentation from MikroORM entities",
+  "keywords": [
+    "mikro-orm",
+    "erd",
+    "mermaid",
+    "markdown",
+    "documentation",
+    "entity",
+    "database"
+  ],
+  "author": "iamkanguk97 (https://github.com/iamkanguk97)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iamkanguk97/mikro-orm-markdown.git"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "bin": {
+    "mikro-orm-markdown": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --project tsconfig.test.json --noEmit",
+    "lint": "eslint src test",
+    "lint:fix": "eslint src test --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build"
+  },
+  "peerDependencies": {
+    "@mikro-orm/core": ">=6.0.0"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "ts-morph": "^23.0.0"
+  },
+  "devDependencies": {
+    "@mikro-orm/core": "^6.0.0",
+    "@mikro-orm/sqlite": "^6.0.0",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/coverage-v8": "^2.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "prettier": "^3.0.0",
+    "tsup": "^8.0.0",
+    "tsx": "^4.22.4",
+    "typescript": "^5.5.0",
+    "vitest": "^2.0.0"
+  }
+}