@mintlify/previewing 4.0.1552 → 4.0.1553

package/dist/__tests__/constants.test.js

@@ -18,6 +18,17 @@ describe('configurePreviewPath', () => {
         expect(constants.CLIENT_PATH).toBe(path.join(constants.MINT_PATH, 'apps', 'client'));
         expect(constants.TAR_PATH).toBe(path.join(constants.PREVIEW_PATH, 'mint.tar.gz'));
     });
+    it('keeps the beta vite client and its content apart from the next preview', () => {
+        constants.configurePreviewPath(3000, 'vite');
+        expect(constants.CLIENT_FRAMEWORK).toBe('vite');
+        expect(constants.PREVIEW_PATH).toBe(path.join(constants.DOT_MINTLIFY, 'previews', '3000-beta'));
+        expect(constants.CLIENT_PATH).toBe(path.join(constants.MINT_PATH, 'apps', 'client-vite'));
+        expect(constants.NEXT_PUBLIC_PATH).toBe(path.join(constants.CLIENT_PATH, '.mint-cli', 'public'));
+        expect(constants.NEXT_PROPS_PATH).toBe(path.join(constants.CLIENT_PATH, '.mint-cli', 'src', '_props'));
+        constants.configurePreviewPath(3000);
+        expect(constants.CLIENT_FRAMEWORK).toBe('next');
+        expect(constants.NEXT_PUBLIC_PATH).toBe(path.join(constants.CLIENT_PATH, 'public'));
+    });
     it('returns to the same files for a reused port', () => {
         constants.configurePreviewPath(4000);
         const firstPath = constants.PREVIEW_PATH;

package/dist/__tests__/listener-graphql-packages.test.js

@@ -16,6 +16,7 @@ vi.mock('../constants.js', async (importOriginal) => {
         ...actual,
         CMD_EXEC_PATH: join(root, 'docs'),
         CLIENT_PATH: join(root, 'client'),
+        CONTENT_PATH: join(root, 'client'),
         NEXT_PROPS_PATH: join(root, 'client', 'src', '_props'),
         NEXT_PUBLIC_PATH: join(root, 'client', 'public'),
     };

package/dist/__tests__/listener-package-manifest.test.js

@@ -18,6 +18,7 @@ vi.mock('../constants.js', async (importOriginal) => {
         ...actual,
         CMD_EXEC_PATH: join(root, 'docs'),
         CLIENT_PATH: join(root, 'client'),
+        CONTENT_PATH: join(root, 'client'),
         NEXT_PROPS_PATH: join(root, 'client', 'src', '_props'),
         NEXT_PUBLIC_PATH: join(root, 'client', 'public'),
     };

package/dist/constants.d.ts

@@ -6,13 +6,16 @@ export declare let PREVIEW_LAST_PATH: string;
 export declare let MINT_PATH: string;
 export declare let VERSION_PATH: string;
 export declare let CLIENT_PATH: string;
+export declare let CONTENT_PATH: string;
 export declare let NEXT_SIDE_EFFECT_PATH: string;
 export declare let NEXT_ROUTER_SERVER_PATH: string;
 export declare let NEXT_CONFIG_PATH: string;
 export declare let NEXT_PUBLIC_PATH: string;
 export declare let NEXT_PROPS_PATH: string;
 export declare let TAR_PATH: string;
-export declare const configurePreviewPath: (port?: string | number) => void;
+export type ClientFramework = 'next' | 'vite';
+export declare let CLIENT_FRAMEWORK: ClientFramework;
+export declare const configurePreviewPath: (port?: string | number, framework?: ClientFramework) => void;
 export declare const configureSharedPreviewPath: () => void;
 export declare const MINT_CLIENT_RELEASES_CLOUDFRONT_URL = "https://releases.mintlify.com";
 export declare const TARGET_MINT_VERSION_URL = "https://releases.mintlify.com/mint-version.txt";

package/dist/constants.js

@@ -10,34 +10,38 @@ export let PREVIEW_LAST_PATH;
 export let MINT_PATH;
 export let VERSION_PATH;
 export let CLIENT_PATH;
+export let CONTENT_PATH;
 export let NEXT_SIDE_EFFECT_PATH;
 export let NEXT_ROUTER_SERVER_PATH;
 export let NEXT_CONFIG_PATH;
 export let NEXT_PUBLIC_PATH;
 export let NEXT_PROPS_PATH;
 export let TAR_PATH;
-const setPreviewPath = (name) => {
-    PREVIEW_PATH = path.join(DOT_MINTLIFY, 'previews', name);
+export let CLIENT_FRAMEWORK = 'next';
+const setPreviewPath = (name, framework = 'next') => {
+    CLIENT_FRAMEWORK = framework;
+    PREVIEW_PATH = path.join(DOT_MINTLIFY, 'previews', framework === 'vite' ? `${name}-beta` : name);
     PREVIEW_LAST_PATH = `${PREVIEW_PATH}-last`;
     MINT_PATH = path.join(PREVIEW_PATH, 'mint');
     VERSION_PATH = path.join(MINT_PATH, 'mint-version.txt');
-    CLIENT_PATH = path.join(MINT_PATH, 'apps', 'client');
+    CLIENT_PATH = path.join(MINT_PATH, 'apps', framework === 'vite' ? 'client-vite' : 'client');
+    CONTENT_PATH = framework === 'vite' ? path.join(CLIENT_PATH, '.mint-cli') : CLIENT_PATH;
     const nextDistServerPath = path.join(MINT_PATH, 'node_modules', 'next', 'dist', 'server');
     NEXT_SIDE_EFFECT_PATH = path.join(nextDistServerPath, 'next.js');
     NEXT_ROUTER_SERVER_PATH = path.join(nextDistServerPath, 'lib', 'router-server.js');
     NEXT_CONFIG_PATH = path.join(CLIENT_PATH, '.next', 'required-server-files.json');
-    NEXT_PUBLIC_PATH = path.join(CLIENT_PATH, 'public');
-    NEXT_PROPS_PATH = path.join(CLIENT_PATH, 'src', '_props');
+    NEXT_PUBLIC_PATH = path.join(CONTENT_PATH, 'public');
+    NEXT_PROPS_PATH = path.join(CONTENT_PATH, 'src', '_props');
     TAR_PATH = path.join(PREVIEW_PATH, 'mint.tar.gz');
 };
 // A port can only belong to one local server at a time, so it gives each running
 // preview an isolated workspace while still allowing warm starts to reuse files.
-export const configurePreviewPath = (port = 3000) => {
+export const configurePreviewPath = (port = 3000, framework = 'next') => {
     const numericPort = Number(port);
     if (!Number.isInteger(numericPort) || numericPort < 1 || numericPort > 65535) {
         throw new Error(`invalid preview port: ${port}`);
     }
-    setPreviewPath(String(numericPort));
+    setPreviewPath(String(numericPort), framework);
 };
 export const configureSharedPreviewPath = () => {
     setPreviewPath('shared');

package/dist/local-preview/index.js

@@ -2,7 +2,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { getFileListSync, prebuild } from '@mintlify/prebuild';
 import fse, { pathExists } from 'fs-extra';
 import pathUtil from 'path';
-import { CLIENT_PATH, CMD_EXEC_PATH, VERSION_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, PREVIEW_PATH, configurePreviewPath, } from '../constants.js';
+import { CLIENT_FRAMEWORK, CMD_EXEC_PATH, CONTENT_PATH, VERSION_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, PREVIEW_PATH, configurePreviewPath, } from '../constants.js';
 import { addLog, clearLogs } from '../logging-state.js';
 import { ErrorLog, SpinnerLog } from '../logs.js';
 import { seedPreviewFromShared } from '../util.js';
@@ -41,6 +41,12 @@ const startDev = async (argv) => {
     const cliVersion = argv.cliVersion;
     const disableOpenApi = argv.disableOpenapi;
     const disablePrefetch = argv.disablePrefetch;
+    if (CLIENT_FRAMEWORK === 'vite' && !localClientVersion) {
+        clearLogs();
+        addLog(_jsx(ErrorLog, { message: `${packageName} dev --beta needs --local-client-version until beta clients are released.` }));
+        await new Promise((resolve) => setTimeout(resolve, 50));
+        process.exit(1);
+    }
     await timeDev('ensure preview directory', () => fse.ensureDir(PREVIEW_PATH));
     if (!localClientVersion && !clientVersion) {
         timeDevSync('seed preview from shared workspace', () => seedPreviewFromShared());
@@ -88,8 +94,9 @@ const startDev = async (argv) => {
             prunePublicOrphans();
         }
     });
-    timeDevSync('switch to local client directory', () => {
-        process.chdir(CLIENT_PATH);
+    await timeDev('switch to local client directory', async () => {
+        await fse.ensureDir(CONTENT_PATH);
+        process.chdir(CONTENT_PATH);
     });
     let fileImportsMap;
     try {
@@ -116,7 +123,7 @@ const startDev = async (argv) => {
 };
 const dev = async (argv) => {
     const port = Number(argv.port ?? 3000);
-    configurePreviewPath(port);
+    configurePreviewPath(port, argv.beta === true ? 'vite' : 'next');
     const releasePreviewLock = acquirePreviewLock(port);
     try {
         await startDev(argv);

package/dist/local-preview/listener/getDocsState.js

@@ -2,8 +2,8 @@ import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivis
 import { upgradeToDocsConfig } from '@mintlify/validation';
 import fse from 'fs-extra';
 import { join } from 'path';
-import { CMD_EXEC_PATH, CLIENT_PATH } from '../../constants.js';
-export const getDocsState = async (onError, { contentDirectory = CMD_EXEC_PATH, clientDirectory = CLIENT_PATH, } = {}) => {
+import { CMD_EXEC_PATH, CONTENT_PATH } from '../../constants.js';
+export const getDocsState = async (onError, { contentDirectory = CMD_EXEC_PATH, clientDirectory = CONTENT_PATH, } = {}) => {
     const mintIgnore = await getMintIgnore(contentDirectory);
     const docsJsonConfigPath = join(contentDirectory, 'docs.json');
     const explicitOverlays = await readExplicitOverlayConfig((await fse.pathExists(docsJsonConfigPath))

package/dist/local-preview/listener/index.js

@@ -9,7 +9,7 @@ import fse from 'fs-extra';
 import fs from 'fs/promises';
 import yaml from 'js-yaml';
 import pathUtil from 'path';
-import { CMD_EXEC_PATH, NEXT_PROPS_PATH, NEXT_PUBLIC_PATH, CLIENT_PATH } from '../../constants.js';
+import { CMD_EXEC_PATH, CONTENT_PATH, NEXT_PROPS_PATH, NEXT_PUBLIC_PATH } from '../../constants.js';
 import { addChangeLog, addErrorLog, clearErrorLogs, getCurrentErrorLogs, } from '../../logging-state.js';
 import { AddedLog, DeletedLog, EditedLog, WarningLog, InfoLog, ErrorLog } from '../../logs.js';
 import { reportPageCompileError, reportPageCompileSuccess } from '../on-demand-page.js';
@@ -69,11 +69,11 @@ const writeDocsConfigWithCurrentNavigation = async (docsConfig) => {
     const propsDocsJsonPath = pathUtil.join(NEXT_PROPS_PATH, 'docs.json');
     try {
         const currentDocsConfig = await readJsonFile(propsDocsJsonPath);
-        await DocsConfigUpdater.writeConfigFile({ ...docsConfig, navigation: currentDocsConfig.navigation }, CLIENT_PATH);
+        await DocsConfigUpdater.writeConfigFile({ ...docsConfig, navigation: currentDocsConfig.navigation }, CONTENT_PATH);
         return;
     }
     catch { }
-    await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+    await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
 };
 const getCurrentRawDocsConfig = async () => {
     const docsJsonPath = pathUtil.join(CMD_EXEC_PATH, 'docs.json');
@@ -202,9 +202,9 @@ const onUnlinkEvent = async (filename, triggerRefresh, options) => {
                 const { mintConfig, openApiFiles, docsConfig } = await getDocsState(handleParseError);
                 await refreshTrackedReferencedFiles();
                 if (mintConfig) {
-                    await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                    await MintConfigUpdater.writeConfigFile(mintConfig, CONTENT_PATH);
                 }
-                await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+                await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
                 await updateOpenApiFiles(openApiFiles, suppressParseError);
                 await updateCustomLanguages(docsConfig, suppressParseError);
                 await updateGeneratedNav(suppressParseError);
@@ -256,9 +256,9 @@ const onUnlinkEvent = async (filename, triggerRefresh, options) => {
                 try {
                     const { mintConfig, openApiFiles, docsConfig } = await getDocsState(handleParseError);
                     if (mintConfig) {
-                        await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                        await MintConfigUpdater.writeConfigFile(mintConfig, CONTENT_PATH);
                     }
-                    await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+                    await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
                     await updateOpenApiFiles(openApiFiles, suppressParseError);
                     await updateGeneratedNav(suppressParseError);
                     triggerRefresh();
@@ -406,9 +406,9 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
             const { mintConfig, openApiFiles, docsConfig, pagesAcc } = await getDocsState(handleParseError);
             await refreshTrackedReferencedFiles();
             if (mintConfig) {
-                await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                await MintConfigUpdater.writeConfigFile(mintConfig, CONTENT_PATH);
             }
-            await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+            await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
             await updateOpenApiFiles(openApiFiles, suppressParseError);
             await updateCustomLanguages(docsConfig, suppressParseError);
             await updateGeneratedNav(suppressParseError, { pagesAcc, docsConfig });
@@ -524,13 +524,13 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
                         // returns the API-expanded config, which we then persist.
                         await updateCustomLanguages(docsConfig, suppressParseError);
                         const generatedDocsConfig = await updateGeneratedNavFromPageMetadataCache(docsConfig, suppressParseError, { reuseGeneratedMetadata: true });
-                        await DocsConfigUpdater.writeConfigFile(generatedDocsConfig, CLIENT_PATH);
+                        await DocsConfigUpdater.writeConfigFile(generatedDocsConfig, CONTENT_PATH);
                     }
                     else if (shouldRegenerateGeneratedData) {
                         // Preserve the old full-rebuild route for top-level api, API-derived
                         // navigation, and top-level api removals.
                         const docsState = await getDocsState(handleParseError);
-                        await DocsConfigUpdater.writeConfigFile(docsState.docsConfig, CLIENT_PATH);
+                        await DocsConfigUpdater.writeConfigFile(docsState.docsConfig, CONTENT_PATH);
                         await updateOpenApiFiles(docsState.openApiFiles, suppressParseError);
                         await updateCustomLanguages(docsState.docsConfig, suppressParseError);
                         await updateGeneratedNav(suppressParseError, {
@@ -570,9 +570,9 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
                 await refreshTrackedReferencedFiles();
                 const { mintConfig, openApiFiles, docsConfig } = await getDocsState(handleParseError);
                 if (mintConfig) {
-                    await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                    await MintConfigUpdater.writeConfigFile(mintConfig, CONTENT_PATH);
                 }
-                await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+                await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
                 await updateOpenApiFiles(openApiFiles, suppressParseError);
                 await updateCustomLanguages(docsConfig, suppressParseError);
             }
@@ -690,7 +690,7 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
         const docsConfig = rawDocsConfig ?? (await getCurrentDocsConfig());
         if (hasDocsConfigApiRoutes(docsConfig)) {
             const generatedDocsConfig = await updateGeneratedNav(suppressParseError);
-            await DocsConfigUpdater.writeConfigFile(generatedDocsConfig, CLIENT_PATH);
+            await DocsConfigUpdater.writeConfigFile(generatedDocsConfig, CONTENT_PATH);
         }
         else {
             await updateGeneratedNavFromPageMetadataCache(docsConfig, suppressParseError);
@@ -699,7 +699,7 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
     else if (regenerateNav) {
         // TODO: Instead of re-generating the entire nav, optimize by just updating the specific page that changed.
         const docsConfig = await updateGeneratedNav(suppressParseError);
-        await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+        await DocsConfigUpdater.writeConfigFile(docsConfig, CONTENT_PATH);
     }
     triggerRefresh();
     return category;

package/dist/local-preview/run.js

@@ -3,7 +3,7 @@ import open from 'better-opn';
 import express from 'express';
 import { createServer } from 'http';
 import { Server as SocketServer } from 'socket.io';
-import { CMD_EXEC_PATH, NEXT_PUBLIC_PATH } from '../constants.js';
+import { CLIENT_FRAMEWORK, CMD_EXEC_PATH, NEXT_PUBLIC_PATH } from '../constants.js';
 import { addLog, removeSpinnerLogs } from '../logging-state.js';
 import { LaunchLog, SearchDisabledLog, UpdateLog } from '../logs.js';
 import { maybeFixMissingWindowsEnvVar } from '../util.js';
@@ -14,6 +14,7 @@ import { getLocalNetworkIp } from './network.js';
 import { ensurePageCompiled, getFailedCompileEvents, markOnDemandPagesReady, setCompileListener, } from './on-demand-page.js';
 import { packageRoute, setPackagesRebuiltListener } from './packages/index.js';
 import { setupNext } from './setupNext.js';
+import { setupVite } from './setupVite.js';
 const PROXY_RESPONSE_HEADER_DENYLIST = new Set([
     'connection',
     'keep-alive',
@@ -52,8 +53,6 @@ export const run = async (argv) => {
     const server = createServer(app);
     const io = new SocketServer(server);
     process.env.LOCAL_OG_PREVIEW = 'true';
-    const requestHandler = await timeDev('setup Next handler', () => setupNext());
-    const localIp = getLocalNetworkIp();
     const apiUrl = argv.apiUrl ?? process.env.MINTLIFY_API_URL ?? 'http://localhost:5000';
     const accessToken = argv.accessToken;
     const subdomain = argv.subdomain;
@@ -61,6 +60,8 @@ export const run = async (argv) => {
     process.env.MINTLIFY_API_URL = apiUrl;
     if (subdomain)
         process.env.MINTLIFY_CLI_SUBDOMAIN = subdomain;
+    const requestHandler = await timeDev('setup client handler', () => CLIENT_FRAMEWORK === 'vite' ? setupVite() : setupNext());
+    const localIp = getLocalNetworkIp();
     app.use(packageRoute.prefix, packageRoute.handler);
     // next-server is bugged, public files added after starting aren't served
     app.use('/', express.static(NEXT_PUBLIC_PATH));

package/dist/local-preview/setupVite.d.ts

@@ -0,0 +1,4 @@
+import type { IncomingMessage, ServerResponse } from 'node:http';
+type RequestListener = (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+export declare const setupVite: () => Promise<RequestListener>;
+export {};

package/dist/local-preview/setupVite.js

@@ -0,0 +1,14 @@
+import fse from 'fs-extra';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { CLIENT_PATH } from '../constants.js';
+export const setupVite = async () => {
+    const entryPath = path.join(CLIENT_PATH, 'dist-cli', 'index.js');
+    if (!(await fse.pathExists(entryPath))) {
+        throw new Error(`Client not built. Run: cd <path>/apps/client-vite && pnpm build:cli`);
+    }
+    const entry = await import(pathToFileURL(entryPath).href);
+    if (!entry.createCliHandler)
+        throw new Error(`${entryPath} does not export createCliHandler`);
+    return entry.createCliHandler();
+};

package/dist/local-preview/update.js

@@ -2,7 +2,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { spawn } from 'child_process';
 import fse from 'fs-extra';
 import path from 'path';
-import { LOCAL_LINKED_CLI_VERSION, MINT_PATH, PREVIEW_PATH, CLIENT_PATH } from '../constants.js';
+import { CLIENT_FRAMEWORK, LOCAL_LINKED_CLI_VERSION, MINT_PATH, PREVIEW_PATH, CLIENT_PATH, } from '../constants.js';
 import { clearLogs, addLog } from '../logging-state.js';
 import { SpinnerLog } from '../logs.js';
 import { getLatestClientVersion, tryDownloadTargetMint, getCompatibleClientVersion, } from './client.js';
@@ -17,15 +17,16 @@ const buildClient = async () => {
     return new Promise((resolve) => {
         clearLogs();
         addLog(_jsx(SpinnerLog, { message: "building local client (this may take a few minutes)..." }));
-        const buildProcess = spawn('pnpm', ['build'], {
+        const vite = CLIENT_FRAMEWORK === 'vite';
+        const buildProcess = spawn('pnpm', [vite ? 'build:cli' : 'build'], {
             cwd: CLIENT_PATH,
             env: {
                 ...process.env,
-                STANDALONE_BUILD: 'true',
+                ...(!vite && { STANDALONE_BUILD: 'true' }),
                 NEXT_PUBLIC_ENV: 'cli',
                 NEXT_PUBLIC_IS_LOCAL_CLIENT: 'true',
             },
-            stdio: 'pipe',
+            stdio: ['ignore', 'ignore', 'pipe'],
             shell: true,
         });
         let stderr = '';