@mintlify/cli 4.0.1341 → 4.0.1343

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1341",
+  "version": "4.0.1343",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,12 +45,12 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1043",
-    "@mintlify/link-rot": "3.0.1236",
+    "@mintlify/common": "1.0.1045",
+    "@mintlify/link-rot": "3.0.1238",
     "@mintlify/models": "0.0.343",
-    "@mintlify/prebuild": "1.0.1191",
-    "@mintlify/previewing": "4.0.1260",
-    "@mintlify/validation": "0.1.799",
+    "@mintlify/prebuild": "1.0.1193",
+    "@mintlify/previewing": "4.0.1262",
+    "@mintlify/validation": "0.1.800",
     "adm-zip": "0.5.16",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -83,7 +83,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.249",
+    "@mintlify/editor": "0.0.251",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/adm-zip": "0.5.7",
@@ -103,5 +103,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "8d31ec350b96cab3712a337498e450d5fb2e30f8"
+  "gitHead": "8abb137ebdfdba53b385f751c5fb9ac79e76dedc"
 }

package/src/addDomain.tsx

@@ -0,0 +1,136 @@
+import { getRelativeRecordName } from '@mintlify/common';
+import { addLog, ErrorLog, removeLastLog, SpinnerLog, SuccessLog } from '@mintlify/previewing';
+import { Box, Text } from 'ink';
+
+import { authenticatedFetch } from './authenticatedFetch.js';
+import { getConfigValue } from './config.js';
+import { API_URL, CUSTOM_DOMAIN_CNAME_TARGET } from './constants.js';
+import { getAccessToken } from './keyring.js';
+import { getCliSubdomains } from './status.js';
+
+interface DnsRecord {
+  type: string;
+  domain: string;
+  value: string;
+  isConfigured?: boolean;
+}
+
+interface CustomDomainCheckResponse {
+  cloudflare?: { dnsRecords?: DnsRecord[] };
+}
+
+const DNS_POLL_INTERVAL_MS = 5_000;
+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> {
+  if (!DOMAIN_PATTERN.test(domain)) {
+    addLog(
+      <ErrorLog
+        message={`invalid domain "${domain}". Expected a bare hostname, e.g. docs.example.com`}
+      />
+    );
+    return;
+  }
+
+  const accessToken = await getAccessToken();
+  if (!accessToken) {
+    addLog(<ErrorLog message="not logged in. Run `mint login` to authenticate." />);
+    return;
+  }
+
+  const subdomains = await getCliSubdomains(accessToken);
+  const configuredSubdomain = getConfigValue('subdomain');
+  const subdomain =
+    configuredSubdomain && subdomains.includes(configuredSubdomain)
+      ? configuredSubdomain
+      : subdomains[0];
+  if (!subdomain) {
+    addLog(<ErrorLog message="no subdomain found. Run `mint status` to check your account." />);
+    return;
+  }
+
+  try {
+    const addRes = await authenticatedFetch(
+      `${API_URL}/api/cli/deployment/custom-domain/${subdomain}/${domain}`,
+      {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ basePath: '' }),
+      }
+    );
+
+    if (!addRes.ok) {
+      const body = await addRes.json().catch(() => ({}));
+      addLog(<ErrorLog message={`could not add domain: ${body.error ?? 'unknown error'}`} />);
+      return;
+    }
+  } catch {
+    addLog(<ErrorLog message="could not reach the server" />);
+    return;
+  }
+
+  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)...`} />
+  );
+
+  let dnsRecords: DnsRecord[] = [];
+  let recordsReady = false;
+  try {
+    for (let attempt = 0; attempt < DNS_POLL_MAX_ATTEMPTS; attempt++) {
+      const checkRes = await authenticatedFetch(
+        `${API_URL}/api/cli/deployment/custom-domain/${subdomain}/${domain}`
+      );
+
+      if (checkRes.ok) {
+        const body = (await checkRes.json()) as CustomDomainCheckResponse;
+        dnsRecords = body.cloudflare?.dnsRecords ?? [];
+
+        const stillGenerating = dnsRecords.some((record) => record.value === 'loading');
+        if (dnsRecords.length > 0 && !stillGenerating) {
+          recordsReady = true;
+          break;
+        }
+      }
+
+      if (attempt < DNS_POLL_MAX_ATTEMPTS - 1) {
+        await new Promise((resolve) => setTimeout(resolve, DNS_POLL_INTERVAL_MS));
+      }
+    }
+  } catch {
+    removeLastLog();
+    addLog(<ErrorLog message="domain added, but could not fetch DNS records" />);
+    return;
+  }
+
+  removeLastLog();
+
+  const readyTxtRecords = dnsRecords.filter(
+    (record) => record.type === 'TXT' && record.value !== 'loading'
+  );
+
+  addLog(<SuccessLog message={`domain ${domain} added`} />);
+  addLog(
+    <Box flexDirection="column" gap={1} paddingY={1}>
+      <Text bold>Add these DNS records with your domain provider:</Text>
+      <Box flexDirection="column" paddingLeft={3}>
+        {readyTxtRecords.map((record) => (
+          <Text key={record.domain}>
+            TXT {getRelativeRecordName(record.domain, domain)} → {record.value}
+          </Text>
+        ))}
+        <Text>
+          CNAME {getRelativeRecordName(domain, domain)} → {CUSTOM_DOMAIN_CNAME_TARGET}
+        </Text>
+      </Box>
+      <Text dimColor>Add the TXT records first; add the CNAME once they're validated.</Text>
+      {!recordsReady && (
+        <Text dimColor>
+          Some TXT records are still being generated. Check the dashboard in a moment for the rest.
+        </Text>
+      )}
+    </Box>
+  );
+}

package/src/cli.tsx

@@ -19,6 +19,7 @@ import yargs, { type Argv } from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
 import { accessibilityCheck } from './accessibilityCheck.js';
+import { addDomain } from './addDomain.js';
 import { comingSoon } from './comingSoon.js';
 import { setTelemetryEnabled } from './config.js';
 import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
@@ -470,6 +471,20 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           await terminate(0);
         }
       )
+      .command(
+        '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)',
+          }),
+        async (argv) => {
+          await addDomain(argv.domain);
+          await terminate(0);
+        }
+      )
       .command('config', 'Manage CLI configuration', (yargs) =>
         yargs
           .command(

package/src/constants.ts

@@ -31,3 +31,5 @@ const PROD_STYTCH_CLIENT_ID = 'connected-app-live-d813eedd-dbb0-434b-a1f9-2ce69e
 
 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;
+
+export const CUSTOM_DOMAIN_CNAME_TARGET = 'cname.mintlify.builders';