@mintlify/previewing 4.0.526 → 4.0.528

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

@@ -0,0 +1,2 @@
+import { ArgumentsCamelCase } from 'yargs';
+export declare const run: (argv: ArgumentsCamelCase) => Promise<void>;

package/dist/local-preview/run.js

@@ -0,0 +1,47 @@
+import open from 'better-opn';
+import Chalk from 'chalk';
+import express from 'express';
+import { createServer } from 'http';
+import { Server as SocketServer } from 'socket.io';
+import { NEXT_PUBLIC_PATH } from '../constants.js';
+import { maybeFixMissingWindowsEnvVar } from '../util.js';
+import listener from './listener/index.js';
+import { setupNext } from './setupNext.js';
+export const run = async (argv) => {
+    const port = argv.port || '3000';
+    const currentPort = parseInt(port, 10) || 3000;
+    const app = express();
+    const server = createServer(app);
+    const io = new SocketServer(server);
+    const requestHandler = await setupNext();
+    // next-server is bugged, public files added after starting aren't served
+    app.use('/', express.static(NEXT_PUBLIC_PATH));
+    app.all('*', (req, res) => requestHandler(req, res));
+    const onChange = () => {
+        io.emit('reload');
+    };
+    server.listen(currentPort, () => {
+        console.log(`${Chalk.green(`Your local preview is available at http://localhost:${port}`)}`);
+        // Note: We wait for this exact text to be sure the server is ready in the cli e2e test,
+        // if it changes, the test will fail/require an update.
+        console.log(`${Chalk.green('Press Ctrl+C any time to stop the local preview.')}`);
+        /**
+         * 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
+         *
+         * Let's use the same workaround that this project did:
+         * https://github.com/sanity-io/sanity/pull/4221/files#diff-aeb574e1becf61f21fdf87fbea709669c93d604d660dad4b0f9e24527a2fb54bR256-R262
+         */
+        maybeFixMissingWindowsEnvVar();
+        if (argv.open) {
+            void open(`http://localhost:${port}`);
+        }
+        // exit with successful status
+        const onExit = () => {
+            process.exit(0);
+        };
+        process.on('SIGINT', onExit);
+        process.on('SIGTERM', onExit);
+    });
+    listener(onChange);
+};

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

@@ -0,0 +1,22 @@
+/**
+ * When creating a standalone build, next.js outputs a server.js file that can be used as
+ * an entry point into the server. However, because we want to customize some parts of the
+ * http server (adding a socket.io server, serving the whole public directory), we
+ * create the server ourselves, and just reproduce the setup that next.js would do.
+ *
+ * Because we need to directly import from node_modules files, this solution seems very hacky,
+ * but it is arguably no more hacky than using the server.js that ships with the standalone
+ * build.
+ *
+ * This function attempts to replicate the behavior of two next.js files:
+ * - environment setup from server.js
+ * - initialization of the request handler from start-server.ts
+ *
+ * Links:
+ * - [standalone build](https://nextjs.org/docs/pages/api-reference/next-config-js/output#automatically-copying-traced-files)
+ * - [server.js](https://github.com/vercel/next.js/blob/492156b4c5e2559b2a280f7d483cd85a8e8742a9/packages/next/src/build/utils.ts#L2108-L2113) (created programmatically)
+ * - [start-server.ts](https://github.com/vercel/next.js/blob/492156b4c5e2559b2a280f7d483cd85a8e8742a9/packages/next/src/server/lib/start-server.ts#L296-L308)
+ *
+ * @returns the request handler provided by next.js
+ */
+export declare const setupNext: () => Promise<any>;

package/dist/local-preview/setupNext.js

@@ -0,0 +1,41 @@
+import fse from 'fs-extra';
+import { pathToFileURL } from 'node:url';
+import { CLIENT_PATH, NEXT_CONFIG_PATH, NEXT_ROUTER_SERVER_PATH, NEXT_SIDE_EFFECT_PATH, } from '../constants.js';
+/**
+ * When creating a standalone build, next.js outputs a server.js file that can be used as
+ * an entry point into the server. However, because we want to customize some parts of the
+ * http server (adding a socket.io server, serving the whole public directory), we
+ * create the server ourselves, and just reproduce the setup that next.js would do.
+ *
+ * Because we need to directly import from node_modules files, this solution seems very hacky,
+ * but it is arguably no more hacky than using the server.js that ships with the standalone
+ * build.
+ *
+ * This function attempts to replicate the behavior of two next.js files:
+ * - environment setup from server.js
+ * - initialization of the request handler from start-server.ts
+ *
+ * Links:
+ * - [standalone build](https://nextjs.org/docs/pages/api-reference/next-config-js/output#automatically-copying-traced-files)
+ * - [server.js](https://github.com/vercel/next.js/blob/492156b4c5e2559b2a280f7d483cd85a8e8742a9/packages/next/src/build/utils.ts#L2108-L2113) (created programmatically)
+ * - [start-server.ts](https://github.com/vercel/next.js/blob/492156b4c5e2559b2a280f7d483cd85a8e8742a9/packages/next/src/server/lib/start-server.ts#L296-L308)
+ *
+ * @returns the request handler provided by next.js
+ */
+export const setupNext = async () => {
+    const hostname = process.env.HOSTNAME || 'localhost';
+    const { config } = await JSON.parse(fse.readFileSync(NEXT_CONFIG_PATH, 'utf8'));
+    process.env.__NEXT_PRIVATE_STANDALONE_CONFIG = JSON.stringify(config);
+    // The server.js provided by next.js's standalone build does a similar import of this file.
+    // Not sure what side effects are being created, but want to change as little as possible.
+    // Also, Windows requires us to use `pathToFileURL` (see #899)
+    await import(pathToFileURL(NEXT_SIDE_EFFECT_PATH).href);
+    const { initialize } = await import(pathToFileURL(NEXT_ROUTER_SERVER_PATH).href);
+    const [requestHandler] = await initialize({
+        dir: CLIENT_PATH,
+        dev: false,
+        hostname,
+        minimalMode: true,
+    });
+    return requestHandler;
+};