@metamask-previews/platform-api-docs 0.0.0-preview-4f4c98e → 0.0.0-preview-eb263b0ee

package/dist/{generate.js → generate.mjs}

@@ -1,14 +1,11 @@
-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.js';
-import { createExtractionProject, extractFromSourceFile, } from './extraction.js';
-import { generateIndexPage, generateNamespacePage, generateSidebars, } from './markdown.js';
-import { discoverFromRootMessengerCapabilitiesTypes } from './root-messenger-discovery.js';
-/** How many skipped capability types to name before summarizing the rest. */
-const MAX_SKIPPED_SHOWN = 10;
+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 { createExtractionProject, extractFromSourceFile } 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.
@@ -331,14 +328,13 @@ async function writeOutput(namespaces, outputDir, repoBaseUrl, indexOptions) {
     await fs.writeFile(path.join(outputDir, 'sidebars.ts'), generateSidebars(namespaces));
 }
 /**
- * Collect capabilities by scanning the project's files.
+ * Scan a project for messenger action/event types and generate documentation.
  *
- * @param projectPath - The project root path.
- * @param scanDirs - Directories (relative to projectPath) to scan.
- * @returns The extracted capabilities.
- * @throws If the project has no scannable directories at all.
+ * @param options - Generation options.
+ * @returns A promise resolving to counts of generated namespaces, actions, and events.
  */
