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

package/dist/docs/markdown.mjs

@@ -0,0 +1,203 @@
+/**
+ * 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.
+ */
+export 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');
+}
+/**
+ * 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 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');
+}
+/**
+ * Generate the index/overview page listing all namespaces.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated markdown string.
+ */
+export 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');
+}
+/**
+ * Generate the sidebars.ts file content for Docusaurus.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @returns The generated TypeScript source string.
+ */
+export 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`;
+}
+//# sourceMappingURL=markdown.mjs.map

package/dist/docs/markdown.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.mjs","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,MAAM,UAAU,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;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,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","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/types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.cjs.map

package/dist/docs/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/docs/types.ts"],"names":[],"mappings":"","sourcesContent":["export type MessengerItemDoc = {\n  typeName: string; // e.g. \"NetworkControllerGetStateAction\"\n  typeString: string; // e.g. \"NetworkController:getState\"\n  kind: 'action' | 'event';\n  jsDoc: string; // Cleaned JSDoc body text (empty if none)\n  handlerOrPayload: string; // Raw type text of handler / payload\n  sourceFile: string; // Relative path from repo root\n  line: number;\n  deprecated: boolean;\n};\n\nexport type NamespaceGroup = {\n  namespace: string;\n  actions: MessengerItemDoc[];\n  events: MessengerItemDoc[];\n};\n\n/**\n * Info about a class method, used to resolve `ClassName['methodName']` handlers.\n */\nexport type MethodInfo = {\n  jsDoc: string;\n  signature: string; // e.g. \"(fields: AddNetworkFields) => NetworkConfiguration\"\n};\n"]}

package/dist/docs/types.d.cts

@@ -0,0 +1,23 @@
+export type MessengerItemDoc = {
+    typeName: string;
+    typeString: string;
+    kind: 'action' | 'event';
+    jsDoc: string;
+    handlerOrPayload: string;
+    sourceFile: string;
+    line: number;
+    deprecated: boolean;
+};
+export type NamespaceGroup = {
+    namespace: string;
+    actions: MessengerItemDoc[];
+    events: MessengerItemDoc[];
+};
+/**
+ * Info about a class method, used to resolve `ClassName['methodName']` handlers.
+ */
+export type MethodInfo = {
+    jsDoc: string;
+    signature: string;
+};
+//# sourceMappingURL=types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/docs/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/docs/types.d.mts

@@ -0,0 +1,23 @@
+export type MessengerItemDoc = {
+    typeName: string;
+    typeString: string;
+    kind: 'action' | 'event';
+    jsDoc: string;
+    handlerOrPayload: string;
+    sourceFile: string;
+    line: number;
+    deprecated: boolean;
+};
+export type NamespaceGroup = {
+    namespace: string;
+    actions: MessengerItemDoc[];
+    events: MessengerItemDoc[];
+};
+/**
+ * Info about a class method, used to resolve `ClassName['methodName']` handlers.
+ */
+export type MethodInfo = {
+    jsDoc: string;
+    signature: string;
+};
+//# sourceMappingURL=types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/docs/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/docs/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/docs/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/docs/types.ts"],"names":[],"mappings":"","sourcesContent":["export type MessengerItemDoc = {\n  typeName: string; // e.g. \"NetworkControllerGetStateAction\"\n  typeString: string; // e.g. \"NetworkController:getState\"\n  kind: 'action' | 'event';\n  jsDoc: string; // Cleaned JSDoc body text (empty if none)\n  handlerOrPayload: string; // Raw type text of handler / payload\n  sourceFile: string; // Relative path from repo root\n  line: number;\n  deprecated: boolean;\n};\n\nexport type NamespaceGroup = {\n  namespace: string;\n  actions: MessengerItemDoc[];\n  events: MessengerItemDoc[];\n};\n\n/**\n * Info about a class method, used to resolve `ClassName['methodName']` handlers.\n */\nexport type MethodInfo = {\n  jsDoc: string;\n  signature: string; // e.g. \"(fields: AddNetworkFields) => NetworkConfiguration\"\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/messenger-cli",
-  "version": "0.0.0-preview-e024252b6",
+  "version": "0.1.0-preview-8f51c7a3a",
   "description": "CLI tools for the MetaMask messenger system",
   "keywords": [
     "MetaMask",
@@ -17,16 +17,19 @@
   "license": "MIT",
   "sideEffects": false,
   "bin": {
-    "messenger-action-types": "./dist/cli.mjs"
+    "messenger-action-types": "./dist/cli.mjs",
+    "messenger-docs": "./dist/docs/cli.mjs"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "template/"
   ],
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
     "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/messenger-cli",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/messenger-cli",
+    "docs": "tsx src/docs/cli.ts",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
     "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
@@ -34,17 +37,29 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
+    "@docusaurus/core": "^3.9.0",
+    "@docusaurus/preset-classic": "^3.9.0",
+    "@docusaurus/theme-common": "^3.9.0",
+    "@easyops-cn/docusaurus-search-local": "^0.55.0",
+    "@mdx-js/react": "^3.0.0",
     "@metamask/utils": "^11.9.0",
+    "execa": "^5.0.0",
+    "glob": "^10.0.0",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
+    "@docusaurus/types": "^3.9.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^29.5.14",
+    "@types/node": "^16.18.54",
+    "@types/react": "^18.3.0",
     "@types/yargs": "^17.0.32",
     "deepmerge": "^4.2.2",
     "eslint": "^9.39.1",
-    "execa": "^5.0.0",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "typescript": "~5.3.3"
@@ -53,6 +68,11 @@
     "eslint": ">=8",
     "typescript": ">=5.0.0"
   },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": "^18.18 || >=20"
   },

package/template/docusaurus.config.ts

@@ -0,0 +1,123 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes } from 'prism-react-renderer';
+
+const codeTheme = themes.dracula;
+
+// When running inside a host project (e.g. metamask-extension) whose React
+// version differs from Docusaurus's, we alias react/react-dom to the copies
+// installed alongside this package.  Only create aliases for packages that
+// actually exist at the NODE_PATH location (they may be hoisted when the host
+// already has a compatible version).
+const extraNodeModules = process.env.NODE_PATH; // eslint-disable-line no-process-env
+const reactAlias: Record<string, string> = {};
+if (extraNodeModules) {
+  for (const pkg of ['react', 'react-dom', '@mdx-js/react']) {
+    const pkgPath = path.join(extraNodeModules, pkg);
+    if (fs.existsSync(pkgPath)) {
+      reactAlias[pkg] = pkgPath;
+    }
+  }
+}
+
+const config: Config = {
+  title: 'Messenger API',
+  tagline: 'Action and event reference for MetaMask controller messengers',
+  url: process.env.DOCS_URL || 'https://metamask.github.io', // eslint-disable-line no-process-env
+  baseUrl: process.env.DOCS_BASE_URL || '/', // eslint-disable-line no-process-env
+  favicon: 'img/favicons/favicon-96x96.png',
+
+  onBrokenLinks: 'warn',
+
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: 'warn',
+    },
+  },
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  plugins: [
+    function resolvePlugin() {
+      return {
+        name: 'resolve-deps',
+        configureWebpack() {
+          if (Object.keys(reactAlias).length === 0) {
+            return {};
+          }
+          return {
+            resolve: { alias: reactAlias },
+          };
+        },
+      };
+    },
+  ],
+
+  themes: [
+    [
+      '@easyops-cn/docusaurus-search-local',
+      {
+        docsRouteBasePath: '/',
+        hashed: true,
+        indexBlog: false,
+        highlightSearchTermsOnTargetPage: true,
+      },
+    ],
+  ],
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts',
+          breadcrumbs: false,
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    colorMode: {
+      respectPrefersColorScheme: true,
+    },
+    navbar: {
+      logo: {
+        alt: 'MetaMask logo',
+        src: 'img/metamask-logo.svg',
+        srcDark: 'img/metamask-logo-dark.svg',
+      },
+      hideOnScroll: false,
+      items: [
+        {
+          href: 'https://github.com/MetaMask/core',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    docs: {
+      sidebar: {
+        autoCollapseCategories: false,
+      },
+    },
+    prism: {
+      theme: codeTheme,
+      defaultLanguage: 'typescript',
+      additionalLanguages: ['bash', 'json'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;