@mintlify/cli 4.0.1084 → 4.0.1086

package/bin/cli.js

@@ -16,9 +16,10 @@ import path from 'path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { accessibilityCheck } from './accessibilityCheck.js';
+import { analyticsBuilder } from './analytics/index.js';
 import { setTelemetryEnabled } from './config.js';
-import { CMD_EXEC_PATH } from './constants.js';
-import { checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, suppressConsoleWarnings, terminate, } from './helpers.js';
+import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
+import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, suppressConsoleWarnings, terminate, } from './helpers.js';
 import { init } from './init.js';
 import { login } from './login.js';
 import { logout } from './logout.js';
@@ -248,18 +249,71 @@ export const cli = ({ packageName = 'mint' }) => {
         }
         yield terminate(1);
     }))
-        .command('status', false, () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('status', 'View current authentication status', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield status();
         yield terminate(0);
     }))
-        .command('logout', false, () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('logout', 'logout of your mintlify account', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield logout();
         yield terminate(0);
     }))
-        .command('login', false, () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('login', 'authenticate your account to mintlify', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield login();
         yield terminate(0);
     }))
+        .command('config', 'manage CLI configuration', (yargs) => yargs
+        .command('set <key> <value>', 'set a configuration value', (yargs) => yargs
+        .positional('key', {
+        type: 'string',
+        demandOption: true,
+        description: 'Config key (e.g. subdomain)',
+    })
+        .positional('value', {
+        type: 'string',
+        demandOption: true,
+        description: 'Config value',
+    }), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        const validKeys = ['subdomain', 'dateFrom', 'dateTo'];
+        if (!validKeys.includes(argv.key)) {
+            addLog(_jsx(ErrorLog, { message: `Unknown config key: "${argv.key}". Valid keys: ${validKeys.join(', ')}` }));
+            yield terminate(1);
+            return;
+        }
+        yield setConfigValue(argv.key, argv.value);
+        addLog(_jsx(SuccessLog, { message: `${argv.key} = "${argv.value}"` }));
+        yield terminate(0);
+    }))
+        .command('get <key>', 'get a configuration value', (yargs) => yargs.positional('key', {
+        type: 'string',
+        demandOption: true,
+        description: 'Config key (e.g. subdomain, dateFrom, dateTo)',
+    }), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        const validKeys = ['subdomain', 'dateFrom', 'dateTo'];
+        if (!validKeys.includes(argv.key)) {
+            addLog(_jsx(ErrorLog, { message: `Unknown config key: "${argv.key}". Valid keys: ${validKeys.join(', ')}` }));
+            yield terminate(1);
+            return;
+        }
+        const val = getConfigValue(argv.key);
+        addLog(_jsx(Text, { children: val !== null && val !== void 0 ? val : 'not set' }));
+        yield terminate(0);
+    }))
+        .command('clear <key>', 'remove a configuration value', (yargs) => yargs.positional('key', {
+        type: 'string',
+        demandOption: true,
+        description: 'Config key (e.g. subdomain, dateFrom, dateTo)',
+    }), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        const validKeys = ['subdomain', 'dateFrom', 'dateTo'];
+        if (!validKeys.includes(argv.key)) {
+            addLog(_jsx(ErrorLog, { message: `Unknown config key: "${argv.key}". Valid keys: ${validKeys.join(', ')}` }));
+            yield terminate(1);
+            return;
+        }
+        yield clearConfigValue(argv.key);
+        addLog(_jsx(SuccessLog, { message: `${argv.key} cleared` }));
+        yield terminate(0);
+    }))
+        .demandCommand(1, 'specify a subcommand: set, get, or clear'))
         .command('update', 'update the CLI to the latest version', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield update({ packageName });
         yield terminate(0);
@@ -337,6 +391,7 @@ export const cli = ({ packageName = 'mint' }) => {
             yield terminate(1);
         }
     }))
+        .command('analytics', 'view analytics for your documentation', analyticsBuilder)
         // Print the help menu when the user enters an invalid command.
         .strictCommands()
         .demandCommand(1, 'unknown command. see above for the list of supported commands.')

