@metamask-previews/platform-api-docs 0.1.0-preview-8bfa290fb → 0.2.0-preview-0a30e47

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/platform-api-docs",
-  "version": "0.1.0-preview-8bfa290fb",
+  "version": "0.2.0-preview-0a30e47",
   "description": "Produces documentation for the platform API, the set of actions and events available in the clients through the message bus",
   "keywords": [
     "Ethereum",
@@ -15,19 +15,22 @@
     "type": "git",
     "url": "https://github.com/MetaMask/core.git"
   },
-  "bin": "./dist/cli.mjs",
+  "bin": "./dist/cli.js",
   "files": [
     "dist/",
     "site/"
   ],
+  "type": "module",
   "sideEffects": false,
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/platform-api-docs",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/platform-api-docs",
     "cli": "tsx src/cli.ts",
@@ -49,7 +52,6 @@
     "@mdx-js/react": "^3.1.1",
     "@metamask/utils": "^11.12.0",
     "execa": "^5.0.0",
-    "glob": "^13.0.6",
     "npm-which": "^3.0.1",
     "prism-react-renderer": "^2.4.1",
     "react": "^19.0.0",
@@ -59,19 +61,20 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
-    "@types/node": "^16.18.54",
+    "@types/node": "^22.13.14",
     "@types/npm-which": "^3",
     "@types/react": "^19.0.0",
     "@types/yargs": "^17.0.32",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
-    "typescript": "~5.3.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }

package/dist/cli.cjs

