@mintlify/previewing 4.0.1189 → 4.0.1190

package/dist/local-preview/dev-timing.d.ts

@@ -0,0 +1,4 @@
+export declare const addDevTimingLog: (message: string, detail?: string) => void;
+export declare const startDevTiming: (label: string) => ((status?: string) => void);
+export declare const timeDev: <Result>(label: string, callback: () => Promise<Result>) => Promise<Result>;
+export declare const timeDevSync: <Result>(label: string, callback: () => Result) => Result;

package/dist/local-preview/dev-timing.js

@@ -0,0 +1,62 @@
+import { createElement } from 'react';
+import { addLog, removeLog, replaceLog } from '../logging-state.js';
+import { InfoLog } from '../logs.js';
+// steps faster than this are not worth reading about
+const MIN_LOGGED_DURATION_MS = 100;
+const isDevTimingEnabled = () => process.env.DEV_TIMING === 'true';
+const getElapsedMs = (startTime) => {
+    return Number((process.hrtime.bigint() - startTime) / 1000000n);
+};
+const formatDuration = (durationMs) => {
+    return durationMs < 1000 ? `${durationMs}ms` : `${(durationMs / 1000).toFixed(1)}s`;
+};
+export const addDevTimingLog = (message, detail) => {
+    if (!isDevTimingEnabled()) {
+        return;
+    }
+    addLog(createElement(InfoLog, { message, detail }));
+};
+export const startDevTiming = (label) => {
+    if (!isDevTimingEnabled()) {
+        return () => { };
+    }
+    const startTime = process.hrtime.bigint();
+    const pendingLog = createElement(InfoLog, { message: label, detail: '...' });
+    addLog(pendingLog);
+    return (status) => {
+        const durationMs = getElapsedMs(startTime);
+        if (!status && durationMs < MIN_LOGGED_DURATION_MS) {
+            removeLog(pendingLog);
+            return;
+        }
+        const finishedLog = createElement(InfoLog, {
+            message: `${label}${status ? ` ${status}` : ''}`,
+            detail: `in ${formatDuration(durationMs)}`,
+        });
+        replaceLog(pendingLog, finishedLog);
+    };
+};
+export const timeDev = async (label, callback) => {
+    const finish = startDevTiming(label);
+    try {
+        const result = await callback();
+        finish();
+        return result;
+    }
+    catch (error) {
+        finish('failed');
+        throw error;
+    }
+};
+export const timeDevSync = (label, callback) => {
+    const finish = startDevTiming(label);
+    try {
+        const result = callback();
+        finish();
+        return result;
+    }
+    catch (error) {
+        finish('failed');
+        throw error;
+    }
+};

package/dist/local-preview/index.js

@@ -5,10 +5,11 @@ import isOnline from 'is-online';
 import { CLIENT_PATH, DOT_MINTLIFY, CMD_EXEC_PATH, VERSION_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, } from '../constants.js';
 import { addLog, clearLogs } from '../logging-state.js';
 import { ErrorLog, SpinnerLog } from '../logs.js';
