@mintlify/cli 4.0.1141 → 4.0.1143

package/bin/update.js

@@ -8,18 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { jsx as _jsx } from "react/jsx-runtime";
-import { SpinnerLog, SuccessLog, ErrorLog, addLog, addErrorLog, clearLogs, } from '@mintlify/previewing';
+import { SpinnerLog, SuccessLog, ErrorLog, addLog, addErrorLog, clearLogs, getLatestClientVersion, downloadTargetMint, getClientVersion, } from '@mintlify/previewing';
 import { execAsync, getLatestCliVersion, getVersions, detectPackageManager } from './helpers.js';
 export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packageName }) {
     addLog(_jsx(SpinnerLog, { message: "updating..." }));
-    const { cli: existingCliVersion } = getVersions();
+    const { cli: existingCliVersion } = getVersions(packageName);
     const latestCliVersion = getLatestCliVersion(packageName);
     const isUpToDate = existingCliVersion && latestCliVersion && latestCliVersion.trim() === existingCliVersion.trim();
-    if (isUpToDate) {
-        addLog(_jsx(SuccessLog, { message: "already up to date" }));
-        return;
-    }
-    if (existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
+    if (!isUpToDate && existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
         const packageManager = yield detectPackageManager({ packageName });
         try {
             clearLogs();
@@ -38,5 +34,31 @@ export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packa
         }
     }
     clearLogs();
-    addLog(_jsx(SuccessLog, { message: `updated ${packageName} to the latest version: ${latestCliVersion}` }));
+    addLog(_jsx(SpinnerLog, { message: "updating client..." }));
+    let clientUpdated = false;
+    const latestClientVersion = yield getLatestClientVersion();
+    if (latestClientVersion) {
+        const existingClientVersion = getClientVersion().trim();
+        if (existingClientVersion !== latestClientVersion.trim()) {
+            try {
+                yield downloadTargetMint({
+                    targetVersion: latestClientVersion,
+                    existingVersion: existingClientVersion === 'none' ? null : existingClientVersion,
+                });
+                clientUpdated = true;
+            }
+            catch (err) {
+                const errorMessage = err instanceof Error ? err.message : String(err);
+                addErrorLog(_jsx(ErrorLog, { message: `Failed to update client: ${errorMessage}` }));
+                return;
+            }
+        }
+    }
+    clearLogs();
+    if (isUpToDate && !clientUpdated) {
+        addLog(_jsx(SuccessLog, { message: "already up to date" }));
+    }
+    else {
+        addLog(_jsx(SuccessLog, { message: `updated ${packageName} to the latest version: ${latestCliVersion}` }));
+    }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1141",
+  "version": "4.0.1143",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,11 +45,12 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.872",
-    "@mintlify/link-rot": "3.0.1050",
-    "@mintlify/prebuild": "1.0.1015",
-    "@mintlify/previewing": "4.0.1076",
-    "@mintlify/validation": "0.1.683",
+    "@mintlify/common": "1.0.873",
+    "@mintlify/link-rot": "3.0.1051",
+    "@mintlify/models": "0.0.301",
+    "@mintlify/prebuild": "1.0.1016",
+    "@mintlify/previewing": "4.0.1077",
+    "@mintlify/validation": "0.1.684",
     "adm-zip": "0.5.16",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -93,5 +94,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "d882bbf0e323d546678aa31f4feaa7663c2f1739"
+  "gitHead": "013911b92fc2916f1ddadcc42ff5397b5ee4d1e7"
 }

package/src/cli.tsx

@@ -111,7 +111,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
         async (argv) => {
           await autoUpgradeIfNeeded();
           const port = await checkPort(argv);
-          const { cli: cliVersion } = getVersions();
+          const { cli: cliVersion } = getVersions(packageName);
           let accessToken: string | undefined;
           let subdomain: string | undefined;
           try {
@@ -183,7 +183,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             }
           }
 
-          const { cli: cliVersion } = getVersions();
+          const { cli: cliVersion } = getVersions(packageName);
           await validateBuild({
             ...argv,
             packageName,
@@ -218,7 +218,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             .example('mintlify export', 'export as export.zip')
             .example('mintlify export --output docs.zip', 'export to custom filename'),
         async (argv) => {
-          const { cli: cliVersion } = getVersions();
+          const { cli: cliVersion } = getVersions(packageName);
           await exportSite({
             ...argv,
             packageName,
@@ -519,7 +519,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
         'Display the current version of the CLI and client',
         () => undefined,
         async () => {
-          const { cli, client } = getVersions();
+          const { cli, client } = getVersions(packageName);
           addLog(
             <Text>
               <Text bold color="green">

package/src/helpers.tsx

@@ -19,6 +19,7 @@ import yaml from 'js-yaml';
 import { exec, execSync } from 'node:child_process';
 import { readFileSync } from 'node:fs';
 import fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
 import { fileURLToPath } from 'node:url';
 import { promisify } from 'node:util';
 import path from 'path';
@@ -129,47 +130,46 @@ export const upgradeConfig = async () => {
   }
 };
 
-// Resolve the CLI's own package.json via `import.meta.url` so the version is
-// always the one shipped with this package, regardless of cwd. See #7121.
-const CLI_PACKAGE_JSON_PATH = (() => {
+const require = createRequire(import.meta.url);
+
+const isRunningFromLinkedBuild = (): boolean => {
   try {
-    return fileURLToPath(new URL('../package.json', import.meta.url));
+    const thisFile = fileURLToPath(import.meta.url);
+    return !thisFile.split(path.sep).includes('node_modules');
   } catch {
-    return undefined;
+    return false;
   }
-})();
+};
 
-const readCliPackageVersion = (): string | undefined => {
-  if (!CLI_PACKAGE_JSON_PATH) return undefined;
+const readPackageVersion = (packageName: string): string | undefined => {
   try {
-    const pkg = JSON.parse(readFileSync(CLI_PACKAGE_JSON_PATH, 'utf8')) as { version?: string };
+    const pkgPath = require.resolve(`${packageName}/package.json`);
+    const pkg = JSON.parse(readFileSync(pkgPath, 'utf8')) as { version?: string };
     return typeof pkg.version === 'string' ? pkg.version : undefined;
   } catch {
     return undefined;
   }
 };
 
-// Outside `node_modules` means `yarn dev` or `npm link`: treat as linked. See #7121.
-const isRunningFromLinkedBuild = (): boolean => {
-  if (!CLI_PACKAGE_JSON_PATH) return false;
-  return !CLI_PACKAGE_JSON_PATH.split(path.sep).includes('node_modules');
-};
-
-export const getCliVersion = (): string | undefined => {
+export const getCliVersion = (
+  packageName: string = process.env.MINTLIFY_PACKAGE_NAME ?? 'mint'
+): string | undefined => {
   if (process.env.CLI_TEST_MODE === 'true') {
     return 'test-cli';
   }
   if (isRunningFromLinkedBuild()) {
     return LOCAL_LINKED_CLI_VERSION;
   }
-  return readCliPackageVersion();
+  return readPackageVersion(packageName);
 };
 
-export const getVersions = (): {
+export const getVersions = (
+  packageName: string = process.env.MINTLIFY_PACKAGE_NAME ?? 'mint'
+): {
   cli: string | undefined;
   client: string | undefined;
 } => {
-  const cli = getCliVersion();
+  const cli = getCliVersion(packageName);
   const client = getClientVersion().trim();
   return { cli, client };
 };

package/src/score/index.tsx

@@ -8,7 +8,7 @@ import { getAccessToken } from '../keyring.js';
 import { getCliSubdomains } from '../status.js';
 import { trackEvent } from '../telemetry/track.js';
 import { fetchScoreBySlug, resolveScoreForUrl } from './client.js';
-import type { Check, ScoreResponse } from './types.js';
+import type { Check, CliCheckStatus, ScoreResponse } from './types.js';
 
 type OutputFormat = 'table' | 'plain' | 'json';
 
@@ -21,13 +21,33 @@ function resolveFormat(argv: { format?: string }): OutputFormat {
   return 'table';
 }
 
-function statusIcon(pass: boolean): string {
-  return pass ? chalk.green('✓') : chalk.red('✗');
+function statusIcon(status: CliCheckStatus): string {
+  switch (status) {
+    case 'pass':
+      return chalk.green('✓');
+    case 'warn':
+      return chalk.yellow('⚠');
+    case 'skip':
+      return chalk.dim('○');
+    case 'fail':
+    case 'error':
+      return chalk.red('✗');
+    default: {
+      const _exhaustive: never = status;
+      void _exhaustive;
+      return chalk.dim('?');
+    }
+  }
+}
+
+function plainStatusLabel(status: CliCheckStatus): string {
+  return status.toUpperCase();
 }
 
 function formatCheckName(name: string): string {
   return name
-    .replace(/([A-Z])/g, ' $1')
+    .replace(/[-_]+/g, ' ')
+    .replace(/([a-z])([A-Z])/g, '$1 $2')
     .replace(/^./, (c) => c.toUpperCase())
     .trim();
 }
@@ -36,7 +56,7 @@ function renderChecks(checks: Check[], indent = 0): string[] {
   const lines: string[] = [];
   const pad = '  '.repeat(indent + 1);
   for (const check of checks) {
-    lines.push(`${pad}${statusIcon(check.pass)}  ${formatCheckName(check.name)}`);
+    lines.push(`${pad}${statusIcon(check.status)}  ${formatCheckName(check.name)}`);
     if (check.children && check.children.length > 0) {
       lines.push(...renderChecks(check.children, indent + 1));
     }
@@ -47,7 +67,7 @@ function renderChecks(checks: Check[], indent = 0): string[] {
 function renderPlain(checks: Check[], prefix = ''): string[] {
   const lines: string[] = [];
   for (const check of checks) {
-    lines.push(`${prefix}${check.pass ? 'PASS' : 'FAIL'}\t${check.name}`);
+    lines.push(`${prefix}${plainStatusLabel(check.status)}\t${check.name}`);
     if (check.children && check.children.length > 0) {
       lines.push(...renderPlain(check.children, prefix + '  '));
     }

package/src/score/types.ts

@@ -1,26 +1,15 @@
-export type Check = {
-  name: string;
-  pass: boolean;
-  metadata?: Record<string, unknown>;
-  children?: Check[];
-};
-
-export type ResolveStatus = 'ready' | 'stale_refresh_queued' | 'queued';
-
-export type ResolveResult = {
-  canonicalUrl: string;
-  slug: string;
-  status: ResolveStatus;
-  trackedSiteId: string;
-};
-
-export type ScoreResponse = {
-  canonicalUrl: string;
-  checks: Check[];
-  computedAt: string;
-  name: string;
-  overallScore: number;
-  passedChecks: number;
-  slug: string;
-  totalChecks: number;
-};
+// These types are defined in `@mintlify/models/src/types/cliScoreResponse.ts`.
+// The server (mintlify/server) is the source of truth for this contract — it
+// implements the response shape in `agentReadinessScore.controller.ts` →
+// `getCliSiteScore`. Do not redefine the shape locally; update the shared
+// package (and bump the dependency in both repos) if you need to change it.
+export type {
+  CliCheckStatus,
+  CliGrade,
+  CliScoreCheck as Check,
+  CliScorePendingResponse,
+  CliScoreResolveResponse as ResolveResult,
+  CliScoreResolveStatus as ResolveStatus,
+  CliScoreResponse as ScoreResponse,
+  CliScoreResponseStatus,
+} from '@mintlify/models';

package/src/update.tsx

@@ -5,23 +5,21 @@ import {
   addLog,
   addErrorLog,
   clearLogs,
+  getLatestClientVersion,
+  downloadTargetMint,
+  getClientVersion,
 } from '@mintlify/previewing';
 
 import { execAsync, getLatestCliVersion, getVersions, detectPackageManager } from './helpers.js';
 
 export const update = async ({ packageName }: { packageName: string }) => {
   addLog(<SpinnerLog message="updating..." />);
-  const { cli: existingCliVersion } = getVersions();
+  const { cli: existingCliVersion } = getVersions(packageName);
   const latestCliVersion = getLatestCliVersion(packageName);
   const isUpToDate =
     existingCliVersion && latestCliVersion && latestCliVersion.trim() === existingCliVersion.trim();
 
-  if (isUpToDate) {
-    addLog(<SuccessLog message="already up to date" />);
-    return;
-  }
-
-  if (existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
+  if (!isUpToDate && existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
     const packageManager = await detectPackageManager({ packageName });
     try {
       clearLogs();
@@ -44,7 +42,32 @@ export const update = async ({ packageName }: { packageName: string }) => {
   }
 
   clearLogs();
-  addLog(
-    <SuccessLog message={`updated ${packageName} to the latest version: ${latestCliVersion}`} />
-  );
+  addLog(<SpinnerLog message="updating client..." />);
+  let clientUpdated = false;
+  const latestClientVersion = await getLatestClientVersion();
+  if (latestClientVersion) {
+    const existingClientVersion = getClientVersion().trim();
+    if (existingClientVersion !== latestClientVersion.trim()) {
+      try {
+        await downloadTargetMint({
+          targetVersion: latestClientVersion,
+          existingVersion: existingClientVersion === 'none' ? null : existingClientVersion,
+        });
+        clientUpdated = true;
+      } catch (err) {
+        const errorMessage = err instanceof Error ? err.message : String(err);
+        addErrorLog(<ErrorLog message={`Failed to update client: ${errorMessage}`} />);
+        return;
+      }
+    }
+  }
+
+  clearLogs();
+  if (isUpToDate && !clientUpdated) {
+    addLog(<SuccessLog message="already up to date" />);
+  } else {
+    addLog(
+      <SuccessLog message={`updated ${packageName} to the latest version: ${latestCliVersion}`} />
+    );
+  }
 };