@himanshusinghs/mongodb-mcp-server 1.7.7 → 1.11.0-prerelease.2

package/dist/esm/setup/setupMcpServer.js

@@ -0,0 +1,384 @@
+/* eslint-disable no-console */
+import select from "@inquirer/select";
+import { input, confirm, password } from "@inquirer/prompts";
+import path from "path";
+import chalk from "chalk";
+import semver from "semver";
+import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
+import { AI_TOOL_REGISTRY, openConfigSettings, TOOLS_WITHOUT_EDITORS } from "./aiTool.js";
+import { formatError, getPlatform } from "./setupAiToolsUtils.js";
+import { packageInfo } from "../common/packageInfo.js";
+import { getAuthType } from "../common/connectionInfo.js";
+import { defaultCreateAtlasLocalClient } from "../common/atlasLocal.js";
+import { NullLogger } from "../common/logging/index.js";
+import { SetupTelemetry } from "./setupTelemetry.js";
+import { Keychain, registerGlobalSecretToRedact } from "../common/keychain.js";
+import { promptAndInstallSkills } from "./installSkills.js";
+const buildEnvObject = (connectionString, serviceWorkerId, serviceWorkerSecret) => {
+    const env = {};
+    if (connectionString) {
+        env.MDB_MCP_CONNECTION_STRING = connectionString;
+    }
+    if (serviceWorkerId) {
+        env.MDB_MCP_API_CLIENT_ID = serviceWorkerId;
+    }
+    if (serviceWorkerSecret) {
+        env.MDB_MCP_API_CLIENT_SECRET = serviceWorkerSecret;
+    }
+    return env;
+};
+const testConnectionString = async (connectionString) => {
+    let attempts = 0;
+    while (true) {
+        attempts += 1;
+        console.log("\nTesting connection...");
+        let serviceProvider;
+        try {
+            serviceProvider = await NodeDriverServiceProvider.connect(connectionString, {
+                productDocsLink: "https://github.com/mongodb-js/mongodb-mcp-server/",
+                productName: "MongoDB MCP",
+                serverSelectionTimeoutMS: 10000,
+            });
+            await serviceProvider.runCommand("admin", { ping: 1 });
+            console.log(chalk.green("✓ Connection successful!"));
+            return { connectionString, testResult: "success", attempts };
+        }
+        catch (error) {
+            console.log(chalk.red("\n✗ Connection failed: " + formatError(error)));
+            console.log(chalk.yellow("\nPlease check:"));
+            console.log(chalk.yellow("  • Your database user credentials are correct"));
+            console.log(chalk.yellow("  • Your IP address is allowed in Network Access"));
+            console.log(chalk.yellow("  • The cluster is running and accessible"));
+            const retry = await confirm({
+                message: "\nWould you like to enter a new connection string and try again?",
+                default: true,
+            });
+            if (retry) {
+                connectionString = await password({ message: "Enter your MongoDB connection string:", mask: true });
+            }
+            else {
+                console.log(chalk.yellow("\nYou might be proceeding with a potentially invalid connection string."));
+                return { connectionString, testResult: "failure", attempts };
+            }
+        }
+        finally {
+            try {
+                await serviceProvider?.close();
+            }
+            catch {
+                // Ignore close errors
+            }
+        }
+    }
+};
+const configureEditor = async (tool, connectionString, serviceWorkerId, serviceWorkerSecret, isReadOnly) => {
+    const { name: displayName, configFileName } = AI_TOOL_REGISTRY[tool];
+    let { configPath } = AI_TOOL_REGISTRY[tool];
+    // Confirm the config path with the user
+    const useDetectedPath = await confirm({
+        message: `Is this the correct path for your ${displayName} config?\n  ${configPath}`,
+        default: true,
+    });
+    if (!useDetectedPath) {
+        configPath = await input({
+            message: `Enter the correct path to your ${displayName} ${configFileName} file:`,
+            default: configPath,
+        });
+    }
+    // Resolve to absolute path and trim so we always write to the intended file
+    configPath = path.resolve(configPath.trim());
+    const env = buildEnvObject(connectionString, serviceWorkerId, serviceWorkerSecret);
+    try {
+        AI_TOOL_REGISTRY[tool].updateConfig(configPath, env, isReadOnly);
+        console.log(`\nConfiguration saved to ${configPath}`);
+        return { usedDefaultConfigPath: useDetectedPath, result: "success" };
+    }
+    catch (error) {
+        console.log(chalk.red(`\nFailed to save configuration: ${formatError(error)}`));
+        return { usedDefaultConfigPath: useDetectedPath, result: "failure", error };
+    }
+};
+const printNewLine = () => {
+    console.log("\n");
+};
+const printLogo = () => {
+    // Unicode block character banner with MongoDB leaf logo
+    const banner = `
+       ▄▄
+      ▟██▙    █▀▄▀█ █▀█ █▄ █ █▀▀ █▀█ █▀▄ █▄▄   █▀▄▀█ █▀▀ █▀█   █▀ █▀▀ █▀█ █ █ █▀▀ █▀█
+     ▟████▙   █ ▀ █ █▄█ █ ▀█ █▄█ █▄█ █▄▀ █▄█   █ ▀ █ █▄▄ █▀▀   ▄█ ██▄ █▀▄ ▀▄▀ ██▄ █▀▄
+     ▜████▛
+      ▜██▛    █▀ █▀▀ ▀█▀ █ █ █▀█
+       ▐▌     ▄█ ██▄  █  █▄█ █▀▀
+  `;
+    console.log(chalk.hex("#00ED64")(banner));
+    printNewLine();
+};
+const validateNodeVersion = () => {
+    const nodeVersion = process.versions.node;
+    const requiredNodeRange = packageInfo.engines.node;
+    if (!nodeVersion || !semver.satisfies(nodeVersion, requiredNodeRange)) {
+        console.log(chalk.red(`Node version satisfying "${requiredNodeRange}" is required for the MongoDB Local MCP Server. Current version: ${nodeVersion ?? "unknown"}. Please install or activate a compatible version.`));
+        printNewLine();
+        return false;
+    }
+    return true;
+};
+const validateDocker = async () => {
+    const client = await defaultCreateAtlasLocalClient({ logger: new NullLogger() });
+    if (client) {
+        try {
+            // Use the client to confirm docker is available and running
+            await client.listDeployments();
+            return true;
+        }
+        catch {
+            // Can't connect to docker daemon, treat as if docker isn't available and return false
+        }
+    }
+    return false;
+};
+const printInstructions = () => {
+    console.log("To install a Local MCP Server configuration, you will need at least ONE of the following:");
+    console.log("1. A MongoDB connection string (requires a cluster or local MongoDB instance)");
+    console.log("2. Your Atlas project's Service Account credentials\n");
+    console.log("It's best to have this information at hand. We will not store any data or credentials in this process.");
+    printNewLine();
+};
+const promptForAITool = async (platform) => {
+    return await select({
+        message: "What tool would you like to use the MongoDB MCP Server with?",
+        choices: [
+            { value: "cursor", name: "Cursor" },
+            { value: "vscode", name: "VS Code" },
+            // Claude Desktop is only supported on macOS and Windows
+            ...(platform !== "linux" ? [{ value: "claudeDesktop", name: "Claude Desktop" }] : []),
+            { value: "claudeCode", name: "Claude Code" },
+            { value: "opencode", name: "Open Code" },
+            { value: "windsurf", name: "Windsurf" },
+        ],
+    });
+};
+const promptForReadonly = async () => {
+    return await confirm({ message: "Install MCP server as Read-only?", default: false });
+};
+const promptForConnectionString = async (config) => {
+    console.log("Providing a connection string allows the MCP server to read and write data to your MongoDB cluster.");
+    const connectionString = await password({
+        message: "Enter your MongoDB connection string (press enter to skip):",
+        mask: true,
+    });
+    if (!connectionString) {
+        return { connectionString: "", provided: false, tested: false, attempts: 0 };
+    }
+    registerGlobalSecretToRedact(connectionString, "mongodb uri");
+    try {
+        const auth = getAuthType(config, connectionString);
+        if (auth === "scram") {
+            const shouldTest = await confirm({ message: "Test your connection string?", default: true });
+            if (shouldTest) {
+                const outcome = await testConnectionString(connectionString);
+                return {
+                    connectionString: outcome.connectionString,
+                    provided: true,
+                    tested: true,
+                    attempts: outcome.attempts,
+                    testResult: outcome.testResult,
+                };
+            }
+        }
+        return { connectionString, provided: true, tested: false, attempts: 0 };
+    }
+    catch {
+        // If auth type detection failed but user provided a connection string, preserve it
+        return { connectionString, provided: true, tested: false, attempts: 0 };
+    }
+};
+const promptForServiceAccountId = async () => {
+    console.log("\nService Accounts allow the MCP Server to access Atlas tools and perform actions on your behalf.");
+    return await input({ message: "Enter your Atlas Service Account Client ID (press enter to skip):" });
+};
+const promptForServiceAccountSecret = async () => {
+    const secret = await password({
+        message: "Enter your Atlas Service Account Secret (press enter to skip):",
+        mask: true,
+    });
+    if (secret.trim()) {
+        registerGlobalSecretToRedact(secret, "private key");
+    }
+    return secret;
+};
+const validateCredentials = (connectionString, serviceAccountId, serviceAccountSecret, hasDocker) => {
+    // If either the connection string is missing or one of the service account credentials, throw error
+    if (!connectionString && (!serviceAccountId || !serviceAccountSecret)) {
+        console.log(chalk.yellow("No credentials have been provided, so the MCP Server will not be able to access your MongoDB data or Atlas project."));
+        if (hasDocker) {
+            console.log(chalk.yellow("Since you have Docker running, you can still use the MCP server with a local Atlas instance running in a container."));
+        }
+        else {
+            console.log(chalk.red("Since you don't have Docker running, you can only connect to a MongoDB instance dynamically, " +
+                chalk.bold(chalk.red("which is strongly discouraged as it will expose your connection string to the LLM."))));
+        }
+        printNewLine();
+    }
+};
+const getAvailablePrompts = (connectionString, serviceAccountId, serviceAccountSecret, hasDocker) => {
+    const availablePrompts = [];
+    if (connectionString) {
+        availablePrompts.push('\t"List the collections in my MongoDB instance"');
+        availablePrompts.push('\t"Show me some db stats about my Atlas cluster"');
+    }
+    if (serviceAccountId && serviceAccountSecret) {
+        availablePrompts.push('\t"What are the clusters in my project?"');
+        availablePrompts.push('\t"Does my project have any active alerts?"');
+    }
+    if (hasDocker) {
+        availablePrompts.push('\t"Create a local Atlas deployment and connect to it"');
+        availablePrompts.push('\t"How many databases are there in my local Atlas instance?"');
+    }
+    if (availablePrompts.length === 0) {
+        availablePrompts.push("\t[strongly discouraged] Connect to a MongoDB instance at mongodb://localhost:27017 and list the databases");
+    }
+    return availablePrompts;
+};
+const promptToOpenConfigFile = async (displayName, tool) => {
+    let openConfigMessage = `Would you like to open the config file in ${displayName}?`;
+    if (TOOLS_WITHOUT_EDITORS.includes(tool)) {
+        openConfigMessage = `Would you like to open the config file in your default editor?`;
+    }
+    const openConfig = await confirm({
+        message: openConfigMessage,
+        default: true,
+    });
+    if (!openConfig) {
+        return { opened: false, result: "success" };
+    }
+    try {
+        await openConfigSettings(tool);
+        return { opened: true, result: "success" };
+    }
+    catch (error) {
+        console.log(chalk.red(`Failed to open config file: ${formatError(error)}`));
+        return { opened: true, result: "failure", error };
+    }
+};
+const formatSkillsResult = (result) => {
+    switch (result.status) {
+        case "installed":
+            return chalk.green("✓ Agent skills installed.");
+        case "skipped":
+            return chalk.dim("○ Agent skills skipped.");
+        case "failed":
+            return chalk.red(`✗ Agent skills install failed (exit ${result.exitCode}).`);
+    }
+};
+const guideUserWithSetupSuccess = (displayName, availablePrompts, skillsResult) => {
+    printNewLine();
+    console.log(chalk.green(`Setup complete! You can now use the MongoDB MCP Server in ${displayName}. You will probably need to restart your application to see the changes.\n`));
+    console.log(formatSkillsResult(skillsResult));
+    printNewLine();
+    console.log("Try a query to get started:\n");
+    console.log(availablePrompts.join("\n"));
+    printNewLine();
+};
+class UnsupportedPlatformError extends Error {
+    constructor() {
+        super("Unsupported platform. Only macOS, Windows and Linux are supported.");
+        this.name = "UnsupportedPlatformError";
+    }
+}
+/**
+ * Runs the interactive setup wizard. When `setupTelemetry` is provided, each
+ * logical step emits a telemetry event so we can track both overall completion
+ * rates and per-step drop-off.
+ */
+export const runSetup = async (config) => {
+    const setupTelemetry = SetupTelemetry.create(config, Keychain.root);
+    // Ensure hard cancellations (SIGINT/SIGTERM outside of an Inquirer prompt)
+    // are still captured. Inquirer itself converts Ctrl+C during prompts into
+    // an ExitPromptError which runSetup already handles.
+    let interrupted = false;
+    const onInterrupt = () => {
+        if (interrupted) {
+            return;
+        }
+        interrupted = true;
+        setupTelemetry.emitCancelled();
+        setupTelemetry
+            .flush()
+            .catch(() => undefined)
+            .finally(() => process.exit(0));
+    };
+    process.on("SIGINT", onInterrupt);
+    process.on("SIGTERM", onInterrupt);
+    let exitCode = 0;
+    try {
+        printLogo();
+        setupTelemetry.emitStarted();
+        const nodeVersionOk = validateNodeVersion();
+        const platform = getPlatform();
+        const platformSupported = platform !== null;
+        if (!platformSupported) {
+            console.log(chalk.red("Unsupported platform. Only macOS, Windows and Linux are supported."));
+            printNewLine();
+            throw new UnsupportedPlatformError();
+        }
+        printInstructions();
+        const hasDocker = await validateDocker();
+        setupTelemetry.emitPrerequisitesChecked({ nodeVersionOk, hasDocker });
+        const tool = await promptForAITool(platform);
+        const displayName = AI_TOOL_REGISTRY[tool].name;
+        setupTelemetry.emitAiToolSelected(tool);
+        printNewLine();
+        const isReadOnly = await promptForReadonly();
+        setupTelemetry.emitReadOnlySelected(isReadOnly);
+        printNewLine();
+        const connectionOutcome = await promptForConnectionString(config);
+        setupTelemetry.emitConnectionStringEntered({
+            provided: connectionOutcome.provided,
+            tested: connectionOutcome.tested,
+            attempts: connectionOutcome.attempts,
+            testResult: connectionOutcome.testResult,
+        });
+        const serviceAccountId = await promptForServiceAccountId();
+        setupTelemetry.emitServiceAccountIdEntered(Boolean(serviceAccountId));
+        const serviceAccountSecret = await promptForServiceAccountSecret();
+        setupTelemetry.emitServiceAccountSecretEntered(Boolean(serviceAccountSecret));
+        printNewLine();
+        validateCredentials(connectionOutcome.connectionString, serviceAccountId, serviceAccountSecret, hasDocker);
+        setupTelemetry.emitCredentialsValidated();
+        const editorOutcome = await configureEditor(tool, connectionOutcome.connectionString, serviceAccountId, serviceAccountSecret, isReadOnly);
+        setupTelemetry.emitEditorConfigured(editorOutcome);
+        const skillsResult = await promptAndInstallSkills({ tool, cwd: process.cwd() });
+        setupTelemetry.emitSkillsInstallPrompted(skillsResult);
+        const availablePrompts = getAvailablePrompts(connectionOutcome.connectionString, serviceAccountId, serviceAccountSecret, hasDocker);
+        guideUserWithSetupSuccess(displayName, availablePrompts, skillsResult);
+        const openOutcome = await promptToOpenConfigFile(displayName, tool);
+        setupTelemetry.emitOpenConfigPrompted(openOutcome);
+        setupTelemetry.emitCompleted();
+    }
+    catch (error) {
+        // Handle Ctrl+C during prompts (inquirer throws ExitPromptError)
+        // Re-throw other errors
+        if (error && typeof error === "object" && "name" in error && error.name === "ExitPromptError") {
+            console.log("\n\nSetup cancelled. Goodbye!");
+            setupTelemetry.emitCancelled();
+        }
+        else {
+            exitCode = 1;
+            setupTelemetry.emitFailed(error);
+            if (!(error instanceof UnsupportedPlatformError)) {
+                // Don't print the error message for UnsupportedPlatformError since we already
+                // printed it earlier.
+                console.error(`Setup failed: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+    }
+    finally {
+        process.off("SIGINT", onInterrupt);
+        process.off("SIGTERM", onInterrupt);
+        await setupTelemetry.flush();
+    }
+    process.exit(exitCode);
+};
+//# sourceMappingURL=setupMcpServer.js.map

package/dist/esm/setup/setupMcpServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupMcpServer.js","sourceRoot":"","sources":["../../../src/setup/setupMcpServer.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAElF,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAE1F,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAA6B,MAAM,oBAAoB,CAAC;AAEvF,MAAM,cAAc,GAAG,CACnB,gBAAwB,EACxB,eAAuB,EACvB,mBAA2B,EACL,EAAE;IACxB,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,IAAI,gBAAgB,EAAE,CAAC;QACnB,GAAG,CAAC,yBAAyB,GAAG,gBAAgB,CAAC;IACrD,CAAC;IACD,IAAI,eAAe,EAAE,CAAC;QAClB,GAAG,CAAC,qBAAqB,GAAG,eAAe,CAAC;IAChD,CAAC;IACD,IAAI,mBAAmB,EAAE,CAAC;QACtB,GAAG,CAAC,yBAAyB,GAAG,mBAAmB,CAAC;IACxD,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,KAAK,EAC9B,gBAAwB,EAOzB,EAAE;IACD,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,OAAO,IAAI,EAAE,CAAC;QACV,QAAQ,IAAI,CAAC,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACvC,IAAI,eAAsD,CAAC;QAE3D,IAAI,CAAC;YACD,eAAe,GAAG,MAAM,yBAAyB,CAAC,OAAO,CAAC,gBAAgB,EAAE;gBACxE,eAAe,EAAE,mDAAmD;gBACpE,WAAW,EAAE,aAAa;gBAC1B,wBAAwB,EAAE,KAAK;aAClC,CAAC,CAAC;YACH,MAAM,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;YACvD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;YACrD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACjE,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,gDAAgD,CAAC,CAAC,CAAC;YAC5E,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,kDAAkD,CAAC,CAAC,CAAC;YAC9E,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,2CAA2C,CAAC,CAAC,CAAC;YAEvE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;gBACxB,OAAO,EAAE,kEAAkE;gBAC3E,OAAO,EAAE,IAAI;aAChB,CAAC,CAAC;YAEH,IAAI,KAAK,EAAE,CAAC;gBACR,gBAAgB,GAAG,MAAM,QAAQ,CAAC,EAAE,OAAO,EAAE,uCAAuC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACxG,CAAC;iBAAM,CAAC;gBACJ,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,yEAAyE,CAAC,CAAC,CAAC;gBACrG,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;YACjE,CAAC;QACL,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC;gBACD,MAAM,eAAe,EAAE,KAAK,EAAE,CAAC;YACnC,CAAC;YAAC,MAAM,CAAC;gBACL,sBAAsB;YAC1B,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,KAAK,EACzB,IAAgB,EAChB,gBAAwB,EACxB,eAAuB,EACvB,mBAA2B,EAC3B,UAAmB,EAKpB,EAAE;IACD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrE,IAAI,EAAE,UAAU,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAE5C,wCAAwC;IACxC,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC;QAClC,OAAO,EAAE,qCAAqC,WAAW,eAAe,UAAU,EAAE;QACpF,OAAO,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,UAAU,GAAG,MAAM,KAAK,CAAC;YACrB,OAAO,EAAE,kCAAkC,WAAW,IAAI,cAAc,QAAQ;YAChF,OAAO,EAAE,UAAU;SACtB,CAAC,CAAC;IACP,CAAC;IAED,4EAA4E;IAC5E,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7C,MAAM,GAAG,GAAG,cAAc,CAAC,gBAAgB,EAAE,eAAe,EAAE,mBAAmB,CAAC,CAAC;IACnF,IAAI,CAAC;QACD,gBAAgB,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,4BAA4B,UAAU,EAAE,CAAC,CAAC;QACtD,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACzE,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,mCAAmC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAChF,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAChF,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAAS,EAAE;IAC5B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,GAAS,EAAE;IACzB,wDAAwD;IACxD,MAAM,MAAM,GAAG;;;;;;;GAOhB,CAAC;IACA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,YAAY,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,GAAY,EAAE;IACtC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC1C,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC;IACnD,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAE,CAAC;QACpE,OAAO,CAAC,GAAG,CACP,KAAK,CAAC,GAAG,CACL,4BAA4B,iBAAiB,oEAAoE,WAAW,IAAI,SAAS,oDAAoD,CAChM,CACJ,CAAC;QACF,YAAY,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,KAAK,IAAsB,EAAE;IAChD,MAAM,MAAM,GAAG,MAAM,6BAA6B,CAAC,EAAE,MAAM,EAAE,IAAI,UAAU,EAAE,EAAE,CAAC,CAAC;IACjF,IAAI,MAAM,EAAE,CAAC;QACT,IAAI,CAAC;YACD,4DAA4D;YAC5D,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,MAAM,CAAC;YACL,sFAAsF;QAC1F,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,GAAS,EAAE;IACjC,OAAO,CAAC,GAAG,CAAC,2FAA2F,CAAC,CAAC;IACzG,OAAO,CAAC,GAAG,CAAC,+EAA+E,CAAC,CAAC;IAC7F,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;IACrE,OAAO,CAAC,GAAG,CACP,wGAAwG,CAC3G,CAAC;IACF,YAAY,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,KAAK,EAAE,QAAkB,EAAuB,EAAE;IACtE,OAAO,MAAM,MAAM,CAAa;QAC5B,OAAO,EAAE,8DAA8D;QACvE,OAAO,EAAE;YACL,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;YACnC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,wDAAwD;YACxD,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAwB,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9F,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE;YAC5C,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE;SAC1C;KACJ,CAAC,CAAC;AACP,CAAC,CAAC;AACF,MAAM,iBAAiB,GAAG,KAAK,IAAsB,EAAE;IACnD,OAAO,MAAM,OAAO,CAAC,EAAE,OAAO,EAAE,kCAAkC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1F,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,EACnC,MAAkB,EAOnB,EAAE;IACD,OAAO,CAAC,GAAG,CAAC,qGAAqG,CAAC,CAAC;IACnH,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC;QACpC,OAAO,EAAE,6DAA6D;QACtE,IAAI,EAAE,IAAI;KACb,CAAC,CAAC;IAEH,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACpB,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACjF,CAAC;IAED,4BAA4B,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;IAE9D,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACnD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAE7F,IAAI,UAAU,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;gBAC7D,OAAO;oBACH,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;oBAC1C,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;iBACjC,CAAC;YACN,CAAC;QACL,CAAC;QACD,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACL,mFAAmF;QACnF,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC5E,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,IAAqB,EAAE;IAC1D,OAAO,CAAC,GAAG,CAAC,mGAAmG,CAAC,CAAC;IACjH,OAAO,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE,mEAAmE,EAAE,CAAC,CAAC;AACzG,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,KAAK,IAAqB,EAAE;IAC9D,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC;QAC1B,OAAO,EAAE,gEAAgE;QACzE,IAAI,EAAE,IAAI;KACb,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAChB,4BAA4B,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CACxB,gBAAwB,EACxB,gBAAwB,EACxB,oBAA4B,EAC5B,SAAkB,EACd,EAAE;IACN,oGAAoG;IACpG,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACpE,OAAO,CAAC,GAAG,CACP,KAAK,CAAC,MAAM,CACR,qHAAqH,CACxH,CACJ,CAAC;QAEF,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CACP,KAAK,CAAC,MAAM,CACR,qHAAqH,CACxH,CACJ,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,GAAG,CACP,KAAK,CAAC,GAAG,CACL,+FAA+F;gBAC3F,KAAK,CAAC,IAAI,CACN,KAAK,CAAC,GAAG,CACL,oFAAoF,CACvF,CACJ,CACR,CACJ,CAAC;QACN,CAAC;QACD,YAAY,EAAE,CAAC;IACnB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CACxB,gBAAwB,EACxB,gBAAwB,EACxB,oBAA4B,EAC5B,SAAkB,EACV,EAAE;IACV,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,IAAI,gBAAgB,EAAE,CAAC;QACnB,gBAAgB,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;QACzE,gBAAgB,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,gBAAgB,IAAI,oBAAoB,EAAE,CAAC;QAC3C,gBAAgB,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QAClE,gBAAgB,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,gBAAgB,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;QAC/E,gBAAgB,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC1F,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,gBAAgB,CAAC,IAAI,CACjB,4GAA4G,CAC/G,CAAC;IACN,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAChC,WAAmB,EACnB,IAAgB,EAKjB,EAAE;IACD,IAAI,iBAAiB,GAAG,6CAA6C,WAAW,GAAG,CAAC;IACpF,IAAI,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,iBAAiB,GAAG,gEAAgE,CAAC;IACzF,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC;QAC7B,OAAO,EAAE,iBAAiB;QAC1B,OAAO,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAChD,CAAC;IAED,IAAI,CAAC;QACD,MAAM,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,+BAA+B,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5E,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACtD,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAA4B,EAAU,EAAE;IAChE,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,WAAW;YACZ,OAAO,KAAK,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACpD,KAAK,SAAS;YACV,OAAO,KAAK,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QAChD,KAAK,QAAQ;YACT,OAAO,KAAK,CAAC,GAAG,CAAC,uCAAuC,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;IACrF,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAC9B,WAAmB,EACnB,gBAA0B,EAC1B,YAAkC,EAC9B,EAAE;IACN,YAAY,EAAE,CAAC;IACf,OAAO,CAAC,GAAG,CACP,KAAK,CAAC,KAAK,CACP,6DAA6D,WAAW,4EAA4E,CACvJ,CACJ,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC9C,YAAY,EAAE,CAAC;IACf,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzC,YAAY,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,wBAAyB,SAAQ,KAAK;IACxC;QACI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAGvE,SAAI,GAAW,0BAA0B,CAAC;IAFnD,CAAC;CAGJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAkB,EAAkB,EAAE;IACjE,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEpE,2EAA2E;IAC3E,0EAA0E;IAC1E,qDAAqD;IACrD,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,WAAW,GAAG,GAAS,EAAE;QAC3B,IAAI,WAAW,EAAE,CAAC;YACd,OAAO;QACX,CAAC;QAED,WAAW,GAAG,IAAI,CAAC;QACnB,cAAc,CAAC,aAAa,EAAE,CAAC;QAC/B,cAAc;aACT,KAAK,EAAE;aACP,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;aACtB,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAEnC,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,IAAI,CAAC;QACD,SAAS,EAAE,CAAC;QACZ,cAAc,CAAC,WAAW,EAAE,CAAC;QAE7B,MAAM,aAAa,GAAG,mBAAmB,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;QAC/B,MAAM,iBAAiB,GAAG,QAAQ,KAAK,IAAI,CAAC;QAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,oEAAoE,CAAC,CAAC,CAAC;YAC7F,YAAY,EAAE,CAAC;YAEf,MAAM,IAAI,wBAAwB,EAAE,CAAC;QACzC,CAAC;QAED,iBAAiB,EAAE,CAAC;QAEpB,MAAM,SAAS,GAAG,MAAM,cAAc,EAAE,CAAC;QACzC,cAAc,CAAC,wBAAwB,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;QAEtE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAChD,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACxC,YAAY,EAAE,CAAC;QAEf,MAAM,UAAU,GAAG,MAAM,iBAAiB,EAAE,CAAC;QAC7C,cAAc,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChD,YAAY,EAAE,CAAC;QAEf,MAAM,iBAAiB,GAAG,MAAM,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAClE,cAAc,CAAC,2BAA2B,CAAC;YACvC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;YACpC,MAAM,EAAE,iBAAiB,CAAC,MAAM;YAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;YACpC,UAAU,EAAE,iBAAiB,CAAC,UAAU;SAC3C,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,MAAM,yBAAyB,EAAE,CAAC;QAC3D,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEtE,MAAM,oBAAoB,GAAG,MAAM,6BAA6B,EAAE,CAAC;QACnE,cAAc,CAAC,+BAA+B,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC9E,YAAY,EAAE,CAAC;QAEf,mBAAmB,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,SAAS,CAAC,CAAC;QAC3G,cAAc,CAAC,wBAAwB,EAAE,CAAC;QAE1C,MAAM,aAAa,GAAG,MAAM,eAAe,CACvC,IAAI,EACJ,iBAAiB,CAAC,gBAAgB,EAClC,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,CACb,CAAC;QACF,cAAc,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAEnD,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAChF,cAAc,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;QAEvD,MAAM,gBAAgB,GAAG,mBAAmB,CACxC,iBAAiB,CAAC,gBAAgB,EAClC,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,CACZ,CAAC;QACF,yBAAyB,CAAC,WAAW,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACpE,cAAc,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAEnD,cAAc,CAAC,aAAa,EAAE,CAAC;IACnC,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,iEAAiE;QACjE,wBAAwB;QACxB,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YAC5F,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YAC7C,cAAc,CAAC,aAAa,EAAE,CAAC;QACnC,CAAC;aAAM,CAAC;YACJ,QAAQ,GAAG,CAAC,CAAC;YACb,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAEjC,IAAI,CAAC,CAAC,KAAK,YAAY,wBAAwB,CAAC,EAAE,CAAC;gBAC/C,8EAA8E;gBAC9E,sBAAsB;gBACtB,OAAO,CAAC,KAAK,CAAC,iBAAiB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7F,CAAC;QACL,CAAC;IACL,CAAC;YAAS,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACpC,MAAM,cAAc,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC,CAAC"}

package/dist/esm/setup/setupTelemetry.d.ts

@@ -0,0 +1,99 @@
+import type { Keychain } from "../common/keychain.js";
+import { DeviceId } from "../helpers/deviceId.js";
+import { Telemetry } from "../telemetry/telemetry.js";
+import type { SkillsInstallOutcome } from "./installSkills.js";
+import type { SetupEventProperties, TelemetryBoolSet, TelemetryResult } from "../telemetry/types.js";
+/**
+ * Context accumulated as the user progresses through the setup wizard. Each
+ * step adds to it, and every emitted event carries the full context so each
+ * event is independently queryable downstream.
+ */
+export type SetupTelemetryContext = Omit<SetupEventProperties, "stage" | "setup_session_id" | "last_step" | "error_type" | "total_duration_ms">;
+export declare const toBoolSet: (value: boolean | undefined) => TelemetryBoolSet | undefined;
+/**
+ * Per-run helper that owns the setup telemetry session: assigns the
+ * `setup_session_id`, tracks wall-clock durations, and
+ * accumulates context so every event carries the full set of known flags.
+ *
+ * One instance is constructed per `runSetup` invocation. Callers emit typed
+ * events at each logical step and call {@link flush} before the process
+ * exits so buffered events are best-effort sent.
+ */
+export declare class SetupTelemetry {
+    private readonly telemetry;
+    private readonly deviceId;
+    private readonly setupSessionId;
+    private readonly startedAt;
+    private stepStartedAt;
+    private lastStep;
+    private context;
+    /**
+     * Builds a fully-wired {@link SetupTelemetry} for the setup CLI: a silent
+     * logger (so telemetry's internal logging doesn't leak into the
+     * interactive wizard), a fresh {@link DeviceId}, an unauthenticated
+     * {@link ApiClient}, and a {@link Telemetry} instance.
+     */
+    static create(config: {
+        apiBaseUrl: string;
+        telemetry: "enabled" | "disabled";
+    }, keychain: Keychain): SetupTelemetry;
+    /**
+     * Direct construction is primarily for tests that want to inject a mock
+     * telemetry pipeline. Production code should use {@link SetupTelemetry.create}.
+     */
+    constructor(telemetry: Telemetry, deviceId: DeviceId);
+    /**
+     * Merges new context values into the accumulated context. Subsequent
+     * events will automatically carry the updated values.
+     */
+    updateContext(patch: Partial<SetupTelemetryContext>): void;
+    /**
+     * Emits a single setup event. `duration_ms` is computed from the time
+     * elapsed since the previous step (or setup start), and `result`
+     * defaults to "success" — callers pass "failure" only when the step's
+     * own code path failed (e.g. writing the editor config threw).
+     */
+    private emit;
+    emitStarted(): void;
+    emitPrerequisitesChecked(props: {
+        nodeVersionOk: boolean;
+        hasDocker?: boolean;
+    }): void;
+    emitAiToolSelected(aiTool: string): void;
+    emitReadOnlySelected(isReadOnly: boolean): void;
+    emitConnectionStringEntered(props: {
+        provided: boolean;
+        tested: boolean;
+        attempts: number;
+        testResult?: TelemetryResult;
+    }): void;
+    emitServiceAccountIdEntered(provided: boolean): void;
+    emitServiceAccountSecretEntered(provided: boolean): void;
+    emitCredentialsValidated(): void;
+    emitEditorConfigured(props: {
+        usedDefaultConfigPath: boolean;
+        result: TelemetryResult;
+        error?: unknown;
+    }): void;
+    emitSkillsInstallPrompted(outcome: SkillsInstallOutcome): void;
+    emitOpenConfigPrompted(props: {
+        opened: boolean;
+        result: TelemetryResult;
+        error?: unknown;
+    }): void;
+    emitCompleted(): void;
+    /**
+     * Emits a cancellation event (e.g. the user hit Ctrl+C). The `result` is
+     * "success" because the cancellation itself was handled gracefully — the
+     * distinct `stage: "cancelled"` is what analytics use to separate
+     * abandoned runs from completed ones.
+     */
+    emitCancelled(): void;
+    emitFailed(error: unknown): void;
+    /**
+     * Best-effort flush of any buffered events before the process exits. Also
+     * closes the owned {@link DeviceId}.
+     */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=setupTelemetry.d.ts.map

package/dist/esm/setup/setupTelemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupTelemetry.d.ts","sourceRoot":"","sources":["../../../src/setup/setupTelemetry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,KAAK,EAGR,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACpC,oBAAoB,EACpB,OAAO,GAAG,kBAAkB,GAAG,WAAW,GAAG,YAAY,GAAG,mBAAmB,CAClF,CAAC;AAEF,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,GAAG,SAAS,KAAG,gBAAgB,GAAG,SAMzE,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,cAAc;IAmCnB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAnC7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwB;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsB;IAChD,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,OAAO,CAA6B;IAE5C;;;;;OAKG;WACW,MAAM,CAChB,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAAA;KAAE,EACjE,QAAQ,EAAE,QAAQ,GACnB,cAAc;IAcjB;;;OAGG;gBAEkB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ;IAGvC;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI;IAIjE;;;;;OAKG;IACH,OAAO,CAAC,IAAI;IA2BL,WAAW,IAAI,IAAI;IAInB,wBAAwB,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAQtF,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKxC,oBAAoB,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI;IAK/C,2BAA2B,CAAC,KAAK,EAAE;QACtC,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,eAAe,CAAC;KAChC,GAAG,IAAI;IAaD,2BAA2B,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAKpD,+BAA+B,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAKxD,wBAAwB,IAAI,IAAI;IAIhC,oBAAoB,CAAC,KAAK,EAAE;QAC/B,qBAAqB,EAAE,OAAO,CAAC;QAC/B,MAAM,EAAE,eAAe,CAAC;QACxB,KAAK,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,IAAI;IAOD,yBAAyB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAW9D,sBAAsB,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAKlG,aAAa,IAAI,IAAI;IAI5B;;;;;OAKG;IACI,aAAa,IAAI,IAAI;IAOrB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAYvC;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAatC"}