-async function collectByScanning(projectPath, scanDirs) {
+export async function generate(options) {
+    const { projectPath, outputDir, scanDirs, projectLabel, commitSha } = options;
     const sources = await discoverScanSources(projectPath, scanDirs);
     if (sources.scanDirs.length === 0 &&
         !sources.packagesDir &&
@@ -347,71 +343,7 @@ async function collectByScanning(projectPath, scanDirs) {
             `Looked for: ${scanDirs.join(', ')}, packages/, node_modules/@metamask/`);
     }
     logScanPlan(sources);
-    return await scanSources(projectPath, sources);
-}
-/**
- * Using the project's root messenger capability collection types as
- * entrypoints, collect the constituent individual capability types and package
- * them so that they can be displayed within the documentation site.
- *
- * @param projectPath - The project root path.
- * @param options - The root-messenger strategy options.
- * @returns The extracted capabilities.
- */
-function collectFromRootMessengerCapabilities(projectPath, options) {
-    const { rootActions, rootEvents } = options;
-    console.log(`Resolving actions from ${rootActions.filePath}#${rootActions.typeName} ` +
-        `and events from ${rootEvents.filePath}#${rootEvents.typeName}...`);
-    const { capabilityPackets, skippedCapabilities } = discoverFromRootMessengerCapabilitiesTypes({
-        projectPath,
-        rootActionsTypeReference: rootActions,
-        rootEventsTypeReference: rootEvents,
-    });
-    // Report rather than drop silently: a jump in any of these usually means the
-    // project changed how it declares its capabilities.
-    warnSkipped('declared inline, with no name to document', skippedCapabilities.unnamedCapabilities);
-    warnSkipped('whose shape could not be read', skippedCapabilities.unextractableCapabilities);
-    // If both capability collection types resolve to nothing, it's always a
-    // misconfiguration (a wrong type name, or imports that didn't resolve).
-    // Failing here matters because generation would otherwise replace an existing
-    // docs directory with an empty one and exit successfully.
-    if (capabilityPackets.length === 0) {
-        throw new Error(`No messenger actions or events found in ` +
-            `${rootActions.filePath}#${rootActions.typeName} or ` +
-            `${rootEvents.filePath}#${rootEvents.typeName}. ` +
-            `Check that these types name the collections carrying every ` +
-            `capability, and that their imports resolve.`);
-    }
-    return capabilityPackets;
-}
-/**
- * Warn about capability types that couldn't be documented, naming them so the
- * warning is actionable.
- *
- * @param description - Why they were skipped, as a noun phrase.
- * @param labels - Labels identifying each skipped type.
- */
-function warnSkipped(description, labels) {
-    if (labels.length === 0) {
-        return;
-    }
-    const shown = labels.slice(0, MAX_SKIPPED_SHOWN);
-    const remaining = labels.length - shown.length;
-    console.warn(`Warning: skipped ${labels.length} capability ` +
-        `${labels.length === 1 ? 'type' : 'types'} ${description}: ` +
-        `${shown.join(', ')}${remaining > 0 ? `, and ${remaining} more` : ''}`);
-}
-/**
- * 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, projectLabel, commitSha } = options;
-    const allItems = options.strategy === 'root-messenger'
-        ? collectFromRootMessengerCapabilities(projectPath, options)
-        : await collectByScanning(projectPath, options.scanDirs);
+    const allItems = await scanSources(projectPath, sources);
     console.log(`Found ${allItems.length} messenger ${allItems.length === 1 ? 'item' : 'items'} total.`);
     const namespaces = groupByNamespace(allItems);
     const repoBaseUrl = await resolveRepoBaseUrl(projectPath, commitSha ?? null);
@@ -431,4 +363,4 @@ export async function generate(options) {
         events: totalEvents,
     };
 }
-//# sourceMappingURL=generate.js.map
+//# sourceMappingURL=generate.mjs.map

package/dist/generate.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.mjs","sourceRoot":"","sources":["../src/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;AAGtC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,wBAAuB;AAC3D,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACtB,yBAAwB;AACzB,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,gBAAgB,EACjB,uBAAsB;AAGvB;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,IAA+B;IACzD,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,0BAA0B,EAAE,EAAE,CAAC;SACvC,WAAW,EAAE,CAAC;IACjB,MAAM,SAAS,GACb,eAAe,CAAC,MAAM,GAAG,CAAC;QAC1B,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;IACR,OAAO,UAAU,GAAG,SAAS,CAAC;AAChC,CAAC;AAED,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE1C;;;;;;;GAOG;AACH,KAAK,UAAU,oBAAoB,CAAC,WAAmB;IACrD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CACpC,KAAK,EACL,CAAC,cAAc,EAAE,SAAS,EAAE,0BAA0B,CAAC,EACvD,EAAE,GAAG,EAAE,WAAW,EAAE,CACrB,CAAC;QACF,gEAAgE;QAChE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,KAAK,KAAK,CAAC,CAAC;YACjB,CAAC,CAAC,kEAAkE;gBAClE,+DAA+D;gBAC/D,6DAA6D;gBAC7D,OAAO,IAAI,MAAM;YACnB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,WAAmB;IAEnB,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,EAAE,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,kBAAkB,CAC/B,WAAmB,EACnB,SAAwB;IAExB,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC;IAClD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,IAAI,CAAC,MAAM,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,OAAO,GAAG,OAAO,SAAS,GAAG,GAAG,CAAC;AACnC,CAAC;AA8CD;;;;;;GAMG;AACH,KAAK,UAAU,mBAAmB,CAChC,WAAmB,EACnB,QAAkB;IAElB,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,IAAI,MAAM,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACvD,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IAE3E,OAAO;QACL,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,CAAC,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI;QACtE,cAAc,EAAE,CAAC,MAAM,eAAe,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,IAAI;KACT,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,OAAoB;IACvC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,CAAC,GAAG,CACT,YAAY,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,sCAAsC,CACrE,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,oBAAoB,CACjC,OAAgB,EAChB,SAAiB,EACjB,WAAmB,EACnB,SAA6C;IAE7C,MAAM,KAAK,GAAgC,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,UAAU,GACd,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CACV,4BAA4B,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAC/D,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,wBAAwB,CACrC,SAAiB,EACjB,OAAe,EACf,eAAwB;IAExB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrE,MAAM,UAAU,GAAG,OAAO;SACvB,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC,CACrE;SACA,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,MAAM,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,WAAW,CACxB,WAAmB,EACnB,OAAoB;IAEpB,MAAM,OAAO,GAAG,uBAAuB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAAgC,EAAE,CAAC;IAEjD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnC,QAAQ,CAAC,IAAI,CACX,GAAG,CAAC,MAAM,oBAAoB,CAC5B,OAAO,EACP,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAC3B,WAAW,EACX,WAAW,CACZ,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,MAAM,wBAAwB,CAC5C,OAAO,CAAC,WAAW,EACnB,KAAK,EACL,KAAK,CACN,CAAC;QACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CACX,GAAG,CAAC,MAAM,oBAAoB,CAC5B,OAAO,EACP,MAAM,EACN,WAAW,EACX,WAAW,CACZ,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,MAAM,wBAAwB,CAC7C,OAAO,CAAC,cAAc,EACtB,MAAM,EACN,IAAI,CACL,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CACX,GAAG,CAAC,MAAM,oBAAoB,CAC5B,OAAO,EACP,OAAO,EACP,WAAW,EACX,YAAY,CACb,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,uBAAuB,CAC9B,WAAwC,EACxC,QAAmC,EACnC,WAAsC;IAEtC,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzC,mEAAmE;IACnE,kEAAkE;IAClE,oEAAoE;IACpE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IACD,MAAM,YAAY,GAChB,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;IAC5D,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7C,mEAAmE;IACnE,sEAAsE;IACtE,mCAAmC;IACnC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;QACvC,YAAY,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9B,MAAM,OAAO,GACX,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,KAAkC;IAElC,MAAM,WAAW,GAAG,IAAI,GAAG,EAA0B,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAqC,CAAC;IAE1D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7D,SAAS;YACX,CAAC;YACD,uBAAuB,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YACrD,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,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAC/C,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,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,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,WAAW,CACxB,UAA4B,EAC5B,SAAiB,EACjB,WAA0B,EAC1B,YAGC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAE7C,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,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,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,EAC9B,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAC5C,CAAC;IAEF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EACnC,gBAAgB,CAAC,UAAU,CAAC,CAC7B,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,OAAwB;IAExB,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAE9E,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAEjE,IACE,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;QAC7B,CAAC,OAAO,CAAC,WAAW;QACpB,CAAC,OAAO,CAAC,cAAc,EACvB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,qCAAqC,WAAW,IAAI;YAClD,eAAe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,sCAAsC,CAC3E,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,OAAO,CAAC,CAAC;IAErB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACzD,OAAO,CAAC,GAAG,CACT,SAAS,QAAQ,CAAC,MAAM,cAAc,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,SAAS,CACxF,CAAC;IAEF,MAAM,UAAU,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,WAAW,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC;IAE7E,MAAM,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE;QACpD,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,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,CACT,sBAAsB,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,GAAG,CACnG,CAAC;IACF,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,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAExD,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';\nimport type { Project } from 'ts-morph';\n\nimport { findDtsFiles, findTsFiles } from './discovery.js';\nimport {\n  createExtractionProject,\n  extractFromSourceFile,\n} from './extraction.js';\nimport {\n  generateIndexPage,\n  generateNamespacePage,\n  generateSidebars,\n} from './markdown.js';\nimport type { MessengerCapabilityPacket, NamespaceGroup } from './types.js';\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: MessengerCapabilityPacket): 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 =\n    namespacePrefix.length > 0 &&\n    item.sourceFile.toLowerCase().includes(namespacePrefix)\n      ? 1\n      : 0;\n  return jsDocScore + homeScore;\n}\n\nconst execFileAsync = promisify(execFile);\n\n/**\n * Resolve the default branch of a project's `origin` remote by reading the\n * symbolic ref `refs/remotes/origin/HEAD`. Falls back to `main` if the\n * symbolic ref isn't set (e.g. in shallow CI clones).\n *\n * @param projectPath - Absolute path to the project root.\n * @returns The default branch name (e.g. \"main\", \"master\", \"develop\").\n */\nasync function resolveDefaultBranch(projectPath: string): Promise<string> {\n  try {\n    const { stdout } = await execFileAsync(\n      'git',\n      ['symbolic-ref', '--short', 'refs/remotes/origin/HEAD'],\n      { cwd: projectPath },\n    );\n    // stdout looks like \"origin/main\"; strip the leading \"origin/\".\n    const trimmed = stdout.trim();\n    const slash = trimmed.indexOf('/');\n    return slash === -1\n      ? // istanbul ignore next: defensive — `symbolic-ref --short` always\n        // returns `origin/<branch>` when the symbolic ref is set; this\n        // fallback only matters if git's output format ever changes.\n        trimmed || 'main'\n      : trimmed.slice(slash + 1);\n  } catch {\n    return 'main';\n  }\n}\n\n/**\n * Resolve the bare GitHub repository URL for a project by reading its\n * `origin` remote.\n *\n * @param projectPath - Absolute path to the project root.\n * @returns A URL like \"https://github.com/Owner/Repo\" or null when the remote\n * isn't a GitHub URL or can't be read.\n */\nexport async function resolveRepoUrl(\n  projectPath: string,\n): 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]}`;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Resolve the GitHub blob base URL used for per-line source links.\n *\n * Prefers the documented commit SHA when one is available so the links point\n * at the exact revision the docs were generated from; falls back to the\n * default branch otherwise.\n *\n * @param projectPath - Absolute path to the project root.\n * @param commitSha - Optional commit SHA to use as the ref. When null, the\n * default branch is used instead.\n * @returns A base URL like \"https://github.com/Owner/Repo/blob/<ref>/\" or null.\n */\nasync function resolveRepoBaseUrl(\n  projectPath: string,\n  commitSha: string | null,\n): Promise<string | null> {\n  const repoUrl = await resolveRepoUrl(projectPath);\n  if (!repoUrl) {\n    return null;\n  }\n  const ref = commitSha ?? (await resolveDefaultBranch(projectPath));\n  return `${repoUrl}/blob/${ref}/`;\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   * Short label identifying the project the docs were generated from (e.g.\n   * \"Core\", \"Extension\"). Stamped in the index page title.\n   */\n  projectLabel?: string | null;\n  /**\n   * Git commit SHA the docs were generated from. Stamped in the index page\n   * intro so engineers know how current the site is.\n   */\n  commitSha?: string | null;\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 * The set of directories available to scan for messenger types, resolved from\n * the project's filesystem layout.\n */\ntype ScanSources = {\n  /** User-configured scan dirs that exist on disk (relative to projectPath). */\n  scanDirs: string[];\n  /** Absolute path to `packages/` if it exists, otherwise null. */\n  packagesDir: string | null;\n  /** Absolute path to `node_modules/@metamask/` if it exists, otherwise null. */\n  nodeModulesDir: string | null;\n};\n\n/**\n * Discover which configured source locations actually exist on disk.\n *\n * @param projectPath - The project root path.\n * @param scanDirs - User-configured scan directories relative to projectPath.\n * @returns A ScanSources object describing the locations to scan.\n */\nasync function discoverScanSources(\n  projectPath: string,\n  scanDirs: string[],\n): Promise<ScanSources> {\n  const existingScanDirs: string[] = [];\n  for (const dir of scanDirs) {\n    if (await directoryExists(path.join(projectPath, dir))) {\n      existingScanDirs.push(dir);\n    }\n  }\n\n  const packagesDir = path.join(projectPath, 'packages');\n  const nodeModulesDir = path.join(projectPath, 'node_modules', '@metamask');\n\n  return {\n    scanDirs: existingScanDirs,\n    packagesDir: (await directoryExists(packagesDir)) ? packagesDir : null,\n    nodeModulesDir: (await directoryExists(nodeModulesDir))\n      ? nodeModulesDir\n      : null,\n  };\n}\n\n/**\n * Log a human-readable description of which source locations will be scanned.\n *\n * @param sources - The resolved scan sources.\n */\nfunction logScanPlan(sources: ScanSources): void {\n  const summary: string[] = [];\n  for (const dir of sources.scanDirs) {\n    summary.push(`${dir}/ (.ts)`);\n  }\n  if (sources.packagesDir) {\n    summary.push('packages/*/src (.ts)');\n  }\n  if (sources.nodeModulesDir) {\n    summary.push('node_modules/@metamask/*/dist (.d.cts)');\n  }\n  console.log(\n    `Scanning ${summary.join(', ')} for Messenger action/event types...`,\n  );\n}\n\n/**\n * Run extraction against every file in a single directory, logging and\n * swallowing per-file failures. All files are added to the shared `project`\n * up front so the type checker can resolve cross-file references when the\n * walker descends into imported types.\n *\n * @param project - The shared ts-morph project.\n * @param directory - The directory to scan.\n * @param projectPath - The project root, used for relative path display.\n * @param findFiles - The function used to enumerate files in the directory.\n * @returns The list of extracted messenger items.\n */\nasync function extractFromDirectory(\n  project: Project,\n  directory: string,\n  projectPath: string,\n  findFiles: (dir: string) => Promise<string[]>,\n): Promise<MessengerCapabilityPacket[]> {\n  const items: MessengerCapabilityPacket[] = [];\n  const files = await findFiles(directory);\n  for (const file of files) {\n    try {\n      const sourceFile =\n        project.getSourceFile(file) ?? project.addSourceFileAtPath(file);\n      items.push(...extractFromSourceFile(sourceFile, projectPath));\n    } catch (error) {\n      console.warn(\n        `Warning: failed to parse ${path.relative(projectPath, file)}`,\n      );\n      console.warn(error);\n    }\n  }\n  return items;\n}\n\n/**\n * Enumerate the subdirectories of a parent directory that match the expected\n * layout (e.g., `packages/*‍/src` or `node_modules/@metamask/*‍/dist`), keeping\n * only those that actually exist.\n *\n * @param parentDir - The parent directory to enumerate.\n * @param subPath - The trailing path component appended to each entry.\n * @param includeSymlinks - Whether to include symbolic links (true for\n * node_modules where workspaces are symlinked).\n * @returns The list of absolute paths to existing target subdirectories.\n */\nasync function listTargetSubdirectories(\n  parentDir: string,\n  subPath: string,\n  includeSymlinks: boolean,\n): Promise<string[]> {\n  const entries = await fs.readdir(parentDir, { withFileTypes: true });\n  const candidates = entries\n    .filter(\n      (entry) =>\n        entry.isDirectory() || (includeSymlinks && entry.isSymbolicLink()),\n    )\n    .map((entry) => path.join(parentDir, entry.name, subPath));\n\n  const existing: string[] = [];\n  for (const candidate of candidates) {\n    if (await directoryExists(candidate)) {\n      existing.push(candidate);\n    }\n  }\n  return existing;\n}\n\n/**\n * Scan every source location described by `sources` and return all extracted\n * messenger items. A single ts-morph Project is shared across every file so\n * the type checker can resolve cross-file references (e.g. a `*Messenger`\n * declaration in one file walking through an imported umbrella union into\n * an auto-generated `*-method-action-types.ts` sibling).\n *\n * @param projectPath - The project root path.\n * @param sources - The set of source locations to scan.\n * @returns A flat list of all extracted messenger items.\n */\nasync function scanSources(\n  projectPath: string,\n  sources: ScanSources,\n): Promise<MessengerCapabilityPacket[]> {\n  const project = createExtractionProject();\n  const allItems: MessengerCapabilityPacket[] = [];\n\n  for (const dir of sources.scanDirs) {\n    allItems.push(\n      ...(await extractFromDirectory(\n        project,\n        path.join(projectPath, dir),\n        projectPath,\n        findTsFiles,\n      )),\n    );\n  }\n\n  if (sources.packagesDir) {\n    const srcDirs = await listTargetSubdirectories(\n      sources.packagesDir,\n      'src',\n      false,\n    );\n    for (const srcDir of srcDirs) {\n      allItems.push(\n        ...(await extractFromDirectory(\n          project,\n          srcDir,\n          projectPath,\n          findTsFiles,\n        )),\n      );\n    }\n  }\n\n  if (sources.nodeModulesDir) {\n    const distDirs = await listTargetSubdirectories(\n      sources.nodeModulesDir,\n      'dist',\n      true,\n    );\n    for (const distDir of distDirs) {\n      allItems.push(\n        ...(await extractFromDirectory(\n          project,\n          distDir,\n          projectPath,\n          findDtsFiles,\n        )),\n      );\n    }\n  }\n\n  return allItems;\n}\n\n/**\n * Replace a previously-seen item in its existing namespace group with a\n * higher-scoring duplicate. Handles the case where the duplicate is a\n * different kind (action vs event) by moving it between lists.\n *\n * @param byNamespace - Map of namespace to its group.\n * @param previous - The previously stored item.\n * @param replacement - The new item to replace it with.\n */\nfunction replaceDuplicateInGroup(\n  byNamespace: Map<string, NamespaceGroup>,\n  previous: MessengerCapabilityPacket,\n  replacement: MessengerCapabilityPacket,\n): void {\n  const namespace = replacement.typeString.split(':')[0];\n  const group = byNamespace.get(namespace);\n  // istanbul ignore next: `previous` and `replacement` have the same\n  // typeString, so they share a namespace, and we always insert the\n  // namespace into `byNamespace` before recording the original entry.\n  if (!group) {\n    return;\n  }\n  const previousList =\n    previous.kind === 'action' ? group.actions : group.events;\n  const index = previousList.indexOf(previous);\n  // istanbul ignore next: `previous` was added to its kind's list by\n  // `groupByNamespace` before being recorded in `seen`, so it is always\n  // present when we look it up here.\n  if (index === -1) {\n    return;\n  }\n  if (previous.kind === replacement.kind) {\n    previousList[index] = replacement;\n  } else {\n    previousList.splice(index, 1);\n    const newList =\n      replacement.kind === 'action' ? group.actions : group.events;\n    newList.push(replacement);\n  }\n}\n\n/**\n * Group items by namespace, deduplicating duplicate typeStrings using\n * `deduplicationScore`. Returns groups sorted alphabetically by namespace,\n * with each group's items sorted alphabetically by typeString.\n *\n * @param items - The full list of extracted items.\n * @returns The deduplicated and sorted namespace groups.\n */\nfunction groupByNamespace(\n  items: MessengerCapabilityPacket[],\n): NamespaceGroup[] {\n  const byNamespace = new Map<string, NamespaceGroup>();\n  const seen = new Map<string, MessengerCapabilityPacket>();\n\n  for (const item of items) {\n    const existing = seen.get(item.typeString);\n    if (existing) {\n      if (deduplicationScore(item) <= deduplicationScore(existing)) {\n        continue;\n      }\n      replaceDuplicateInGroup(byNamespace, existing, item);\n      seen.set(item.typeString, item);\n      continue;\n    }\n\n    seen.set(item.typeString, item);\n    const namespace = item.typeString.split(':')[0];\n    let group = byNamespace.get(namespace);\n    if (!group) {\n      group = { namespace, actions: [], events: [] };\n      byNamespace.set(namespace, group);\n    }\n    if (item.kind === 'action') {\n      group.actions.push(item);\n    } else {\n      group.events.push(item);\n    }\n  }\n\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  return namespaces;\n}\n\n/**\n * Write generated docs (namespace pages, index page, sidebars) to disk,\n * replacing any existing `docs/` directory.\n *\n * @param namespaces - The grouped namespaces to render.\n * @param outputDir - The root output directory.\n * @param repoBaseUrl - GitHub blob base URL for source links, or null.\n * @param indexOptions - Options stamped on the index page header.\n * @param indexOptions.projectLabel - Short label identifying the project.\n * @param indexOptions.commitSha - Git commit SHA the docs were generated from.\n * @returns Promise that resolves once all files are written.\n */\nasync function writeOutput(\n  namespaces: NamespaceGroup[],\n  outputDir: string,\n  repoBaseUrl: string | null,\n  indexOptions: {\n    projectLabel?: string | null;\n    commitSha?: string | null;\n  },\n): Promise<void> {\n  const docsDir = path.join(outputDir, 'docs');\n\n  if (await directoryExists(docsDir)) {\n    await fs.rm(docsDir, { recursive: true });\n  }\n  await fs.mkdir(docsDir, { recursive: true });\n\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  await fs.writeFile(\n    path.join(docsDir, 'index.md'),\n    generateIndexPage(namespaces, indexOptions),\n  );\n\n  await fs.writeFile(\n    path.join(outputDir, 'sidebars.ts'),\n    generateSidebars(namespaces),\n  );\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, projectLabel, commitSha } = options;\n\n  const sources = await discoverScanSources(projectPath, scanDirs);\n\n  if (\n    sources.scanDirs.length === 0 &&\n    !sources.packagesDir &&\n    !sources.nodeModulesDir\n  ) {\n    throw new Error(\n      `No scannable directories found in ${projectPath}. ` +\n        `Looked for: ${scanDirs.join(', ')}, packages/, node_modules/@metamask/`,\n    );\n  }\n\n  logScanPlan(sources);\n\n  const allItems = await scanSources(projectPath, sources);\n  console.log(\n    `Found ${allItems.length} messenger ${allItems.length === 1 ? 'item' : 'items'} total.`,\n  );\n\n  const namespaces = groupByNamespace(allItems);\n  const repoBaseUrl = await resolveRepoBaseUrl(projectPath, commitSha ?? null);\n\n  await writeOutput(namespaces, outputDir, repoBaseUrl, {\n    projectLabel,\n    commitSha,\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(\n    `Generated docs for ${namespaces.length} ${namespaces.length === 1 ? 'namespace' : 'namespaces'}.`,\n  );\n  console.log(`  Actions: ${totalActions}`);\n  console.log(`  Events: ${totalEvents}`);\n  console.log(`Output: ${path.join(outputDir, 'docs')}/`);\n\n  return {\n    namespaces: namespaces.length,\n    actions: totalActions,\n    events: totalEvents,\n  };\n}\n"]}

package/dist/markdown.cjs

@@ -0,0 +1,239 @@
+"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 matches exactly in known names values
+        for (const [, href] of knownNames) {
+            if (href.endsWith(`#${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('');
+    }
+    // For sources scanned out of an @metamask/*/dist directory we render an
+    // npm link, since the original .ts paths are not part of the repo we're
+    // documenting. Other `node_modules/` paths fall through to the normal
+    // source-link branches.
+    const metamaskPkgMatch = item.sourceFile.match(/node_modules\/(@metamask\/[^/]+)/u);
+    if (metamaskPkgMatch) {
+        const pkgName = metamaskPkgMatch[1];
+        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('');
+    }
+    // Only actions get a parameters table — events carry a positional tuple
+    // payload, not named arguments, so a `@param` table doesn't fit.
+    if (item.kind === 'action' && item.params.length > 0) {
+        parts.push('**Parameters**:');
+        parts.push('');
+        parts.push('| Name | Description |');
+        parts.push('|------|-------------|');
+        for (const param of item.params) {
+            const description = linkifyReferences(param.description, namespace, knownNames);
+            parts.push(`| \`${param.name}\` | ${description} |`);
+        }
+        parts.push('');
+    }
+    if (item.kind === 'action' && item.returns) {
+        parts.push(`**Returns**: ${linkifyReferences(item.returns, namespace, knownNames)}`);
+        parts.push('');
+    }
+    const signatureLabel = item.kind === 'action' ? 'Handler' : 'Payload';
+    parts.push(`**${signatureLabel} signature**:`);
+    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.
+ * @param options - Optional project label and commit SHA to stamp in the header.
+ * @returns The generated markdown string.
+ */
+function generateIndexPage(namespaces, options = {}) {
+    const totalActions = namespaces.reduce((sum, ns) => sum + ns.actions.length, 0);
+    const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);
+    const projectSuffix = options.projectLabel
+        ? ` (${options.projectLabel})`
+        : '';
+    const parts = [];
+    parts.push('---');
+    parts.push(`title: "Platform API${projectSuffix} Reference"`);
+    parts.push('slug: "/"');
+    parts.push('---');
+    parts.push('');
+    parts.push(`# Platform API${projectSuffix}`);
+    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('');
+    if (options.commitSha) {
+        parts.push(`Generated from commit \`${options.commitSha}\`.`);
+        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/platform-api-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/markdown.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.cjs","sourceRoot":"","sources":["../src/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,IAAI,MAAM,EAAE,CAAC,EAAE,CAAC;gBAChC,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,IAA+B,EAC/B,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,wEAAwE;IACxE,wEAAwE;IACxE,sEAAsE;IACtE,wBAAwB;IACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAC5C,mCAAmC,CACpC,CAAC;IACF,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACpC,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,wEAAwE;IACxE,iEAAiE;IACjE,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACrC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,iBAAiB,CACnC,KAAK,CAAC,WAAW,EACjB,SAAS,EACT,UAAU,CACX,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,QAAQ,WAAW,IAAI,CAAC,CAAC;QACvD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,KAAK,CAAC,IAAI,CACR,gBAAgB,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,EAAE,CACzE,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,KAAK,CAAC,IAAI,CAAC,KAAK,cAAc,eAAe,CAAC,CAAC;IAC/C,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;AA1ED,oDA0EC;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;AAmBD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,UAA4B,EAC5B,UAA4B,EAAE;IAE9B,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;IAC9E,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY;QACxC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,GAAG;QAC9B,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,uBAAuB,aAAa,aAAa,CAAC,CAAC;IAC9D,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,aAAa,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CACR,iIAAiI,CAClI,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,SAAS,KAAK,CAAC,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,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;AAlDD,8CAkDC;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,6GAA6G,IAAI,CAAC,SAAS,CAChI,OAAO,EACP,IAAI,EACJ,CAAC,CACF,+BAA+B,CAAC;AACnC,CAAC;AA1BD,4CA0BC","sourcesContent":["import type { MessengerCapabilityPacket, NamespaceGroup } from './types.js';\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 matches exactly in known names values\n    for (const [, href] of knownNames) {\n      if (href.endsWith(`#${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: MessengerCapabilityPacket,\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  // For sources scanned out of an @metamask/*/dist directory we render an\n  // npm link, since the original .ts paths are not part of the repo we're\n  // documenting. Other `node_modules/` paths fall through to the normal\n  // source-link branches.\n  const metamaskPkgMatch = item.sourceFile.match(\n    /node_modules\\/(@metamask\\/[^/]+)/u,\n  );\n  if (metamaskPkgMatch) {\n    const pkgName = metamaskPkgMatch[1];\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  // Only actions get a parameters table — events carry a positional tuple\n  // payload, not named arguments, so a `@param` table doesn't fit.\n  if (item.kind === 'action' && item.params.length > 0) {\n    parts.push('**Parameters**:');\n    parts.push('');\n    parts.push('| Name | Description |');\n    parts.push('|------|-------------|');\n    for (const param of item.params) {\n      const description = linkifyReferences(\n        param.description,\n        namespace,\n        knownNames,\n      );\n      parts.push(`| \\`${param.name}\\` | ${description} |`);\n    }\n    parts.push('');\n  }\n\n  if (item.kind === 'action' && item.returns) {\n    parts.push(\n      `**Returns**: ${linkifyReferences(item.returns, namespace, knownNames)}`,\n    );\n    parts.push('');\n  }\n\n  const signatureLabel = item.kind === 'action' ? 'Handler' : 'Payload';\n  parts.push(`**${signatureLabel} signature**:`);\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 * Options controlling how {@link generateIndexPage} renders the index header.\n */\nexport type IndexPageOptions = {\n  /**\n   * Short label identifying the project the docs were generated from (e.g.\n   * \"Core\", \"Extension\"). When provided, the title is rendered as\n   * `Platform API (Core)`.\n   */\n  projectLabel?: string | null;\n  /**\n   * Git commit SHA the docs were generated from. When provided, it's shown\n   * in the intro so engineers know how current the site is.\n   */\n  commitSha?: string | null;\n};\n\n/**\n * Generate the index/overview page listing all namespaces.\n *\n * @param namespaces - All namespace groups sorted alphabetically.\n * @param options - Optional project label and commit SHA to stamp in the header.\n * @returns The generated markdown string.\n */\nexport function generateIndexPage(\n  namespaces: NamespaceGroup[],\n  options: IndexPageOptions = {},\n): 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  const projectSuffix = options.projectLabel\n    ? ` (${options.projectLabel})`\n    : '';\n\n  const parts: string[] = [];\n  parts.push('---');\n  parts.push(`title: \"Platform API${projectSuffix} Reference\"`);\n  parts.push('slug: \"/\"');\n  parts.push('---');\n  parts.push('');\n  parts.push(`# Platform API${projectSuffix}`);\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  if (options.commitSha) {\n    parts.push(`Generated from commit \\`${options.commitSha}\\`.`);\n    parts.push('');\n  }\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/platform-api-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/{markdown.d.ts → markdown.d.cts}

@@ -1,4 +1,4 @@
-import type { MessengerCapabilityPacket, NamespaceGroup } from './types.js';
+import type { MessengerCapabilityPacket, NamespaceGroup } from "./types.cjs";
 /**
  * Generate markdown documentation for a single messenger item.
  *
@@ -49,4 +49,4 @@ export declare function generateIndexPage(namespaces: NamespaceGroup[], options?
  * @returns The generated TypeScript source string.
  */
 export declare function generateSidebars(namespaces: NamespaceGroup[]): string;
-//# sourceMappingURL=markdown.d.ts.map
+//# sourceMappingURL=markdown.d.cts.map

package/dist/markdown.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.cts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,oBAAmB;AAuC5E;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,yBAAyB,EAC/B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,GACzB,MAAM,CAqER;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;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,cAAc,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,MAAM,CA+CR;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CA0BrE"}

package/dist/markdown.d.mts

@@ -0,0 +1,52 @@
+import type { MessengerCapabilityPacket, 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: MessengerCapabilityPacket, 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;
+/**
+ * Options controlling how {@link generateIndexPage} renders the index header.
+ */
+export type IndexPageOptions = {
+    /**
+     * Short label identifying the project the docs were generated from (e.g.
+     * "Core", "Extension"). When provided, the title is rendered as
+     * `Platform API (Core)`.
+     */
+    projectLabel?: string | null;
+    /**
+     * Git commit SHA the docs were generated from. When provided, it's shown
+     * in the intro so engineers know how current the site is.
+     */
+    commitSha?: string | null;
+};
+/**
+ * Generate the index/overview page listing all namespaces.
+ *
+ * @param namespaces - All namespace groups sorted alphabetically.
+ * @param options - Optional project label and commit SHA to stamp in the header.
+ * @returns The generated markdown string.
+ */
+export declare function generateIndexPage(namespaces: NamespaceGroup[], options?: IndexPageOptions): 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/markdown.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.mts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,oBAAmB;AAuC5E;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,yBAAyB,EAC/B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,GACzB,MAAM,CAqER;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;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,cAAc,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,MAAM,CA+CR;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CA0BrE"}

package/dist/{markdown.js → markdown.mjs}

@@ -229,4 +229,4 @@ export function generateSidebars(namespaces) {
     };
     return `// This file is auto-generated by @metamask/platform-api-docs\n// Do not edit manually.\nconst sidebars = ${JSON.stringify(sidebar, null, 2)};\nexport default sidebars;\n`;
 }
-//# sourceMappingURL=markdown.js.map
+//# sourceMappingURL=markdown.mjs.map

package/dist/markdown.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.mjs","sourceRoot":"","sources":["../src/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,IAAI,MAAM,EAAE,CAAC,EAAE,CAAC;gBAChC,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,IAA+B,EAC/B,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,wEAAwE;IACxE,wEAAwE;IACxE,sEAAsE;IACtE,wBAAwB;IACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAC5C,mCAAmC,CACpC,CAAC;IACF,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACpC,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,wEAAwE;IACxE,iEAAiE;IACjE,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACrC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,iBAAiB,CACnC,KAAK,CAAC,WAAW,EACjB,SAAS,EACT,UAAU,CACX,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,QAAQ,WAAW,IAAI,CAAC,CAAC;QACvD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,KAAK,CAAC,IAAI,CACR,gBAAgB,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,EAAE,CACzE,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,KAAK,CAAC,IAAI,CAAC,KAAK,cAAc,eAAe,CAAC,CAAC;IAC/C,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;AAmBD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,UAA4B,EAC5B,UAA4B,EAAE;IAE9B,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;IAC9E,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY;QACxC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,GAAG;QAC9B,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,uBAAuB,aAAa,aAAa,CAAC,CAAC;IAC9D,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,aAAa,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CACR,iIAAiI,CAClI,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,SAAS,KAAK,CAAC,CAAC;QAC9D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,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,6GAA6G,IAAI,CAAC,SAAS,CAChI,OAAO,EACP,IAAI,EACJ,CAAC,CACF,+BAA+B,CAAC;AACnC,CAAC","sourcesContent":["import type { MessengerCapabilityPacket, NamespaceGroup } from './types.js';\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 matches exactly in known names values\n    for (const [, href] of knownNames) {\n      if (href.endsWith(`#${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: MessengerCapabilityPacket,\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  // For sources scanned out of an @metamask/*/dist directory we render an\n  // npm link, since the original .ts paths are not part of the repo we're\n  // documenting. Other `node_modules/` paths fall through to the normal\n  // source-link branches.\n  const metamaskPkgMatch = item.sourceFile.match(\n    /node_modules\\/(@metamask\\/[^/]+)/u,\n  );\n  if (metamaskPkgMatch) {\n    const pkgName = metamaskPkgMatch[1];\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  // Only actions get a parameters table — events carry a positional tuple\n  // payload, not named arguments, so a `@param` table doesn't fit.\n  if (item.kind === 'action' && item.params.length > 0) {\n    parts.push('**Parameters**:');\n    parts.push('');\n    parts.push('| Name | Description |');\n    parts.push('|------|-------------|');\n    for (const param of item.params) {\n      const description = linkifyReferences(\n        param.description,\n        namespace,\n        knownNames,\n      );\n      parts.push(`| \\`${param.name}\\` | ${description} |`);\n    }\n    parts.push('');\n  }\n\n  if (item.kind === 'action' && item.returns) {\n    parts.push(\n      `**Returns**: ${linkifyReferences(item.returns, namespace, knownNames)}`,\n    );\n    parts.push('');\n  }\n\n  const signatureLabel = item.kind === 'action' ? 'Handler' : 'Payload';\n  parts.push(`**${signatureLabel} signature**:`);\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 * Options controlling how {@link generateIndexPage} renders the index header.\n */\nexport type IndexPageOptions = {\n  /**\n   * Short label identifying the project the docs were generated from (e.g.\n   * \"Core\", \"Extension\"). When provided, the title is rendered as\n   * `Platform API (Core)`.\n   */\n  projectLabel?: string | null;\n  /**\n   * Git commit SHA the docs were generated from. When provided, it's shown\n   * in the intro so engineers know how current the site is.\n   */\n  commitSha?: string | null;\n};\n\n/**\n * Generate the index/overview page listing all namespaces.\n *\n * @param namespaces - All namespace groups sorted alphabetically.\n * @param options - Optional project label and commit SHA to stamp in the header.\n * @returns The generated markdown string.\n */\nexport function generateIndexPage(\n  namespaces: NamespaceGroup[],\n  options: IndexPageOptions = {},\n): 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  const projectSuffix = options.projectLabel\n    ? ` (${options.projectLabel})`\n    : '';\n\n  const parts: string[] = [];\n  parts.push('---');\n  parts.push(`title: \"Platform API${projectSuffix} Reference\"`);\n  parts.push('slug: \"/\"');\n  parts.push('---');\n  parts.push('');\n  parts.push(`# Platform API${projectSuffix}`);\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  if (options.commitSha) {\n    parts.push(`Generated from commit \\`${options.commitSha}\\`.`);\n    parts.push('');\n  }\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/platform-api-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/types.cjs

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

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A documented parameter for an action handler or event payload — name from\n * the JSDoc `@param` tag, description from the tag's comment body.\n */\nexport type DocumentedParameter = {\n  name: string;\n  description: string;\n};\n\n/**\n * Information about a messenger action or event extracted from its type\n * in a source file.\n */\nexport type MessengerCapabilityPacket = {\n  /** The capability type's TypeScript identifier, e.g. `NetworkControllerGetStateAction`. */\n  typeName: string;\n  /** The capability's messenger key, e.g. `NetworkController:getState`. */\n  typeString: string;\n  /** Whether the capability is an action (request/response) or an event (broadcast). */\n  kind: 'action' | 'event';\n  /** Cleaned description body — content above the first JSDoc tag. */\n  jsDoc: string;\n  /**\n   * Documented parameters — populated from `@param` tags, in source order.\n   * For actions these describe the handler's arguments; for events they\n   * describe the payload tuple's positional elements.\n   */\n  params: DocumentedParameter[];\n  /** Documented return value — populated from a `@returns` tag, if any. */\n  returns: string;\n  /** Raw type text of the handler (action) or payload (event). */\n  handlerOrPayload: string;\n  /** Path to the file the capability was declared in, relative to the project root. */\n  sourceFile: string;\n  /** 1-based line number of the capability declaration. */\n  line: number;\n  /** Whether the capability is marked `@deprecated`. */\n  deprecated: boolean;\n};\n\n/**\n * A namespace's actions and events, after dedup and sorting.\n */\nexport type NamespaceGroup = {\n  namespace: string;\n  actions: MessengerCapabilityPacket[];\n  events: MessengerCapabilityPacket[];\n};\n"]}

package/dist/{types.d.ts → types.d.cts}

@@ -44,4 +44,4 @@ export type NamespaceGroup = {
     actions: MessengerCapabilityPacket[];
     events: MessengerCapabilityPacket[];
 };
-//# sourceMappingURL=types.d.ts.map
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,2FAA2F;IAC3F,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,UAAU,EAAE,MAAM,CAAC;IACnB,sFAAsF;IACtF,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,gBAAgB,EAAE,MAAM,CAAC;IACzB,qFAAqF;IACrF,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACrC,CAAC"}