+import { timeDev, timeDevSync } from './dev-timing.js';
 import { run } from './run.js';
 import { silentUpdateClient } from './update.js';
 const dev = async (argv) => {
-    const hasInternet = await isOnline();
+    const hasInternet = await timeDev('check internet', () => isOnline());
     const localSchema = argv['local-schema'];
     const clientVersion = argv['client-version'];
     const localClientVersion = argv['local-client-version'];
@@ -16,10 +17,10 @@ const dev = async (argv) => {
     const groups = argv.groups;
     const cliVersion = argv.cliVersion;
     const disableOpenApi = argv.disableOpenapi;
-    await fse.ensureDir(DOT_MINTLIFY);
-    const versionString = (await pathExists(VERSION_PATH))
-        ? fse.readFileSync(VERSION_PATH, 'utf8')
-        : null;
+    await timeDev('ensure .mintlify directory', () => fse.ensureDir(DOT_MINTLIFY));
+    const versionString = await timeDev('read local client version', async () => {
+        return (await pathExists(VERSION_PATH)) ? fse.readFileSync(VERSION_PATH, 'utf8') : null;
+    });
     if (!versionString && !localClientVersion && !hasInternet) {
         clearLogs();
         addLog(_jsx(ErrorLog, { message: `running ${packageName} dev after updating requires an internet connection.` }));
@@ -27,12 +28,12 @@ const dev = async (argv) => {
         process.exit(1);
     }
     addLog(_jsx(SpinnerLog, { message: "preparing local preview..." }));
-    const { needsUpdate, error } = await silentUpdateClient({
+    const { needsUpdate, error } = await timeDev('update local client', () => silentUpdateClient({
         versionString,
         clientVersion,
         localClientVersion,
         cliVersion,
-    });
+    }));
     if (error) {
         clearLogs();
         addLog(_jsx(ErrorLog, { message: error }));
@@ -40,17 +41,21 @@ const dev = async (argv) => {
         process.exit(1);
     }
     // clear preexisting prebuild files
-    fse.emptyDirSync(NEXT_PUBLIC_PATH);
-    fse.emptyDirSync(NEXT_PROPS_PATH);
-    process.chdir(CLIENT_PATH);
+    timeDevSync('clear prebuild output', () => {
+        fse.emptyDirSync(NEXT_PUBLIC_PATH);
+        fse.emptyDirSync(NEXT_PROPS_PATH);
+    });
+    timeDevSync('switch to local client directory', () => {
+        process.chdir(CLIENT_PATH);
+    });
     let fileImportsMap;
     try {
-        const result = await prebuild(CMD_EXEC_PATH, {
+        const result = await timeDev('prebuild content', () => prebuild(CMD_EXEC_PATH, {
             localSchema,
             groups,
             disableOpenApi,
             allowSourceRefs: true,
-        });
+        }));
         fileImportsMap = result?.fileImportsMap;
     }
     catch (err) {
@@ -60,6 +65,6 @@ const dev = async (argv) => {
         await new Promise((resolve) => setTimeout(resolve, 50));
         process.exit(1);
     }
-    await run({ ...argv, needsUpdate, fileImportsMap });
+    await timeDev('start preview runtime', () => run({ ...argv, needsUpdate, fileImportsMap }));
 };
 export default dev;

package/dist/local-preview/run.js

@@ -4,9 +4,10 @@ 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 { addLog, removeLastLog } from '../logging-state.js';
+import { addLog, removeSpinnerLogs } from '../logging-state.js';
 import { LaunchLog, UpdateLog } from '../logs.js';
 import { maybeFixMissingWindowsEnvVar } from '../util.js';
+import { addDevTimingLog, startDevTiming, timeDev } from './dev-timing.js';
 import listener, { initializeDocsConfigHashCache, initializeFrontmatterHashCache, initializeImportCache, } from './listener/index.js';
 import { refreshTrackedReferencedFiles } from './listener/referencedFiles.js';
 import { getLocalNetworkIp } from './network.js';
@@ -48,7 +49,7 @@ export const run = async (argv) => {
     const app = express();
     const server = createServer(app);
     const io = new SocketServer(server);
-    const requestHandler = await setupNext();
+    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;
@@ -120,8 +121,10 @@ export const run = async (argv) => {
     const onChange = () => {
         io.emit('reload');
     };
+    const finishServerListenTiming = startDevTiming('server ready');
     server.listen(currentPort, () => {
-        removeLastLog();
+        finishServerListenTiming();
+        removeSpinnerLogs();
         if (argv.needsUpdate) {
             addLog(_jsx(UpdateLog, { updateCommand: `${argv.packageName} update` }));
         }
@@ -144,9 +147,10 @@ export const run = async (argv) => {
         process.on('SIGINT', onExit);
         process.on('SIGTERM', onExit);
     });
-    await initializeImportCache(CMD_EXEC_PATH, argv.fileImportsMap);
-    await initializeFrontmatterHashCache();
-    await initializeDocsConfigHashCache();
-    await refreshTrackedReferencedFiles();
+    await timeDev('initialize import cache', () => initializeImportCache(CMD_EXEC_PATH, argv.fileImportsMap));
+    await timeDev('initialize frontmatter cache', () => initializeFrontmatterHashCache());
+    await timeDev('initialize docs config cache', () => initializeDocsConfigHashCache());
+    await timeDev('refresh referenced files', () => refreshTrackedReferencedFiles());
+    addDevTimingLog('watching for file changes');
     listener(onChange);
 };

package/dist/local-preview/validate-build.js

@@ -5,19 +5,20 @@ import isOnline from 'is-online';
 import { CLIENT_PATH, DOT_MINTLIFY, CMD_EXEC_PATH, VERSION_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, } from '../constants.js';
 import { addLog, clearLogs } from '../logging-state.js';
 import { ErrorLog, SpinnerLog, SuccessLog } from '../logs.js';
+import { timeDev, timeDevSync } from './dev-timing.js';
 import { silentUpdateClient } from './update.js';
 const validateBuild = async (argv) => {
-    const hasInternet = await isOnline();
+    const hasInternet = await timeDev('check internet', () => isOnline());
     const localSchema = argv['local-schema'];
     const clientVersion = argv['client-version'];
     const packageName = argv.packageName;
     const groups = argv.groups;
     const cliVersion = argv.cliVersion;
     const disableOpenApi = argv.disableOpenapi;
-    await fse.ensureDir(DOT_MINTLIFY);
-    const versionString = (await pathExists(VERSION_PATH))
-        ? fse.readFileSync(VERSION_PATH, 'utf8')
-        : null;
+    await timeDev('ensure .mintlify directory', () => fse.ensureDir(DOT_MINTLIFY));
+    const versionString = await timeDev('read local client version', async () => {
+        return (await pathExists(VERSION_PATH)) ? fse.readFileSync(VERSION_PATH, 'utf8') : null;
+    });
     if (!versionString && !hasInternet) {
         clearLogs();
         addLog(_jsx(ErrorLog, { message: `running ${packageName} validate-build after updating requires an internet connection.` }));
@@ -25,12 +26,12 @@ const validateBuild = async (argv) => {
         process.exit(1);
     }
     addLog(_jsx(SpinnerLog, { message: "validating build..." }));
-    const { error } = await silentUpdateClient({
+    const { error } = await timeDev('update local client', () => silentUpdateClient({
         versionString,
         clientVersion,
         cliVersion,
         localClientVersion: undefined,
-    });
+    }));
     if (error) {
         clearLogs();
         addLog(_jsx(ErrorLog, { message: error }));
@@ -38,11 +39,15 @@ const validateBuild = async (argv) => {
         process.exit(1);
     }
     // clear preexisting prebuild files
-    fse.emptyDirSync(NEXT_PUBLIC_PATH);
-    fse.emptyDirSync(NEXT_PROPS_PATH);
-    process.chdir(CLIENT_PATH);
+    timeDevSync('clear prebuild output', () => {
+        fse.emptyDirSync(NEXT_PUBLIC_PATH);
+        fse.emptyDirSync(NEXT_PROPS_PATH);
+    });
+    timeDevSync('switch to local client directory', () => {
+        process.chdir(CLIENT_PATH);
+    });
     try {
-        await prebuild(CMD_EXEC_PATH, { localSchema, groups, disableOpenApi, strict: true });
+        await timeDev('prebuild content', () => prebuild(CMD_EXEC_PATH, { localSchema, groups, disableOpenApi, strict: true }));
         clearLogs();
         addLog(_jsx(SuccessLog, { message: "build validation passed" }));
         await new Promise((resolve) => setTimeout(resolve, 50));

package/dist/logging-state.d.ts

@@ -8,4 +8,7 @@ export declare const addRawErrorLog: (message: string) => void;
 export declare const clearErrorLogs: () => void;
 export declare const clearLogs: () => void;
 export declare const removeLastLog: () => void;
+export declare const removeLog: (target: React.ReactNode) => void;
+export declare const replaceLog: (target: React.ReactNode, next: React.ReactNode) => void;
+export declare const removeSpinnerLogs: () => void;
 export declare const getCurrentErrorLogs: () => React.ReactNode[];

package/dist/logging-state.js

@@ -1,6 +1,6 @@
 import { render } from 'ink';
 import React from 'react';
-import { Logs } from './logs.js';
+import { Logs, SpinnerLog } from './logs.js';
 let currentLogs = [];
 let currentChangeLogs = [];
 let currentErrorLogs = [];
@@ -57,6 +57,23 @@ export const removeLastLog = () => {
     currentLogs = currentLogs.slice(0, -1);
     setLogsCallback?.(currentLogs);
 };
+export const removeLog = (target) => {
+    ensureLoggingInstance();
+    currentLogs = currentLogs.filter((log) => log !== target);
+    setLogsCallback?.(currentLogs);
+};
+export const replaceLog = (target, next) => {
+    ensureLoggingInstance();
+    const index = currentLogs.indexOf(target);
+    currentLogs =
+        index === -1 ? [...currentLogs, next] : currentLogs.map((log, i) => (i === index ? next : log));
+    setLogsCallback?.(currentLogs);
+};
+export const removeSpinnerLogs = () => {
+    ensureLoggingInstance();
+    currentLogs = currentLogs.filter((log) => !(React.isValidElement(log) && log.type === SpinnerLog));
+    setLogsCallback?.(currentLogs);
+};
 export const getCurrentErrorLogs = () => {
     return currentErrorLogs;
 };

package/dist/logs.d.ts

@@ -3,8 +3,9 @@ export declare const LaunchLog: ({ localUrl, networkUrl }: {
     localUrl: string;
     networkUrl?: string;
 }) => import("react/jsx-runtime").JSX.Element | null;
-export declare const InfoLog: ({ message }: {
+export declare const InfoLog: ({ message, detail }: {
     message: string;
+    detail?: string;
 }) => import("react/jsx-runtime").JSX.Element | null;
 export declare const SuccessLog: ({ message }: {
     message: string;

package/dist/logs.js

@@ -11,12 +11,12 @@ export const LaunchLog = ({ localUrl, networkUrl }) => {
     }
     return (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsxs(Text, { children: [_jsx(Text, { color: "green", bold: true, children: "\u2713" }), ' ', _jsx(Text, { children: "preview ready" })] }), _jsx(EmptyLineLog, {}), _jsxs(Text, { children: ['\u00A0'.repeat(2), "local", '\u00A0'.repeat(3), "\u2192", '\u00A0'.repeat(1), localUrl] }), networkUrl && (_jsxs(Text, { children: ['\u00A0'.repeat(2), "network", '\u00A0'.repeat(1), "\u2192", '\u00A0'.repeat(1), networkUrl] })), _jsx(EmptyLineLog, {}), _jsxs(Text, { dimColor: true, children: ["press ", _jsx(Text, { bold: true, children: "ctrl+c" }), " to exit the preview"] }), _jsx(EmptyLineLog, {})] }));
 };
-export const InfoLog = ({ message }) => {
+export const InfoLog = ({ message, detail }) => {
     if (process.env.CLI_TEST_MODE === 'true') {
-        console.log(`info ${message}`);
+        console.log(`info ${message}${detail ? ` ${detail}` : ''}`);
         return null;
     }
-    return (_jsxs(Box, { children: [_jsx(Text, { color: "blue", bold: true, children: "info" }), _jsxs(Text, { children: [" ", message] })] }));
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "blue", bold: true, children: "info" }), _jsxs(Text, { children: [" ", message] }), detail && _jsxs(Text, { dimColor: true, children: [" ", detail] })] }));
 };
 export const SuccessLog = ({ message }) => {
     if (process.env.CLI_TEST_MODE === 'true') {