@mintlify/previewing 4.0.562 → 4.0.564

package/dist/__tests__/dev.test.js

@@ -52,9 +52,10 @@ const runMock = vi.mocked(run);
 const buildLoggerMock = vi.mocked(utils.buildLogger);
 const processExitMock = mockProcessExit();
 const downloadTargetMintMock = vi.mocked(downloadTargetMint);
-const emptyYargs = {
+const defaultYargs = {
     _: [],
     $0: '',
+    packageName: 'mintlify',
 };
 describe('dev', () => {
     beforeEach(() => {
@@ -65,7 +66,7 @@ describe('dev', () => {
         process.chdir = originalChdir;
     });
     it('happy path', async () => {
-        await dev(emptyYargs);
+        await dev(defaultYargs);
         expect(buildLoggerMock).toHaveBeenCalledWith('Preparing local Mintlify instance...');
         expect(prebuildMock).toHaveBeenCalled();
         expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
@@ -74,52 +75,65 @@ describe('dev', () => {
     it('prebuild fails', async () => {
         const errorText = 'Some OpenAPI or docs.json schema error';
         prebuildMock.mockRejectedValueOnce(new Error(errorText));
-        await dev(emptyYargs);
+        await dev(defaultYargs);
         expect(buildLoggerMock).toHaveBeenCalledWith('Preparing local Mintlify instance...');
         expect(buildLoggerMock().fail).toHaveBeenCalledWith(errorText);
         expect(processExitMock).toHaveBeenCalledWith(1);
     });
-});
-describe('dev with no internet', () => {
-    beforeEach(() => {
-        process.chdir = vi.fn();
-        vi.clearAllMocks();
-    });
-    afterEach(() => {
-        process.chdir = originalChdir;
+    it('fails if no existing client version and no internet', async () => {
+        vi.mocked(isOnline).mockResolvedValueOnce(false);
+        vi.mocked(fse.pathExists).mockResolvedValueOnce();
+        await dev(defaultYargs).catch(() => { });
+        expect(processExitMock).toHaveBeenCalledWith(1);
+        expect(buildLoggerMock().fail).toHaveBeenCalledWith('Running mintlify dev after updating requires an internet connection.');
     });
-    it('fails if no existing version', async () => {
+    it('fails if no existing client version and no internet - mint command', async () => {
         vi.mocked(isOnline).mockResolvedValueOnce(false);
         vi.mocked(fse.pathExists).mockResolvedValueOnce();
-        await dev(emptyYargs).catch(() => { });
+        await dev({ ...defaultYargs, packageName: 'mint' }).catch(() => { });
         expect(processExitMock).toHaveBeenCalledWith(1);
-        expect(buildLoggerMock().fail).toHaveBeenCalledWith('Running mintlify dev afer updating requires an internet connection.');
+        expect(buildLoggerMock().fail).toHaveBeenCalledWith('Running mint dev after updating requires an internet connection.');
     });
     it('has existing version but fails to get targetMintVersion', async () => {
         vi.mocked(isOnline).mockResolvedValueOnce(false);
         vi.mocked(getTargetMintVersion).mockResolvedValueOnce(undefined);
-        await dev(emptyYargs);
+        await dev(defaultYargs);
         expect(buildLoggerMock().warn).toHaveBeenCalledWith('Failed to get latest Mintlify client version. Your current version is: 1.0.0, which may not be the latest Mintlify client version.');
         expect(prebuildMock).toHaveBeenCalled();
         expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
         expect(runMock).toHaveBeenCalled();
     });
-});
-describe('dev downloads new version', () => {
-    beforeEach(() => {
-        process.chdir = vi.fn();
-        vi.clearAllMocks();
-    });
-    afterEach(() => {
-        process.chdir = originalChdir;
+    it('downloads client with --client-version arg', async () => {
+        await dev({ ...defaultYargs, 'client-version': '1.0.3' });
+        expect(buildLoggerMock).toHaveBeenCalledWith('Preparing local Mintlify instance...');
+        expect(downloadTargetMintMock).toHaveBeenCalled();
+        expect(prebuildMock).toHaveBeenCalled();
+        expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
+        expect(runMock).toHaveBeenCalled();
     });
-    it('happy path', async () => {
-        vi.mocked(getTargetMintVersion).mockResolvedValueOnce('1.0.1');
-        await dev(emptyYargs);
+    it('downloads client if no existing version', async () => {
+        vi.mocked(fse.pathExists).mockResolvedValueOnce();
+        await dev(defaultYargs);
         expect(buildLoggerMock).toHaveBeenCalledWith('Preparing local Mintlify instance...');
         expect(downloadTargetMintMock).toHaveBeenCalled();
         expect(prebuildMock).toHaveBeenCalled();
         expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
         expect(runMock).toHaveBeenCalled();
     });
+    it('warns about update if target version is different from existing version', async () => {
+        vi.mocked(getTargetMintVersion).mockResolvedValueOnce('1.0.1');
+        await dev(defaultYargs);
+        expect(buildLoggerMock().warn).toHaveBeenCalledWith('An update is available. Run `mintlify update` to update to the latest version.');
+        expect(prebuildMock).toHaveBeenCalled();
+        expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
+        expect(runMock).toHaveBeenCalled();
+    });
+    it('warns about update if target version is different from existing version - mint command', async () => {
+        vi.mocked(getTargetMintVersion).mockResolvedValueOnce('1.0.1');
+        await dev({ ...defaultYargs, packageName: 'mint' });
+        expect(buildLoggerMock().warn).toHaveBeenCalledWith('An update is available. Run `mint update` to update to the latest version.');
+        expect(prebuildMock).toHaveBeenCalled();
+        expect(buildLoggerMock().succeed).toHaveBeenCalledWith('Local Mintlify instance is ready. Launching your site...');
+        expect(runMock).toHaveBeenCalled();
+    });
 });

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { getTargetMintVersion, downloadTargetMint } from './local-preview/client.js';
 import dev from './local-preview/index.js';
 import { getClientVersion } from './util.js';
-export { dev, getClientVersion };
+export { dev, getClientVersion, getTargetMintVersion, downloadTargetMint };

package/dist/index.js

@@ -1,3 +1,4 @@
+import { getTargetMintVersion, downloadTargetMint } from './local-preview/client.js';
 import dev from './local-preview/index.js';
 import { getClientVersion } from './util.js';
-export { dev, getClientVersion };
+export { dev, getClientVersion, getTargetMintVersion, downloadTargetMint };

package/dist/local-preview/index.js

@@ -14,12 +14,13 @@ const dev = async (argv) => {
     const hasInternet = await isOnline();
     const localSchema = argv['local-schema'];
     const clientVersion = argv['client-version'];
+    const packageName = argv.packageName;
     await fse.ensureDir(DOT_MINTLIFY);
     const versionString = (await pathExists(VERSION_PATH))
         ? fse.readFileSync(VERSION_PATH, 'utf8')
         : null;
     if (!versionString && !hasInternet) {
-        logger.fail('Running mintlify dev afer updating requires an internet connection.');
+        logger.fail(`Running ${packageName} dev after updating requires an internet connection.`);
         process.exit(1);
     }
     const targetMintVersion = await getTargetMintVersion(logger);
@@ -27,13 +28,20 @@ const dev = async (argv) => {
         logger.stopAndPersist({ symbol: '✓' });
         logger.warn(`Failed to get latest Mintlify client version. Your current version is: ${versionString?.trim()}, which may not be the latest Mintlify client version.`);
     }
-    const shouldDownload = versionString !== targetMintVersion || clientVersion !== undefined;
-    if (shouldDownload && hasInternet && targetMintVersion) {
-        await downloadTargetMint({
-            logger,
-            targetVersion: clientVersion ?? targetMintVersion,
-            existingVersion: versionString,
-        });
+    // update the client if the user has provided a version with --client-version
+    // or if there is no version and there is internet and the target version is available
+    if (clientVersion !== undefined || (!versionString && hasInternet && targetMintVersion)) {
+        const version = clientVersion ?? targetMintVersion;
+        if (version) {
+            await downloadTargetMint({
+                logger,
+                targetVersion: version,
+                existingVersion: versionString,
+            });
+        }
+    }
+    if (versionString && targetMintVersion && versionString.trim() !== targetMintVersion.trim()) {
+        logger.warn(`An update is available. Run \`${packageName} update\` to update to the latest version.`);
     }
     // clear preexisting prebuild files
     fse.emptyDirSync(NEXT_PUBLIC_PATH);