@mintlify/previewing 4.0.1514 → 4.0.1516

package/dist/__tests__/validate-build.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/validate-build.test.js

@@ -0,0 +1,58 @@
+import { prebuild } from '@mintlify/prebuild';
+import isOnline from 'is-online';
+import { checkBuild } from '../local-preview/validate-build.js';
+import { addLog } from '../logging-state.js';
+vi.mock('@mintlify/prebuild', async (importOriginal) => {
+    const mod = await importOriginal();
+    return { ...mod, prebuild: vi.fn() };
+});
+vi.mock('is-online', () => ({ default: vi.fn() }));
+vi.mock('fs-extra', () => {
+    const mocks = {
+        ensureDir: vi.fn().mockResolvedValue(undefined),
+        pathExists: vi.fn().mockResolvedValue(true),
+        readFileSync: vi.fn().mockReturnValue('1.0.0'),
+        emptyDirSync: vi.fn(),
+    };
+    return { ...mocks, default: mocks };
+});
+vi.mock('../local-preview/update.js', () => ({
+    silentUpdateClient: vi.fn(async () => ({ needsUpdate: false, error: undefined })),
+}));
+vi.mock('../logging-state.js', async (importOriginal) => {
+    const mod = await importOriginal();
+    return { ...mod, addLog: vi.fn(), clearLogs: vi.fn() };
+});
+const argv = { _: [], $0: 'mint', packageName: 'mint' };
+describe('checkBuild', () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.mocked(isOnline).mockResolvedValue(true);
+        vi.spyOn(process, 'chdir').mockImplementation(() => undefined);
+    });
+    it('passes when prebuild succeeds', async () => {
+        vi.mocked(prebuild).mockResolvedValue(undefined);
+        expect(await checkBuild(argv)).toEqual({ passed: true });
+    });
+    it('returns a build failure instead of exiting', async () => {
+        vi.mocked(prebuild).mockRejectedValue(new Error('boom'));
+        expect(await checkBuild(argv)).toEqual({ passed: false, error: 'boom' });
+    });
+    it.each([
+        ['passes', () => vi.mocked(prebuild).mockResolvedValue(undefined)],
+        ['fails', () => vi.mocked(prebuild).mockRejectedValue(new Error('boom'))],
+    ])('restores the working directory and logs nothing when the build %s', async (_label, mock) => {
+        mock();
+        const cwd = process.cwd();
+        await checkBuild(argv);
+        expect(process.chdir).toHaveBeenLastCalledWith(cwd);
+        expect(addLog).not.toHaveBeenCalled();
+    });
+    it('throws when offline with no client', async () => {
+        const fse = await import('fs-extra');
+        vi.mocked(fse.pathExists).mockResolvedValueOnce(false);
+        vi.mocked(isOnline).mockResolvedValue(false);
+        await expect(checkBuild(argv)).rejects.toThrow('requires an internet connection');
+        expect(prebuild).not.toHaveBeenCalled();
+    });
+});

package/dist/index.d.ts

@@ -2,9 +2,10 @@ import { LOCAL_LINKED_CLI_VERSION } from './constants.js';
 import { getLatestClientVersion, downloadTargetMint, getVersionMap } from './local-preview/client.js';
 import { exportSite } from './local-preview/export.js';
 import dev from './local-preview/index.js';
-import validateBuild from './local-preview/validate-build.js';
+import validateBuild, { checkBuild } from './local-preview/validate-build.js';
+export type { BuildValidationResult } from './local-preview/validate-build.js';
 import { getClientVersion } from './util.js';
 export * from './logs.js';
 export * from './logging-state.js';
 export * from './packages/index.js';
-export { dev, exportSite, validateBuild, getClientVersion, getLatestClientVersion, downloadTargetMint, getVersionMap, LOCAL_LINKED_CLI_VERSION, };
+export { dev, exportSite, validateBuild, checkBuild, getClientVersion, getLatestClientVersion, downloadTargetMint, getVersionMap, LOCAL_LINKED_CLI_VERSION, };

package/dist/index.js

@@ -2,9 +2,9 @@ import { LOCAL_LINKED_CLI_VERSION } from './constants.js';
 import { getLatestClientVersion, downloadTargetMint, getVersionMap, } from './local-preview/client.js';
 import { exportSite } from './local-preview/export.js';
 import dev from './local-preview/index.js';
