@mintlify/cli 4.0.1075 → 4.0.1077

package/__test__/keyring.test.ts

@@ -0,0 +1,52 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+const mockKeytar = {
+  setPassword: vi.fn().mockResolvedValue(undefined),
+  getPassword: vi.fn().mockResolvedValue('test-token'),
+  deletePassword: vi.fn().mockResolvedValue(true),
+};
+
+vi.mock('keytar', () => ({
+  default: mockKeytar,
+  setPassword: mockKeytar.setPassword,
+  getPassword: mockKeytar.getPassword,
+  deletePassword: mockKeytar.deletePassword,
+}));
+
+describe('keyring', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    vi.resetModules();
+  });
+
+  it('stores access and refresh tokens via keytar', async () => {
+    const { storeCredentials } = await import('../src/keyring.js');
+    await storeCredentials('access', 'refresh');
+    expect(mockKeytar.setPassword).toHaveBeenCalledWith('mintlify', 'access_token', 'access');
+    expect(mockKeytar.setPassword).toHaveBeenCalledWith('mintlify', 'refresh_token', 'refresh');
+  });
+
+  it('retrieves the access token via keytar', async () => {
+    const { getAccessToken } = await import('../src/keyring.js');
+    const token = await getAccessToken();
+    expect(token).toBe('test-token');
+    expect(mockKeytar.getPassword).toHaveBeenCalledWith('mintlify', 'access_token');
+  });
+
+  it('deletes both tokens via keytar', async () => {
+    const { clearCredentials } = await import('../src/keyring.js');
+    await clearCredentials();
+    expect(mockKeytar.deletePassword).toHaveBeenCalledWith('mintlify', 'access_token');
+    expect(mockKeytar.deletePassword).toHaveBeenCalledWith('mintlify', 'refresh_token');
+  });
+
+  it('throws a helpful error when keytar is not installed', async () => {
+    vi.doMock('keytar', () => {
+      throw new Error('Cannot find module');
+    });
+    const { storeCredentials } = await import('../src/keyring.js');
+    await expect(storeCredentials('a', 'b')).rejects.toThrow(
+      'keytar is required for credential storage but is not installed'
+    );
+  });
+});

package/bin/keyring.js

@@ -7,12 +7,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import keytar from 'keytar';
 const SERVICE = 'mintlify';
 const ACCESS_TOKEN_ACCOUNT = 'access_token';
 const REFRESH_TOKEN_ACCOUNT = 'refresh_token';
+function getKeytar() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return yield import('keytar');
+        }
+        catch (_a) {
+            throw new Error('keytar is required for credential storage but is not installed. Install it with: npm install keytar');
+        }
+    });
+}
 export function storeCredentials(accessToken, refreshToken) {
     return __awaiter(this, void 0, void 0, function* () {
+        const keytar = yield getKeytar();
         yield Promise.all([
             keytar.setPassword(SERVICE, ACCESS_TOKEN_ACCOUNT, accessToken),
             keytar.setPassword(SERVICE, REFRESH_TOKEN_ACCOUNT, refreshToken),
@@ -21,11 +31,13 @@ export function storeCredentials(accessToken, refreshToken) {
 }
 export function getAccessToken() {
     return __awaiter(this, void 0, void 0, function* () {
+        const keytar = yield getKeytar();
         return keytar.getPassword(SERVICE, ACCESS_TOKEN_ACCOUNT);
     });
 }
 export function clearCredentials() {
     return __awaiter(this, void 0, void 0, function* () {
+        const keytar = yield getKeytar();
         yield Promise.all([
             keytar.deletePassword(SERVICE, ACCESS_TOKEN_ACCOUNT),
             keytar.deletePassword(SERVICE, REFRESH_TOKEN_ACCOUNT),

package/bin/login.js

@@ -7,10 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { input } from '@inquirer/prompts';
 import { addLog } from '@mintlify/previewing';
-import { Text } from 'ink';
+import chalk from 'chalk';
+import { Box, Text } from 'ink';
+import open from 'open';
 import { calculatePKCECodeChallenge, randomNonce, randomPKCECodeVerifier, randomState, } from 'openid-client';
 import { DASHBOARD_URL, STYTCH_CLIENT_ID, TOKEN_ENDPOINT } from './constants.js';
 import { storeCredentials } from './keyring.js';
@@ -25,8 +27,21 @@ export function login() {
         const authorizeUrl = new URL('/api/cli/oauth/authorize', DASHBOARD_URL);
         authorizeUrl.searchParams.set('state', state);
         authorizeUrl.searchParams.set('code_challenge', codeChallenge);
-        addLog(_jsxs(Text, { children: ["Opening browser to log in to Mintlify... ", authorizeUrl.toString()] }));
-        const code = yield input({ message: 'Paste the code from your browser:' });
+        const url = authorizeUrl.toString();
+        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({
+            message: '█',
+            theme: {
+                prefix: chalk.dim(' │'),
+                style: {
+                    answer: (text) => chalk.cyan(text),
+                },
+            },
+        });
         const res = yield fetch(TOKEN_ENDPOINT, {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
@@ -40,11 +55,11 @@ export function login() {
         });
         const body = yield res.json().catch(() => ({}));
         if (!res.ok) {
-            addLog(_jsxs(Text, { color: "red", children: ["Login failed: ", (_b = (_a = body.error_message) !== null && _a !== void 0 ? _a : body.error) !== null && _b !== void 0 ? _b : 'unknown error'] }));
+            addLog(_jsxs(Text, { color: "red", children: ["\u2716 Login failed: ", (_b = (_a = body.error_message) !== null && _a !== void 0 ? _a : body.error) !== null && _b !== void 0 ? _b : 'unknown error'] }));
             return;
         }
         const token = body;
         yield storeCredentials(token.access_token, token.refresh_token);
-        addLog(_jsx(Text, { color: "green", children: "Logged in successfully." }));
+        addLog(_jsx(Text, { color: "green", children: "\u2714 Logged in successfully." }));
     });
 }