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

package/CHANGELOG.md

@@ -9,6 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012))
+- Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012), [#9913](https://github.com/MetaMask/core/pull/9913))
 
 [Unreleased]: https://github.com/MetaMask/core/

package/README.md

@@ -35,12 +35,45 @@ Options:
   --build                  Generate docs and build static site
   --serve                  Generate docs, build, and serve static site
   --dev                    Generate docs and start dev server with hot reload
-  --scan-dir <dir>         Extra source directory to scan (repeatable)
+  --strategy <name>        How to find actions and events: "scan" (default) or
+                           "root-messenger" (see below)
+  --scan-dir <dir>         Extra source directory to scan (repeatable; --strategy scan only)
+  --root-actions <ref>     Type aliasing the union of every action, as "<file>#<TypeName>"
+                           (required with --strategy root-messenger)
+  --root-events <ref>      Type aliasing the union of every event, as "<file>#<TypeName>"
+                           (required with --strategy root-messenger)
   --output <dir>           Output directory (default: <project-path>/.platform-api-docs)
   --project-label <label>  Short label identifying the project (e.g. "Core", "Extension")
   --help                   Show this help message
 ```
 
+## Strategies
+
+Which strategy to use depends on whether the project has a single messenger carrying every action and event.
+
+### `scan` (default)
+
+Parses every TypeScript source and declaration file it can find — the scan directories, `packages/*/src`, and `node_modules/@metamask/*/dist` — and reads every `*Messenger` type alias it encounters.
+
+Use this when no single messenger aggregates every capability, as in a monorepo of independently published packages.
+
+### `root-messenger`
+
+Resolves the two types the project declares for its root messenger capabilities — the collection of every action and the collection of every event — and lets the TypeScript type checker walk them. Only the files named on the command line are opened.
+
+Use this when the project has one root messenger carrying every action and event, as a client application built on these packages does. It is substantially faster than `scan`, because it reads what the project already declares instead of re-deriving it, and it documents only what is reachable through that messenger.
+
+```
+platform-api-docs \
+  --strategy root-messenger \
+  --root-actions 'src/messenger.ts#RootActions' \
+  --root-events 'src/messenger.ts#RootEvents'
+```
+
+Each reference names a type alias, written by hand or computed — the type checker resolves either.
+
+The docs contain exactly what the named types contain, so those types should be the ones carrying every capability rather than a narrowed subset. Capability types that can't be documented are reported rather than dropped silently: those declared inline in the capability collection type (with no name or JSDoc to document), and those whose shape can't be read (most often a `type` property that isn't a namespaced string literal).
+
 ## Contributing
 
 This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

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

@@ -1,36 +1,11 @@
 #!/usr/bin/env node
-function $__filename(fileUrl) {
-    const url = new URL(fileUrl);
-    return url.pathname.replace(/^\/([a-zA-Z]:)/u, "$1");
-}
-function $getDirname(path) {
-    const sanitisedPath = path.toString().replace(/\\/gu, "/").replace(/\/$/u, "");
-    const index = sanitisedPath.lastIndexOf("/");
-    if (index === -1) {
-        return path;
-    }
-    if (index === 0) {
-        return "/";
-    }
-    return sanitisedPath.slice(0, index);
-}
-function $__dirname(url) {
-    return $getDirname($__filename(url));
-}
-function $importDefault(module) {
-    if (module?.__esModule) {
-        return module.default;
-    }
-    return module;
-}
-import $execa from "execa/index.js";
-const execa = $importDefault($execa);
-import * as fs from "node:fs/promises";
-import * as path from "node:path";
-import $npmWhich from "npm-which";
-const npmWhich = $importDefault($npmWhich);
-import yargs from "yargs";
-import { generate, resolveRepoUrl } from "./generate.mjs";
+import execa from 'execa';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import npmWhich from 'npm-which';
+import yargs from 'yargs';
+import { generate, resolveRepoUrl } from './generate.js';
+import { parseRootCapabilitiesTypeReference } from './root-messenger-discovery.js';
 /**
  * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using
  * `npm-which` lets the lookup track wherever the installed Docusaurus puts
@@ -39,7 +14,7 @@ import { generate, resolveRepoUrl } from "./generate.mjs";
  * @returns Absolute path to the `docusaurus` executable.
  */
 function resolveDocusaurus() {
-    return npmWhich($__dirname(import.meta.url)).sync('docusaurus');
+    return npmWhich(import.meta.dirname).sync('docusaurus');
 }
 /**
  * Run a Docusaurus command.
@@ -68,15 +43,11 @@ async function runDocusaurus(command, cwd, extraEnv = {}) {
  * @param outDir - The output directory to set up.
  */
 async function setupSite(outDir) {
-    const packageDir = path.resolve($__dirname(import.meta.url), '..');
+    const packageDir = path.resolve(import.meta.dirname, '..');
     const siteDir = path.join(packageDir, 'site');
     const packageNodeModules = path.join(packageDir, 'node_modules');
     const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);
     console.log(`\nSetting up Docusaurus site in ${outDir}...`);
-    // `fs.cp` has been available since Node 16.7 and only got the "stable"
-    // marker in 22.3 — it's functional throughout our supported Node range
-    // (`^18.18 || >=20`), even though the linter flags the older versions.
-    // eslint-disable-next-line n/no-unsupported-features/node-builtins
     await fs.cp(siteDir, outDir, {
         recursive: true,
         filter: (source) => !skip.has(path.basename(source)),
@@ -127,10 +98,45 @@ async function resolveCommitSha(projectPath) {
     }
 }
 /**
- * Main CLI entry point.
+ * Reject flag combinations that don't make sense, so a mistaken invocation
+ * fails instead of silently producing docs built the wrong way.
+ *
+ * Flags belonging to the strategy that wasn't selected are errors rather than
+ * ignored. Used as a yargs `.check`, so failures print alongside usage.
+ *
+ * @param argv - The parsed arguments.
+ * @param argv.strategy - The selected discovery strategy.
+ * @param argv.rootActions - The parsed root actions type reference.
+ * @param argv.rootEvents - The parsed root events type reference.
+ * @param argv.scanDir - The additional directories to scan.
+ * @returns True when the combination is valid.
  */
-async function main() {
-    const argv = await yargs(process.argv.slice(2))
+function checkStrategyArgs({ strategy, rootActions, rootEvents, scanDir = [], }) {
+    if (strategy !== 'root-messenger') {
+        if (rootActions !== undefined || rootEvents !== undefined) {
+            throw new Error('--root-actions and --root-events only apply to --strategy root-messenger.');
+        }
+        return { strategy: 'scan', scanDir };
+    }
+    if (rootActions === undefined || rootEvents === undefined) {
+        throw new Error('--strategy root-messenger requires both --root-actions and --root-events, ' +
+            'each written as "<file>#<TypeName>".');
+    }
+    if (scanDir.length > 0) {
+        throw new Error('--scan-dir only applies to --strategy scan; --strategy root-messenger reads ' +
+            'only the files named by --root-actions and --root-events.');
+    }
+    return { strategy, rootActions, rootEvents };
+}
+/**
+ * Parse and validate CLI arguments.
+ *
+ * @param argumentsForParsing - Arguments to parse, excluding the Node and
+ * script paths.
+ * @returns Parsed arguments, discriminated by discovery strategy.
+ */
+async function parseArguments(argumentsForParsing = process.argv.slice(2)) {
+    const argv = await yargs(argumentsForParsing)
         .command('$0 [project-path]', 'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.', (yargsInstance) => {
         yargsInstance.positional('project-path', {
             type: 'string',
@@ -153,9 +159,25 @@ async function main() {
         description: 'Generate platform API docs and serve a development-only site',
         default: false,
     })
-        .option('scan-dir', {
+        .option('strategy', {
+        type: 'string',
+        description: 'How to find messenger actions and events. "scan" parses every source and declaration file looking for messenger types. "root-messenger" instead resolves the two types the project declares for its root messenger',
+        default: 'scan',
+    })
+        .choices('strategy', ['scan', 'root-messenger'])
+        .option('root-actions', {
+        type: 'string',
+        coerce: parseRootCapabilitiesTypeReference,
+        description: 'Type aliasing the union of every action on the root messenger, written as "<file>#<TypeName>" (required with --strategy root-messenger)',
+    })
+        .option('root-events', {
         type: 'string',
-        array: true,
+        coerce: parseRootCapabilitiesTypeReference,
+        description: 'Type aliasing the union of every event on the root messenger, written as "<file>#<TypeName>" (required with --strategy root-messenger)',
+    })
+        .option('scan-dir', {
+        type: 'array',
+        string: true,
         description: 'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',
         default: [],
     })
@@ -175,25 +197,60 @@ async function main() {
         type: 'string',
         description: 'Path prefix the built site will be served under, e.g. /core/platform-api/',
     })
-        .help().argv;
-    const projectPathArg = argv['project-path'];
-    const resolvedProjectPath = path.resolve(typeof projectPathArg === 'string' ? projectPathArg : '.');
+        .help()
+        .parse();
+    const strategyArguments = checkStrategyArgs(argv);
+    const projectPath = argv['project-path'];
+    if (typeof projectPath !== 'string') {
+        throw new Error('Expected --project-path to be a string.');
+    }
+    return {
+        build: argv.build,
+        serve: argv.serve,
+        dev: argv.dev,
+        'project-path': projectPath,
+        output: argv.output,
+        'project-label': argv['project-label'],
+        'site-url': argv['site-url'],
+        'site-base-url': argv['site-base-url'],
+        ...strategyArguments,
+    };
+}
+/**
+ * Main CLI entry point.
+ */
+async function main() {
+    const argv = await parseArguments();
+    const resolvedProjectPath = path.resolve(argv['project-path']);
     const resolvedOutputDir = path.resolve(argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'));
-    const scanDirs = ['src', ...argv['scan-dir']].filter((dir, index, dirs) => dirs.indexOf(dir) === index);
-    const projectLabel = typeof argv['project-label'] === 'string' &&
-        argv['project-label'].length > 0
+    const projectLabel = argv['project-label'] && argv['project-label'].length > 0
         ? argv['project-label']
         : null;
     const commitSha = await resolveCommitSha(resolvedProjectPath);
     const repoUrl = await resolveRepoUrl(resolvedProjectPath);
     // Step 1: Generate docs
-    await generate({
-        projectPath: resolvedProjectPath,
-        outputDir: resolvedOutputDir,
-        scanDirs,
-        projectLabel,
-        commitSha,
-    });
+    if (argv.strategy === 'root-messenger') {
+        await generate({
+            projectPath: resolvedProjectPath,
+            outputDir: resolvedOutputDir,
+            projectLabel,
+            commitSha,
+            strategy: 'root-messenger',
+            rootActions: argv.rootActions,
+            rootEvents: argv.rootEvents,
+        });
+    }
+    else {
+        const scanDirs = ['src', ...argv.scanDir].filter((dir, index, dirs) => dirs.indexOf(dir) === index);
+        await generate({
+            projectPath: resolvedProjectPath,
+            outputDir: resolvedOutputDir,
+            projectLabel,
+            commitSha,
+            strategy: 'scan',
+            scanDirs,
+        });
+    }
     // Step 2: If --build, --serve, or --dev, set up and run Docusaurus
     if (argv.build || argv.serve || argv.dev) {
         await setupSite(resolvedOutputDir);
@@ -236,4 +293,4 @@ main().catch((error) => {
     console.error(error);
     process.exitCode = 1;
 });
-//# sourceMappingURL=cli.mjs.map
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,EAAE,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AAoDnF;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,QAAQ,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,QAAQ,GAA2B,EAAE;IAErC,MAAM,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC1C,GAAG;QACH,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,SAAS,CAAC,MAAc;IACrC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,GAAG,CAAC,mCAAmC,MAAM,KAAK,CAAC,CAAC;IAE5D,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;QAC3B,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IAEH,sEAAsE;IACtE,4EAA4E;IAC5E,0EAA0E;IAC1E,2EAA2E;IAC3E,uEAAuE;IACvE,2DAA2D;IAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACnD,IAAI,CAAC;QACH,uEAAuE;QACvE,2DAA2D;QAC3D,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,SAAS,CAChB,WAAW,EACX,IAAI,CAAC,SAAS,CACZ,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACtE,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,iBAAiB,CAAC,EACzB,QAAQ,EACR,WAAW,EACX,UAAU,EACV,OAAO,GAAG,EAAE,GAMb;IACC,IAAI,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAClC,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IACvC,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CACb,4EAA4E;YAC1E,sCAAsC,CACzC,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,8EAA8E;YAC5E,2DAA2D,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,cAAc,CAC3B,mBAAmB,GAAa,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAErD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,mBAAmB,CAAC;SAC1C,OAAO,CACN,mBAAmB,EACnB,0HAA0H,EAC1H,CAAC,aAAa,EAAE,EAAE;QAChB,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE;YACvC,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;IACL,CAAC,CACF;SACA,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,SAAS;QACf,WAAW,EACT,8DAA8D;QAChE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,oNAAoN;QACtN,OAAO,EAAE,MAAM;KAChB,CAAC;SACD,OAAO,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAU,CAAC;SACxD,MAAM,CAAC,cAAc,EAAE;QACtB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,kCAAkC;QAC1C,WAAW,EACT,yIAAyI;KAC5I,CAAC;SACD,MAAM,CAAC,aAAa,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,kCAAkC;QAC1C,WAAW,EACT,wIAAwI;KAC3I,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,IAAI;QACZ,WAAW,EACT,4HAA4H;QAC9H,OAAO,EAAE,EAAE;KACZ,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;KAChC,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,yGAAyG;KAC5G,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,kFAAkF;KACrF,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,2EAA2E;KAC9E,CAAC;SACD,IAAI,EAAE;SACN,KAAK,EAAE,CAAC;IAEX,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAElD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,cAAc,EAAE,WAAW;QAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAC5B,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QACtC,GAAG,iBAAiB;KACrB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,MAAM,cAAc,EAAE,CAAC;IAEpC,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAC/D,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CACpC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CACpE,CAAC;IACF,MAAM,YAAY,GAChB,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QACvD,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QACvB,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,IAAI,IAAI,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QACvC,MAAM,QAAQ,CAAC;YACb,WAAW,EAAE,mBAAmB;YAChC,SAAS,EAAE,iBAAiB;YAC5B,YAAY;YACZ,SAAS;YACT,QAAQ,EAAE,gBAAgB;YAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAClD,CAAC;QAEF,MAAM,QAAQ,CAAC;YACb,WAAW,EAAE,mBAAmB;YAChC,SAAS,EAAE,iBAAiB;YAC5B,YAAY;YACZ,SAAS;YACT,QAAQ,EAAE,MAAM;YAChB,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,mEAAmE;IACnE,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEnC,kEAAkE;QAClE,kEAAkE;QAClE,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,IAAI,YAAY,EAAE,CAAC;YACjB,aAAa,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAClD,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,aAAa,CAAC,eAAe,GAAG,SAAS,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC;QACD,IACE,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,QAAQ;YACzC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBACxC,MAAM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport execa from 'execa';\nimport * as fs from 'node:fs/promises';\nimport * as path from 'node:path';\nimport npmWhich from 'npm-which';\nimport yargs from 'yargs';\n\nimport { generate, resolveRepoUrl } from './generate.js';\nimport type { RootCapabilitiesTypeReference } from './root-messenger-discovery.js';\nimport { parseRootCapabilitiesTypeReference } from './root-messenger-discovery.js';\n\n/**\n * Arguments shared by both discovery strategies.\n */\ntype CommonArguments = {\n  /** Whether to build the generated site. */\n  build: boolean;\n  /** Whether to serve the production build. */\n  serve: boolean;\n  /** Whether to serve the development site. */\n  dev: boolean;\n  /** Path to the project being documented. */\n  'project-path': string;\n  /** Directory where generated documentation is written. */\n  output?: string;\n  /** Label displayed in the generated documentation. */\n  'project-label'?: string;\n  /** URL where the generated site is served. */\n  'site-url'?: string;\n  /** Base path where the generated site is served. */\n  'site-base-url'?: string;\n};\n\n/**\n * Arguments for the strategy that scans configured source directories.\n */\ntype ScanStrategyArguments = {\n  /** The selected strategy. */\n  strategy: 'scan';\n  /** Directories, relative to the project root, to scan. */\n  scanDir: string[];\n};\n\n/**\n * Arguments for the strategy that resolves a root messenger's type unions.\n */\ntype RootMessengerStrategyArguments = {\n  /** The selected strategy. */\n  strategy: 'root-messenger';\n  /** The root messenger actions type reference. */\n  rootActions: RootCapabilitiesTypeReference;\n  /** The root messenger events type reference. */\n  rootEvents: RootCapabilitiesTypeReference;\n};\n\n/**\n * Parsed CLI arguments, discriminated by the selected discovery strategy.\n */\ntype ParsedArguments = CommonArguments &\n  (ScanStrategyArguments | RootMessengerStrategyArguments);\n\n/**\n * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using\n * `npm-which` lets the lookup track wherever the installed Docusaurus puts\n * its binary, so a future Docusaurus upgrade can't break this path.\n *\n * @returns Absolute path to the `docusaurus` executable.\n */\nfunction resolveDocusaurus(): string {\n  return npmWhich(import.meta.dirname).sync('docusaurus');\n}\n\n/**\n * Run a Docusaurus command.\n *\n * @param command - The docusaurus command (start, build, serve).\n * @param cwd - The site directory.\n * @param extraEnv - Extra environment variables passed through to the\n * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,\n * `DOCS_REPO_URL`).\n */\nasync function runDocusaurus(\n  command: string,\n  cwd: string,\n  extraEnv: Record<string, string> = {},\n): Promise<void> {\n  await execa(resolveDocusaurus(), [command], {\n    cwd,\n    stdio: 'inherit',\n    env: { ...process.env, ...extraEnv },\n  });\n}\n\n/**\n * Copy site files into the output directory, skipping `node_modules`, `docs`,\n * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be\n * carried over from the source `site/` directory. `tsconfig.json` extends the\n * monorepo's `tsconfig.base.json` via a relative path that only resolves from\n * the source location — it's there for IDE / lint inheritance, not for\n * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.\n *\n * @param outDir - The output directory to set up.\n */\nasync function setupSite(outDir: string): Promise<void> {\n  const packageDir = path.resolve(import.meta.dirname, '..');\n  const siteDir = path.join(packageDir, 'site');\n  const packageNodeModules = path.join(packageDir, 'node_modules');\n  const skip = new Set(['node_modules', 'docs', 'tsconfig.json']);\n\n  console.log(`\\nSetting up Docusaurus site in ${outDir}...`);\n\n  await fs.cp(siteDir, outDir, {\n    recursive: true,\n    filter: (source) => !skip.has(path.basename(source)),\n  });\n\n  // Symlink this package's `node_modules` into the output so the copied\n  // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can\n  // resolve their deps the same way they do in the source tree. Without it,\n  // Node's resolver walks up from the output and can't reach our nested deps\n  // when the package is installed as a regular dependency by an external\n  // consumer (e.g. `metamask-extension`, `metamask-mobile`).\n  const linkPath = path.join(outDir, 'node_modules');\n  try {\n    // `'junction'` works cross-platform (POSIX ignores it; Windows uses it\n    // without admin) — `'dir'` would require admin on Windows.\n    await fs.symlink(packageNodeModules, linkPath, 'junction');\n  } catch (error) {\n    if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {\n      throw error;\n    }\n  }\n\n  // Write a minimal package.json so Docusaurus doesn't warn about a missing one\n  const pkgJsonPath = path.join(outDir, 'package.json');\n  try {\n    await fs.access(pkgJsonPath);\n  } catch {\n    await fs.writeFile(\n      pkgJsonPath,\n      JSON.stringify(\n        { name: 'platform-api-docs-site', private: true },\n        null,\n        2,\n      ),\n    );\n  }\n}\n\n/**\n * Resolve the short Git commit SHA the docs are being generated from.\n * Returns null when the project isn't a git repo or git isn't available.\n *\n * @param projectPath - The project root path.\n * @returns The short SHA, or null on failure.\n */\nasync function resolveCommitSha(projectPath: string): Promise<string | null> {\n  try {\n    const { stdout } = await execa('git', ['rev-parse', '--short', 'HEAD'], {\n      cwd: projectPath,\n    });\n    const trimmed = stdout.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Reject flag combinations that don't make sense, so a mistaken invocation\n * fails instead of silently producing docs built the wrong way.\n *\n * Flags belonging to the strategy that wasn't selected are errors rather than\n * ignored. Used as a yargs `.check`, so failures print alongside usage.\n *\n * @param argv - The parsed arguments.\n * @param argv.strategy - The selected discovery strategy.\n * @param argv.rootActions - The parsed root actions type reference.\n * @param argv.rootEvents - The parsed root events type reference.\n * @param argv.scanDir - The additional directories to scan.\n * @returns True when the combination is valid.\n */\nfunction checkStrategyArgs({\n  strategy,\n  rootActions,\n  rootEvents,\n  scanDir = [],\n}: {\n  strategy?: 'root-messenger' | 'scan';\n  rootActions?: RootCapabilitiesTypeReference;\n  rootEvents?: RootCapabilitiesTypeReference;\n  scanDir?: string[];\n}): ScanStrategyArguments | RootMessengerStrategyArguments {\n  if (strategy !== 'root-messenger') {\n    if (rootActions !== undefined || rootEvents !== undefined) {\n      throw new Error(\n        '--root-actions and --root-events only apply to --strategy root-messenger.',\n      );\n    }\n    return { strategy: 'scan', scanDir };\n  }\n\n  if (rootActions === undefined || rootEvents === undefined) {\n    throw new Error(\n      '--strategy root-messenger requires both --root-actions and --root-events, ' +\n        'each written as \"<file>#<TypeName>\".',\n    );\n  }\n  if (scanDir.length > 0) {\n    throw new Error(\n      '--scan-dir only applies to --strategy scan; --strategy root-messenger reads ' +\n        'only the files named by --root-actions and --root-events.',\n    );\n  }\n\n  return { strategy, rootActions, rootEvents };\n}\n\n/**\n * Parse and validate CLI arguments.\n *\n * @param argumentsForParsing - Arguments to parse, excluding the Node and\n * script paths.\n * @returns Parsed arguments, discriminated by discovery strategy.\n */\nasync function parseArguments(\n  argumentsForParsing: string[] = process.argv.slice(2),\n): Promise<ParsedArguments> {\n  const argv = await yargs(argumentsForParsing)\n    .command(\n      '$0 [project-path]',\n      'Produces documentation for the platform API, the set of actions and events available in clients through the message bus.',\n      (yargsInstance) => {\n        yargsInstance.positional('project-path', {\n          type: 'string',\n          description: 'Path to the project to scan',\n          default: '.',\n        });\n      },\n    )\n    .option('build', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and build a production-ready site',\n      default: false,\n    })\n    .option('serve', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a production-ready site',\n      default: false,\n    })\n    .option('dev', {\n      type: 'boolean',\n      description:\n        'Generate platform API docs and serve a development-only site',\n      default: false,\n    })\n    .option('strategy', {\n      type: 'string',\n      description:\n        'How to find messenger actions and events. \"scan\" parses every source and declaration file looking for messenger types. \"root-messenger\" instead resolves the two types the project declares for its root messenger',\n      default: 'scan',\n    })\n    .choices('strategy', ['scan', 'root-messenger'] as const)\n    .option('root-actions', {\n      type: 'string',\n      coerce: parseRootCapabilitiesTypeReference,\n      description:\n        'Type aliasing the union of every action on the root messenger, written as \"<file>#<TypeName>\" (required with --strategy root-messenger)',\n    })\n    .option('root-events', {\n      type: 'string',\n      coerce: parseRootCapabilitiesTypeReference,\n      description:\n        'Type aliasing the union of every event on the root messenger, written as \"<file>#<TypeName>\" (required with --strategy root-messenger)',\n    })\n    .option('scan-dir', {\n      type: 'array',\n      string: true,\n      description:\n        'Additional directories within the project to scan for messenger actions and events (note: may be specified multiple times)',\n      default: [],\n    })\n    .option('output', {\n      type: 'string',\n      description: 'Output directory',\n    })\n    .option('project-label', {\n      type: 'string',\n      description:\n        'Short label identifying the project (e.g. \"Core\", \"Extension\") — stamped on the site title and headings',\n    })\n    .option('site-url', {\n      type: 'string',\n      description:\n        'Absolute URL the built site will be served from, e.g. https://metamask.github.io',\n    })\n    .option('site-base-url', {\n      type: 'string',\n      description:\n        'Path prefix the built site will be served under, e.g. /core/platform-api/',\n    })\n    .help()\n    .parse();\n\n  const strategyArguments = checkStrategyArgs(argv);\n\n  const projectPath = argv['project-path'];\n  if (typeof projectPath !== 'string') {\n    throw new Error('Expected --project-path to be a string.');\n  }\n\n  return {\n    build: argv.build,\n    serve: argv.serve,\n    dev: argv.dev,\n    'project-path': projectPath,\n    output: argv.output,\n    'project-label': argv['project-label'],\n    'site-url': argv['site-url'],\n    'site-base-url': argv['site-base-url'],\n    ...strategyArguments,\n  };\n}\n\n/**\n * Main CLI entry point.\n */\nasync function main(): Promise<void> {\n  const argv = await parseArguments();\n\n  const resolvedProjectPath = path.resolve(argv['project-path']);\n  const resolvedOutputDir = path.resolve(\n    argv.output ?? path.join(resolvedProjectPath, '.platform-api-docs'),\n  );\n  const projectLabel =\n    argv['project-label'] && argv['project-label'].length > 0\n      ? argv['project-label']\n      : null;\n  const commitSha = await resolveCommitSha(resolvedProjectPath);\n  const repoUrl = await resolveRepoUrl(resolvedProjectPath);\n\n  // Step 1: Generate docs\n  if (argv.strategy === 'root-messenger') {\n    await generate({\n      projectPath: resolvedProjectPath,\n      outputDir: resolvedOutputDir,\n      projectLabel,\n      commitSha,\n      strategy: 'root-messenger',\n      rootActions: argv.rootActions,\n      rootEvents: argv.rootEvents,\n    });\n  } else {\n    const scanDirs = ['src', ...argv.scanDir].filter(\n      (dir, index, dirs) => dirs.indexOf(dir) === index,\n    );\n\n    await generate({\n      projectPath: resolvedProjectPath,\n      outputDir: resolvedOutputDir,\n      projectLabel,\n      commitSha,\n      strategy: 'scan',\n      scanDirs,\n    });\n  }\n\n  // Step 2: If --build, --serve, or --dev, set up and run Docusaurus\n  if (argv.build || argv.serve || argv.dev) {\n    await setupSite(resolvedOutputDir);\n\n    // Translate CLI flags into the environment variables Docusaurus's\n    // config reads. Keeping the CLI surface flag-only means consumers\n    // (workflow files, package.json scripts) don't have to know how the\n    // values are plumbed through to Docusaurus.\n    const docusaurusEnv: Record<string, string> = {};\n    if (projectLabel) {\n      docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;\n    }\n    if (commitSha) {\n      docusaurusEnv.DOCS_COMMIT_SHA = commitSha;\n    }\n    if (repoUrl) {\n      docusaurusEnv.DOCS_REPO_URL = repoUrl;\n    }\n    if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {\n      docusaurusEnv.DOCS_URL = argv['site-url'];\n    }\n    if (\n      typeof argv['site-base-url'] === 'string' &&\n      argv['site-base-url'].length > 0\n    ) {\n      docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];\n    }\n\n    if (argv.dev) {\n      console.log('\\nStarting dev server...');\n      await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);\n    } else if (argv.build || argv.serve) {\n      console.log('\\nBuilding static site...');\n      await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);\n\n      if (argv.serve) {\n        console.log('\\nServing static site...');\n        await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);\n      }\n    }\n  }\n}\n\nmain().catch((error) => {\n  console.error(error);\n  process.exitCode = 1;\n});\n"]}

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

@@ -19,4 +19,4 @@ export declare function findTsFiles(dir: string): Promise<string[]>;
  * @returns A promise that resolves to a sorted array of absolute file paths.
  */
 export declare function findDtsFiles(dir: string): Promise<string[]>;
-//# sourceMappingURL=discovery.d.cts.map
+//# sourceMappingURL=discovery.d.ts.map

package/dist/discovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,wBAAsB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAkBhE;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAOjE"}

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

@@ -1,4 +1,4 @@
-import { glob } from "glob";
+import { glob } from 'glob';
 /**
  * Find all non-test TypeScript source files in a directory.
  * Skips node_modules, dist, test directories, and declaration files.
@@ -45,4 +45,4 @@ export async function findDtsFiles(dir) {
     });
     return matches.sort();
 }
-//# sourceMappingURL=discovery.mjs.map
+//# sourceMappingURL=discovery.js.map

package/dist/discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAW;IAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE;QACpC,GAAG,EAAE,GAAG;QACR,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE;YACN,oBAAoB;YACpB,YAAY;YACZ,iBAAiB;YACjB,aAAa;YACb,YAAY;YACZ,iBAAiB;YACjB,cAAc;YACd,gBAAgB;YAChB,cAAc;YACd,WAAW;SACZ;KACF,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW;IAC5C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE;QACvC,GAAG,EAAE,GAAG;QACR,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,CAAC,oBAAoB,CAAC;KAC/B,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC","sourcesContent":["import { glob } from 'glob';\n\n/**\n * Find all non-test TypeScript source files in a directory.\n * Skips node_modules, dist, test directories, and declaration files.\n *\n * Results are sorted lexicographically so that downstream consumers\n * (extraction, deduplication, output ordering) behave deterministically\n * across filesystems.\n *\n * @param dir - The directory to search.\n * @returns A promise that resolves to a sorted array of absolute file paths.\n */\nexport async function findTsFiles(dir: string): Promise<string[]> {\n  const matches = await glob('**/*.ts', {\n    cwd: dir,\n    absolute: true,\n    ignore: [\n      '**/node_modules/**',\n      '**/dist/**',\n      '**/__tests__/**',\n      '**/tests/**',\n      '**/test/**',\n      '**/__mocks__/**',\n      '**/*.test.ts',\n      '**/*.test-d.ts',\n      '**/*.spec.ts',\n      '**/*.d.ts',\n    ],\n  });\n  return matches.sort();\n}\n\n/**\n * Find all `.d.cts` declaration files in a directory.\n * Skips nested node_modules subdirectories. See {@link findTsFiles} for the\n * note about sorting.\n *\n * @param dir - The directory to search.\n * @returns A promise that resolves to a sorted array of absolute file paths.\n */\nexport async function findDtsFiles(dir: string): Promise<string[]> {\n  const matches = await glob('**/*.d.cts', {\n    cwd: dir,\n    absolute: true,\n    ignore: ['**/node_modules/**'],\n  });\n  return matches.sort();\n}\n"]}

package/dist/extraction.d.ts

@@ -0,0 +1,83 @@
+import type { Identifier, InterfaceDeclaration, SourceFile, TypeAliasDeclaration, TypeReferenceNode } from 'ts-morph';
+import { Project } from 'ts-morph';
+import type { MessengerCapabilityPacket } from './types.js';
+/**
+ * A messenger capability type whose body invokes a capability-type-constructor
+ * utility such as `ControllerGetStateAction<...>` or
+ * `ControllerStateChangeEvent<...>`. The walker classifies the body once when
+ * it captures the declaration so the extractor can read the body's type name
+ * and type arguments without re-running the AST guards.
+ */
+type ConstructorMessengerCapabilityTypeDeclaration = {
+    bodyShape: 'constructor';
+    kind: 'action' | 'event';
+    declaration: TypeAliasDeclaration;
+    body: TypeReferenceNode;
+    typeName: Identifier;
+};
+/**
+ * A messenger capability type whose declaration carries the action/event
+ * shape directly — either an interface or a type alias for a type literal.
+ * The extractor reads `type`, `handler`, and `payload` from the members.
+ */
+type ObjectMessengerCapabilityTypeDeclaration = {
+    bodyShape: 'object';
+    kind: 'action' | 'event';
+    declaration: TypeAliasDeclaration | InterfaceDeclaration;
+};
+/**
+ * Represents a type declaration (type alias or interface) for an individual
+ * messenger action or event, tagged with the body shape the walker
+ * identified.
+ */
+type MessengerCapabilityTypeDeclaration = ConstructorMessengerCapabilityTypeDeclaration | ObjectMessengerCapabilityTypeDeclaration;
+/**
+ * Tag a capability type declaration with the body shape it has, so the right
+ * extractor can read it: 'constructor' for a capability-type-constructor
+ * invocation such as `ControllerGetStateAction<...>`, 'object' otherwise.
+ *
+ * Callers must resolve unions and bare type references first, so that the
+ * declaration reaching here is a leaf.
+ *
+ * @param declaration - The type alias or interface to classify.
+ * @param kind - Whether to tag the declaration as 'action' or 'event'.
+ * @returns The tagged declaration, or null for a qualified-name reference.
+ */
+export declare function classifyMessengerCapabilityTypeDeclaration(declaration: TypeAliasDeclaration | InterfaceDeclaration, kind: 'action' | 'event'): MessengerCapabilityTypeDeclaration | null;
+/**
+ * Given the declaration of a messenger capability type, extract information
+ * about it (action/event type string, handler/payload arguments and return
+ * type, etc.)
+ *
+ * @param capabilityTypeDeclaration - The statement that declared the type for a
+ * messenger action or event, extracted in a previous step.
+ * @param projectPath - Project root, used for computing relative source paths.
+ * @returns Information that may be extracted from the messenger capability type
+ * (may be `null` if the type is ineligible for extraction).
+ */
+export declare function extractFromMessengerCapabilityTypeDeclaration(capabilityTypeDeclaration: MessengerCapabilityTypeDeclaration, projectPath: string): MessengerCapabilityPacket | null;
+/**
+ * Create a ts-morph Project configured for messenger-docs extraction. The
+ * caller should add every source file that may be referenced (directly or
+ * transitively) before calling {@link extractFromSourceFile}, so the type
+ * checker can resolve cross-file references.
+ *
+ * @returns A new ts-morph Project.
+ */
+export declare function createExtractionProject(): Project;
+/**
+ * Extract information (action/event type string, handler/payload arguments and
+ * return type, etc.) about every messenger action or event type which is
+ * reachable through all of a source file's `*Messenger` type declarations.
+ *
+ * The caller is responsible for ensuring `sourceFile` (plus any files it
+ * imports from) belongs to a `ts-morph` Project so cross-file symbol resolution
+ * works.
+ *
+ * @param sourceFile - The TypeScript source file to extract from.
+ * @param projectPath - Project root, used for computing relative source paths.
+ * @returns The extracted information about actions and events.
+ */
+export declare function extractFromSourceFile(sourceFile: SourceFile, projectPath: string): MessengerCapabilityPacket[];
+export {};
+//# sourceMappingURL=extraction.d.ts.map

package/dist/extraction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.d.ts","sourceRoot":"","sources":["../src/extraction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EACV,oBAAoB,EAMpB,UAAU,EACV,oBAAoB,EAGpB,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAsB,OAAO,EAAM,MAAM,UAAU,CAAC;AAE3D,OAAO,KAAK,EACV,yBAAyB,EAE1B,MAAM,YAAY,CAAC;AAiQpB;;;;;;GAMG;AACH,KAAK,6CAA6C,GAAG;IACnD,SAAS,EAAE,aAAa,CAAC;IACzB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzB,WAAW,EAAE,oBAAoB,CAAC;IAClC,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,KAAK,wCAAwC,GAAG;IAC9C,SAAS,EAAE,QAAQ,CAAC;IACpB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzB,WAAW,EAAE,oBAAoB,GAAG,oBAAoB,CAAC;CAC1D,CAAC;AAEF;;;;GAIG;AACH,KAAK,kCAAkC,GACnC,6CAA6C,GAC7C,wCAAwC,CAAC;AAE7C;;;;;;;;;;;GAWG;AACH,wBAAgB,0CAA0C,CACxD,WAAW,EAAE,oBAAoB,GAAG,oBAAoB,EACxD,IAAI,EAAE,QAAQ,GAAG,OAAO,GACvB,kCAAkC,GAAG,IAAI,CA4C3C;AA2QD;;;;;;;;;;GAUG;AACH,wBAAgB,6CAA6C,CAC3D,yBAAyB,EAAE,kCAAkC,EAC7D,WAAW,EAAE,MAAM,GAClB,yBAAyB,GAAG,IAAI,CAWlC;AA4QD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,IAAI,OAAO,CAgBjD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,MAAM,GAClB,yBAAyB,EAAE,CAkB7B"}

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

@@ -1,5 +1,5 @@
-import * as path from "node:path";
-import { Node as NodeGuards, Project, ts } from "ts-morph";
+import * as path from 'node:path';
+import { Node as NodeGuards, Project, ts } from 'ts-morph';
 // ---------------------------------------------------------------------------
 // NOTE: `ts-morph` is used heavily in this file to parse and extract
 // information from TypeScript files. Although this library is not well
@@ -19,15 +19,11 @@ import { Node as NodeGuards, Project, ts } from "ts-morph";
  */
 function escapeJsDocTextForMdx(text) {
     const withLinksResolved = text.replace(/\{@link\s+([^}]+)\}/gu, '`$1`');
-    return withLinksResolved.replace(/`[^`]*`|(\{)|(\})/gu, (match, open, close) => {
-        if (open) {
-            return '\\{';
-        }
-        if (close) {
-            return '\\}';
-        }
-        return match;
-    });
+    // Escape the characters MDX reads as syntax rather than text: `{` and `}`
+    // open an expression, and `<` opens a JSX tag — so an unescaped return type
+    // like `Promise<Foo[]>` fails the site build. Content already inside a code
+    // span is left alone.
+    return withLinksResolved.replace(/`[^`]*`|([{}<])/gu, (match, special) => special === undefined ? match : `\\${special}`);
 }
 /**
  * Extract the comment text of a JSDoc tag — the part that comes after the tag
@@ -216,6 +212,59 @@ function buildMethodSignature(method) {
     // so we don't need to wrap again.
     return `(${signatureParams}) => ${returnType}`;
 }
+/**
+ * Tag a capability type declaration with the body shape it has, so the right
+ * extractor can read it: 'constructor' for a capability-type-constructor
+ * invocation such as `ControllerGetStateAction<...>`, 'object' otherwise.
+ *
+ * Callers must resolve unions and bare type references first, so that the
+ * declaration reaching here is a leaf.
+ *
+ * @param declaration - The type alias or interface to classify.
+ * @param kind - Whether to tag the declaration as 'action' or 'event'.
+ * @returns The tagged declaration, or null for a qualified-name reference.
+ */
+export function classifyMessengerCapabilityTypeDeclaration(declaration, kind) {
+    // Interfaces always carry their members directly.
+    // EXAMPLE:
+    //   interface FooControllerSomeAction { ... }
+    if (NodeGuards.isInterfaceDeclaration(declaration)) {
+        return { bodyShape: 'object', kind, declaration };
+    }
+    const body = declaration.getTypeNode();
+    // A TypeReference body is a capability-type-constructor invocation (e.g.
+    // `ControllerGetStateAction<typeof name, State>`). Tag it so the constructor
+    // extractor can read `body` directly without re-checking its shape.
+    // EXAMPLE:
+    //   type FooControllerSomeAction = ControllerGetStateAction<...>
+    //                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    if (body && NodeGuards.isTypeReference(body)) {
+        // Reject qualified-name constructor type names, as we need a plain
+        // identifier to match the constructor by name.
+        // EXAMPLE:
+        //   import * as somePackage from '....js';
+        //   type FooControllerSomeAction = somePackage.ControllerGetStateAction<...>
+        //                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+        const constructorTypeName = body.getTypeName();
+        if (!NodeGuards.isIdentifier(constructorTypeName)) {
+            return null;
+        }
+        return {
+            bodyShape: 'constructor',
+            kind,
+            declaration,
+            body,
+            typeName: constructorTypeName,
+        };
+    }
+    // Anything else (a type literal, intersection, conditional, …) goes to the
+    // literal extractor, which knows how to read members off a type literal and
+    // rejects exotic shapes.
+    // EXAMPLE:
+    //   type FooControllerSomeAction = { ... }
+    //   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    return { bodyShape: 'object', kind, declaration };
+}
 /**
  * Looks for Messenger types in the source file (that is, those that are type
  * aliases whose names end with "Messenger"), then extracts the `Actions` and
@@ -379,44 +428,19 @@ function recursivelyFindMessengerCapabilityTypeDeclarations(node, kind, visitedT
                 }
                 continue;
             }
-            // A TypeReference body with type arguments is a capability-type-
+            // Everything else is a leaf capability type — a capability-type-
             // constructor invocation (e.g. `ControllerGetStateAction<typeof name,
-            // State>`). Tag it so the constructor extractor can read `body`
-            // directly without re-checking its shape.
-            // EXAMPLE:
+            // State>`) or a literal object type. Tag it so the matching extractor
+            // can read it without re-checking its shape.
+            // EXAMPLES:
             //   type FooControllerSomeAction = ControllerGetStateAction<...>
-            //                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-            if (body && NodeGuards.isTypeReference(body)) {
-                // Reject qualified-name constructor type names, as we need a plain
-                // identifier to match the constructor by name.
-                // EXAMPLE:
-                //   // Bad
-                //   import * as somePackage from '....js';
-                //   type FooControllerSomeAction = somePackage.ControllerGetStateAction<...>
-                //                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-                const constructorTypeName = body.getTypeName();
-                if (NodeGuards.isIdentifier(constructorTypeName)) {
-                    result.capabilityTypeDeclarations.push({
-                        bodyShape: 'constructor',
-                        kind,
-                        declaration,
-                        body,
-                        typeName: constructorTypeName,
-                    });
-                }
-                continue;
-            }
-            // Anything else (a type literal, intersection, conditional, …) gets
-            // tagged for the literal extractor, which knows how to read members
-            // off a type literal and rejects exotic shapes.
-            // EXAMPLE:
+            //   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             //   type FooControllerSomeAction = { ... }
             //   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-            result.capabilityTypeDeclarations.push({
-                bodyShape: 'object',
-                kind,
-                declaration,
-            });
+            const classified = classifyMessengerCapabilityTypeDeclaration(declaration, kind);
+            if (classified) {
+                result.capabilityTypeDeclarations.push(classified);
+            }
         }
         // Interfaces always carry their members directly — tag for the literal
         // extractor.
@@ -447,7 +471,7 @@ function recursivelyFindMessengerCapabilityTypeDeclarations(node, kind, visitedT
  * @returns Information that may be extracted from the messenger capability type
  * (may be `null` if the type is ineligible for extraction).
  */
-function extractFromMessengerCapabilityTypeDeclaration(capabilityTypeDeclaration, projectPath) {
+export function extractFromMessengerCapabilityTypeDeclaration(capabilityTypeDeclaration, projectPath) {
     if (capabilityTypeDeclaration.bodyShape === 'constructor') {
         return tryToExtractFromCapabilityTypeConstructor(capabilityTypeDeclaration, projectPath);
     }
@@ -723,4 +747,4 @@ export function extractFromSourceFile(sourceFile, projectPath) {
     }
     return messengerCapabilityPackets;
 }
-//# sourceMappingURL=extraction.mjs.map
+//# sourceMappingURL=extraction.js.map