package/bin/config.js

@@ -40,3 +40,17 @@ export function setTelemetryEnabled(enabled) {
         yield writeConfig({ telemetryEnabled: enabled });
     });
 }
+export function getConfigValue(key) {
+    const config = readConfig();
+    return config[key];
+}
+export function setConfigValue(key, value) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield writeConfig({ [key]: value });
+    });
+}
+export function clearConfigValue(key) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield writeConfig({ [key]: undefined });
+    });
+}

package/bin/constants.js

@@ -1,11 +1,19 @@
-var _a;
+var _a, _b;
+import { LOCAL_LINKED_CLI_VERSION } from '@mintlify/previewing';
 import os from 'os';
 import path from 'path';
+import { getCliVersion } from './helpers.js';
 export const HOME_DIR = os.homedir();
-export const CMD_EXEC_PATH = process.cwd();
 export const CONFIG_DIR = path.join(HOME_DIR, '.config', 'mintlify');
 export const CLI_CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
 export const TELEMETRY_ASYNC_TIMEOUT_MS = 10000;
-export const DASHBOARD_URL = (_a = process.env.MINTLIFY_DASHBOARD_URL) !== null && _a !== void 0 ? _a : 'http://localhost:3000';
-export const TOKEN_ENDPOINT = 'https://test.stytch.com/v1/public/project-test-2d86347b-dfdb-4609-be69-12d8146220bd/oauth2/token';
-export const STYTCH_CLIENT_ID = 'connected-app-test-b597afb3-304a-420f-bc13-dacca566c59f';
+export const CALLBACK_PORT = 11582;
+const IS_LOCAL_BUILD = process.env.CLI_TEST_MODE === 'true' ? true : getCliVersion() == LOCAL_LINKED_CLI_VERSION;
+export const API_URL = (_a = process.env.MINTLIFY_API_URL) !== null && _a !== void 0 ? _a : (IS_LOCAL_BUILD ? 'http://localhost:5000' : 'https://leaves.mintlify.com');
+export const DASHBOARD_URL = (_b = process.env.MINTLIFY_DASHBOARD_URL) !== null && _b !== void 0 ? _b : (IS_LOCAL_BUILD ? 'http://localhost:3000' : 'https://dashboard.mintlify.com');
+const DEV_TOKEN_ENDPOINT = 'https://test.stytch.com/v1/public/project-test-2d86347b-dfdb-4609-be69-12d8146220bd/oauth2/token';
+const DEV_STYTCH_CLIENT_ID = 'connected-app-test-b597afb3-304a-420f-bc13-dacca566c59f';
+const PROD_TOKEN_ENDPOINT = 'https://api.stytch.com/v1/public/project-live-731b7a04-9ac3-4923-90b8-0806d4aa29d4/oauth2/token';
+const PROD_STYTCH_CLIENT_ID = 'connected-app-live-d813eedd-dbb0-434b-a1f9-2ce69e5efc49';
+export const TOKEN_ENDPOINT = IS_LOCAL_BUILD ? DEV_TOKEN_ENDPOINT : PROD_TOKEN_ENDPOINT;
+export const STYTCH_CLIENT_ID = IS_LOCAL_BUILD ? DEV_STYTCH_CLIENT_ID : PROD_STYTCH_CLIENT_ID;

package/bin/helpers.js

@@ -21,8 +21,8 @@ import { exec, execSync } from 'node:child_process';
 import { promisify } from 'node:util';
 import path from 'path';
 import yargs from 'yargs';
-import { CMD_EXEC_PATH } from './constants.js';
 import { shutdownPostHog } from './telemetry/client.js';
