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

package/dist/generate.cjs

@@ -1,394 +0,0 @@
-"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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = exports.resolveRepoUrl = void 0;
-const node_1 = require("@metamask/utils/node");
-const node_child_process_1 = require("node:child_process");
-const fs = __importStar(require("node:fs/promises"));
-const path = __importStar(require("node:path"));
-const node_util_1 = require("node:util");
-const discovery_js_1 = require("./discovery.cjs");
-const extraction_js_1 = require("./extraction.cjs");
-const markdown_js_1 = require("./markdown.cjs");
-/**
- * Compute a deduplication score for a messenger item, preferring items with
- * JSDoc and from the "home" package whose name matches the namespace.
- *
- * @param item - The messenger item to score.
- * @returns A numeric score (higher is better).
- */
-function deduplicationScore(item) {
-    const jsDocScore = item.jsDoc ? 2 : 0;
-    const namespacePrefix = item.typeString
-        .split(':')[0]
-        .replace(/(?:Controller|Service)$/u, '')
-        .toLowerCase();
-    const homeScore = namespacePrefix.length > 0 &&
-        item.sourceFile.toLowerCase().includes(namespacePrefix)
-        ? 1
-        : 0;
-    return jsDocScore + homeScore;
-}
-const execFileAsync = (0, node_util_1.promisify)(node_child_process_1.execFile);
-/**
- * Resolve the default branch of a project's `origin` remote by reading the
- * symbolic ref `refs/remotes/origin/HEAD`. Falls back to `main` if the
- * symbolic ref isn't set (e.g. in shallow CI clones).
- *
- * @param projectPath - Absolute path to the project root.
- * @returns The default branch name (e.g. "main", "master", "develop").
- */
-async function resolveDefaultBranch(projectPath) {
-    try {
-        const { stdout } = await execFileAsync('git', ['symbolic-ref', '--short', 'refs/remotes/origin/HEAD'], { cwd: projectPath });
-        // stdout looks like "origin/main"; strip the leading "origin/".
-        const trimmed = stdout.trim();
-        const slash = trimmed.indexOf('/');
-        return slash === -1
-            ? // istanbul ignore next: defensive — `symbolic-ref --short` always
-                // returns `origin/<branch>` when the symbolic ref is set; this
-                // fallback only matters if git's output format ever changes.
-                trimmed || 'main'
-            : trimmed.slice(slash + 1);
-    }
-    catch {
-        return 'main';
-    }
-}
-/**
- * Resolve the bare GitHub repository URL for a project by reading its
- * `origin` remote.
- *
- * @param projectPath - Absolute path to the project root.
- * @returns A URL like "https://github.com/Owner/Repo" or null when the remote
- * isn't a GitHub URL or can't be read.
- */
-async function resolveRepoUrl(projectPath) {
-    try {
-        const { stdout: remoteRaw } = await execFileAsync('git', ['remote', 'get-url', 'origin'], { cwd: projectPath });
-        const remote = remoteRaw.trim();
-        // Parse owner/repo from SSH or HTTPS remote URLs
-        // Handles aliases like github.com-Org used in SSH configs
-        const match = remote.match(/github\.com[^:/]*[:/]([^/]+\/[^/]+?)(?:\.git)?$/u);
-        if (!match) {
-            return null;
-        }
-        return `https://github.com/${match[1]}`;
-    }
-    catch {
-        return null;
-    }
-}
-exports.resolveRepoUrl = resolveRepoUrl;
-/**
- * Resolve the GitHub blob base URL used for per-line source links.
- *
- * Prefers the documented commit SHA when one is available so the links point
- * at the exact revision the docs were generated from; falls back to the
- * default branch otherwise.
- *
- * @param projectPath - Absolute path to the project root.
- * @param commitSha - Optional commit SHA to use as the ref. When null, the
- * default branch is used instead.
- * @returns A base URL like "https://github.com/Owner/Repo/blob/<ref>/" or null.
- */
-async function resolveRepoBaseUrl(projectPath, commitSha) {
-    const repoUrl = await resolveRepoUrl(projectPath);
-    if (!repoUrl) {
-        return null;
-    }
-    const ref = commitSha ?? (await resolveDefaultBranch(projectPath));
-    return `${repoUrl}/blob/${ref}/`;
-}
-/**
- * Discover which configured source locations actually exist on disk.
- *
- * @param projectPath - The project root path.
- * @param scanDirs - User-configured scan directories relative to projectPath.
- * @returns A ScanSources object describing the locations to scan.
- */
-async function discoverScanSources(projectPath, scanDirs) {
-    const existingScanDirs = [];
-    for (const dir of scanDirs) {
-        if (await (0, node_1.directoryExists)(path.join(projectPath, dir))) {
-            existingScanDirs.push(dir);
-        }
-    }
-    const packagesDir = path.join(projectPath, 'packages');
-    const nodeModulesDir = path.join(projectPath, 'node_modules', '@metamask');
-    return {
-        scanDirs: existingScanDirs,
-        packagesDir: (await (0, node_1.directoryExists)(packagesDir)) ? packagesDir : null,
-        nodeModulesDir: (await (0, node_1.directoryExists)(nodeModulesDir))
-            ? nodeModulesDir
-            : null,
-    };
-}
-/**
- * Log a human-readable description of which source locations will be scanned.
- *
- * @param sources - The resolved scan sources.
- */
-function logScanPlan(sources) {
-    const summary = [];
-    for (const dir of sources.scanDirs) {
-        summary.push(`${dir}/ (.ts)`);
-    }
-    if (sources.packagesDir) {
-        summary.push('packages/*/src (.ts)');
-    }
-    if (sources.nodeModulesDir) {
-        summary.push('node_modules/@metamask/*/dist (.d.cts)');
-    }
-    console.log(`Scanning ${summary.join(', ')} for Messenger action/event types...`);
-}
-/**
- * Run extraction against every file in a single directory, logging and
- * swallowing per-file failures. All files are added to the shared `project`
- * up front so the type checker can resolve cross-file references when the
- * walker descends into imported types.
- *
- * @param project - The shared ts-morph project.
- * @param directory - The directory to scan.
- * @param projectPath - The project root, used for relative path display.
- * @param findFiles - The function used to enumerate files in the directory.
- * @returns The list of extracted messenger items.
- */
-async function extractFromDirectory(project, directory, projectPath, findFiles) {
-    const items = [];
-    const files = await findFiles(directory);
-    for (const file of files) {
-        try {
-            const sourceFile = project.getSourceFile(file) ?? project.addSourceFileAtPath(file);
-            items.push(...(0, extraction_js_1.extractFromSourceFile)(sourceFile, projectPath));
-        }
-        catch (error) {
-            console.warn(`Warning: failed to parse ${path.relative(projectPath, file)}`);
-            console.warn(error);
-        }
-    }
-    return items;
-}
-/**
- * Enumerate the subdirectories of a parent directory that match the expected
- * layout (e.g., `packages/*‍/src` or `node_modules/@metamask/*‍/dist`), keeping
- * only those that actually exist.
- *
- * @param parentDir - The parent directory to enumerate.
- * @param subPath - The trailing path component appended to each entry.
- * @param includeSymlinks - Whether to include symbolic links (true for
- * node_modules where workspaces are symlinked).
- * @returns The list of absolute paths to existing target subdirectories.
- */
-async function listTargetSubdirectories(parentDir, subPath, includeSymlinks) {
-    const entries = await fs.readdir(parentDir, { withFileTypes: true });
-    const candidates = entries
-        .filter((entry) => entry.isDirectory() || (includeSymlinks && entry.isSymbolicLink()))
-        .map((entry) => path.join(parentDir, entry.name, subPath));
-    const existing = [];
-    for (const candidate of candidates) {
-        if (await (0, node_1.directoryExists)(candidate)) {
-            existing.push(candidate);
-        }
-    }
-    return existing;
-}
-/**
- * Scan every source location described by `sources` and return all extracted
- * messenger items. A single ts-morph Project is shared across every file so
- * the type checker can resolve cross-file references (e.g. a `*Messenger`
- * declaration in one file walking through an imported umbrella union into
- * an auto-generated `*-method-action-types.ts` sibling).
- *
- * @param projectPath - The project root path.
- * @param sources - The set of source locations to scan.
- * @returns A flat list of all extracted messenger items.
- */
-async function scanSources(projectPath, sources) {
-    const project = (0, extraction_js_1.createExtractionProject)();
-    const allItems = [];
-    for (const dir of sources.scanDirs) {
-        allItems.push(...(await extractFromDirectory(project, path.join(projectPath, dir), projectPath, discovery_js_1.findTsFiles)));
-    }
-    if (sources.packagesDir) {
-        const srcDirs = await listTargetSubdirectories(sources.packagesDir, 'src', false);
-        for (const srcDir of srcDirs) {
-            allItems.push(...(await extractFromDirectory(project, srcDir, projectPath, discovery_js_1.findTsFiles)));
-        }
-    }
-    if (sources.nodeModulesDir) {
-        const distDirs = await listTargetSubdirectories(sources.nodeModulesDir, 'dist', true);
-        for (const distDir of distDirs) {
-            allItems.push(...(await extractFromDirectory(project, distDir, projectPath, discovery_js_1.findDtsFiles)));
-        }
-    }
-    return allItems;
-}
-/**
- * Replace a previously-seen item in its existing namespace group with a
- * higher-scoring duplicate. Handles the case where the duplicate is a
- * different kind (action vs event) by moving it between lists.
- *
- * @param byNamespace - Map of namespace to its group.
- * @param previous - The previously stored item.
- * @param replacement - The new item to replace it with.
- */
-function replaceDuplicateInGroup(byNamespace, previous, replacement) {
-    const namespace = replacement.typeString.split(':')[0];
-    const group = byNamespace.get(namespace);
-    // istanbul ignore next: `previous` and `replacement` have the same
-    // typeString, so they share a namespace, and we always insert the
-    // namespace into `byNamespace` before recording the original entry.
-    if (!group) {
-        return;
-    }
-    const previousList = previous.kind === 'action' ? group.actions : group.events;
-    const index = previousList.indexOf(previous);
-    // istanbul ignore next: `previous` was added to its kind's list by
-    // `groupByNamespace` before being recorded in `seen`, so it is always
-    // present when we look it up here.
-    if (index === -1) {
-        return;
-    }
-    if (previous.kind === replacement.kind) {
-        previousList[index] = replacement;
-    }
-    else {
-        previousList.splice(index, 1);
-        const newList = replacement.kind === 'action' ? group.actions : group.events;
-        newList.push(replacement);
-    }
-}
-/**
- * Group items by namespace, deduplicating duplicate typeStrings using
- * `deduplicationScore`. Returns groups sorted alphabetically by namespace,
- * with each group's items sorted alphabetically by typeString.
- *
- * @param items - The full list of extracted items.
- * @returns The deduplicated and sorted namespace groups.
- */
-function groupByNamespace(items) {
-    const byNamespace = new Map();
-    const seen = new Map();
-    for (const item of items) {
-        const existing = seen.get(item.typeString);
-        if (existing) {
-            if (deduplicationScore(item) <= deduplicationScore(existing)) {
-                continue;
-            }
-            replaceDuplicateInGroup(byNamespace, existing, item);
-            seen.set(item.typeString, item);
-            continue;
-        }
-        seen.set(item.typeString, item);
-        const namespace = item.typeString.split(':')[0];
-        let group = byNamespace.get(namespace);
-        if (!group) {
-            group = { namespace, actions: [], events: [] };
-            byNamespace.set(namespace, group);
-        }
-        if (item.kind === 'action') {
-            group.actions.push(item);
-        }
-        else {
-            group.events.push(item);
-        }
-    }
-    const namespaces = Array.from(byNamespace.values()).sort((a, b) => a.namespace.localeCompare(b.namespace));
-    for (const ns of namespaces) {
-        ns.actions.sort((a, b) => a.typeString.localeCompare(b.typeString));
-        ns.events.sort((a, b) => a.typeString.localeCompare(b.typeString));
-    }
-    return namespaces;
-}
-/**
- * Write generated docs (namespace pages, index page, sidebars) to disk,
- * replacing any existing `docs/` directory.
- *
- * @param namespaces - The grouped namespaces to render.
- * @param outputDir - The root output directory.
- * @param repoBaseUrl - GitHub blob base URL for source links, or null.
- * @param indexOptions - Options stamped on the index page header.
- * @param indexOptions.projectLabel - Short label identifying the project.
- * @param indexOptions.commitSha - Git commit SHA the docs were generated from.
- * @returns Promise that resolves once all files are written.
- */
-async function writeOutput(namespaces, outputDir, repoBaseUrl, indexOptions) {
-    const docsDir = path.join(outputDir, 'docs');
-    if (await (0, node_1.directoryExists)(docsDir)) {
-        await fs.rm(docsDir, { recursive: true });
-    }
-    await fs.mkdir(docsDir, { recursive: true });
-    for (const ns of namespaces) {
-        const nsDir = path.join(docsDir, ns.namespace);
-        await fs.mkdir(nsDir, { recursive: true });
-        if (ns.actions.length > 0) {
-            await fs.writeFile(path.join(nsDir, 'actions.md'), (0, markdown_js_1.generateNamespacePage)(ns, 'action', repoBaseUrl));
-        }
-        if (ns.events.length > 0) {
-            await fs.writeFile(path.join(nsDir, 'events.md'), (0, markdown_js_1.generateNamespacePage)(ns, 'event', repoBaseUrl));
-        }
-    }
-    await fs.writeFile(path.join(docsDir, 'index.md'), (0, markdown_js_1.generateIndexPage)(namespaces, indexOptions));
-    await fs.writeFile(path.join(outputDir, 'sidebars.ts'), (0, markdown_js_1.generateSidebars)(namespaces));
-}
-/**
- * Scan a project for messenger action/event types and generate documentation.
- *
- * @param options - Generation options.
- * @returns A promise resolving to counts of generated namespaces, actions, and events.
- */
-async function generate(options) {
-    const { projectPath, outputDir, scanDirs, projectLabel, commitSha } = options;
-    const sources = await discoverScanSources(projectPath, scanDirs);
-    if (sources.scanDirs.length === 0 &&
-        !sources.packagesDir &&
-        !sources.nodeModulesDir) {
-        throw new Error(`No scannable directories found in ${projectPath}. ` +
-            `Looked for: ${scanDirs.join(', ')}, packages/, node_modules/@metamask/`);
-    }
-    logScanPlan(sources);
-    const allItems = await scanSources(projectPath, sources);
-    console.log(`Found ${allItems.length} messenger ${allItems.length === 1 ? 'item' : 'items'} total.`);
-    const namespaces = groupByNamespace(allItems);
-    const repoBaseUrl = await resolveRepoBaseUrl(projectPath, commitSha ?? null);
-    await writeOutput(namespaces, outputDir, repoBaseUrl, {
-        projectLabel,
-        commitSha,
-    });
-    const totalActions = namespaces.reduce((sum, ns) => sum + ns.actions.length, 0);
-    const totalEvents = namespaces.reduce((sum, ns) => sum + ns.events.length, 0);
-    console.log(`Generated docs for ${namespaces.length} ${namespaces.length === 1 ? 'namespace' : 'namespaces'}.`);
-    console.log(`  Actions: ${totalActions}`);
-    console.log(`  Events: ${totalEvents}`);
-    console.log(`Output: ${path.join(outputDir, 'docs')}/`);
-    return {
-        namespaces: namespaces.length,
-        actions: totalActions,
-        events: totalEvents,
-    };
-}
-exports.generate = generate;
-//# sourceMappingURL=generate.cjs.map

