mikro-orm-markdown 0.1.0-alpha.1 → 0.1.0-alpha.3

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,22 +17,34 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
   MetadataLoadError: () => MetadataLoadError,
-  generateMarkdown: () => generateMarkdown
+  generateMarkdown: () => generateMarkdown,
+  resolveJsDocSources: () => resolveJsDocSources
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/docs/jsdoc.ts
 var import_ts_morph = require("ts-morph");
-function loadJsDoc(srcGlobs) {
+function loadJsDoc(filePaths) {
   const entities = /* @__PURE__ */ new Map();
   const props = /* @__PURE__ */ new Map();
-  if (srcGlobs.length === 0) return { entities, props };
+  const classNames = /* @__PURE__ */ new Set();
+  if (filePaths.length === 0) {
+    return { entities, props, sourceFileCount: 0, classNames };
+  }
   const project = new import_ts_morph.Project({
     skipAddingFilesFromTsConfig: true,
     skipLoadingLibFiles: true,
@@ -39,30 +53,44 @@ function loadJsDoc(srcGlobs) {
       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 });
+  for (const filePath of filePaths) {
+    try {
+      project.addSourceFilesAtPaths(filePath);
+    } catch {
+    }
+  }
+  const sourceFiles = project.getSourceFiles();
+  for (const sourceFile of sourceFiles) {
+    try {
+      for (const cls of sourceFile.getClasses()) {
+        const className = cls.getName();
+        if (!className) {
+          continue;
+        }
+        classNames.add(className);
+        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 info = parsePropJsDoc(propDocs);
+          if (info.description !== void 0 || info.atLeastOne) {
+            propMap.set(prop.getName(), info);
+          }
+        }
+        if (propMap.size > 0) {
+          props.set(className, propMap);
         }
       }
-      if (propMap.size > 0) {
-        props.set(className, propMap);
-      }
+    } catch {
     }
   }
-  return { entities, props };
+  return { entities, props, sourceFileCount: sourceFiles.length, classNames };
 }
 function parseEntityJsDoc(jsDocs) {
   const namespaces = [];
@@ -72,14 +100,21 @@ function parseEntityJsDoc(jsDocs) {
   let description;
   for (const doc of jsDocs) {
     const desc = doc.getDescription().trim();
-    if (desc && description === void 0) description = desc;
+    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;
+      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 {
@@ -90,15 +125,25 @@ function parseEntityJsDoc(jsDocs) {
     hidden
   };
 }
-function extractDescription(jsDocs) {
+function parsePropJsDoc(jsDocs) {
+  let description;
+  let atLeastOne = false;
   for (const doc of jsDocs) {
     const desc = doc.getDescription().trim();
-    if (desc) return desc;
+    if (desc && description === void 0) {
+      description = desc;
+    }
+    for (const tag of doc.getTags()) {
+      if (tag.getTagName() === "atLeastOne") {
+        atLeastOne = true;
+      }
+    }
   }
-  return void 0;
+  return { ...description !== void 0 && { description }, atLeastOne };
 }
 
 // src/metadata/load.ts
+var path = __toESM(require("path"), 1);
 var import_core = require("@mikro-orm/core");
 var MetadataLoadError = class extends Error {
   constructor(message, cause) {
@@ -107,12 +152,46 @@ var MetadataLoadError = class extends Error {
     this.name = "MetadataLoadError";
   }
 };
+async function closeDiscoveryResources(orm) {
+  await orm.config.getMetadataCacheAdapter()?.close?.();
+  await orm.config.getResultCacheAdapter()?.close?.();
+}
+function collectEntitySchemaNames(options) {
+  const configuredEntities = [...options.entities ?? [], ...options.entitiesTs ?? []];
+  const names = [];
+  for (const entity of configuredEntities) {
+    if (entity instanceof import_core.EntitySchema) {
+      names.push(entity.meta.className);
+      continue;
+    }
+    if (entity !== null && typeof entity === "object" && "schema" in entity && entity.schema instanceof import_core.EntitySchema) {
+      names.push(entity.schema.meta.className);
+    }
+  }
+  return names;
+}
+function assertNoEntitySchemaEntities(options) {
+  const schemaNames = collectEntitySchemaNames(options);
+  if (schemaNames.length === 0) {
+    return;
+  }
+  throw new MetadataLoadError(
+    `EntitySchema-defined entities are not currently supported: ${schemaNames.join(", ")}.
+Use decorator-based @Entity() classes instead.`
+  );
+}
 async function loadEntityMetadata(options) {
+  assertNoEntitySchemaEntities(options);
   let orm;
   try {
     orm = await import_core.MikroORM.init({
       ...options,
-      debug: false
+      debug: false,
+      connect: false,
+      // Always disable the metadata cache for one-shot doc runs so the project
+      // is never littered with a temp/ folder, regardless of how metadataProvider
+      // was configured.
+      metadataCache: { ...options.metadataCache, enabled: false }
     });
   } catch (cause) {
     throw new MetadataLoadError(
@@ -127,20 +206,73 @@ async function loadEntityMetadata(options) {
         "No entities were discovered. Check that your config specifies at least one entity path or class."
       );
     }
-    return all;
+    const baseDir = orm.config.get("baseDir");
+    const sourcePaths = [...new Set(all.filter((m) => m.path).map((m) => path.resolve(baseDir, m.path)))];
+    return { metas: all, sourcePaths };
   } finally {
-    await orm.close(true);
+    await closeDiscoveryResources(orm);
   }
 }
 
+// src/model/build.ts
+var import_core3 = require("@mikro-orm/core");
+
 // src/render/mermaid.ts
 var import_core2 = require("@mikro-orm/core");
+
+// src/render/escape.ts
+var MARKDOWN_INLINE_SPECIAL_CHARS = /[\\`|*#]/g;
+var MERMAID_IDENTIFIER_INVALID_CHARS = /[^a-zA-Z0-9_]/g;
+function normalizeInlineText(value) {
+  return value.replace(/\r\n?/g, "\n").replace(/[\n\t]+/g, " ").replace(/\s{2,}/g, " ").trim();
+}
+function splitNormalizedLines(value) {
+  return value.replace(/\r\n?/g, "\n").split("\n");
+}
+function escapeHtmlText(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+function escapeMarkdownInline(value) {
+  return escapeHtmlText(normalizeInlineText(value)).replace(MARKDOWN_INLINE_SPECIAL_CHARS, "\\$&");
+}
+function escapeMarkdownTableCell(value) {
+  return splitNormalizedLines(value).map((line) => escapeMarkdownInline(line)).join("<br>");
+}
+function escapeMarkdownParagraph(value) {
+  return splitNormalizedLines(value).map((line) => escapeMarkdownInline(line)).join("  \n");
+}
+function renderMarkdownBlockQuote(value) {
+  return splitNormalizedLines(value).map((line) => `> ${escapeMarkdownInline(line)}`).join("\n");
+}
+function renderMarkdownInlineCode(value) {
+  const normalized = normalizeInlineText(value);
+  const backtickRuns = normalized.match(/`+/g) ?? [];
+  const longestRun = Math.max(0, ...backtickRuns.map((run) => run.length));
+  const fence = "`".repeat(longestRun + 1);
+  const needsPadding = normalized.startsWith("`") || normalized.endsWith("`");
+  const content = needsPadding ? ` ${normalized} ` : normalized;
+  return `${fence}${content}${fence}`;
+}
+function toMermaidIdentifier(value) {
+  const normalized = normalizeInlineText(value).replace(MERMAID_IDENTIFIER_INVALID_CHARS, "_").replace(/_+/g, "_");
+  const identifier = normalized === "" ? "_" : normalized;
+  return /^[a-zA-Z_]/.test(identifier) ? identifier : `_${identifier}`;
+}
+function escapeMermaidQuotedText(value) {
+  return normalizeInlineText(value).replace(/\\/g, "\\\\").replace(/"/g, '\\"');
+}
+function toMarkdownAnchor(value) {
+  return normalizeInlineText(value).toLowerCase().replace(/[^\p{L}\p{N}\s_-]/gu, "").replace(/\s+/g, "-");
+}
+
+// src/render/mermaid.ts
 var FORMULA_DUMMY_TABLE = {
   alias: "e0",
   name: "",
   qualifiedName: "",
   toString: () => "e0"
 };
+var UNRESOLVED_FORMULA = "<unresolved>";
 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));
@@ -148,13 +280,14 @@ function buildDiagramModel(metas) {
   return { entities, relations };
 }
 function buildEntityModel(meta, metaByClass) {
-  const isStiRoot = meta.discriminatorColumn !== void 0 && !meta.discriminatorValue;
+  const isStiRoot = meta.discriminatorColumn !== void 0 && !meta.extends;
   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);
+    if (isStiRoot && prop.inherited === true) {
+      continue;
+    }
+    columns.push(...buildColumns(prop, metaByClass, meta));
   }
   return {
     className: meta.className,
@@ -164,61 +297,123 @@ function buildEntityModel(meta, metaByClass) {
     isEmbeddable: meta.embeddable === true,
     ...isStiRoot && { discriminatorColumn: meta.discriminatorColumn },
     ...isStiChild && { extendsEntity: meta.extends },
+    ...isStiChild && meta.discriminatorValue !== void 0 && { discriminatorValue: String(meta.discriminatorValue) },
     constraints: buildConstraints(meta)
   };
 }
-function buildColumn(prop, metaByClass, owningMeta) {
-  if (prop.kind === import_core2.ReferenceKind.EMBEDDED) return null;
+function buildColumns(prop, metaByClass, owningMeta) {
+  if (prop.kind === import_core2.ReferenceKind.EMBEDDED) {
+    if (prop.object === true || prop.array === true) {
+      return [
+        {
+          propName: prop.name,
+          fieldName: prop.fieldNames?.[0] ?? prop.name,
+          type: "json",
+          isPrimary: false,
+          isForeignKey: false,
+          isUnique: prop.unique === true,
+          isNullable: prop.nullable === true,
+          ...prop.comment !== void 0 && { comment: prop.comment },
+          embeddedIn: prop.array === true ? `${prop.type}[]` : prop.type
+        }
+      ];
+    }
+    return [];
+  }
   if (prop.kind === import_core2.ReferenceKind.SCALAR) {
+    if (prop.object === true && prop.embedded !== void 0) {
+      return [];
+    }
     const formulaExpr = prop.formula !== void 0 ? resolveFormulaExpr(prop.formula) : void 0;
     let embeddedIn;
+    let embeddedPropName;
     if (prop.embedded !== void 0) {
       const parentPropName = prop.embedded[0];
       embeddedIn = owningMeta.properties[parentPropName]?.type;
+      embeddedPropName = prop.embedded[1];
     }
     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 }
-    };
+    const enumItems = prop.enum === true && Array.isArray(prop.items) && prop.items.length > 0 ? prop.items.map((item) => String(item)) : void 0;
+    return [
+      {
+        propName: prop.name,
+        fieldName: prop.fieldNames?.[0] ?? prop.name,
+        // Store the original type (e.g. `varchar(255)`); the Mermaid renderer
+        // sanitizes it for diagram identifiers, while the markdown table shows
+        // it verbatim. Guard against a missing type so downstream string
+        // handling never sees undefined (matches the FK path's defaulting).
+        type: prop.type ?? "unknown",
+        isPrimary: prop.primary === true,
+        isForeignKey: false,
+        isUnique: prop.unique === true,
+        isNullable: prop.nullable === true,
+        ...prop.comment !== void 0 && { comment: prop.comment },
+        ...formulaExpr !== void 0 && { formula: formulaExpr },
+        ...embeddedIn !== void 0 && { embeddedIn },
+        ...embeddedPropName !== void 0 && { embeddedPropName },
+        ...isDiscriminator && { isDiscriminator: true },
+        ...enumItems !== void 0 && { enumItems }
+      }
+    ];
   }
   if (prop.kind === import_core2.ReferenceKind.MANY_TO_ONE || prop.kind === import_core2.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
-    };
+    const cols = buildForeignKeyColumns(prop, metaByClass);
+    if (prop.type === owningMeta.className) {
+      return cols.map((col) => ({ ...col, isSelfReference: true }));
+    }
+    return cols;
   }
-  return null;
+  return [];
 }
 function resolveFormulaExpr(cb) {
   try {
-    const cols = new Proxy({}, {
-      get: (_target, key) => typeof key === "string" ? key : ""
-    });
-    return cb(FORMULA_DUMMY_TABLE, cols);
+    const cols = new Proxy(
+      {},
+      {
+        get: (_target, key) => typeof key === "string" ? key : ""
+      }
+    );
+    const result = cb(FORMULA_DUMMY_TABLE, cols);
+    return typeof result === "string" ? result : String(result);
   } catch {
-    return "";
+    return UNRESOLVED_FORMULA;
   }
 }
-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 buildForeignKeyColumns(prop, metaByClass) {
+  const fieldNames = prop.fieldNames && prop.fieldNames.length > 0 ? prop.fieldNames : [`${prop.name}_id`];
+  const fkTypes = resolveFkTypes(prop, metaByClass, fieldNames.length);
+  return fieldNames.map((fieldName, index) => ({
+    propName: prop.name,
+    fieldName,
+    type: fkTypes[index] ?? fkTypes[0] ?? "integer",
+    isPrimary: prop.primary === true,
+    isForeignKey: true,
+    isUnique: prop.unique === true,
+    isNullable: prop.nullable === true,
+    ...prop.comment !== void 0 && { comment: prop.comment },
+    referencedEntity: prop.type
+  }));
+}
+function resolveFkTypes(prop, metaByClass, fieldNameCount) {
+  const refMeta = metaByClass.get(prop.type);
+  if (!refMeta) {
+    return Array.from({ length: fieldNameCount }, () => "integer");
+  }
+  const primaryProps = getPrimaryProps(refMeta);
+  const referencedColumnNames = prop.referencedColumnNames ?? [];
+  return Array.from({ length: fieldNameCount }, (_value, index) => {
+    const referencedColumnName = referencedColumnNames[index];
+    const pkProp = referencedColumnName !== void 0 ? primaryProps.find((candidate) => candidate.fieldNames.includes(referencedColumnName)) : void 0;
+    return (pkProp ?? primaryProps[index] ?? primaryProps[0])?.type ?? "integer";
+  });
+}
+function getPrimaryProps(meta) {
+  const primaryKeys = meta.primaryKeys ?? [];
+  const orderedPrimaryProps = primaryKeys.map((key) => meta.properties[String(key)]).filter((prop) => prop !== void 0);
+  if (orderedPrimaryProps.length > 0) {
+    return orderedPrimaryProps;
+  }
+  return Object.values(meta.properties).filter((prop) => prop.primary === true);
 }
 function buildConstraints(meta) {
   const result = [];
@@ -226,7 +421,7 @@ function buildConstraints(meta) {
     const props = idx.properties;
     result.push({
       type: "index",
-      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],
+      properties: resolveConstraintProperties(meta, props),
       ...idx.name !== void 0 && { name: idx.name }
     });
   }
@@ -234,12 +429,14 @@ function buildConstraints(meta) {
     const props = uniq.properties;
     result.push({
       type: "unique",
-      properties: Array.isArray(props) ? props.map(String) : props ? [String(props)] : [],
+      properties: resolveConstraintProperties(meta, props),
       ...uniq.name !== void 0 && { name: uniq.name }
     });
   }
   for (const check of meta.checks ?? []) {
-    if (typeof check.expression !== "string") continue;
+    if (typeof check.expression !== "string") {
+      continue;
+    }
     result.push({
       type: "check",
       properties: [],
@@ -249,13 +446,30 @@ function buildConstraints(meta) {
   }
   return result;
 }
+function resolveConstraintProperties(meta, props) {
+  const propNames = Array.isArray(props) ? props : props !== void 0 ? [props] : [];
+  return propNames.flatMap((propName) => {
+    const prop = meta.properties[String(propName)];
+    if (prop === void 0) {
+      return [String(propName)];
+    }
+    if (prop.fieldNames !== void 0 && prop.fieldNames.length > 0) {
+      return prop.fieldNames;
+    }
+    return [prop.name];
+  });
+}
 function buildRelationEdges(metas) {
   const edges = [];
   for (const meta of metas) {
-    if (meta.pivotTable || meta.embeddable) continue;
+    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);
+      if (edge !== null) {
+        edges.push(edge);
+      }
     }
   }
   return edges;
@@ -263,6 +477,9 @@ function buildRelationEdges(metas) {
 function buildEdge(fromEntity, prop) {
   const isNullable = prop.nullable === true;
   if (prop.kind === import_core2.ReferenceKind.MANY_TO_ONE) {
+    if (prop.type === fromEntity) {
+      return null;
+    }
     return {
       fromEntity,
       toEntity: prop.type,
@@ -294,7 +511,7 @@ function buildEdge(fromEntity, prop) {
 function renderErDiagram(model) {
   const lines = ["erDiagram"];
   for (const entity of model.entities) {
-    lines.push(`  ${entity.className} {`);
+    lines.push(`  ${toMermaidIdentifier(entity.className)} {`);
     for (const col of entity.columns) {
       lines.push(`    ${renderColumnLine(col)}`);
     }
@@ -302,16 +519,18 @@ function renderErDiagram(model) {
   }
   for (const rel of model.relations) {
     lines.push(
-      `  ${rel.fromEntity} ${rel.fromCardinality}--${rel.toCardinality} ${rel.toEntity} : "${rel.label}"`
+      `  ${toMermaidIdentifier(rel.fromEntity)} ${rel.fromCardinality}--${rel.toCardinality} ${toMermaidIdentifier(rel.toEntity)} : "${escapeMermaidQuotedText(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";
+  if (col.isPrimary) {
+    qualifier = " PK";
+  } else if (col.isUnique) {
+    qualifier = " UK";
+  }
   let comment;
   if (col.formula !== void 0) {
     comment = col.formula ? `formula: ${col.formula}` : "formula";
@@ -319,41 +538,54 @@ function renderColumnLine(col) {
     comment = "discriminator";
   } else if (col.embeddedIn !== void 0) {
     comment = `[${col.embeddedIn}]`;
-  } else if (col.fieldName !== col.propName) {
-    comment = col.propName;
+  } else if (col.isSelfReference) {
+    comment = "self-ref";
   }
-  const commentStr = comment !== void 0 ? ` "${comment}"` : "";
-  return `${col.type} ${col.fieldName}${qualifier}${commentStr}`;
-}
-function normalizeType(type) {
-  return type.replace(/[^a-zA-Z0-9_]/g, "_");
+  const commentStr = comment !== void 0 ? ` "${escapeMermaidQuotedText(comment)}"` : "";
+  return `${toMermaidIdentifier(col.type)} ${toMermaidIdentifier(col.fieldName)}${qualifier}${commentStr}`;
 }
 
 // src/model/build.ts
-function buildDocumentModel(metas, jsDocResult, title, description) {
-  const { entities: diagramEntities, relations: allRelations } = buildDiagramModel(metas);
+var FROM_ONE_OR_MORE = "}|";
+var TO_ONE_OR_MORE = "|{";
+function buildDocumentModel(metas, jsDocResult, title, description, onWarn) {
+  const { entities: diagramEntities, relations } = buildDiagramModel(metas);
+  const allRelations = applyAtLeastOne(relations, metas, jsDocResult.props, onWarn);
+  const hiddenClasses = /* @__PURE__ */ new Set();
+  for (const model of diagramEntities) {
+    if (jsDocResult.entities.get(model.className)?.hidden) {
+      hiddenClasses.add(model.className);
+    }
+  }
   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 });
+    if (jsDoc?.hidden) {
+      continue;
+    }
+    const columns = model.columns.filter(
+      (col) => !(col.isForeignKey && col.referencedEntity !== void 0 && hiddenClasses.has(col.referencedEntity))
+    );
+    const visibleModel = columns.length === model.columns.length ? model : { ...model, columns };
+    const ownPropDocs = jsDocResult.props.get(model.className) ?? /* @__PURE__ */ new Map();
+    const propDocs = withEmbeddedPropDocs(ownPropDocs, visibleModel.columns, jsDocResult.props);
+    enrichedByClass.set(model.className, { model: visibleModel, jsDoc, propDocs });
   }
   const groupNames = /* @__PURE__ */ new Set();
   let anyUntagged = false;
   for (const { jsDoc } of enrichedByClass.values()) {
-    const allNs = [
-      ...jsDoc?.namespaces ?? [],
-      ...jsDoc?.erdNamespaces ?? [],
-      ...jsDoc?.describeNamespaces ?? []
-    ];
+    const allNs = [...jsDoc?.namespaces ?? [], ...jsDoc?.erdNamespaces ?? [], ...jsDoc?.describeNamespaces ?? []];
     if (allNs.length === 0) {
       anyUntagged = true;
     } else {
-      for (const ns of allNs) groupNames.add(ns);
+      for (const ns of allNs) {
+        groupNames.add(ns);
+      }
     }
   }
-  if (anyUntagged) groupNames.add("default");
+  if (anyUntagged) {
+    groupNames.add("default");
+  }
   const groups = [];
   for (const groupName of groupNames) {
     const isDefault = groupName === "default";
@@ -364,46 +596,153 @@ function buildDocumentModel(metas, jsDocResult, title, description) {
       ({ 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)
-    );
+    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;
+    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 withEmbeddedPropDocs(ownPropDocs, columns, allPropDocs) {
+  const merged = new Map(ownPropDocs);
+  for (const col of columns) {
+    if (merged.has(col.propName) || col.embeddedIn === void 0 || col.embeddedPropName === void 0) {
+      continue;
+    }
+    const info = allPropDocs.get(col.embeddedIn)?.get(col.embeddedPropName);
+    if (info) {
+      merged.set(col.propName, info);
+    }
+  }
+  return merged;
+}
+function applyAtLeastOne(relations, metas, props, onWarn) {
+  const adjusted = relations.map((edge) => ({ ...edge }));
+  const metaByClass = new Map(metas.map((m) => [m.className, m]));
+  for (const [className, propMap] of props) {
+    const meta = metaByClass.get(className);
+    if (!meta) {
+      continue;
+    }
+    for (const [propName, info] of propMap) {
+      if (!info.atLeastOne) {
+        continue;
+      }
+      const prop = meta.properties[propName];
+      if (!prop) {
+        continue;
+      }
+      let edge;
+      if (prop.kind === import_core3.ReferenceKind.ONE_TO_MANY && prop.mappedBy) {
+        edge = adjusted.find(
+          (e) => e.fromEntity === prop.type && e.toEntity === className && e.label === prop.mappedBy
+        );
+        if (edge) {
+          edge.fromCardinality = FROM_ONE_OR_MORE;
+        }
+      } else if (prop.kind === import_core3.ReferenceKind.MANY_TO_MANY && prop.owner === true) {
+        edge = adjusted.find((e) => e.fromEntity === className && e.toEntity === prop.type && e.label === propName);
+        if (edge) {
+          edge.toCardinality = TO_ONE_OR_MORE;
+        }
+      } else if (prop.kind === import_core3.ReferenceKind.MANY_TO_MANY && prop.mappedBy) {
+        edge = adjusted.find(
+          (e) => e.fromEntity === prop.type && e.toEntity === className && e.label === prop.mappedBy
+        );
+        if (edge) {
+          edge.fromCardinality = FROM_ONE_OR_MORE;
+        }
+      }
+      if (!edge) {
+        onWarn?.(
+          `@atLeastOne on ${className}.${propName} had no effect: no matching relation edge was found. It applies only to collection relations that can be matched to a rendered edge: @OneToMany with mappedBy, or @ManyToMany on either the owning side or an inverse mappedBy side.`
+        );
+      }
+    }
+  }
+  return adjusted;
+}
 function hasNoNamespaceTags(jsDoc) {
-  if (!jsDoc) return true;
+  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;
+  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;
+  if (isDefault) {
+    return hasNoNamespaceTags(jsDoc);
+  }
+  if (!jsDoc) {
+    return false;
+  }
   return jsDoc.namespaces.includes(groupName) || jsDoc.describeNamespaces.includes(groupName);
 }
 
+// src/provider.ts
+async function withTsMorphMetadataProvider(options, onWarn) {
+  if (options.metadataProvider !== void 0) {
+    return options;
+  }
+  try {
+    const { TsMorphMetadataProvider } = await import("@mikro-orm/reflection");
+    return { ...options, metadataProvider: TsMorphMetadataProvider };
+  } catch (err) {
+    const code = err !== null && typeof err === "object" && "code" in err ? err.code : void 0;
+    const isNotInstalled = code === "MODULE_NOT_FOUND" || code === "ERR_MODULE_NOT_FOUND";
+    if (!isNotInstalled && onWarn) {
+      onWarn(
+        `@mikro-orm/reflection is installed but failed to load: ${err instanceof Error ? err.message : String(err)}. Ensure all @mikro-orm/* packages are installed at the same version.`
+      );
+    }
+    return options;
+  }
+}
+
 // src/render/markdown.ts
 function renderMarkdown(docModel) {
-  const sections = [`# ${docModel.title}`];
+  const sections = [`# ${escapeMarkdownInline(docModel.title)}`];
   if (docModel.description) {
-    sections.push(docModel.description);
+    sections.push(escapeMarkdownParagraph(docModel.description));
+  }
+  if (docModel.groups.length > 1) {
+    sections.push(renderTableOfContents(docModel.groups));
   }
   for (const group of docModel.groups) {
     sections.push(renderGroupSection(group));
   }
   return sections.join("\n\n");
 }
+function renderBulletSection(header, items, renderItem) {
+  const lines = [header, ""];
+  for (const item of items) {
+    lines.push(renderItem(item));
+  }
+  return lines.join("\n");
+}
+function renderTableOfContents(groups) {
+  return renderBulletSection("## Contents", groups, (group) => {
+    const label = escapeMarkdownInline(group.name).replace(/[[\]]/g, "\\$&");
+    return `- [${label}](#${toMarkdownAnchor(group.name)})`;
+  });
+}
 function renderGroupSection(group) {
-  const parts = [`## ${group.name}`];
+  const parts = [`## ${escapeMarkdownInline(group.name)}`];
   if (group.erdEntities.length > 0) {
     const diagramModel = {
       entities: group.erdEntities.map((e) => e.model),
@@ -417,16 +756,18 @@ function renderGroupSection(group) {
   return parts.join("\n\n");
 }
 function renderEntitySection(entity) {
-  const parts = [`### ${entity.model.className}`];
+  const parts = [`### ${escapeMarkdownInline(entity.model.className)}`];
+  parts.push(`*Table: ${renderMarkdownInlineCode(entity.model.tableName)}*`);
   if (entity.jsDoc?.description) {
-    parts.push(`> ${entity.jsDoc.description}`);
+    parts.push(renderMarkdownBlockQuote(entity.jsDoc.description));
   }
   if (entity.model.discriminatorColumn) {
+    parts.push(`*STI root \u2014 discriminator column: ${renderMarkdownInlineCode(entity.model.discriminatorColumn)}*`);
+  } else if (entity.model.extendsEntity) {
+    const discValue = entity.model.discriminatorValue !== void 0 ? `, discriminator value: ${renderMarkdownInlineCode(entity.model.discriminatorValue)}` : "";
     parts.push(
-      `*STI root \u2014 discriminator column: \`${entity.model.discriminatorColumn}\`*`
+      `*Extends ${renderMarkdownInlineCode(entity.model.extendsEntity)} (Single Table Inheritance${discValue})*`
     );
-  } else if (entity.model.extendsEntity) {
-    parts.push(`*Extends \`${entity.model.extendsEntity}\` (Single Table Inheritance)*`);
   }
   if (entity.model.columns.length > 0) {
     parts.push(renderColumnTable(entity));
@@ -434,6 +775,10 @@ function renderEntitySection(entity) {
   if (entity.model.constraints.length > 0) {
     parts.push(renderConstraints(entity.model.constraints));
   }
+  const computedColumns = entity.model.columns.filter((col) => col.formula !== void 0);
+  if (computedColumns.length > 0) {
+    parts.push(renderComputedColumns(computedColumns));
+  }
   return parts.join("\n\n");
 }
 function renderColumnTable(entity) {
@@ -442,48 +787,137 @@ function renderColumnTable(entity) {
   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} |`;
+    const docDesc = entity.propDocs.get(col.propName)?.description ?? col.comment ?? "";
+    const enumDesc = col.enumItems !== void 0 ? `One of: ${col.enumItems.join(", ")}` : "";
+    const desc = [docDesc, enumDesc].filter((part) => part !== "").join("\n");
+    return `| ${escapeMarkdownTableCell(col.fieldName)} | ${escapeMarkdownTableCell(col.type)} | ${escapeMarkdownTableCell(key)} | ${nullable} | ${escapeMarkdownTableCell(desc)} |`;
   });
   return [header, sep, ...rows].join("\n");
 }
 function resolveColumnKey(col) {
-  if (col.isPrimary) return "PK";
+  const fkKey = col.fieldName !== col.propName ? `FK (${col.propName})` : "FK";
+  if (col.isPrimary && col.isForeignKey) {
+    return `PK, ${fkKey}`;
+  }
+  if (col.isPrimary) {
+    return "PK";
+  }
   if (col.isForeignKey) {
-    return col.fieldName !== col.propName ? `FK (${col.propName})` : "FK";
+    return fkKey;
+  }
+  if (col.isUnique) {
+    return "UK";
+  }
+  if (col.isDiscriminator) {
+    return "discriminator";
+  }
+  if (col.embeddedIn !== void 0) {
+    return `[${col.embeddedIn}]`;
   }
-  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 renderComputedColumns(columns) {
+  return renderBulletSection("**Computed columns:**", columns, (col) => {
+    const expr = col.formula ? `: ${renderMarkdownInlineCode(col.formula)}` : "";
+    return `- ${renderMarkdownInlineCode(col.fieldName)}${expr}`;
+  });
+}
 function renderConstraints(constraints) {
-  const lines = ["**Constraints:**", ""];
-  for (const c of constraints) {
-    const name = c.name ? ` \`${c.name}\`` : "";
+  return renderBulletSection("**Constraints:**", constraints, (c) => {
+    const name = c.name ? ` ${renderMarkdownInlineCode(c.name)}` : "";
+    const properties = c.properties.map(escapeMarkdownInline).join(", ");
     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 `- Index${name}: (${properties})`;
     }
-  }
-  return lines.join("\n");
+    if (c.type === "unique") {
+      return `- Unique${name}: (${properties})`;
+    }
+    return `- Check${name}: ${renderMarkdownInlineCode(c.expression ?? "")}`;
+  });
 }
 
 // src/index.ts
+var COMPILED_JS = /\.(c|m)?js$/i;
+function resolveJsDocSources(sourcePaths, src, onWarn) {
+  if (src !== void 0 && src.length > 0) {
+    return src;
+  }
+  if (sourcePaths.some((p) => COMPILED_JS.test(p)) && onWarn) {
+    onWarn(
+      'Entities were discovered from compiled JavaScript, so JSDoc descriptions and @namespace/@hidden tags cannot be read (build tools strip comments). Hidden entities may be exposed. Pass --src "<glob to your .ts sources>" (or the `src` option) to read JSDoc from the original TypeScript files.'
+    );
+  }
+  return sourcePaths;
+}
+function assertExplicitJsDocSourceCoverage(metas, jsDocResult, src, onWarn) {
+  if (jsDocResult.sourceFileCount === 0) {
+    throw new Error(
+      `No source files matched the explicit src paths: ${src.join(", ")}
+Check the --src glob/path (or the \`src\` option). Without matching TypeScript sources, JSDoc tags such as @namespace and @hidden cannot be read.`
+    );
+  }
+  const isRenderable = (meta) => !meta.pivotTable && !meta.embeddable;
+  const missingConcrete = metas.filter((meta) => isRenderable(meta) && !meta.abstract).map((meta) => meta.className).filter((className) => !jsDocResult.classNames.has(className));
+  if (missingConcrete.length > 0) {
+    throw new Error(
+      `Explicit src paths did not include source declarations for discovered entities: ${missingConcrete.join(", ")}
+Check that --src (or the \`src\` option) points at all TypeScript entity files. JSDoc tags such as @namespace and @hidden for missing entities cannot be read.`
+    );
+  }
+  if (onWarn) {
+    const missingAbstract = metas.filter((meta) => isRenderable(meta) && meta.abstract).map((meta) => meta.className).filter((className) => !jsDocResult.classNames.has(className));
+    if (missingAbstract.length > 0) {
+      onWarn(
+        `Abstract STI parent entities were not found in the explicit src paths: ${missingAbstract.join(", ")}
+@hidden and @namespace tags for these entities will not be applied. Include their source files in --src to enable JSDoc tags for them.`
+      );
+    }
+  }
+}
+function errorMessages(err) {
+  const messages = [];
+  const seen = /* @__PURE__ */ new Set();
+  let current = err;
+  while (current instanceof Error && !seen.has(current)) {
+    seen.add(current);
+    messages.push(current.message);
+    current = current.cause;
+  }
+  return messages;
+}
+function isMissingTsMorphSourceFile(err) {
+  return errorMessages(err).some((message) => message.includes("Source file") && message.includes("not found"));
+}
+async function loadEntityMetadataWithTsMorphFallback(originalOrm, effectiveOrm) {
+  try {
+    return await loadEntityMetadata(effectiveOrm);
+  } catch (err) {
+    const wasAutoInjected = originalOrm.metadataProvider === void 0 && effectiveOrm.metadataProvider !== void 0;
+    if (!wasAutoInjected || !isMissingTsMorphSourceFile(err)) {
+      throw err;
+    }
+    try {
+      return await loadEntityMetadata(originalOrm);
+    } catch {
+      throw err;
+    }
+  }
+}
 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);
+  const { orm, title = "Database Schema", description, src, onWarn } = options;
+  const effectiveOrm = await withTsMorphMetadataProvider(orm, onWarn);
+  const { metas, sourcePaths } = await loadEntityMetadataWithTsMorphFallback(orm, effectiveOrm);
+  const jsDocResult = loadJsDoc(resolveJsDocSources(sourcePaths, src, onWarn));
+  if (src !== void 0 && src.length > 0) {
+    assertExplicitJsDocSourceCoverage(metas, jsDocResult, src, onWarn);
+  }
+  const docModel = buildDocumentModel(metas, jsDocResult, title, description, onWarn);
   return renderMarkdown(docModel);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MetadataLoadError,
-  generateMarkdown
+  generateMarkdown,
+  resolveJsDocSources
 });
 //# sourceMappingURL=index.cjs.map