-import validateBuild from './local-preview/validate-build.js';
+import validateBuild, { checkBuild } from './local-preview/validate-build.js';
 import { getClientVersion } from './util.js';
 export * from './logs.js';
 export * from './logging-state.js';
 export * from './packages/index.js';
-export { dev, exportSite, validateBuild, getClientVersion, getLatestClientVersion, downloadTargetMint, getVersionMap, LOCAL_LINKED_CLI_VERSION, };
+export { dev, exportSite, validateBuild, checkBuild, getClientVersion, getLatestClientVersion, downloadTargetMint, getVersionMap, LOCAL_LINKED_CLI_VERSION, };

package/dist/local-preview/validate-build.d.ts

@@ -1,3 +1,10 @@
 import { ArgumentsCamelCase } from 'yargs';
+export type BuildValidationResult = {
+    passed: true;
+} | {
+    passed: false;
+    error: string;
+};
+export declare const checkBuild: (argv: ArgumentsCamelCase) => Promise<BuildValidationResult>;
 declare const validateBuild: (argv: ArgumentsCamelCase, onSuccess?: () => Promise<void>) => Promise<never>;
 export default validateBuild;

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

@@ -7,7 +7,7 @@ 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, onSuccess) => {
+export const checkBuild = async (argv) => {
     configureSharedPreviewPath();
     const hasInternet = await timeDev('check internet', () => isOnline());
     const localSchema = argv['local-schema'];
@@ -21,12 +21,8 @@ const validateBuild = async (argv, onSuccess) => {
         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.` }));
-        await new Promise((resolve) => setTimeout(resolve, 50));
-        process.exit(1);
+        throw new Error(`running ${packageName} validate-build after updating requires an internet connection.`);
     }
-    addLog(_jsx(SpinnerLog, { message: "validating build..." }));
     const { error } = await timeDev('update local client', () => silentUpdateClient({
         versionString,
         clientVersion,
@@ -34,16 +30,14 @@ const validateBuild = async (argv, onSuccess) => {
         localClientVersion: undefined,
     }));
     if (error) {
-        clearLogs();
-        addLog(_jsx(ErrorLog, { message: error }));
-        await new Promise((resolve) => setTimeout(resolve, 50));
-        process.exit(1);
+        throw new Error(error);
     }
     // clear preexisting prebuild files
     timeDevSync('clear prebuild output', () => {
         fse.emptyDirSync(NEXT_PUBLIC_PATH);
         fse.emptyDirSync(NEXT_PROPS_PATH);
     });
+    const cwd = process.cwd();
     timeDevSync('switch to local client directory', () => {
         process.chdir(CLIENT_PATH);
     });
@@ -55,18 +49,38 @@ const validateBuild = async (argv, onSuccess) => {
             strict: true,
             skipStaticFiles: true,
         }));
+        return { passed: true };
+    }
+    catch (err) {
+        const errorText = err instanceof Error && err.message ? err.message : 'build validation failed';
+        return { passed: false, error: errorText };
+    }
+    finally {
+        process.chdir(cwd);
+    }
+};
+const validateBuild = async (argv, onSuccess) => {
+    addLog(_jsx(SpinnerLog, { message: "validating build..." }));
+    let code;
+    try {
+        const result = await checkBuild(argv);
         clearLogs();
-        addLog(_jsx(SuccessLog, { message: "build validation passed" }));
-        await onSuccess?.();
-        await new Promise((resolve) => setTimeout(resolve, 50));
-        process.exit(0);
+        if (result.passed) {
+            addLog(_jsx(SuccessLog, { message: "build validation passed" }));
+            await onSuccess?.();
+            code = 0;
+        }
+        else {
+            addLog(_jsx(ErrorLog, { message: result.error }));
+            code = 1;
+        }
     }
     catch (err) {
         clearLogs();
-        const errorText = err instanceof Error && err.message ? err.message : 'build validation failed';
-        addLog(_jsx(ErrorLog, { message: errorText }));
-        await new Promise((resolve) => setTimeout(resolve, 50));
-        process.exit(1);
+        addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : String(err) }));
+        code = 2;
     }
+    await new Promise((resolve) => setTimeout(resolve, 50));
+    process.exit(code);
 };
 export default validateBuild;