@ankhorage/paradox 0.0.7 → 0.0.9

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.0.9
+
+### Patch Changes
+
+- 8904673: Handle exports and type members without declaration nodes defensively during analysis.
+
+## 0.0.8
+
+### Patch Changes
+
+- 46fd38d: Render Mermaid diagrams visually in the generated static documentation app.
+
+  The generated `paradox/index.html` now loads Mermaid in the browser, renders diagram blocks visually, and keeps the raw Mermaid source available in a collapsible section for offline fallback, copying, and debugging.
+
 ## 0.0.7
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @ankhorage/paradox
 
-![license: MIT](./paradox/badges/license.svg) ![npm: v0.0.6](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
+![license: MIT](./paradox/badges/license.svg) ![npm: v0.0.8](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
 
 Deterministic documentation generator for TypeScript packages.
 

package/dist/analyze/exports.js

@@ -14,7 +14,10 @@ export function analyzeExports(project, options) {
         const exported = sourceFile.getExportSymbols();
         for (const symbol of exported) {
             const resolved = resolveExportSymbol(symbol);
-            const [decl] = resolved.getDeclarations();
+            const decl = getFirstDeclaration(resolved.getDeclarations());
+            if (decl === null) {
+                continue;
+            }
             const rawComment = getParadoxComment(decl);
             const parsed = rawComment
                 ? parseParadoxComment(rawComment)
@@ -67,6 +70,10 @@ function getEntryPointSourceFiles(project, options) {
     })
         .filter((sourceFile) => sourceFile != null);
 }
+function getFirstDeclaration(declarations) {
+    const [declaration = null] = declarations;
+    return declaration;
+}
 function inferKind(node) {
     if ('getParameters' in node)
         return 'function';

package/dist/analyze/utils/getExportMetadata.js

@@ -63,24 +63,42 @@ function getSignature(declaration, params, returns) {
 function getMembers(node) {
     if (getCallableNode(node) !== null)
         return [];
-    return node
-        .getType()
-        .getProperties()
-        .map((property) => {
-        const [declaration] = property.getDeclarations();
+    if (Node.isInterfaceDeclaration(node)) {
+        return getMembersFromProperties(node.getType().getProperties());
+    }
+    if (Node.isTypeAliasDeclaration(node)) {
+        const typeNode = node.getTypeNode();
+        if (!typeNode || !Node.isTypeLiteral(typeNode))
+            return [];
+        return getMembersFromProperties(node.getType().getProperties());
+    }
+    return [];
+}
+function getMembersFromProperties(properties) {
+    return properties.flatMap((property) => {
+        const declaration = getFirstDeclaration(property.getDeclarations());
+        if (declaration === null) {
+            return [];
+        }
         const rawComment = getParadoxComment(declaration);
         const parsed = rawComment
             ? parseParadoxComment(rawComment)
             : { description: null, isConfig: false, params: {}, returns: null };
-        return {
-            name: property.getName(),
-            kind: isMemberMethodDeclaration(declaration) ? 'method' : 'property',
-            type: property.getTypeAtLocation(declaration).getText(declaration),
-            required: !property.isOptional(),
-            description: parsed.description,
-        };
+        return [
+            {
+                name: property.getName(),
+                kind: isMemberMethodDeclaration(declaration) ? 'method' : 'property',
+                type: property.getTypeAtLocation(declaration).getText(declaration),
+                required: !property.isOptional(),
+                description: parsed.description,
+            },
+        ];
     });
 }
+function getFirstDeclaration(declarations) {
+    const [declaration = null] = declarations;
+    return declaration;
+}
 function getCallableDeclarations(symbol, node) {
     const declarations = symbol
         .getDeclarations()

package/dist/analyze/utils/getParadoxComment.d.ts

@@ -2,4 +2,4 @@ import type { Node } from 'ts-morph';
 /***
  * Reads the nearest Paradox doc comment attached to a declaration.
  */
-export declare function getParadoxComment(node: Node): string | null;
+export declare function getParadoxComment(node: Node | undefined): string | null;

package/dist/analyze/utils/getParadoxComment.js

@@ -2,6 +2,8 @@
  * Reads the nearest Paradox doc comment attached to a declaration.
  */
 export function getParadoxComment(node) {
+    if (!node)
+        return null;
     const sourceFile = node.getSourceFile();
     const text = sourceFile.getFullText();
     const nodeStart = node.getStart(false);

package/dist/render/renderers/html.js

@@ -100,6 +100,8 @@ export function renderHtml({ diagrams, model, }) {
         padding: 1rem;
       }
       .empty { font-style: italic; color: #6f7f9c; }
+      .mermaid { margin: 1rem 0; overflow: auto; }
+      details > summary { cursor: pointer; color: #5e6d8c; font-size: 0.9rem; margin-top: 0.5rem; user-select: none; }
       @media (max-width: 900px) {
         .layout { grid-template-columns: 1fr; }
         .sidebar { position: static; max-height: none; border-right: 0; border-bottom: 1px solid #d8dfec; }
@@ -169,6 +171,10 @@ export function renderHtml({ diagrams, model, }) {
         }
       });
     </script>
+    <script type="module">
+      import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
+      mermaid.initialize({ startOnLoad: true });
+    </script>
   </body>
 </html>
 `,
@@ -270,7 +276,11 @@ function renderDiagramCard(diagram) {
     return `<article class="item" data-search="${escapeAttribute(`${diagram.title} ${diagram.path}`)}">
     <h3>${escapeHtml(diagram.title)}</h3>
     <p class="muted"><code>${escapeHtml(diagram.path)}</code></p>
-    <pre>${escapeHtml(diagram.content)}</pre>
+    <div class="mermaid">${escapeHtml(diagram.content)}</div>
+    <details>
+      <summary>View Mermaid source</summary>
+      <pre>${escapeHtml(diagram.content)}</pre>
+    </details>
   </article>`;
 }
 function renderInlineCodeList(values) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {