@metamask-previews/messenger-cli 0.0.0-preview-e024252b6 → 0.1.0-preview-8f51c7a3a

package/dist/docs/generate.mjs

@@ -0,0 +1,227 @@
+import { directoryExists } from "@metamask/utils/node";
+import { execFile } from "node:child_process";
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import { promisify } from "node:util";
+import { findDtsFiles, findTsFiles } from "./discovery.mjs";
+import { extractFromFile } from "./extraction.mjs";
+import { generateIndexPage, generateNamespacePage, generateSidebars } from "./markdown.mjs";
+/**
+ * Compute a deduplication score for a messenger item, preferring items with
+ * JSDoc and from the "home" package whose name matches the namespace.
+ *
+ * @param item - The messenger item to score.
+ * @returns A numeric score (higher is better).
+ */
+function deduplicationScore(item) {
+    const jsDocScore = item.jsDoc ? 2 : 0;
+    const namespacePrefix = item.typeString
+        .split(':')[0]
+        .replace(/Controller|Service/u, '')
+        .toLowerCase();
+    const homeScore = item.sourceFile.includes(namespacePrefix) ? 1 : 0;
+    return jsDocScore + homeScore;
+}
+const execFileAsync = promisify(execFile);
+/**
+ * Resolve the GitHub blob base URL for a project by reading its git remote.
+ *
+ * @param projectPath - Absolute path to the project root.
+ * @returns A base URL like "https://github.com/Owner/Repo/blob/main/" or null.
+ */
+async function resolveRepoBaseUrl(projectPath) {
+    try {
+        const { stdout: remoteRaw } = await execFileAsync('git', ['remote', 'get-url', 'origin'], { cwd: projectPath });
+        const remote = remoteRaw.trim();
+        // Parse owner/repo from SSH or HTTPS remote URLs
+        // Handles aliases like github.com-Org used in SSH configs
+        const match = remote.match(/github\.com[^:/]*[:/]([^/]+\/[^/]+?)(?:\.git)?$/u);
+        if (!match) {
+            return null;
+        }
+        return `https://github.com/${match[1]}/blob/main/`;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Scan a project for messenger action/event types and generate documentation.
+ *
+ * @param options - Generation options.
+ * @returns A promise resolving to counts of generated namespaces, actions, and events.
+ */
+export async function generate(options) {
+    const { projectPath, outputDir, scanDirs } = options;
+    const allItems = [];
+    // Check which sources are available
+    const existingScanDirs = [];
+    for (const dir of scanDirs) {
+        const abs = path.join(projectPath, dir);
+        if (await directoryExists(abs)) {
+            existingScanDirs.push(dir);
+        }
+    }
+    const packagesDir = path.join(projectPath, 'packages');
+    const hasPackages = await directoryExists(packagesDir);
+    const nmDir = path.join(projectPath, 'node_modules', '@metamask');
+    const hasNodeModules = await directoryExists(nmDir);
+    const sources = [];
+    for (const dir of existingScanDirs) {
+        sources.push(`${dir}/ (.ts)`);
+    }
+    if (hasPackages) {
+        sources.push('packages/*/src (.ts)');
+    }
+    if (hasNodeModules) {
+        sources.push('node_modules/@metamask/*/dist (.d.cts)');
+    }
+    console.log(`Scanning ${sources.join(', ')} for Messenger action/event types...`);
+    // Scan configured source directories for .ts files
+    for (const dir of existingScanDirs) {
+        const abs = path.join(projectPath, dir);
+        const tsFiles = await findTsFiles(abs);
+        for (const file of tsFiles) {
+            try {
+                const items = await extractFromFile(file, projectPath);
+                allItems.push(...items);
+            }
+            catch (error) {
+                console.warn(`Warning: failed to parse ${path.relative(projectPath, file)}: ${String(error)}`);
+            }
+        }
+    }
+    // Scan packages/*/src for .ts source files (monorepo)
+    if (hasPackages) {
+        const entries = await fs.readdir(packagesDir, { withFileTypes: true });
+        const packageDirs = entries
+            .filter((dirent) => dirent.isDirectory())
+            .map((dirent) => path.join(packagesDir, dirent.name, 'src'));
+        for (const srcDir of packageDirs) {
+            if (!(await directoryExists(srcDir))) {
+                continue;
+            }
+            const tsFiles = await findTsFiles(srcDir);
+            for (const file of tsFiles) {
+                try {
+                    const items = await extractFromFile(file, projectPath);
+                    allItems.push(...items);
+                }
+                catch (error) {
+                    console.warn(`Warning: failed to parse ${path.relative(projectPath, file)}: ${String(error)}`);
+                }
+            }
+        }
+    }
+    // Scan node_modules/@metamask/*/dist for .d.cts declaration files
+    if (hasNodeModules) {
+        const entries = await fs.readdir(nmDir, { withFileTypes: true });
+        const pkgDirs = entries
+            .filter((dirent) => dirent.isDirectory() || dirent.isSymbolicLink())
+            .map((dirent) => path.join(nmDir, dirent.name, 'dist'));
+        for (const distDir of pkgDirs) {
+            if (!(await directoryExists(distDir))) {
+                continue;
+            }
+            const dtsFiles = await findDtsFiles(distDir);
+            for (const file of dtsFiles) {
+                try {
+                    const items = await extractFromFile(file, projectPath);
+                    allItems.push(...items);
+                }
+                catch (error) {
+                    console.warn(`Warning: failed to parse ${path.relative(projectPath, file)}: ${String(error)}`);
+                }
+            }
+        }
+    }
+    if (existingScanDirs.length === 0 && !hasPackages && !hasNodeModules) {
+        throw new Error(`No scannable directories found in ${projectPath}. ` +
+            `Looked for: ${scanDirs.join(', ')}, packages/, node_modules/@metamask/`);
+    }
+    console.log(`Found ${allItems.length} messenger items total.`);
+    // Group by namespace (part before the colon), deduplicating by typeString.
+    // When duplicates exist, prefer the one with JSDoc, or from the package
+    // whose name matches the namespace.
+    const byNamespace = new Map();
+    const seen = new Map(); // key: typeString
+    for (const item of allItems) {
+        const existing = seen.get(item.typeString);
+        if (existing) {
+            // Prefer item with JSDoc, or from the "home" package
+            const existingScore = deduplicationScore(existing);
+            const newScore = deduplicationScore(item);
+            if (newScore <= existingScore) {
+                continue;
+            }
+            // Replace existing with better item
+            const ns = item.typeString.split(':')[0];
+            const group = byNamespace.get(ns);
+            if (group) {
+                const list = item.kind === 'action' ? group.actions : group.events;
+                const idx = list.indexOf(existing);
+                if (idx !== -1) {
+                    list[idx] = item;
+                }
+            }
+            seen.set(item.typeString, item);
+            continue;
+        }
+        seen.set(item.typeString, item);
+        const ns = item.typeString.split(':')[0];
+        if (!byNamespace.has(ns)) {
+            byNamespace.set(ns, { namespace: ns, actions: [], events: [] });
+        }
+        const group = byNamespace.get(ns);
+        if (group) {
+            if (item.kind === 'action') {
+                group.actions.push(item);
+            }
+            else {
+                group.events.push(item);
+            }
+        }
+    }
+    // Sort namespaces alphabetically, sort items within each namespace
+    const namespaces = Array.from(byNamespace.values()).sort((a, b) => a.namespace.localeCompare(b.namespace));
+    for (const ns of namespaces) {
+        ns.actions.sort((a, b) => a.typeString.localeCompare(b.typeString));
+        ns.events.sort((a, b) => a.typeString.localeCompare(b.typeString));
+    }
+    // Resolve repository base URL for source links
+    const repoBaseUrl = await resolveRepoBaseUrl(projectPath);
+    // Write output
+    const docsDir = path.join(outputDir, 'docs');
+    // Clean existing generated docs
+    if (await directoryExists(docsDir)) {
+        await fs.rm(docsDir, { recursive: true });
+    }
+    await fs.mkdir(docsDir, { recursive: true });
+    // Generate namespace pages
+    for (const ns of namespaces) {
+        const nsDir = path.join(docsDir, ns.namespace);
+        await fs.mkdir(nsDir, { recursive: true });
+        if (ns.actions.length > 0) {
+            await fs.writeFile(path.join(nsDir, 'actions.md'), generateNamespacePage(ns, 'action', repoBaseUrl));
+        }
+        if (ns.events.length > 0) {
+            await fs.writeFile(path.join(nsDir, 'events.md'), generateNamespacePage(ns, 'event', repoBaseUrl));
+        }
+    }
+    // Generate index page
+    await fs.writeFile(path.join(docsDir, 'index.md'), generateIndexPage(namespaces));
+    // Generate sidebars
+    await fs.writeFile(path.join(outputDir, 'sidebars.ts'), generateSidebars(namespaces));
+    const totalActions = namespaces.reduce((sum, ns) => sum + ns.actions.length, 0);
+    const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);
+    console.log(`Generated docs for ${namespaces.length} namespaces.`);
+    console.log(`  Actions: ${totalActions}`);
+    console.log(`  Events: ${totalEvents}`);
+    console.log(`Output: ${docsDir}/`);
+    return {
+        namespaces: namespaces.length,
+        actions: totalActions,
+        events: totalEvents,
+    };
+}
+//# sourceMappingURL=generate.mjs.map

package/dist/docs/generate.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.mjs","sourceRoot":"","sources":["../../src/docs/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,6BAA6B;AACvD,OAAO,EAAE,QAAQ,EAAE,2BAA2B;AAC9C,OAAO,KAAK,EAAE,yBAAyB;AACvC,OAAO,KAAK,IAAI,kBAAkB;AAClC,OAAO,EAAE,SAAS,EAAE,kBAAkB;AAEtC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,wBAAoB;AACxD,OAAO,EAAE,eAAe,EAAE,yBAAqB;AAC/C,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,gBAAgB,EACjB,uBAAmB;AAGpB;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,IAAsB;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU;SACpC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACb,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC;SAClC,WAAW,EAAE,CAAC;IACjB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,UAAU,GAAG,SAAS,CAAC;AAChC,CAAC;AAED,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE1C;;;;;GAKG;AACH,KAAK,UAAU,kBAAkB,CAAC,WAAmB;IACnD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,aAAa,CAC/C,KAAK,EACL,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC/B,EAAE,GAAG,EAAE,WAAW,EAAE,CACrB,CAAC;QAEF,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAEhC,iDAAiD;QACjD,0DAA0D;QAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CACxB,kDAAkD,CACnD,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,sBAAsB,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAuBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,OAAwB;IAExB,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,QAAQ,GAAuB,EAAE,CAAC;IAExC,oCAAoC;IACpC,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACxC,IAAI,MAAM,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IAClE,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC;IAEpD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,CAAC,GAAG,CACT,YAAY,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,sCAAsC,CACrE,CAAC;IAEF,mDAAmD;IACnD,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBACvD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YAC1B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CACV,4BAA4B,IAAI,CAAC,QAAQ,CACvC,WAAW,EACX,IAAI,CACL,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,CACtB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,sDAAsD;IACtD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,OAAO;aACxB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;aACxC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAE/D,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,CAAC,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,IAAI,CAAC;oBACH,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;oBACvD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;gBAC1B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,IAAI,CACV,4BAA4B,IAAI,CAAC,QAAQ,CACvC,WAAW,EACX,IAAI,CACL,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,CACtB,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,MAAM,OAAO,GAAG,OAAO;aACpB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;aACnE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAE1D,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBACtC,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;YAC7C,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC;oBACH,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;oBACvD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;gBAC1B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,IAAI,CACV,4BAA4B,IAAI,CAAC,QAAQ,CACvC,WAAW,EACX,IAAI,CACL,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,CACtB,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,cAAc,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CACb,qCAAqC,WAAW,IAAI;YAClD,eAAe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,sCAAsC,CAC3E,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,MAAM,yBAAyB,CAAC,CAAC;IAE/D,2EAA2E;IAC3E,wEAAwE;IACxE,oCAAoC;IACpC,MAAM,WAAW,GAAG,IAAI,GAAG,EAA0B,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,GAAG,EAA4B,CAAC,CAAC,kBAAkB;IAEpE,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,QAAQ,EAAE,CAAC;YACb,qDAAqD;YACrD,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,QAAQ,IAAI,aAAa,EAAE,CAAC;gBAC9B,SAAS;YACX,CAAC;YACD,oCAAoC;YACpC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;gBACnE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACnC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;oBACf,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAChC,SAAS;QACX,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACzB,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC3B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAED,mEAAmE;IACnE,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAChE,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CACvC,CAAC;IAEF,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QACpE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,+CAA+C;IAC/C,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAE1D,eAAe;IACf,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAE7C,gCAAgC;IAChC,IAAI,MAAM,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACnC,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7C,2BAA2B;IAC3B,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3C,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,EAC9B,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,CACjD,CAAC;QACJ,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,EAC7B,qBAAqB,CAAC,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,CAChD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,sBAAsB;IACtB,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,EAC9B,iBAAiB,CAAC,UAAU,CAAC,CAC9B,CAAC;IAEF,oBAAoB;IACpB,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EACnC,gBAAgB,CAAC,UAAU,CAAC,CAC7B,CAAC;IAEF,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EACpC,CAAC,CACF,CAAC;IACF,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE9E,OAAO,CAAC,GAAG,CAAC,sBAAsB,UAAU,CAAC,MAAM,cAAc,CAAC,CAAC;IACnE,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,GAAG,CAAC,aAAa,WAAW,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,GAAG,CAAC,CAAC;IAEnC,OAAO;QACL,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,OAAO,EAAE,YAAY;QACrB,MAAM,EAAE,WAAW;KACpB,CAAC;AACJ,CAAC","sourcesContent":["import { directoryExists } from '@metamask/utils/node';\nimport { execFile } from 'node:child_process';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport { promisify } from 'node:util';\n\nimport { findDtsFiles, findTsFiles } from './discovery';\nimport { extractFromFile } from './extraction';\nimport {\n  generateIndexPage,\n  generateNamespacePage,\n  generateSidebars,\n} from './markdown';\nimport type { MessengerItemDoc, NamespaceGroup } from './types';\n\n/**\n * Compute a deduplication score for a messenger item, preferring items with\n * JSDoc and from the \"home\" package whose name matches the namespace.\n *\n * @param item - The messenger item to score.\n * @returns A numeric score (higher is better).\n */\nfunction deduplicationScore(item: MessengerItemDoc): number {\n  const jsDocScore = item.jsDoc ? 2 : 0;\n  const namespacePrefix = item.typeString\n    .split(':')[0]\n    .replace(/Controller|Service/u, '')\n    .toLowerCase();\n  const homeScore = item.sourceFile.includes(namespacePrefix) ? 1 : 0;\n  return jsDocScore + homeScore;\n}\n\nconst execFileAsync = promisify(execFile);\n\n/**\n * Resolve the GitHub blob base URL for a project by reading its git remote.\n *\n * @param projectPath - Absolute path to the project root.\n * @returns A base URL like \"https://github.com/Owner/Repo/blob/main/\" or null.\n */\nasync function resolveRepoBaseUrl(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout: remoteRaw } = await execFileAsync(\n      'git',\n      ['remote', 'get-url', 'origin'],\n      { cwd: projectPath },\n    );\n\n    const remote = remoteRaw.trim();\n\n    // Parse owner/repo from SSH or HTTPS remote URLs\n    // Handles aliases like github.com-Org used in SSH configs\n    const match = remote.match(\n      /github\\.com[^:/]*[:/]([^/]+\\/[^/]+?)(?:\\.git)?$/u,\n    );\n    if (!match) {\n      return null;\n    }\n\n    return `https://github.com/${match[1]}/blob/main/`;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Options for the generate function.\n */\nexport type GenerateOptions = {\n  /** Absolute path to the project to scan. */\n  projectPath: string;\n  /** Absolute path to the output directory for generated docs. */\n  outputDir: string;\n  /** Directories (relative to projectPath) to scan for .ts source files. */\n  scanDirs: string[];\n};\n\n/**\n * Result returned by the generate function.\n */\nexport type GenerateResult = {\n  namespaces: number;\n  actions: number;\n  events: number;\n};\n\n/**\n * Scan a project for messenger action/event types and generate documentation.\n *\n * @param options - Generation options.\n * @returns A promise resolving to counts of generated namespaces, actions, and events.\n */\nexport async function generate(\n  options: GenerateOptions,\n): Promise<GenerateResult> {\n  const { projectPath, outputDir, scanDirs } = options;\n\n  const allItems: MessengerItemDoc[] = [];\n\n  // Check which sources are available\n  const existingScanDirs: string[] = [];\n  for (const dir of scanDirs) {\n    const abs = path.join(projectPath, dir);\n    if (await directoryExists(abs)) {\n      existingScanDirs.push(dir);\n    }\n  }\n  const packagesDir = path.join(projectPath, 'packages');\n  const hasPackages = await directoryExists(packagesDir);\n  const nmDir = path.join(projectPath, 'node_modules', '@metamask');\n  const hasNodeModules = await directoryExists(nmDir);\n\n  const sources: string[] = [];\n  for (const dir of existingScanDirs) {\n    sources.push(`${dir}/ (.ts)`);\n  }\n  if (hasPackages) {\n    sources.push('packages/*/src (.ts)');\n  }\n  if (hasNodeModules) {\n    sources.push('node_modules/@metamask/*/dist (.d.cts)');\n  }\n  console.log(\n    `Scanning ${sources.join(', ')} for Messenger action/event types...`,\n  );\n\n  // Scan configured source directories for .ts files\n  for (const dir of existingScanDirs) {\n    const abs = path.join(projectPath, dir);\n    const tsFiles = await findTsFiles(abs);\n    for (const file of tsFiles) {\n      try {\n        const items = await extractFromFile(file, projectPath);\n        allItems.push(...items);\n      } catch (error) {\n        console.warn(\n          `Warning: failed to parse ${path.relative(\n            projectPath,\n            file,\n          )}: ${String(error)}`,\n        );\n      }\n    }\n  }\n\n  // Scan packages/*/src for .ts source files (monorepo)\n  if (hasPackages) {\n    const entries = await fs.readdir(packagesDir, { withFileTypes: true });\n    const packageDirs = entries\n      .filter((dirent) => dirent.isDirectory())\n      .map((dirent) => path.join(packagesDir, dirent.name, 'src'));\n\n    for (const srcDir of packageDirs) {\n      if (!(await directoryExists(srcDir))) {\n        continue;\n      }\n\n      const tsFiles = await findTsFiles(srcDir);\n      for (const file of tsFiles) {\n        try {\n          const items = await extractFromFile(file, projectPath);\n          allItems.push(...items);\n        } catch (error) {\n          console.warn(\n            `Warning: failed to parse ${path.relative(\n              projectPath,\n              file,\n            )}: ${String(error)}`,\n          );\n        }\n      }\n    }\n  }\n\n  // Scan node_modules/@metamask/*/dist for .d.cts declaration files\n  if (hasNodeModules) {\n    const entries = await fs.readdir(nmDir, { withFileTypes: true });\n    const pkgDirs = entries\n      .filter((dirent) => dirent.isDirectory() || dirent.isSymbolicLink())\n      .map((dirent) => path.join(nmDir, dirent.name, 'dist'));\n\n    for (const distDir of pkgDirs) {\n      if (!(await directoryExists(distDir))) {\n        continue;\n      }\n\n      const dtsFiles = await findDtsFiles(distDir);\n      for (const file of dtsFiles) {\n        try {\n          const items = await extractFromFile(file, projectPath);\n          allItems.push(...items);\n        } catch (error) {\n          console.warn(\n            `Warning: failed to parse ${path.relative(\n              projectPath,\n              file,\n            )}: ${String(error)}`,\n          );\n        }\n      }\n    }\n  }\n\n  if (existingScanDirs.length === 0 && !hasPackages && !hasNodeModules) {\n    throw new Error(\n      `No scannable directories found in ${projectPath}. ` +\n        `Looked for: ${scanDirs.join(', ')}, packages/, node_modules/@metamask/`,\n    );\n  }\n\n  console.log(`Found ${allItems.length} messenger items total.`);\n\n  // Group by namespace (part before the colon), deduplicating by typeString.\n  // When duplicates exist, prefer the one with JSDoc, or from the package\n  // whose name matches the namespace.\n  const byNamespace = new Map<string, NamespaceGroup>();\n  const seen = new Map<string, MessengerItemDoc>(); // key: typeString\n\n  for (const item of allItems) {\n    const existing = seen.get(item.typeString);\n    if (existing) {\n      // Prefer item with JSDoc, or from the \"home\" package\n      const existingScore = deduplicationScore(existing);\n      const newScore = deduplicationScore(item);\n      if (newScore <= existingScore) {\n        continue;\n      }\n      // Replace existing with better item\n      const ns = item.typeString.split(':')[0];\n      const group = byNamespace.get(ns);\n      if (group) {\n        const list = item.kind === 'action' ? group.actions : group.events;\n        const idx = list.indexOf(existing);\n        if (idx !== -1) {\n          list[idx] = item;\n        }\n      }\n      seen.set(item.typeString, item);\n      continue;\n    }\n\n    seen.set(item.typeString, item);\n    const ns = item.typeString.split(':')[0];\n    if (!byNamespace.has(ns)) {\n      byNamespace.set(ns, { namespace: ns, actions: [], events: [] });\n    }\n    const group = byNamespace.get(ns);\n    if (group) {\n      if (item.kind === 'action') {\n        group.actions.push(item);\n      } else {\n        group.events.push(item);\n      }\n    }\n  }\n\n  // Sort namespaces alphabetically, sort items within each namespace\n  const namespaces = Array.from(byNamespace.values()).sort((a, b) =>\n    a.namespace.localeCompare(b.namespace),\n  );\n\n  for (const ns of namespaces) {\n    ns.actions.sort((a, b) => a.typeString.localeCompare(b.typeString));\n    ns.events.sort((a, b) => a.typeString.localeCompare(b.typeString));\n  }\n\n  // Resolve repository base URL for source links\n  const repoBaseUrl = await resolveRepoBaseUrl(projectPath);\n\n  // Write output\n  const docsDir = path.join(outputDir, 'docs');\n\n  // Clean existing generated docs\n  if (await directoryExists(docsDir)) {\n    await fs.rm(docsDir, { recursive: true });\n  }\n  await fs.mkdir(docsDir, { recursive: true });\n\n  // Generate namespace pages\n  for (const ns of namespaces) {\n    const nsDir = path.join(docsDir, ns.namespace);\n    await fs.mkdir(nsDir, { recursive: true });\n\n    if (ns.actions.length > 0) {\n      await fs.writeFile(\n        path.join(nsDir, 'actions.md'),\n        generateNamespacePage(ns, 'action', repoBaseUrl),\n      );\n    }\n\n    if (ns.events.length > 0) {\n      await fs.writeFile(\n        path.join(nsDir, 'events.md'),\n        generateNamespacePage(ns, 'event', repoBaseUrl),\n      );\n    }\n  }\n\n  // Generate index page\n  await fs.writeFile(\n    path.join(docsDir, 'index.md'),\n    generateIndexPage(namespaces),\n  );\n\n  // Generate sidebars\n  await fs.writeFile(\n    path.join(outputDir, 'sidebars.ts'),\n    generateSidebars(namespaces),\n  );\n\n  const totalActions = namespaces.reduce(\n    (sum, ns) => sum + ns.actions.length,\n    0,\n  );\n  const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);\n\n  console.log(`Generated docs for ${namespaces.length} namespaces.`);\n  console.log(`  Actions: ${totalActions}`);\n  console.log(`  Events: ${totalEvents}`);\n  console.log(`Output: ${docsDir}/`);\n\n  return {\n    namespaces: namespaces.length,\n    actions: totalActions,\n    events: totalEvents,\n  };\n}\n"]}

package/dist/docs/markdown.cjs

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSidebars = exports.generateIndexPage = exports.generateNamespacePage = exports.generateItemMarkdown = void 0;
+/**
+ * Convert backtick-quoted action/event names in text into links when they
+ * match a known item in the same namespace. For example, `` `setActiveNetwork` ``
+ * becomes a link to `#networkcontrollersetactivenetwork` on the actions page.
+ *
+ * @param text - The markdown text to process.
+ * @param namespace - The current namespace (e.g. "NetworkController").
+ * @param knownNames - Map from short name (e.g. "setActiveNetwork") to the page-relative path and anchor.
+ * @returns The text with backtick references replaced by links.
+ */
+function linkifyReferences(text, namespace, knownNames) {
+    return text.replace(/`([a-zA-Z]\w*)`/gu, (match, name) => {
+        const link = knownNames.get(name);
+        if (link) {
+            return `[\`${name}\`](${link})`;
+        }
+        // Also try with namespace prefix (e.g. "NetworkController:setActiveNetwork")
+        const fullName = `${namespace}:${name}`;
+        const anchor = fullName.toLowerCase().replace(/[^a-z0-9]/gu, '');
+        const linkFull = knownNames.get(fullName);
+        if (linkFull) {
+            return `[\`${name}\`](${linkFull})`;
+        }
+        // Check if the anchor exists anywhere in known names values
+        for (const [, href] of knownNames) {
+            if (href.includes(anchor)) {
+                return `[\`${name}\`](${href})`;
+            }
+        }
+        return match;
+    });
+}
+/**
+ * Generate markdown documentation for a single messenger item.
+ *
+ * @param item - The messenger item to document.
+ * @param namespace - The current namespace.
+ * @param knownNames - Map from short/full names to their link paths.
+ * @param repoBaseUrl - Optional GitHub blob base URL (e.g. "https://github.com/Owner/Repo/blob/sha/").
+ * @returns The generated markdown string.
+ */
+function generateItemMarkdown(item, namespace, knownNames, repoBaseUrl) {
+    const parts = [];
+    parts.push(`### \`${item.typeString}\``);
+    parts.push('');
+    if (item.deprecated) {
+        parts.push('> **Deprecated**');
+        parts.push('');
+    }
+    if (item.sourceFile.includes('node_modules/')) {
+        const pkgMatch = item.sourceFile.match(/node_modules\/(@metamask\/[^/]+)/u);
+        const pkgName = pkgMatch ? pkgMatch[1] : item.sourceFile;
+        const npmUrl = `https://www.npmjs.com/package/${pkgName}`;
+        parts.push(`**Package**: [\`${pkgName}\`](${npmUrl})`);
+    }
+    else if (repoBaseUrl) {
+        const ghUrl = `${repoBaseUrl}${item.sourceFile}#L${item.line}`;
+        parts.push(`**Source**: [${item.sourceFile}:${item.line}](${ghUrl})`);
+    }
+    else {
+        parts.push(`**Source**: \`${item.sourceFile}:${item.line}\``);
+    }
+    parts.push('');
+    if (item.jsDoc) {
+        parts.push(linkifyReferences(item.jsDoc, namespace, knownNames));
+        parts.push('');
+    }
+    const label = item.kind === 'action' ? 'Handler' : 'Payload';
+    parts.push(`**${label}**:`);
+    parts.push('');
+    parts.push('```typescript');
+    parts.push(item.handlerOrPayload);
+    parts.push('```');
+    parts.push('');
+    return parts.join('\n');
+}
+exports.generateItemMarkdown = generateItemMarkdown;
+/**
+ * Generate a full markdown page for a namespace's actions or events.
+ *
+ * @param ns - The namespace group to generate a page for.
+ * @param kind - Whether to generate the actions or events page.
+ * @param repoBaseUrl - Optional GitHub blob base URL for source links.
+ * @returns The generated markdown string.
+ */
+function generateNamespacePage(ns, kind, repoBaseUrl = null) {
+    const items = kind === 'action' ? ns.actions : ns.events;
+    const title = kind === 'action' ? 'Actions' : 'Events';
+    const parts = [];
+    parts.push('---');
+    parts.push(`title: "${ns.namespace} ${title}"`);
+    parts.push(`sidebar_label: "${title}"`);
+    parts.push('---');
+    parts.push('');
+    parts.push(`# ${ns.namespace} ${title}`);
+    parts.push('');
+    if (items.length === 0) {
+        parts.push(`_No ${kind}s found for this namespace._`);
+        parts.push('');
+        return parts.join('\n');
+    }
+    parts.push(`${items.length} ${kind}${items.length === 1 ? '' : 's'} registered.`);
+    parts.push('');
+    // Build a map of known names → link paths for cross-referencing.
+    // Actions on same page get #anchor, actions/events on sibling page get relative path.
+    const knownNames = new Map();
+    for (const action of ns.actions) {
+        const shortName = action.typeString.split(':')[1];
+        const anchor = action.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');
+        const href = kind === 'action' ? `#${anchor}` : `./actions#${anchor}`;
+        knownNames.set(shortName, href);
+        knownNames.set(action.typeString, href);
+    }
+    for (const event of ns.events) {
+        const shortName = event.typeString.split(':')[1];
+        const anchor = event.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');
+        const href = kind === 'event' ? `#${anchor}` : `./events#${anchor}`;
+        knownNames.set(shortName, href);
+        knownNames.set(event.typeString, href);
+    }
+    // Table of contents
+    parts.push('| Name | Deprecated |');
+    parts.push('|------|-----------|');
+    for (const item of items) {
+        const name = item.typeString.split(':')[1];
+        // Docusaurus uses github-slugger: strips non-alphanumeric, lowercases, no dashes for special chars in code spans
+        const anchor = item.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');
+        const dep = item.deprecated ? 'Yes' : '';
+        parts.push(`| [\`${name}\`](#${anchor}) | ${dep} |`);
+    }
+    parts.push('');
+    parts.push('---');
+    parts.push('');
+    for (const item of items) {
+        parts.push(generateItemMarkdown(item, ns.namespace, knownNames, repoBaseUrl));
+        parts.push('---');
+        parts.push('');
+    }
+    return parts.join('\n');
+}
+exports.generateNamespacePage = generateNamespacePage;
+/**
+ * Generate the index/overview page listing all namespaces.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated markdown string.
+ */
+function generateIndexPage(namespaces) {
+    const totalActions = namespaces.reduce((sum, ns) => sum + ns.actions.length, 0);
+    const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);
+    const parts = [];
+    parts.push('---');
+    parts.push('title: "Messenger API Reference"');
+    parts.push('slug: "/"');
+    parts.push('---');
+    parts.push('');
+    parts.push('# Messenger API');
+    parts.push('');
+    parts.push('This site documents every action and event registered on the Messenger — the type-safe message bus used across all controllers.');
+    parts.push('');
+    parts.push(`- **${namespaces.length}** namespaces`);
+    parts.push(`- **${totalActions}** actions`);
+    parts.push(`- **${totalEvents}** events`);
+    parts.push('');
+    parts.push('## Namespaces');
+    parts.push('');
+    parts.push('| Namespace | Actions | Events |');
+    parts.push('|-----------|---------|--------|');
+    for (const ns of namespaces) {
+        const firstLink = ns.actions.length > 0
+            ? `${ns.namespace}/actions`
+            : `${ns.namespace}/events`;
+        parts.push(`| [${ns.namespace}](${firstLink}) | ${ns.actions.length} | ${ns.events.length} |`);
+    }
+    parts.push('');
+    return parts.join('\n');
+}
+exports.generateIndexPage = generateIndexPage;
+/**
+ * Generate the sidebars.ts file content for Docusaurus.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated TypeScript source string.
+ */
+function generateSidebars(namespaces) {
+    const items = namespaces.map((ns) => ({
+        type: 'category',
+        label: ns.namespace,
+        items: [
+            ...(ns.actions.length > 0 ? [`${ns.namespace}/actions`] : []),
+            ...(ns.events.length > 0 ? [`${ns.namespace}/events`] : []),
+        ],
+    }));
+    const sidebar = {
+        messengerSidebar: [
+            {
+                type: 'doc',
+                id: 'index',
+                label: 'Overview',
+            },
+            ...items,
+        ],
+    };
+    return `// This file is auto-generated by @metamask/messenger-docs\n// Do not edit manually.\nconst sidebars = ${JSON.stringify(sidebar, null, 2)};\nexport default sidebars;\n`;
+}
+exports.generateSidebars = generateSidebars;
+//# sourceMappingURL=markdown.cjs.map

