@mintlify/cli 4.0.1358 → 4.0.1360

package/bin/addDomain.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-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';
 import { authenticatedFetch } from './authenticatedFetch.js';
@@ -19,13 +19,21 @@ import { getCliSubdomains } from './status.js';
 const DNS_POLL_INTERVAL_MS = 5000;
 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 function addDomain(domain) {
+export function addDomain(domain, basePath) {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f, _g;
         if (!DOMAIN_PATTERN.test(domain)) {
             addLog(_jsx(ErrorLog, { message: `invalid domain "${domain}". Expected a bare hostname, e.g. docs.example.com` }));
             return;
         }
+        const normalizedBasePath = normalizeBasePath(basePath === null || basePath === void 0 ? void 0 : basePath.trim());
+        if (normalizedBasePath) {
+            const basePathError = validateCustomDomainBasePath(normalizedBasePath);
+            if (basePathError) {
+                addLog(_jsx(ErrorLog, { message: `invalid base path "${basePath}": ${basePathError}` }));
+                return;
+            }
+        }
         const accessToken = yield getAccessToken();
         if (!accessToken) {
             addLog(_jsx(ErrorLog, { message: "not logged in. Run `mint login` to authenticate." }));
@@ -44,7 +52,7 @@ export function addDomain(domain) {
             const addRes = yield authenticatedFetch(`${API_URL}/api/cli/deployment/custom-domain/${subdomain}/${domain}`, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
-                body: JSON.stringify({ basePath: '' }),
+                body: JSON.stringify({ basePath: normalizedBasePath ? '/docs' : '' }),
             });
             if (!addRes.ok) {
                 const body = yield addRes.json().catch(() => ({}));
@@ -52,10 +60,37 @@ export function addDomain(domain) {
                 return;
             }
         }
-        catch (_d) {
+        catch (_h) {
             addLog(_jsx(ErrorLog, { message: "could not reach the server" }));
             return;
         }
+        let basePathSaved = false;
+        let basePathPending = false;
+        if (normalizedBasePath) {
+            addLog(_jsx(SpinnerLog, { message: `setting base path to ${normalizedBasePath}...` }));
+            try {
+                const basePathRes = yield 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 = (yield basePathRes.json().catch(() => ({})));
+                    basePathSaved = true;
+                    basePathPending = Boolean(body.pendingBasePathUpdate);
+                }
+                else {
+                    const body = (yield basePathRes.json().catch(() => ({})));
+                    const reason = (_e = (_d = (_c = (_b = body.issues) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.message) !== null && _d !== void 0 ? _d : body.error) !== null && _e !== void 0 ? _e : 'unknown error';
+                    addLog(_jsx(ErrorLog, { message: `domain added, but base path was not saved: ${reason}` }));
+                }
+            }
+            catch (_j) {
+                removeLastLog();
+                addLog(_jsx(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(_jsx(SpinnerLog, { message: `waiting for DNS records to generate (up to ${maxWaitSeconds}s)...` }));
         let dnsRecords = [];
@@ -65,7 +100,7 @@ export function addDomain(domain) {
                 const checkRes = yield authenticatedFetch(`${API_URL}/api/cli/deployment/custom-domain/${subdomain}/${domain}`);
                 if (checkRes.ok) {
                     const body = (yield checkRes.json());
-                    dnsRecords = (_c = (_b = body.cloudflare) === null || _b === void 0 ? void 0 : _b.dnsRecords) !== null && _c !== void 0 ? _c : [];
+                    dnsRecords = (_g = (_f = body.cloudflare) === null || _f === void 0 ? void 0 : _f.dnsRecords) !== null && _g !== void 0 ? _g : [];
                     const stillGenerating = dnsRecords.some((record) => record.value === 'loading');
                     if (dnsRecords.length > 0 && !stillGenerating) {
                         recordsReady = true;
@@ -77,14 +112,19 @@ export function addDomain(domain) {
                 }
             }
         }
-        catch (_e) {
+        catch (_k) {
             removeLastLog();
             addLog(_jsx(ErrorLog, { message: "domain added, but could not fetch DNS records" }));
             return;
         }
         removeLastLog();
         const readyTxtRecords = dnsRecords.filter((record) => record.type === 'TXT' && record.value !== 'loading');
-        addLog(_jsx(SuccessLog, { message: `domain ${domain} added` }));
-        addLog(_jsxs(Box, { flexDirection: "column", gap: 1, paddingY: 1, children: [_jsx(Text, { bold: true, children: "Add these DNS records with your domain provider:" }), _jsxs(Box, { flexDirection: "column", paddingLeft: 3, children: [readyTxtRecords.map((record) => (_jsxs(Text, { children: ["TXT ", getRelativeRecordName(record.domain, domain), " \u2192 ", record.value] }, record.domain))), _jsxs(Text, { children: ["CNAME ", getRelativeRecordName(domain, domain), " \u2192 ", CUSTOM_DOMAIN_CNAME_TARGET] })] }), _jsx(Text, { dimColor: true, children: "Add the TXT records first; add the CNAME once they're validated." }), !recordsReady && (_jsx(Text, { dimColor: true, children: "Some TXT records are still being generated. Check the dashboard in a moment for the rest." }))] }));
+        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(_jsx(SuccessLog, { message: successMessage }));
+        addLog(_jsxs(Box, { flexDirection: "column", gap: 1, paddingY: 1, children: [_jsx(Text, { bold: true, children: "Add these DNS records with your domain provider:" }), _jsxs(Box, { flexDirection: "column", paddingLeft: 3, children: [readyTxtRecords.map((record) => (_jsxs(Text, { children: ["TXT ", getRelativeRecordName(record.domain, domain), " \u2192 ", record.value] }, record.domain))), _jsxs(Text, { children: ["CNAME ", getRelativeRecordName(domain, domain), " \u2192 ", CUSTOM_DOMAIN_CNAME_TARGET] })] }), _jsx(Text, { dimColor: true, children: "Add the TXT records first; add the CNAME once they're validated." }), basePathPending && (_jsx(Text, { dimColor: true, children: "The base path takes effect when that deploy finishes; the current path stays up until then." })), basePathSaved && (_jsxs(Text, { dimColor: true, children: ["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"] })), !recordsReady && (_jsx(Text, { dimColor: true, children: "Some TXT records are still being generated. Check the dashboard in a moment for the rest." }))] }));
     });
 }

package/bin/cli.js

@@ -372,12 +372,17 @@ export const cli = ({ packageName = 'mint' }) => {
         });
         yield terminate(0);
     }))
-        .command('add-domain <domain>', 'Add a custom domain to your deployment', (yargs) => yargs.positional('domain', {
+        .command('add-domain <domain>', 'Add a custom domain to your deployment', (yargs) => 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)',
     }), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-        yield addDomain(argv.domain);
+        yield addDomain(argv.domain, argv.basePath);
         yield terminate(0);
     }))
         .command('config', 'Manage CLI configuration', (yargs) => yargs