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

package/dist/cli.js

@@ -237,6 +237,8 @@ function toMarkdownAnchor(value) {
 }
 
 // src/render/mermaid.ts
+var MERMAID_LAYOUTS = ["dagre", "elk", "elk.stress"];
+var MERMAID_THEMES = ["default", "neutral", "dark", "forest", "base"];
 var FORMULA_DUMMY_TABLE = {
   alias: "e0",
   name: "",
@@ -375,9 +377,31 @@ function resolveFkTypes(prop, metaByClass, fieldNameCount) {
   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";
+    const resolvedProp = pkProp ?? primaryProps[index] ?? primaryProps[0];
+    const rawType = resolvedProp?.type ?? "integer";
+    const pkIndex = resolvedProp !== void 0 ? primaryProps.indexOf(resolvedProp) : 0;
+    return resolveScalarType(rawType, metaByClass, pkIndex);
   });
 }
+function resolveScalarType(type, metaByClass, pkIndex = 0, depth = 0) {
+  if (depth >= 5) {
+    return "integer";
+  }
+  const refMeta = metaByClass.get(type);
+  if (!refMeta) {
+    return type;
+  }
+  const primaryProps = getPrimaryProps(refMeta);
+  if (primaryProps.length === 0) {
+    return type;
+  }
+  const targetProp = primaryProps[pkIndex] ?? primaryProps[0];
+  const nextType = targetProp?.type ?? type;
+  if (nextType === type) {
+    return type;
+  }
+  return resolveScalarType(nextType, metaByClass, pkIndex, depth + 1);
+}
 function getPrimaryProps(meta) {
   const primaryKeys = meta.primaryKeys ?? [];
   const orderedPrimaryProps = primaryKeys.map((key) => meta.properties[String(key)]).filter((prop) => prop !== void 0);
@@ -479,8 +503,41 @@ function buildEdge(fromEntity, prop) {
   }
   return null;
 }