package/dist/docs/markdown.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.cjs","sourceRoot":"","sources":["../../src/docs/markdown.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;GASG;AACH,SAAS,iBAAiB,CACxB,IAAY,EACZ,SAAiB,EACjB,UAA+B;IAE/B,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,IAAY,EAAE,EAAE;QAC/D,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,MAAM,IAAI,OAAO,IAAI,GAAG,CAAC;QAClC,CAAC;QACD,6EAA6E;QAC7E,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,MAAM,IAAI,OAAO,QAAQ,GAAG,CAAC;QACtC,CAAC;QACD,4DAA4D;QAC5D,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;YAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,OAAO,MAAM,IAAI,OAAO,IAAI,GAAG,CAAC;YAClC,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAClC,IAAsB,EACtB,SAAiB,EACjB,UAA+B,EAC/B,WAA0B;IAE1B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;IACzC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACzD,MAAM,MAAM,GAAG,iCAAiC,OAAO,EAAE,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,mBAAmB,OAAO,OAAO,MAAM,GAAG,CAAC,CAAC;IACzD,CAAC;SAAM,IAAI,WAAW,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,WAAW,GAAG,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/D,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,GAAG,CAAC,CAAC;IACxE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;IAChE,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AA3CD,oDA2CC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,EAAkB,EAClB,IAAwB,EACxB,cAA6B,IAAI;IAEjC,MAAM,KAAK,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC;IACzD,MAAM,KAAK,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IACvD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,IAAI,KAAK,GAAG,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,CAAC,mBAAmB,KAAK,GAAG,CAAC,CAAC;IACxC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC;IACzC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,8BAA8B,CAAC,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI,CACR,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,cAAc,CACtE,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,iEAAiE;IACjE,sFAAsF;IACtF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,KAAK,MAAM,MAAM,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,aAAa,MAAM,EAAE,CAAC;QACtE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAChC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,YAAY,MAAM,EAAE,CAAC;QACpE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAChC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,oBAAoB;IACpB,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACpC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,iHAAiH;QACjH,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QACxE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,QAAQ,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CACR,oBAAoB,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAClE,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AArED,sDAqEC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,UAA4B;IAC5D,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EACpC,CAAC,CACF,CAAC;IACF,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CACR,iIAAiI,CAClI,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,MAAM,eAAe,CAAC,CAAC;IACpD,KAAK,CAAC,IAAI,CAAC,OAAO,YAAY,YAAY,CAAC,CAAC;IAC5C,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,WAAW,CAAC,CAAC;IAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAE/C,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,MAAM,SAAS,GACb,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YACnB,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,UAAU;YAC3B,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,SAAS,CAAC;QAC/B,KAAK,CAAC,IAAI,CACR,MAAM,EAAE,CAAC,SAAS,KAAK,SAAS,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CACnF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAxCD,8CAwCC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,UAA4B;IAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,EAAE,CAAC,SAAS;QACnB,KAAK,EAAE;YACL,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D;KACF,CAAC,CAAC,CAAC;IAEJ,MAAM,OAAO,GAAG;QACd,gBAAgB,EAAE;YAChB;gBACE,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,OAAO;gBACX,KAAK,EAAE,UAAU;aAClB;YACD,GAAG,KAAK;SACT;KACF,CAAC;IAEF,OAAO,0GAA0G,IAAI,CAAC,SAAS,CAC7H,OAAO,EACP,IAAI,EACJ,CAAC,CACF,+BAA+B,CAAC;AACnC,CAAC;AA1BD,4CA0BC","sourcesContent":["import type { MessengerItemDoc, NamespaceGroup } from './types';\n\n/**\n * Convert backtick-quoted action/event names in text into links when they\n * match a known item in the same namespace. For example, `` `setActiveNetwork` ``\n * becomes a link to `#networkcontrollersetactivenetwork` on the actions page.\n *\n * @param text - The markdown text to process.\n * @param namespace - The current namespace (e.g. \"NetworkController\").\n * @param knownNames - Map from short name (e.g. \"setActiveNetwork\") to the page-relative path and anchor.\n * @returns The text with backtick references replaced by links.\n */\nfunction linkifyReferences(\n  text: string,\n  namespace: string,\n  knownNames: Map<string, string>,\n): string {\n  return text.replace(/`([a-zA-Z]\\w*)`/gu, (match, name: string) => {\n    const link = knownNames.get(name);\n    if (link) {\n      return `[\\`${name}\\`](${link})`;\n    }\n    // Also try with namespace prefix (e.g. \"NetworkController:setActiveNetwork\")\n    const fullName = `${namespace}:${name}`;\n    const anchor = fullName.toLowerCase().replace(/[^a-z0-9]/gu, '');\n    const linkFull = knownNames.get(fullName);\n    if (linkFull) {\n      return `[\\`${name}\\`](${linkFull})`;\n    }\n    // Check if the anchor exists anywhere in known names values\n    for (const [, href] of knownNames) {\n      if (href.includes(anchor)) {\n        return `[\\`${name}\\`](${href})`;\n      }\n    }\n    return match;\n  });\n}\n\n/**\n * Generate markdown documentation for a single messenger item.\n *\n * @param item - The messenger item to document.\n * @param namespace - The current namespace.\n * @param knownNames - Map from short/full names to their link paths.\n * @param repoBaseUrl - Optional GitHub blob base URL (e.g. \"https://github.com/Owner/Repo/blob/sha/\").\n * @returns The generated markdown string.\n */\nexport function generateItemMarkdown(\n  item: MessengerItemDoc,\n  namespace: string,\n  knownNames: Map<string, string>,\n  repoBaseUrl: string | null,\n): string {\n  const parts: string[] = [];\n\n  parts.push(`### \\`${item.typeString}\\``);\n  parts.push('');\n\n  if (item.deprecated) {\n    parts.push('> **Deprecated**');\n    parts.push('');\n  }\n\n  if (item.sourceFile.includes('node_modules/')) {\n    const pkgMatch = item.sourceFile.match(/node_modules\\/(@metamask\\/[^/]+)/u);\n    const pkgName = pkgMatch ? pkgMatch[1] : item.sourceFile;\n    const npmUrl = `https://www.npmjs.com/package/${pkgName}`;\n    parts.push(`**Package**: [\\`${pkgName}\\`](${npmUrl})`);\n  } else if (repoBaseUrl) {\n    const ghUrl = `${repoBaseUrl}${item.sourceFile}#L${item.line}`;\n    parts.push(`**Source**: [${item.sourceFile}:${item.line}](${ghUrl})`);\n  } else {\n    parts.push(`**Source**: \\`${item.sourceFile}:${item.line}\\``);\n  }\n  parts.push('');\n\n  if (item.jsDoc) {\n    parts.push(linkifyReferences(item.jsDoc, namespace, knownNames));\n    parts.push('');\n  }\n\n  const label = item.kind === 'action' ? 'Handler' : 'Payload';\n  parts.push(`**${label}**:`);\n  parts.push('');\n  parts.push('```typescript');\n  parts.push(item.handlerOrPayload);\n  parts.push('```');\n  parts.push('');\n\n  return parts.join('\\n');\n}\n\n/**\n * Generate a full markdown page for a namespace's actions or events.\n *\n * @param ns - The namespace group to generate a page for.\n * @param kind - Whether to generate the actions or events page.\n * @param repoBaseUrl - Optional GitHub blob base URL for source links.\n * @returns The generated markdown string.\n */\nexport function generateNamespacePage(\n  ns: NamespaceGroup,\n  kind: 'action' | 'event',\n  repoBaseUrl: string | null = null,\n): string {\n  const items = kind === 'action' ? ns.actions : ns.events;\n  const title = kind === 'action' ? 'Actions' : 'Events';\n  const parts: string[] = [];\n\n  parts.push('---');\n  parts.push(`title: \"${ns.namespace} ${title}\"`);\n  parts.push(`sidebar_label: \"${title}\"`);\n  parts.push('---');\n  parts.push('');\n  parts.push(`# ${ns.namespace} ${title}`);\n  parts.push('');\n\n  if (items.length === 0) {\n    parts.push(`_No ${kind}s found for this namespace._`);\n    parts.push('');\n    return parts.join('\\n');\n  }\n\n  parts.push(\n    `${items.length} ${kind}${items.length === 1 ? '' : 's'} registered.`,\n  );\n  parts.push('');\n\n  // Build a map of known names → link paths for cross-referencing.\n  // Actions on same page get #anchor, actions/events on sibling page get relative path.\n  const knownNames = new Map<string, string>();\n  for (const action of ns.actions) {\n    const shortName = action.typeString.split(':')[1];\n    const anchor = action.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');\n    const href = kind === 'action' ? `#${anchor}` : `./actions#${anchor}`;\n    knownNames.set(shortName, href);\n    knownNames.set(action.typeString, href);\n  }\n  for (const event of ns.events) {\n    const shortName = event.typeString.split(':')[1];\n    const anchor = event.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');\n    const href = kind === 'event' ? `#${anchor}` : `./events#${anchor}`;\n    knownNames.set(shortName, href);\n    knownNames.set(event.typeString, href);\n  }\n\n  // Table of contents\n  parts.push('| Name | Deprecated |');\n  parts.push('|------|-----------|');\n  for (const item of items) {\n    const name = item.typeString.split(':')[1];\n    // Docusaurus uses github-slugger: strips non-alphanumeric, lowercases, no dashes for special chars in code spans\n    const anchor = item.typeString.toLowerCase().replace(/[^a-z0-9]/gu, '');\n    const dep = item.deprecated ? 'Yes' : '';\n    parts.push(`| [\\`${name}\\`](#${anchor}) | ${dep} |`);\n  }\n  parts.push('');\n  parts.push('---');\n  parts.push('');\n\n  for (const item of items) {\n    parts.push(\n      generateItemMarkdown(item, ns.namespace, knownNames, repoBaseUrl),\n    );\n    parts.push('---');\n    parts.push('');\n  }\n\n  return parts.join('\\n');\n}\n\n/**\n * Generate the index/overview page listing all namespaces.\n *\n * @param namespaces - All namespace groups sorted alphabetically.\n * @returns The generated markdown string.\n */\nexport function generateIndexPage(namespaces: NamespaceGroup[]): string {\n  const totalActions = namespaces.reduce(\n    (sum, ns) => sum + ns.actions.length,\n    0,\n  );\n  const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);\n\n  const parts: string[] = [];\n  parts.push('---');\n  parts.push('title: \"Messenger API Reference\"');\n  parts.push('slug: \"/\"');\n  parts.push('---');\n  parts.push('');\n  parts.push('# Messenger API');\n  parts.push('');\n  parts.push(\n    'This site documents every action and event registered on the Messenger — the type-safe message bus used across all controllers.',\n  );\n  parts.push('');\n  parts.push(`- **${namespaces.length}** namespaces`);\n  parts.push(`- **${totalActions}** actions`);\n  parts.push(`- **${totalEvents}** events`);\n  parts.push('');\n  parts.push('## Namespaces');\n  parts.push('');\n  parts.push('| Namespace | Actions | Events |');\n  parts.push('|-----------|---------|--------|');\n\n  for (const ns of namespaces) {\n    const firstLink =\n      ns.actions.length > 0\n        ? `${ns.namespace}/actions`\n        : `${ns.namespace}/events`;\n    parts.push(\n      `| [${ns.namespace}](${firstLink}) | ${ns.actions.length} | ${ns.events.length} |`,\n    );\n  }\n\n  parts.push('');\n  return parts.join('\\n');\n}\n\n/**\n * Generate the sidebars.ts file content for Docusaurus.\n *\n * @param namespaces - All namespace groups sorted alphabetically.\n * @returns The generated TypeScript source string.\n */\nexport function generateSidebars(namespaces: NamespaceGroup[]): string {\n  const items = namespaces.map((ns) => ({\n    type: 'category',\n    label: ns.namespace,\n    items: [\n      ...(ns.actions.length > 0 ? [`${ns.namespace}/actions`] : []),\n      ...(ns.events.length > 0 ? [`${ns.namespace}/events`] : []),\n    ],\n  }));\n\n  const sidebar = {\n    messengerSidebar: [\n      {\n        type: 'doc',\n        id: 'index',\n        label: 'Overview',\n      },\n      ...items,\n    ],\n  };\n\n  return `// This file is auto-generated by @metamask/messenger-docs\\n// Do not edit manually.\\nconst sidebars = ${JSON.stringify(\n    sidebar,\n    null,\n    2,\n  )};\\nexport default sidebars;\\n`;\n}\n"]}

package/dist/docs/markdown.d.cts

@@ -0,0 +1,35 @@
+import type { MessengerItemDoc, NamespaceGroup } from "./types.cjs";
+/**
+ * Generate markdown documentation for a single messenger item.
+ *
+ * @param item - The messenger item to document.
+ * @param namespace - The current namespace.
+ * @param knownNames - Map from short/full names to their link paths.
+ * @param repoBaseUrl - Optional GitHub blob base URL (e.g. "https://github.com/Owner/Repo/blob/sha/").
+ * @returns The generated markdown string.
+ */
+export declare function generateItemMarkdown(item: MessengerItemDoc, namespace: string, knownNames: Map<string, string>, repoBaseUrl: string | null): string;
+/**
+ * Generate a full markdown page for a namespace's actions or events.
+ *
+ * @param ns - The namespace group to generate a page for.
+ * @param kind - Whether to generate the actions or events page.
+ * @param repoBaseUrl - Optional GitHub blob base URL for source links.
+ * @returns The generated markdown string.
+ */
+export declare function generateNamespacePage(ns: NamespaceGroup, kind: 'action' | 'event', repoBaseUrl?: string | null): string;
+/**
+ * Generate the index/overview page listing all namespaces.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated markdown string.
+ */
+export declare function generateIndexPage(namespaces: NamespaceGroup[]): string;
+/**
+ * Generate the sidebars.ts file content for Docusaurus.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated TypeScript source string.
+ */
+export declare function generateSidebars(namespaces: NamespaceGroup[]): string;
+//# sourceMappingURL=markdown.d.cts.map

package/dist/docs/markdown.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.cts","sourceRoot":"","sources":["../../src/docs/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,oBAAgB;AAuChE;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gBAAgB,EACtB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,GACzB,MAAM,CAsCR;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,cAAc,EAClB,IAAI,EAAE,QAAQ,GAAG,OAAO,EACxB,WAAW,GAAE,MAAM,GAAG,IAAW,GAChC,MAAM,CAiER;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CAwCtE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CA0BrE"}

package/dist/docs/markdown.d.mts

@@ -0,0 +1,35 @@
+import type { MessengerItemDoc, NamespaceGroup } from "./types.mjs";
+/**
+ * Generate markdown documentation for a single messenger item.
+ *
+ * @param item - The messenger item to document.
+ * @param namespace - The current namespace.
+ * @param knownNames - Map from short/full names to their link paths.
+ * @param repoBaseUrl - Optional GitHub blob base URL (e.g. "https://github.com/Owner/Repo/blob/sha/").
+ * @returns The generated markdown string.
+ */
+export declare function generateItemMarkdown(item: MessengerItemDoc, namespace: string, knownNames: Map<string, string>, repoBaseUrl: string | null): string;
+/**
+ * Generate a full markdown page for a namespace's actions or events.
+ *
+ * @param ns - The namespace group to generate a page for.
+ * @param kind - Whether to generate the actions or events page.
+ * @param repoBaseUrl - Optional GitHub blob base URL for source links.
+ * @returns The generated markdown string.
+ */
+export declare function generateNamespacePage(ns: NamespaceGroup, kind: 'action' | 'event', repoBaseUrl?: string | null): string;
+/**
+ * Generate the index/overview page listing all namespaces.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated markdown string.
+ */
+export declare function generateIndexPage(namespaces: NamespaceGroup[]): string;
+/**
+ * Generate the sidebars.ts file content for Docusaurus.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated TypeScript source string.
+ */
+export declare function generateSidebars(namespaces: NamespaceGroup[]): string;
+//# sourceMappingURL=markdown.d.mts.map

package/dist/docs/markdown.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.mts","sourceRoot":"","sources":["../../src/docs/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,oBAAgB;AAuChE;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gBAAgB,EACtB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,GACzB,MAAM,CAsCR;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,cAAc,EAClB,IAAI,EAAE,QAAQ,GAAG,OAAO,EACxB,WAAW,GAAE,MAAM,GAAG,IAAW,GAChC,MAAM,CAiER;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CAwCtE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CA0BrE"}