@@ -1,328 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const execa_1 = __importDefault(require("execa/index.js"));
-const fs = __importStar(require("node:fs/promises"));
-const path = __importStar(require("node:path"));
-const npm_which_1 = __importDefault(require("npm-which"));
-const yargs_1 = __importDefault(require("yargs"));
-const generate_js_1 = require("./generate.cjs");
-const root_messenger_discovery_js_1 = require("./root-messenger-discovery.cjs");
-/**
- * Locate the Docusaurus binary in this package's `node_modules/.bin`. Using
- * `npm-which` lets the lookup track wherever the installed Docusaurus puts
- * its binary, so a future Docusaurus upgrade can't break this path.
- *
- * @returns Absolute path to the `docusaurus` executable.
- */
-function resolveDocusaurus() {
-    return (0, npm_which_1.default)(__dirname).sync('docusaurus');
-}
-/**
- * Run a Docusaurus command.
- *
- * @param command - The docusaurus command (start, build, serve).
- * @param cwd - The site directory.
- * @param extraEnv - Extra environment variables passed through to the
- * Docusaurus process (e.g. `DOCS_PROJECT_LABEL`, `DOCS_COMMIT_SHA`,
- * `DOCS_REPO_URL`).
- */
-async function runDocusaurus(command, cwd, extraEnv = {}) {
-    await (0, execa_1.default)(resolveDocusaurus(), [command], {
-        cwd,
-        stdio: 'inherit',
-        env: { ...process.env, ...extraEnv },
-    });
-}
-/**
- * Copy site files into the output directory, skipping `node_modules`, `docs`,
- * and `tsconfig.json`. `docs` is owned by the doc generator and shouldn't be
- * carried over from the source `site/` directory. `tsconfig.json` extends the
- * monorepo's `tsconfig.base.json` via a relative path that only resolves from
- * the source location — it's there for IDE / lint inheritance, not for
- * Docusaurus, which uses `jiti` and doesn't consult the tsconfig at runtime.
- *
- * @param outDir - The output directory to set up.
- */
-async function setupSite(outDir) {
-    const packageDir = path.resolve(__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)),
-    });
-    // Symlink this package's `node_modules` into the output so the copied
-    // `docusaurus.config.ts` and the rest of Docusaurus's bundling pipeline can
-    // resolve their deps the same way they do in the source tree. Without it,
-    // Node's resolver walks up from the output and can't reach our nested deps
-    // when the package is installed as a regular dependency by an external
-    // consumer (e.g. `metamask-extension`, `metamask-mobile`).
-    const linkPath = path.join(outDir, 'node_modules');
-    try {
-        // `'junction'` works cross-platform (POSIX ignores it; Windows uses it
-        // without admin) — `'dir'` would require admin on Windows.
-        await fs.symlink(packageNodeModules, linkPath, 'junction');
-    }
-    catch (error) {
-        if (error.code !== 'EEXIST') {
-            throw error;
-        }
-    }
-    // Write a minimal package.json so Docusaurus doesn't warn about a missing one
-    const pkgJsonPath = path.join(outDir, 'package.json');
-    try {
-        await fs.access(pkgJsonPath);
-    }
-    catch {
-        await fs.writeFile(pkgJsonPath, JSON.stringify({ name: 'platform-api-docs-site', private: true }, null, 2));
-    }
-}
-/**
- * Resolve the short Git commit SHA the docs are being generated from.
- * Returns null when the project isn't a git repo or git isn't available.
- *
- * @param projectPath - The project root path.
- * @returns The short SHA, or null on failure.
- */
-async function resolveCommitSha(projectPath) {
-    try {
-        const { stdout } = await (0, execa_1.default)('git', ['rev-parse', '--short', 'HEAD'], {
-            cwd: projectPath,
-        });
-        const trimmed = stdout.trim();
-        return trimmed.length > 0 ? trimmed : null;
-    }
-    catch {
-        return null;
-    }
-}
-/**
- * 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.
- */
-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 (0, yargs_1.default)(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',
-            description: 'Path to the project to scan',
-            default: '.',
-        });
-    })
-        .option('build', {
-        type: 'boolean',
-        description: 'Generate platform API docs and build a production-ready site',
-        default: false,
-    })
-        .option('serve', {
-        type: 'boolean',
-        description: 'Generate platform API docs and serve a production-ready site',
-        default: false,
-    })
-        .option('dev', {
-        type: 'boolean',
-        description: 'Generate platform API docs and serve a development-only site',
-        default: false,
-    })
-        .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: root_messenger_discovery_js_1.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',
-        coerce: root_messenger_discovery_js_1.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: [],
-    })
-        .option('output', {
-        type: 'string',
-        description: 'Output directory',
-    })
-        .option('project-label', {
-        type: 'string',
-        description: 'Short label identifying the project (e.g. "Core", "Extension") — stamped on the site title and headings',
-    })
-        .option('site-url', {
-        type: 'string',
-        description: 'Absolute URL the built site will be served from, e.g. https://metamask.github.io',
-    })
-        .option('site-base-url', {
-        type: 'string',
-        description: 'Path prefix the built site will be served under, e.g. /core/platform-api/',
-    })
-        .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 projectLabel = argv['project-label'] && argv['project-label'].length > 0
-        ? argv['project-label']
-        : null;
-    const commitSha = await resolveCommitSha(resolvedProjectPath);
-    const repoUrl = await (0, generate_js_1.resolveRepoUrl)(resolvedProjectPath);
-    // Step 1: Generate docs
-    if (argv.strategy === 'root-messenger') {
-        await (0, generate_js_1.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 (0, generate_js_1.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);
-        // Translate CLI flags into the environment variables Docusaurus's
-        // config reads. Keeping the CLI surface flag-only means consumers
-        // (workflow files, package.json scripts) don't have to know how the
-        // values are plumbed through to Docusaurus.
-        const docusaurusEnv = {};
-        if (projectLabel) {
-            docusaurusEnv.DOCS_PROJECT_LABEL = projectLabel;
-        }
-        if (commitSha) {
-            docusaurusEnv.DOCS_COMMIT_SHA = commitSha;
-        }
-        if (repoUrl) {
-            docusaurusEnv.DOCS_REPO_URL = repoUrl;
-        }
-        if (typeof argv['site-url'] === 'string' && argv['site-url'].length > 0) {
-            docusaurusEnv.DOCS_URL = argv['site-url'];
-        }
-        if (typeof argv['site-base-url'] === 'string' &&
-            argv['site-base-url'].length > 0) {
-            docusaurusEnv.DOCS_BASE_URL = argv['site-base-url'];
-        }
-        if (argv.dev) {
-            console.log('\nStarting dev server...');
-            await runDocusaurus('start', resolvedOutputDir, docusaurusEnv);
-        }
-        else if (argv.build || argv.serve) {
-            console.log('\nBuilding static site...');
-            await runDocusaurus('build', resolvedOutputDir, docusaurusEnv);
-            if (argv.serve) {
-                console.log('\nServing static site...');
-                await runDocusaurus('serve', resolvedOutputDir, docusaurusEnv);
-            }
-        }
-    }
-}
-main().catch((error) => {
-    console.error(error);
-    process.exitCode = 1;
-});
-//# sourceMappingURL=cli.cjs.map

