@mintlify/cli 4.0.1359 → 4.0.1361

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1359",
+  "version": "4.0.1361",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,12 +45,12 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1057",
-    "@mintlify/link-rot": "3.0.1251",
+    "@mintlify/common": "1.0.1059",
+    "@mintlify/link-rot": "3.0.1253",
     "@mintlify/models": "0.0.344",
-    "@mintlify/prebuild": "1.0.1206",
-    "@mintlify/previewing": "4.0.1275",
-    "@mintlify/validation": "0.1.808",
+    "@mintlify/prebuild": "1.0.1208",
+    "@mintlify/previewing": "4.0.1277",
+    "@mintlify/validation": "0.1.809",
     "adm-zip": "0.5.16",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -81,7 +81,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.264",
+    "@mintlify/editor": "0.0.266",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/adm-zip": "0.5.7",
@@ -101,5 +101,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "1b7774aa5f93b4b4bf0229a41cf2bb94512f704d"
+  "gitHead": "01132fcdea1229b4af02723b1cd62a2bae73ecf6"
 }

package/src/addDomain.tsx

@@ -1,4 +1,8 @@
-import { getRelativeRecordName } from '@mintlify/common';
+import {
+  getRelativeRecordName,
+  normalizeBasePath,
+  validateCustomDomainBasePath,
+} from '@mintlify/common';
 import { addLog, ErrorLog, removeLastLog, SpinnerLog, SuccessLog } from '@mintlify/previewing';
 import { Box, Text } from 'ink';
 
@@ -24,7 +28,7 @@ const DNS_POLL_MAX_ATTEMPTS = 3;
 
 const DOMAIN_PATTERN = /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$/i;
 
-export async function addDomain(domain: string): Promise<void> {
+export async function addDomain(domain: string, basePath?: string): Promise<void> {
   if (!DOMAIN_PATTERN.test(domain)) {
     addLog(
       <ErrorLog
@@ -34,6 +38,15 @@ export async function addDomain(domain: string): Promise<void> {
     return;
   }
 
+  const normalizedBasePath = normalizeBasePath(basePath?.trim());
+  if (normalizedBasePath) {
+    const basePathError = validateCustomDomainBasePath(normalizedBasePath);
+    if (basePathError) {
+      addLog(<ErrorLog message={`invalid base path "${basePath}": ${basePathError}`} />);
+      return;
+    }
+  }
+
   const accessToken = await getAccessToken();
   if (!accessToken) {
     addLog(<ErrorLog message="not logged in. Run `mint login` to authenticate." />);
@@ -57,7 +70,7 @@ export async function addDomain(domain: string): Promise<void> {
       {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ basePath: '' }),
+        body: JSON.stringify({ basePath: normalizedBasePath ? '/docs' : '' }),
       }
     );
 
@@ -71,6 +84,44 @@ export async function addDomain(domain: string): Promise<void> {
     return;
   }
 
+  let basePathSaved = false;
+  let basePathPending = false;
+  if (normalizedBasePath) {
+    addLog(<SpinnerLog message={`setting base path to ${normalizedBasePath}...`} />);
+    try {
+      const basePathRes = await authenticatedFetch(
+        `${API_URL}/api/cli/deployment/base-path/${subdomain}`,
+        {
+          method: 'PUT',
+          headers: { 'Content-Type': 'application/json' },
+          body: JSON.stringify({ basePath: normalizedBasePath }),
+        }
+      );
+
+      removeLastLog();
+
+      if (basePathRes.ok) {
+        const body = (await basePathRes.json().catch(() => ({}))) as {
+          pendingBasePathUpdate?: unknown;
+        };
+        basePathSaved = true;
+        basePathPending = Boolean(body.pendingBasePathUpdate);
+      } else {
+        const body = (await basePathRes.json().catch(() => ({}))) as {
+          error?: string;
+          issues?: Array<{ message?: string }>;
+        };
+        const reason = body.issues?.[0]?.message ?? body.error ?? 'unknown error';
+        addLog(<ErrorLog message={`domain added, but base path was not saved: ${reason}`} />);
+      }
+    } catch {
+      removeLastLog();
+      addLog(
+        <ErrorLog message="domain added, but base path was not saved: could not reach the server" />
+      );
+    }
+  }
+
   const maxWaitSeconds = ((DNS_POLL_MAX_ATTEMPTS - 1) * DNS_POLL_INTERVAL_MS) / 1000;
   addLog(
     <SpinnerLog message={`waiting for DNS records to generate (up to ${maxWaitSeconds}s)...`} />
@@ -111,7 +162,13 @@ export async function addDomain(domain: string): Promise<void> {
     (record) => record.type === 'TXT' && record.value !== 'loading'
   );
 
-  addLog(<SuccessLog message={`domain ${domain} added`} />);
+  const successMessage = basePathPending
+    ? `domain ${domain} added; base path ${normalizedBasePath} queued for the next deploy`
+    : basePathSaved
+      ? `domain ${domain} added (serving at ${normalizedBasePath})`
+      : `domain ${domain} added`;
+
+  addLog(<SuccessLog message={successMessage} />);
   addLog(
     <Box flexDirection="column" gap={1} paddingY={1}>
       <Text bold>Add these DNS records with your domain provider:</Text>
@@ -126,6 +183,19 @@ export async function addDomain(domain: string): Promise<void> {
         </Text>
       </Box>
       <Text dimColor>Add the TXT records first; add the CNAME once they're validated.</Text>
+      {basePathPending && (
+        <Text dimColor>
+          The base path takes effect when that deploy finishes; the current path stays up until
+          then.
+        </Text>
+      )}
+      {basePathSaved && (
+        <Text dimColor>
+          The CNAME sends all paths on {domain} to Mintlify. Only add it if this domain hosts
+          nothing else. Otherwise, set up a reverse proxy for {normalizedBasePath}:
+          https://www.mintlify.com/docs/deploy/docs-subpath
+        </Text>
+      )}
       {!recordsReady && (
         <Text dimColor>
           Some TXT records are still being generated. Check the dashboard in a moment for the rest.

package/src/cli.tsx

@@ -482,13 +482,18 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
         'add-domain <domain>',
         'Add a custom domain to your deployment',
         (yargs: Argv) =>
-          yargs.positional('domain', {
-            type: 'string',
-            demandOption: true,
-            description: 'The custom domain to add (e.g. docs.example.com)',
-          }),
+          yargs
+            .positional('domain', {
+              type: 'string',
+              demandOption: true,
+              description: 'The custom domain to add (e.g. docs.example.com)',
+            })
+            .option('basePath', {
+              type: 'string',
+              description: 'Serve the docs under a base path (e.g. /docs)',
+            }),
         async (argv) => {
-          await addDomain(argv.domain);
+          await addDomain(argv.domain, argv.basePath);
           await terminate(0);
         }
       )