package/dist/generate.cjs.map

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

package/dist/generate.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.cts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAuEA;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAuBxB;AA0BD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAgWF;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,cAAc,CAAC,CAiDzB"}

package/dist/generate.d.mts

@@ -1,46 +0,0 @@
-/**
- * Resolve the bare GitHub repository URL for a project by reading its
- * `origin` remote.
- *
- * @param projectPath - Absolute path to the project root.
- * @returns A URL like "https://github.com/Owner/Repo" or null when the remote
- * isn't a GitHub URL or can't be read.
- */
-export declare function resolveRepoUrl(projectPath: string): Promise<string | null>;
-/**
- * Options for the generate function.
- */
-export type GenerateOptions = {
-    /** Absolute path to the project to scan. */
-    projectPath: string;
-    /** Absolute path to the output directory for generated docs. */
-    outputDir: string;
-    /** Directories (relative to projectPath) to scan for .ts source files. */
-    scanDirs: string[];
-    /**
-     * Short label identifying the project the docs were generated from (e.g.
-     * "Core", "Extension"). Stamped in the index page title.
-     */
-    projectLabel?: string | null;
-    /**
-     * Git commit SHA the docs were generated from. Stamped in the index page
-     * intro so engineers know how current the site is.
-     */
-    commitSha?: string | null;
-};
-/**
- * Result returned by the generate function.
- */
-export type GenerateResult = {
-    namespaces: number;
-    actions: number;
-    events: number;
-};
-/**
- * Scan a project for messenger action/event types and generate documentation.
- *
- * @param options - Generation options.
- * @returns A promise resolving to counts of generated namespaces, actions, and events.
- */
-export declare function generate(options: GenerateOptions): Promise<GenerateResult>;
-//# sourceMappingURL=generate.d.mts.map

package/dist/generate.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.mts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAuEA;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAuBxB;AA0BD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAgWF;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,cAAc,CAAC,CAiDzB"}

package/dist/generate.mjs.map

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