-function renderErDiagram(model) {
-  const lines = ["erDiagram"];
+function normalizeType(type) {
+  const t = type.toLowerCase().trim();
+  if (t === "uuid" || t === "text" || t === "string" || t.startsWith("varchar")) {
+    return "string";
+  }
+  if (t === "timestamptz" || t === "timestamp" || t === "datetime") {
+    return "datetime";
+  }
+  if (t === "integer" || t === "int" || t === "bigint" || t === "smallint") {
+    return "integer";
+  }
+  if (t === "doubletype" || t === "double precision" || t === "double" || t === "float" || t === "decimal") {
+    return "float";
+  }
+  if (t === "boolean" || t === "bool") {
+    return "boolean";
+  }
+  if (t === "jsonb") {
+    return "json";
+  }
+  return type;
+}
+function renderErDiagram(model, mermaid) {
+  const lines = [];
+  if (mermaid?.layout !== void 0 || mermaid?.theme !== void 0) {
+    lines.push("---", "config:");
+    if (mermaid.layout !== void 0) {
+      lines.push(`  layout: ${mermaid.layout}`);
+    }
+    if (mermaid.theme !== void 0) {
+      lines.push(`  theme: ${mermaid.theme}`);
+    }
+    lines.push("---");
+  }
+  lines.push("erDiagram");
   for (const entity of model.entities) {
     lines.push(`  ${toMermaidIdentifier(entity.className)} {`);
     for (const col of entity.columns) {
@@ -513,7 +570,7 @@ function renderColumnLine(col) {
     comment = "self-ref";
   }
   const commentStr = comment !== void 0 ? ` "${escapeMermaidQuotedText(comment)}"` : "";
-  return `${toMermaidIdentifier(col.type)} ${toMermaidIdentifier(col.fieldName)}${qualifier}${commentStr}`;
+  return `${toMermaidIdentifier(normalizeType(col.type))} ${toMermaidIdentifier(col.fieldName)}${qualifier}${commentStr}`;
 }
 
 // src/model/build.ts
@@ -560,9 +617,16 @@ function buildDocumentModel(metas, jsDocResult, title, description, onWarn) {
   const groups = [];
   for (const groupName of groupNames) {
     const isDefault = groupName === "default";
-    const erdEntities = [...enrichedByClass.values()].filter(
-      ({ jsDoc }) => belongsToGroupForErd(jsDoc, groupName, isDefault)
-    );
+    const erdEntities = [...enrichedByClass.values()].filter(({ jsDoc }) => belongsToGroupForErd(jsDoc, groupName, isDefault)).map((entity) => {
+      if (isCrossNamespaceInGroup(entity.jsDoc, groupName, isDefault)) {
+        const pkColumns = entity.model.columns.filter((col) => col.isPrimary);
+        if (pkColumns.length === 0) {
+          return null;
+        }
+        return { ...entity, model: { ...entity.model, columns: pkColumns } };
+      }
+      return entity;
+    }).filter((entity) => entity !== null);
     const textEntities = [...enrichedByClass.values()].filter(
       ({ jsDoc }) => belongsToGroupForText(jsDoc, groupName, isDefault)
     );
@@ -664,6 +728,12 @@ function belongsToGroupForText(jsDoc, groupName, isDefault) {
   }
   return jsDoc.namespaces.includes(groupName) || jsDoc.describeNamespaces.includes(groupName);
 }
+function isCrossNamespaceInGroup(jsDoc, groupName, isDefault) {
+  if (isDefault || !jsDoc) {
+    return false;
+  }
+  return jsDoc.erdNamespaces.includes(groupName) && !jsDoc.namespaces.includes(groupName) && !jsDoc.describeNamespaces.includes(groupName);
+}
 
 // src/provider.ts
 async function withTsMorphMetadataProvider(options, onWarn) {
@@ -686,7 +756,7 @@ async function withTsMorphMetadataProvider(options, onWarn) {
 }
 
 // src/render/markdown.ts
-function renderMarkdown(docModel) {
+function renderMarkdown(docModel, mermaid) {
   const sections = [`# ${escapeMarkdownInline(docModel.title)}`];
   if (docModel.description) {
     sections.push(escapeMarkdownParagraph(docModel.description));
@@ -695,7 +765,7 @@ function renderMarkdown(docModel) {
     sections.push(renderTableOfContents(docModel.groups));
   }
   for (const group of docModel.groups) {
-    sections.push(renderGroupSection(group));
+    sections.push(renderGroupSection(group, mermaid));
   }
   return sections.join("\n\n");
 }
@@ -712,14 +782,14 @@ function renderTableOfContents(groups) {
     return `- [${label}](#${toMarkdownAnchor(group.name)})`;
   });
 }
-function renderGroupSection(group) {
+function renderGroupSection(group, mermaid) {
   const parts = [`## ${escapeMarkdownInline(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```");
+    parts.push("```mermaid\n" + renderErDiagram(diagramModel, mermaid) + "\n```");
   }
   for (const entity of group.textEntities) {
     parts.push(renderEntitySection(entity));
@@ -761,7 +831,7 @@ function renderColumnTable(entity) {
     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 `| ${escapeMarkdownTableCell(col.fieldName)} | ${escapeMarkdownTableCell(normalizeType(col.type))} | ${escapeMarkdownTableCell(key)} | ${nullable} | ${escapeMarkdownTableCell(desc)} |`;
   });
   return [header, sep, ...rows].join("\n");
 }
@@ -875,7 +945,7 @@ async function loadEntityMetadataWithTsMorphFallback(originalOrm, effectiveOrm)
   }
 }
 async function generateMarkdown(options) {
-  const { orm, title = "Database Schema", description, src, onWarn } = options;
+  const { orm, title = "Database Schema", description, src, onWarn, mermaid } = options;
   const effectiveOrm = await withTsMorphMetadataProvider(orm, onWarn);
   const { metas, sourcePaths } = await loadEntityMetadataWithTsMorphFallback(orm, effectiveOrm);
   const jsDocResult = loadJsDoc(resolveJsDocSources(sourcePaths, src, onWarn));
@@ -883,7 +953,7 @@ async function generateMarkdown(options) {
     assertExplicitJsDocSourceCoverage(metas, jsDocResult, src, onWarn);
   }
   const docModel = buildDocumentModel(metas, jsDocResult, title, description, onWarn);
-  return renderMarkdown(docModel);
+  return renderMarkdown(docModel, mermaid);
 }
 
 // src/cli.ts
@@ -998,9 +1068,34 @@ async function writeMarkdownFile(outPath, markdown) {
 ${formatFileSystemError(cause)}`, { cause });
   }
 }
+function parseMermaidOptions(opts) {
+  const { mermaidLayout, mermaidTheme } = opts;
+  if (mermaidLayout !== void 0 && !MERMAID_LAYOUTS.includes(mermaidLayout)) {
+    process.stderr.write(
+      `Error: Invalid --mermaid-layout "${mermaidLayout}". Allowed values: ${MERMAID_LAYOUTS.join(", ")}
+`
+    );
+    process.exit(1);
+  }
+  if (mermaidTheme !== void 0 && !MERMAID_THEMES.includes(mermaidTheme)) {
+    process.stderr.write(
+      `Error: Invalid --mermaid-theme "${mermaidTheme}". Allowed values: ${MERMAID_THEMES.join(", ")}
+`
+    );
+    process.exit(1);
+  }
+  if (mermaidLayout === void 0 && mermaidTheme === void 0) {
+    return void 0;
+  }
+  return {
+    ...mermaidLayout !== void 0 && { layout: mermaidLayout },
+    ...mermaidTheme !== void 0 && { theme: mermaidTheme }
+  };
+}
 async function run(opts) {
   const configPath = path2.resolve(opts.config);
   const outPath = path2.resolve(opts.out);
+  const mermaid = parseMermaidOptions(opts);
   let ormOptions;
   try {
     ormOptions = await loadOrmOptions(configPath, opts.tsconfig);
@@ -1019,6 +1114,7 @@ ${err instanceof Error ? err.message : String(err)}
       title: opts.title,
       ...opts.description !== void 0 && { description: opts.description },
       ...opts.src !== void 0 && { src: opts.src },
+      ...mermaid !== void 0 && { mermaid },
       onWarn: (message) => void process.stderr.write(`Warning: ${message}
 `)
     });
@@ -1043,7 +1139,7 @@ var program = new Command().name("mikro-orm-markdown").description("Generate Mer
 ).option(
   "--src <paths...>",
   "Source .ts file globs to read JSDoc from when entities run from compiled .js (comments are stripped at build time)"
-).action(run);
+).option("--mermaid-layout <layout>", `Mermaid layout engine injected as frontmatter (${MERMAID_LAYOUTS.join("|")})`).option("--mermaid-theme <theme>", `Mermaid theme injected as frontmatter (${MERMAID_THEMES.join("|")})`).action(run);
 function isDirectCliExecution() {
   const entryPoint = process.argv[1];
   if (entryPoint === void 0) {