@metamask-previews/platform-api-docs 0.0.0-preview-1275d0fda

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,IAAsC,EACtC,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 { ExtractedMessengerCapabilityType, 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 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: ExtractedMessengerCapabilityType,\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.cts

@@ -0,0 +1,52 @@
+import type { ExtractedMessengerCapabilityType, NamespaceGroup } from "./types.cjs";
+/**
+ * Generate markdown documentation for a single messenger item.
+ *
+ * @param item - The messenger item to document.
+ * @param namespace - The current namespace.
+ * @param knownNames - Map from short/full names to their link paths.
+ * @param repoBaseUrl - Optional GitHub blob base URL (e.g. "https://github.com/Owner/Repo/blob/sha/").
+ * @returns The generated markdown string.
+ */
+export declare function generateItemMarkdown(item: ExtractedMessengerCapabilityType, 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.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,gCAAgC,EAAE,cAAc,EAAE,oBAAgB;AAuChF;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gCAAgC,EACtC,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 { ExtractedMessengerCapabilityType, 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: ExtractedMessengerCapabilityType, 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,gCAAgC,EAAE,cAAc,EAAE,oBAAgB;AAuChF;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gCAAgC,EACtC,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.mjs

@@ -0,0 +1,232 @@
+/**
+ * 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.
+ */
+export 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');
+}
+/**
+ * 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.
+ * @param options - Optional project label and commit SHA to stamp in the header.
+ * @returns The generated markdown string.
+ */
+export 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');
+}
+/**
+ * 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/platform-api-docs\n// Do not edit manually.\nconst sidebars = ${JSON.stringify(sidebar, null, 2)};\nexport default sidebars;\n`;
+}
+//# 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,IAAsC,EACtC,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 { ExtractedMessengerCapabilityType, 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 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: ExtractedMessengerCapabilityType,\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 * One messenger capability — an action or event registered with the platform\n * — distilled from its TypeScript definition.\n */\nexport type ExtractedMessengerCapabilityType = {\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: ExtractedMessengerCapabilityType[];\n  events: ExtractedMessengerCapabilityType[];\n};\n\n/**\n * Info about a class method, used to resolve `ClassName['methodName']`\n * handlers — captures both the textual signature and the documented\n * parameters / return so the capability inherits the method's JSDoc when\n * the type alias itself has none.\n */\nexport type MethodInfo = {\n  /** Cleaned description body — content above the first JSDoc tag. */\n  jsDoc: string;\n  /** Documented parameters from the method's `@param` tags. */\n  params: DocumentedParameter[];\n  /** Documented return value from the method's `@returns` tag, if any. */\n  returns: string;\n  /** Method signature in TypeScript syntax, e.g. `(fields: AddNetworkFields) => NetworkConfiguration`. */\n  signature: string;\n};\n"]}

package/dist/types.d.cts

@@ -0,0 +1,63 @@
+/**
+ * A documented parameter for an action handler or event payload — name from
+ * the JSDoc `@param` tag, description from the tag's comment body.
+ */
+export type DocumentedParameter = {
+    name: string;
+    description: string;
+};
+/**
+ * One messenger capability — an action or event registered with the platform
+ * — distilled from its TypeScript definition.
+ */
+export type ExtractedMessengerCapabilityType = {
+    /** The capability type's TypeScript identifier, e.g. `NetworkControllerGetStateAction`. */
+    typeName: string;
+    /** The capability's messenger key, e.g. `NetworkController:getState`. */
+    typeString: string;
+    /** Whether the capability is an action (request/response) or an event (broadcast). */
+    kind: 'action' | 'event';
+    /** Cleaned description body — content above the first JSDoc tag. */
+    jsDoc: string;
+    /**
+     * Documented parameters — populated from `@param` tags, in source order.
+     * For actions these describe the handler's arguments; for events they
+     * describe the payload tuple's positional elements.
+     */
+    params: DocumentedParameter[];
+    /** Documented return value — populated from a `@returns` tag, if any. */
+    returns: string;
+    /** Raw type text of the handler (action) or payload (event). */
+    handlerOrPayload: string;
+    /** Path to the file the capability was declared in, relative to the project root. */
+    sourceFile: string;
+    /** 1-based line number of the capability declaration. */
+    line: number;
+    /** Whether the capability is marked `@deprecated`. */
+    deprecated: boolean;
+};
+/**
+ * A namespace's actions and events, after dedup and sorting.
+ */
+export type NamespaceGroup = {
+    namespace: string;
+    actions: ExtractedMessengerCapabilityType[];
+    events: ExtractedMessengerCapabilityType[];
+};
+/**
+ * Info about a class method, used to resolve `ClassName['methodName']`
+ * handlers — captures both the textual signature and the documented
+ * parameters / return so the capability inherits the method's JSDoc when
+ * the type alias itself has none.
+ */
+export type MethodInfo = {
+    /** Cleaned description body — content above the first JSDoc tag. */
+    jsDoc: string;
+    /** Documented parameters from the method's `@param` tags. */
+    params: DocumentedParameter[];
+    /** Documented return value from the method's `@returns` tag, if any. */
+    returns: string;
+    /** Method signature in TypeScript syntax, e.g. `(fields: AddNetworkFields) => NetworkConfiguration`. */
+    signature: string;
+};
+//# 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,gCAAgC,GAAG;IAC7C,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,gCAAgC,EAAE,CAAC;IAC5C,MAAM,EAAE,gCAAgC,EAAE,CAAC;CAC5C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,wGAAwG;IACxG,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,63 @@
+/**
+ * A documented parameter for an action handler or event payload — name from
+ * the JSDoc `@param` tag, description from the tag's comment body.
+ */
+export type DocumentedParameter = {
+    name: string;
+    description: string;
+};
+/**
+ * One messenger capability — an action or event registered with the platform
+ * — distilled from its TypeScript definition.
+ */
+export type ExtractedMessengerCapabilityType = {
+    /** The capability type's TypeScript identifier, e.g. `NetworkControllerGetStateAction`. */
+    typeName: string;
+    /** The capability's messenger key, e.g. `NetworkController:getState`. */
+    typeString: string;
+    /** Whether the capability is an action (request/response) or an event (broadcast). */
+    kind: 'action' | 'event';
+    /** Cleaned description body — content above the first JSDoc tag. */
+    jsDoc: string;
+    /**
+     * Documented parameters — populated from `@param` tags, in source order.
+     * For actions these describe the handler's arguments; for events they
+     * describe the payload tuple's positional elements.
+     */
+    params: DocumentedParameter[];
+    /** Documented return value — populated from a `@returns` tag, if any. */
+    returns: string;
+    /** Raw type text of the handler (action) or payload (event). */
+    handlerOrPayload: string;
+    /** Path to the file the capability was declared in, relative to the project root. */
+    sourceFile: string;
+    /** 1-based line number of the capability declaration. */
+    line: number;
+    /** Whether the capability is marked `@deprecated`. */
+    deprecated: boolean;
+};
+/**
+ * A namespace's actions and events, after dedup and sorting.
+ */
+export type NamespaceGroup = {
+    namespace: string;
+    actions: ExtractedMessengerCapabilityType[];
+    events: ExtractedMessengerCapabilityType[];
+};
+/**
+ * Info about a class method, used to resolve `ClassName['methodName']`
+ * handlers — captures both the textual signature and the documented
+ * parameters / return so the capability inherits the method's JSDoc when
+ * the type alias itself has none.
+ */
+export type MethodInfo = {
+    /** Cleaned description body — content above the first JSDoc tag. */
+    jsDoc: string;
+    /** Documented parameters from the method's `@param` tags. */
+    params: DocumentedParameter[];
+    /** Documented return value from the method's `@returns` tag, if any. */
+    returns: string;
+    /** Method signature in TypeScript syntax, e.g. `(fields: AddNetworkFields) => NetworkConfiguration`. */
+    signature: string;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","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,gCAAgC,GAAG;IAC7C,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,gCAAgC,EAAE,CAAC;IAC5C,MAAM,EAAE,gCAAgC,EAAE,CAAC;CAC5C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,wGAAwG;IACxG,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/types.mjs

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

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","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 * One messenger capability — an action or event registered with the platform\n * — distilled from its TypeScript definition.\n */\nexport type ExtractedMessengerCapabilityType = {\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: ExtractedMessengerCapabilityType[];\n  events: ExtractedMessengerCapabilityType[];\n};\n\n/**\n * Info about a class method, used to resolve `ClassName['methodName']`\n * handlers — captures both the textual signature and the documented\n * parameters / return so the capability inherits the method's JSDoc when\n * the type alias itself has none.\n */\nexport type MethodInfo = {\n  /** Cleaned description body — content above the first JSDoc tag. */\n  jsDoc: string;\n  /** Documented parameters from the method's `@param` tags. */\n  params: DocumentedParameter[];\n  /** Documented return value from the method's `@returns` tag, if any. */\n  returns: string;\n  /** Method signature in TypeScript syntax, e.g. `(fields: AddNetworkFields) => NetworkConfiguration`. */\n  signature: string;\n};\n"]}