@mintlify/previewing 4.0.1522 → 4.0.1523

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

@@ -74,28 +74,15 @@ beforeEach(() => {
     vi.clearAllMocks();
     watcher.handlers = {};
 });
-afterEach(() => {
-    vi.unstubAllEnvs();
-});
 describe('listener package manifest changes', () => {
-    it('treats a root package.json as a potential OpenAPI spec when the flag is off', async () => {
-        vi.stubEnv('MINTLIFY_NATIVE_NPM_PACKAGES', undefined);
-        await change('package.json');
-        expect(notifyPackageInputChange).toHaveBeenCalledWith('package.json', 'potentialJsonOpenApiSpec');
-        expect(validate).toHaveBeenCalledWith(manifest);
-        expect(triggerRefresh).toHaveBeenCalledOnce();
-        edited('package.json');
-    });
-    it('leaves a root package.json to the packages runtime when the flag is on', async () => {
-        vi.stubEnv('MINTLIFY_NATIVE_NPM_PACKAGES', '1');
+    it('leaves a root package.json to the packages runtime', async () => {
         await change('package.json');
         expect(notifyPackageInputChange).toHaveBeenCalledWith('package.json', 'potentialJsonOpenApiSpec');
         expect(validate).not.toHaveBeenCalled();
         expect(triggerRefresh).not.toHaveBeenCalled();
         edited('package.json');
     });
-    it('still parses a nested package.json when the flag is on', async () => {
-        vi.stubEnv('MINTLIFY_NATIVE_NPM_PACKAGES', '1');
+    it('still parses a nested package.json', async () => {
         await change(join('snippets', 'package.json'));
         expect(validate).toHaveBeenCalledWith(manifest);
         expect(triggerRefresh).toHaveBeenCalledOnce();

package/dist/__tests__/{packages-flag.test.js → packages-runtime-wiring.test.js}

@@ -1,9 +1,9 @@
 import { prebuild } from '@mintlify/prebuild';
 import { mockProcessExit } from 'vitest-mock-process';
 import { configurePreviewPath } from '../constants.js';
-import { dev, isNativePackagesEnabled } from '../index.js';
+import { dev } from '../index.js';
 import listener from '../local-preview/listener/index.js';
-import { packageRoute, setPackagesRebuiltListener, startPackagesDev, } from '../local-preview/packages/index.js';
+import { setPackagesRebuiltListener, startPackagesDev } from '../local-preview/packages/index.js';
 const captured = vi.hoisted(() => ({ app: undefined }));
 vi.mock('http', async (importOriginal) => {
     const actual = await importOriginal();
@@ -73,7 +73,6 @@ vi.mock('../local-preview/packages/index.js', () => ({
 const originalChdir = process.chdir;
 const processExitMock = mockProcessExit();
 const argv = { _: [], $0: '', packageName: 'mint', cliVersion: '1.0.0' };
-const setFlag = (value) => vi.stubEnv('MINTLIFY_NATIVE_NPM_PACKAGES', value);
 const startRun = async () => {
     const { run } = await vi.importActual('../local-preview/run.js');
     await run({ ...argv, needsUpdate: false });
@@ -97,39 +96,8 @@ beforeEach(() => {
 });
 afterEach(() => {
     process.chdir = originalChdir;
-    vi.unstubAllEnvs();
 });
-describe('isNativePackagesEnabled', () => {
-    it('is on only when MINTLIFY_NATIVE_NPM_PACKAGES is 1', () => {
-        setFlag(undefined);
-        expect(isNativePackagesEnabled()).toBe(false);
-        setFlag('true');
-        expect(isNativePackagesEnabled()).toBe(false);
-        setFlag('0');
-        expect(isNativePackagesEnabled()).toBe(false);
-        setFlag('1');
-        expect(isNativePackagesEnabled()).toBe(true);
-    });
-});
-describe('mint dev with native npm packages off', () => {
-    beforeEach(() => setFlag(undefined));
-    it('skips the packages runtime and tells prebuild to ignore packages', async () => {
-        await dev(argv);
-        expect(processExitMock).not.toHaveBeenCalled();
-        expect(startPackagesDev).not.toHaveBeenCalled();
-        expect(prebuild).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({ nativePackages: false }));
-    });
-    it('lets /_mintlify/pkg requests fall through to the next handler', async () => {
-        configurePreviewPath(3000);
-        await startRun();
-        expect(await get('/_mintlify/pkg/x/client/a.js')).toBe('next');
-        expect(packageRoute.handler).not.toHaveBeenCalled();
-        expect(setPackagesRebuiltListener).not.toHaveBeenCalled();
-        expect(listener).toHaveBeenCalledWith(expect.any(Function), expect.objectContaining({ nativePackages: false }), expect.any(Promise));
-    });
-});
-describe('mint dev with MINTLIFY_NATIVE_NPM_PACKAGES=1', () => {
-    beforeEach(() => setFlag('1'));
+describe('mint dev npm packages', () => {
     it('starts the packages runtime and tells prebuild to read packages', async () => {
         await dev(argv);
         expect(processExitMock).not.toHaveBeenCalled();

package/dist/local-preview/index.js

@@ -6,7 +6,6 @@ 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 { addLog, clearLogs } from '../logging-state.js';
 import { ErrorLog, SpinnerLog } from '../logs.js';
-import { isNativePackagesEnabled } from '../packages/flag.js';
 import { seedPreviewFromShared } from '../util.js';
 import { timeDev, timeDevSync } from './dev-timing.js';
 import { ensureDocsConfig } from './ensure-docs-config.js';
@@ -92,7 +91,6 @@ const startDev = async (argv) => {
     timeDevSync('switch to local client directory', () => {
         process.chdir(CLIENT_PATH);
     });
-    const nativePackages = isNativePackagesEnabled();
     let fileImportsMap;
     try {
         const result = await timeDev('prebuild content', () => prebuild(CMD_EXEC_PATH, {
@@ -102,7 +100,7 @@ const startDev = async (argv) => {
             disablePrefetch,
             allowSourceRefs: true,
             lazyPages: true,
-            nativePackages,
+            nativePackages: true,
         }));
         fileImportsMap = result?.fileImportsMap;
     }
@@ -113,8 +111,7 @@ const startDev = async (argv) => {
         await new Promise((resolve) => setTimeout(resolve, 50));
         process.exit(1);
     }
-    if (nativePackages)
-        await timeDev('build npm packages', () => startPackagesDev());
+    await timeDev('build npm packages', () => startPackagesDev());
     await timeDev('start preview runtime', () => run({ ...argv, needsUpdate, fileImportsMap }));
 };
 const dev = async (argv) => {

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

@@ -12,7 +12,6 @@ import pathUtil from 'path';
 import { CMD_EXEC_PATH, NEXT_PROPS_PATH, NEXT_PUBLIC_PATH, CLIENT_PATH } from '../../constants.js';
 import { addChangeLog, addErrorLog, clearErrorLogs, getCurrentErrorLogs, } from '../../logging-state.js';
 import { AddedLog, DeletedLog, EditedLog, WarningLog, InfoLog, ErrorLog } from '../../logs.js';
-import { isNativePackagesEnabled } from '../../packages/flag.js';
 import { reportPageCompileError, reportPageCompileSuccess } from '../on-demand-page.js';
 import { notifyPackageInputChange, writePackageBuildProps } from '../packages/index.js';
 import { clearDocsConfigCaches, getDocsConfigApiHash, getDocsConfigNavigationHash, getVariablesHash, hasDocsConfigApiChanged, hasDocsConfigNavigationChanged, hasNavigationApiReference, hadDocsConfigApiReference, hasDocsConfigVariablesChanged, updateDocsConfigHashCache, } from './docs-config-cache.js';
@@ -397,7 +396,7 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
     const importedFiles = getImportedFilesFromCache();
     const potentialCategory = getFileCategory(filename, { importedFiles });
     await notifyPackageInputChange(filename, potentialCategory);
-    if (isNativePackagesEnabled() && isPackageManifestPath(filename))
+    if (isPackageManifestPath(filename))
         return null;
     if (hasTrackedReferencedFile(filename)) {
         if (await fse.pathExists(pathUtil.join(CMD_EXEC_PATH, 'docs.json'))) {

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

@@ -28,7 +28,7 @@ const reporter = {
         }
     },
     missingNodeModules: (docsRoot) => {
-        addErrorLog(_jsx(ErrorLog, { message: `docs.json uses npm packages but ${path.join(docsRoot, 'node_modules')} is missing. Run npm install in ${docsRoot}; package components stay empty until then.` }));
+        addErrorLog(_jsx(ErrorLog, { message: `docs.json uses npm packages but ${path.join(docsRoot, 'node_modules')} is missing. Run npm install --ignore-scripts in ${docsRoot}; package components stay empty until then.` }));
     },
     configError: (message) => {
         addErrorLog(_jsx(ErrorLog, { message: `npm packages: ${message}` }));

package/dist/local-preview/run.js

@@ -6,7 +6,6 @@ import { Server as SocketServer } from 'socket.io';
 import { CMD_EXEC_PATH, NEXT_PUBLIC_PATH } from '../constants.js';
 import { addLog, removeSpinnerLogs } from '../logging-state.js';
 import { LaunchLog, SearchDisabledLog, UpdateLog } from '../logs.js';
-import { isNativePackagesEnabled } from '../packages/flag.js';
 import { maybeFixMissingWindowsEnvVar } from '../util.js';
 import { addDevTimingLog, startDevTiming, timeDev } from './dev-timing.js';
 import listener, { initializeDocsConfigHashCache, initializeFrontmatterHashCache, initializeImportCache, } from './listener/index.js';
@@ -55,7 +54,6 @@ export const run = async (argv) => {
     process.env.LOCAL_OG_PREVIEW = 'true';
     const requestHandler = await timeDev('setup Next handler', () => setupNext());
     const localIp = getLocalNetworkIp();
-    const nativePackages = isNativePackagesEnabled();
     const apiUrl = argv.apiUrl ?? process.env.MINTLIFY_API_URL ?? 'http://localhost:5000';
     const accessToken = argv.accessToken;
     const subdomain = argv.subdomain;
@@ -63,8 +61,7 @@ export const run = async (argv) => {
     process.env.MINTLIFY_API_URL = apiUrl;
     if (subdomain)
         process.env.MINTLIFY_CLI_SUBDOMAIN = subdomain;
-    if (nativePackages)
-        app.use(packageRoute.prefix, packageRoute.handler);
+    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));
     app.use((req, _res, next) => {
@@ -138,8 +135,7 @@ export const run = async (argv) => {
     const onChange = () => {
         io.emit('reload');
     };
-    if (nativePackages)
-        setPackagesRebuiltListener(onChange);
+    setPackagesRebuiltListener(onChange);
     setCompileListener((event) => {
         io.emit('compiling', event);
     });
@@ -149,7 +145,8 @@ export const run = async (argv) => {
         }
     });
     const finishServerListenTiming = startDevTiming('server ready');
-    server.listen(currentPort, () => {
+    const exposeOnNetwork = argv.host === true;
+    server.listen(currentPort, exposeOnNetwork ? undefined : 'localhost', () => {
         finishServerListenTiming();
         removeSpinnerLogs();
         if (argv.needsUpdate) {
@@ -158,7 +155,7 @@ export const run = async (argv) => {
         if (!accessToken) {
             addLog(_jsx(SearchDisabledLog, { loginCommand: `${argv.packageName} login` }));
         }
-        addLog(_jsx(LaunchLog, { localUrl: `http://localhost:${port}`, networkUrl: localIp ? `http://${localIp}:${port}` : undefined }));
+        addLog(_jsx(LaunchLog, { localUrl: `http://localhost:${port}`, networkUrl: exposeOnNetwork && localIp ? `http://${localIp}:${port}` : undefined }));
         /**
          * We're running into a known bug with the `open` package, where Windows machines error out because process.env.SYSTEMROOT is not set:
          * https://github.com/sindresorhus/open/issues/292
@@ -191,7 +188,7 @@ export const run = async (argv) => {
         disablePrefetch: argv.disablePrefetch,
         allowSourceRefs: true,
         lazyPages: true,
-        nativePackages,
+        nativePackages: true,
     }, watcherGate);
     await timeDev('initialize import cache', () => initializeImportCache(CMD_EXEC_PATH, argv.fileImportsMap));
     markOnDemandPagesReady();

package/dist/packages/index.d.ts

@@ -1,3 +1,2 @@
 export { collectPackageIslands, PackageIslandCollector, resolvePageContent, type CollectedIslands, type CollectPackageIslandsInput, type PackageIslandProblem, type PageIslands, } from './collect.js';
-export { isNativePackagesEnabled } from './flag.js';
 export { normalizeProviderPath, readPackagesSetup, type PackagesSetup } from './setup.js';

package/dist/packages/index.js

@@ -1,3 +1,2 @@
 export { collectPackageIslands, PackageIslandCollector, resolvePageContent, } from './collect.js';
-export { isNativePackagesEnabled } from './flag.js';
 export { normalizeProviderPath, readPackagesSetup } from './setup.js';