package/dist/cli.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.cjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,2DAA0B;AAC1B,qDAAuC;AACvC,gDAAkC;AAClC,0DAAiC;AACjC,kDAA0B;AAE1B,gDAAyD;AAEzD,gFAAmF;AAoDnF;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,EAAE;IAErC,MAAM,IAAA,eAAK,EAAC,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,SAAS,EAAE,IAAI,CAAC,CAAC;IACjD,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,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,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,IAAA,eAAK,EAAC,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,sBAAgC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAErD,MAAM,IAAI,GAAG,MAAM,IAAA,eAAK,EAAC,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,gEAAkC;QAC1C,WAAW,EACT,yIAAyI;KAC5I,CAAC;SACD,MAAM,CAAC,aAAa,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,gEAAkC;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,IAAA,4BAAc,EAAC,mBAAmB,CAAC,CAAC;IAE1D,wBAAwB;IACxB,IAAI,IAAI,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QACvC,MAAM,IAAA,sBAAQ,EAAC;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,IAAA,sBAAQ,EAAC;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(__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(__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  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\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/cli.d.cts

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

package/dist/cli.d.cts.map

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

package/dist/cli.d.mts

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

package/dist/cli.d.mts.map

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

package/dist/cli.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.mjs","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,MAAK,uBAAc;;AAC1B,OAAO,KAAK,EAAE,yBAAyB;AACvC,OAAO,KAAK,IAAI,kBAAkB;AAClC,OAAO,SAAQ,kBAAkB;;AACjC,OAAO,KAAK,cAAc;AAE1B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,uBAAsB;AAEzD,OAAO,EAAE,kCAAkC,EAAE,uCAAsC;AAoDnF;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,OAAO,QAAQ,6BAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAC1B,OAAe,EACf,GAAW,EACX,WAAmC,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,8BAAY,IAAI,CAAC,CAAC;IACjD,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,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,mEAAmE;IACnE,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,sBAAgC,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(__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(__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  // `fs.cp` has been available since Node 16.7 and only got the \"stable\"\n  // marker in 22.3 — it's functional throughout our supported Node range\n  // (`^18.18 || >=20`), even though the linter flags the older versions.\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins\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.cjs

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findDtsFiles = exports.findTsFiles = void 0;
-const glob_1 = require("glob");
-/**
- * Find all non-test TypeScript source files in a directory.
- * Skips node_modules, dist, test directories, and declaration files.
- *
- * Results are sorted lexicographically so that downstream consumers
- * (extraction, deduplication, output ordering) behave deterministically
- * across filesystems.
- *
- * @param dir - The directory to search.
- * @returns A promise that resolves to a sorted array of absolute file paths.
- */
-async function findTsFiles(dir) {
-    const matches = await (0, glob_1.glob)('**/*.ts', {
-        cwd: dir,
-        absolute: true,
-        ignore: [
-            '**/node_modules/**',
-            '**/dist/**',
-            '**/__tests__/**',
-            '**/tests/**',
-            '**/test/**',
-            '**/__mocks__/**',
-            '**/*.test.ts',
-            '**/*.test-d.ts',
-            '**/*.spec.ts',
-            '**/*.d.ts',
-        ],
-    });
-    return matches.sort();
-}
-exports.findTsFiles = findTsFiles;
-/**
- * Find all `.d.cts` declaration files in a directory.
- * Skips nested node_modules subdirectories. See {@link findTsFiles} for the
- * note about sorting.
- *
- * @param dir - The directory to search.
- * @returns A promise that resolves to a sorted array of absolute file paths.
- */
-async function findDtsFiles(dir) {
-    const matches = await (0, glob_1.glob)('**/*.d.cts', {
-        cwd: dir,
-        absolute: true,
-        ignore: ['**/node_modules/**'],
-    });
-    return matches.sort();
-}
-exports.findDtsFiles = findDtsFiles;
-//# sourceMappingURL=discovery.cjs.map

package/dist/discovery.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"discovery.cjs","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":";;;AAAA,+BAA4B;AAE5B;;;;;;;;;;GAUG;AACI,KAAK,UAAU,WAAW,CAAC,GAAW;IAC3C,MAAM,OAAO,GAAG,MAAM,IAAA,WAAI,EAAC,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;AAlBD,kCAkBC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,YAAY,CAAC,GAAW;IAC5C,MAAM,OAAO,GAAG,MAAM,IAAA,WAAI,EAAC,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;AAPD,oCAOC","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/discovery.d.cts

@@ -1,22 +0,0 @@
-/**
- * Find all non-test TypeScript source files in a directory.
- * Skips node_modules, dist, test directories, and declaration files.
- *
- * Results are sorted lexicographically so that downstream consumers
- * (extraction, deduplication, output ordering) behave deterministically
- * across filesystems.
- *
- * @param dir - The directory to search.
- * @returns A promise that resolves to a sorted array of absolute file paths.
- */
-export declare function findTsFiles(dir: string): Promise<string[]>;
-/**
- * Find all `.d.cts` declaration files in a directory.
- * Skips nested node_modules subdirectories. See {@link findTsFiles} for the
- * note about sorting.
- *
- * @param dir - The directory to search.
- * @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

package/dist/discovery.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"discovery.d.cts","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.d.mts

@@ -1,22 +0,0 @@
-/**
- * Find all non-test TypeScript source files in a directory.
- * Skips node_modules, dist, test directories, and declaration files.
- *
- * Results are sorted lexicographically so that downstream consumers
- * (extraction, deduplication, output ordering) behave deterministically
- * across filesystems.
- *
- * @param dir - The directory to search.
- * @returns A promise that resolves to a sorted array of absolute file paths.
- */
-export declare function findTsFiles(dir: string): Promise<string[]>;
-/**
- * Find all `.d.cts` declaration files in a directory.
- * Skips nested node_modules subdirectories. See {@link findTsFiles} for the
- * note about sorting.
- *
- * @param dir - The directory to search.
- * @returns A promise that resolves to a sorted array of absolute file paths.
- */
-export declare function findDtsFiles(dir: string): Promise<string[]>;
-//# sourceMappingURL=discovery.d.mts.map

package/dist/discovery.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"discovery.d.mts","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"}