+export const CMD_EXEC_PATH = process.cwd();
 export const checkPort = (argv) => __awaiter(void 0, void 0, void 0, function* () {
     const initialPort = typeof argv.port === 'number' ? argv.port : 3000;
     if (initialPort === (yield detect(initialPort)))

package/bin/keyring.js

@@ -12,10 +12,13 @@ const ACCESS_TOKEN_ACCOUNT = 'access_token';
 const REFRESH_TOKEN_ACCOUNT = 'refresh_token';
 function getKeytar() {
     return __awaiter(this, void 0, void 0, function* () {
+        var _a;
         try {
-            return yield import('keytar');
+            const mod = yield import('keytar');
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- ESM wraps CJS in { default: ... } at runtime despite types
+            return (_a = mod.default) !== null && _a !== void 0 ? _a : mod;
         }
-        catch (_a) {
+        catch (_b) {
             throw new Error('keytar is required for credential storage but is not installed. Install it with: npm install keytar');
         }
     });

package/bin/login.js

@@ -14,6 +14,7 @@ import chalk from 'chalk';
 import { Box, Text } from 'ink';
 import open from 'open';
 import { calculatePKCECodeChallenge, randomNonce, randomPKCECodeVerifier, randomState, } from 'openid-client';
+import { startCallbackServer } from './callbackServer.js';
 import { DASHBOARD_URL, STYTCH_CLIENT_ID, TOKEN_ENDPOINT } from './constants.js';
 import { storeCredentials } from './keyring.js';
 export function login() {
@@ -28,12 +29,13 @@ export function login() {
         authorizeUrl.searchParams.set('state', state);
         authorizeUrl.searchParams.set('code_challenge', codeChallenge);
         const url = authorizeUrl.toString();
+        const { codePromise, close: closeServer } = yield startCallbackServer();
         addLog(_jsxs(Box, { flexDirection: "column", gap: 1, paddingY: 1, children: [_jsxs(Text, { bold: true, children: [_jsx(Text, { color: "green", children: "\u25C6 " }), "A browser window will open for Mintlify authentication"] }), _jsxs(Box, { flexDirection: "column", paddingLeft: 3, gap: 1, children: [_jsx(Text, { dimColor: true, children: "If your browser doesn't open automatically, copy this URL:" }), _jsx(Text, { color: "cyan", children: url })] })] }));
         open(url).catch(() => { });
         addLog(_jsxs(Box, { flexDirection: "column", paddingLeft: 1, marginTop: 1, children: [_jsx(Text, { dimColor: true, children: "\u256D\u2500 Paste the authorization code from your browser" }), _jsx(Text, { dimColor: true, children: "\u2502" })] }));
         // Let ink finish rendering before inquirer takes over stdout
         yield new Promise((resolve) => setTimeout(resolve, 50));
-        const code = yield input({
+        const inputPromise = input({
             message: '█',
             theme: {
                 prefix: chalk.dim(' │'),
@@ -42,6 +44,18 @@ export function login() {
                 },
             },
         });
+        let code;
+        try {
+            code = yield Promise.race([codePromise, inputPromise]);
+        }
+        catch (_c) {
+            closeServer();
+            inputPromise.cancel();
+            addLog(_jsx(Text, { color: "red", children: "\u2716 Login cancelled." }));
+            return;
+        }
+        closeServer();
+        inputPromise.cancel();
         const res = yield fetch(TOKEN_ENDPOINT, {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },

package/bin/status.js

@@ -7,13 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var _a;
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { addLog } from '@mintlify/previewing';
 import { Text } from 'ink';
 import { z } from 'zod';
+import { API_URL } from './constants.js';
 import { getAccessToken } from './keyring.js';
-const API_URL = (_a = process.env.MINTLIFY_API_URL) !== null && _a !== void 0 ? _a : 'http://localhost:5000';
 const StatusResponseSchema = z.object({
     user: z.object({ email: z.string() }),
     org: z.object({ name: z.string() }),

package/bin/telemetry/client.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { PostHog } from 'posthog-node';
-import { TELEMETRY_ASYNC_TIMEOUT_MS } from '../constants.js';
+const TELEMETRY_ASYNC_TIMEOUT_MS = 10000;
 const POSTHOG_API_KEY = 'phc_eNuN6Ojnk9O7uWfC17z12AK85fNR0BY6IiGVy0Gfwzw';
 const POSTHOG_HOST = 'https://ph.mintlify.com';
 let client = null;