@mintlify/previewing 4.0.527 → 4.0.529

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

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { findAndRemoveImports, hasImports, getFileCategory, openApiCheck, stringifyTree, } from '@mintlify/common';
 import { createPage, MintConfigUpdater, DocsConfigUpdater, preparseMdxTree, } from '@mintlify/prebuild';
 import Chalk from 'chalk';
@@ -35,9 +26,9 @@ const listener = (callback) => {
         .on('change', (filename) => onChangeEvent(filename, callback))
         .on('unlink', onUnlinkEvent);
 };
-const onAddEvent = (filename, callback) => __awaiter(void 0, void 0, void 0, function* () {
+const onAddEvent = async (filename, callback) => {
     try {
-        const category = yield onUpdateEvent(filename, callback);
+        const category = await onUpdateEvent(filename, callback);
         switch (category) {
             case 'page':
                 console.log('New page detected: ', filename);
@@ -67,10 +58,10 @@ const onAddEvent = (filename, callback) => __awaiter(void 0, void 0, void 0, fun
     catch (error) {
         console.error(error.message);
     }
-});
-const onChangeEvent = (filename, callback) => __awaiter(void 0, void 0, void 0, function* () {
+};
+const onChangeEvent = async (filename, callback) => {
     try {
-        const category = yield onUpdateEvent(filename, callback);
+        const category = await onUpdateEvent(filename, callback);
         switch (category) {
             case 'page':
                 console.log('Page edited: ', filename);
@@ -100,8 +91,8 @@ const onChangeEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
     catch (error) {
         console.error(error.message);
     }
-});
-const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function* () {
+};
+const onUnlinkEvent = async (filename) => {
     try {
         const potentialCategory = getFileCategory(filename);
         const targetPath = getTargetPath(potentialCategory, filename);
@@ -113,7 +104,7 @@ const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function*
             potentialCategory === 'snippet-v2' ||
             potentialCategory === 'css' ||
             potentialCategory === 'js') {
-            yield fse.remove(targetPath);
+            await fse.remove(targetPath);
         }
         switch (potentialCategory) {
             case 'page':
@@ -125,16 +116,16 @@ const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function*
                 break;
             case 'mintConfig':
                 console.error('⚠️ mint.json has been deleted.');
-                yield validateConfigFiles();
+                await validateConfigFiles();
                 break;
             case 'docsConfig':
                 console.error('⚠️ docs.json has been deleted.');
-                yield validateConfigFiles();
+                await validateConfigFiles();
                 break;
             case 'potentialJsonOpenApiSpec':
             case 'potentialYamlOpenApiSpec':
-                yield updateOpenApiFiles();
-                yield updateGeneratedNav();
+                await updateOpenApiFiles();
+                await updateGeneratedNav();
                 break;
             case 'css':
                 console.log(`CSS file deleted: ${filename}`);
@@ -150,7 +141,7 @@ const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function*
     catch (error) {
         console.error(error.message);
     }
-});
+};
 const getTargetPath = (potentialCategory, filePath) => {
     switch (potentialCategory) {
         case 'page':
@@ -172,12 +163,12 @@ const getTargetPath = (potentialCategory, filePath) => {
             throw new Error('Invalid category');
     }
 };
-const validateConfigFiles = () => __awaiter(void 0, void 0, void 0, function* () {
+const validateConfigFiles = async () => {
     try {
         const mintConfigPath = pathUtil.join(CMD_EXEC_PATH, 'mint.json');
         const docsConfigPath = pathUtil.join(CMD_EXEC_PATH, 'docs.json');
-        const mintConfigExists = yield fse.pathExists(mintConfigPath);
-        const docsConfigExists = yield fse.pathExists(docsConfigPath);
+        const mintConfigExists = await fse.pathExists(mintConfigPath);
+        const docsConfigExists = await fse.pathExists(docsConfigPath);
         if (!mintConfigExists && !docsConfigExists) {
             console.error('⚠️ Error: Neither mint.json nor docs.json found in the directory');
             process.exit(1);
@@ -186,13 +177,13 @@ const validateConfigFiles = () => __awaiter(void 0, void 0, void 0, function* ()
     catch (error) {
         console.error('⚠️ Error validating configuration files:', error);
     }
-});
+};
 /**
  * This function is called when a file is added or changed
  * @param filename
  * @returns FileCategory
  */
-const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0, function* () {
+const onUpdateEvent = async (filename, callback) => {
     const filePath = pathUtil.join(CMD_EXEC_PATH, filename);
     const potentialCategory = getFileCategory(filename);
     const targetPath = getTargetPath(potentialCategory, filename);
@@ -204,46 +195,46 @@ const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
     switch (potentialCategory) {
         case 'page': {
             regenerateNav = true;
-            let contentStr = (yield readFile(filePath)).toString();
-            const tree = yield preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
-            const importsResponse = yield findAndRemoveImports(tree);
+            let contentStr = (await readFile(filePath)).toString();
+            const tree = await preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
+            const importsResponse = await findAndRemoveImports(tree);
             if (hasImports(importsResponse)) {
-                contentStr = stringifyTree(yield resolveAllImports(Object.assign(Object.assign({}, importsResponse), { filename })));
+                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }));
             }
-            const { pageContent } = yield createPage(filename, contentStr, CMD_EXEC_PATH, [], []);
-            yield fse.outputFile(targetPath, pageContent, {
+            const { pageContent } = await createPage(filename, contentStr, CMD_EXEC_PATH, [], []);
+            await fse.outputFile(targetPath, pageContent, {
                 flag: 'w',
             });
             break;
         }
         case 'snippet': {
-            yield fse.copy(filePath, targetPath);
+            await fse.copy(filePath, targetPath);
             break;
         }
         case 'snippet-v2': {
-            let contentStr = (yield readFile(filePath)).toString();
-            const tree = yield preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
-            const importsResponse = yield findAndRemoveImports(tree);
+            let contentStr = (await readFile(filePath)).toString();
+            const tree = await preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
+            const importsResponse = await findAndRemoveImports(tree);
             if (hasImports(importsResponse)) {
-                contentStr = stringifyTree(yield resolveAllImports(Object.assign(Object.assign({}, importsResponse), { filename })));
+                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }));
             }
-            yield fse.outputFile(targetPath, contentStr, {
+            await fse.outputFile(targetPath, contentStr, {
                 flag: 'w',
             });
-            const updatedSnippets = yield generateDependentSnippets(filename, importsResponse);
-            yield generatePagesWithImports(new Set(updatedSnippets));
+            const updatedSnippets = await generateDependentSnippets(filename, importsResponse);
+            await generatePagesWithImports(new Set(updatedSnippets));
             break;
         }
         case 'mintConfig':
         case 'docsConfig': {
             regenerateNav = true;
             try {
-                const { mintConfig, openApiFiles, docsConfig } = yield getDocsState();
+                const { mintConfig, openApiFiles, docsConfig } = await getDocsState();
                 if (mintConfig) {
-                    yield MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                    await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
                 }
-                yield DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
-                yield updateOpenApiFiles(openApiFiles);
+                await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+                await updateOpenApiFiles(openApiFiles);
             }
             catch (err) {
                 console.error(err);
@@ -254,19 +245,19 @@ const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
         case 'potentialJsonOpenApiSpec': {
             let doc;
             try {
-                const file = yield fs.readFile(filePath, 'utf-8');
-                doc = yield openApiCheck(yaml.load(file));
+                const file = await fs.readFile(filePath, 'utf-8');
+                doc = await openApiCheck(yaml.load(file));
             }
-            catch (_a) {
+            catch {
                 doc = undefined;
             }
             if (doc) {
-                yield upsertOpenApiFile({
+                await upsertOpenApiFile({
                     filename: pathUtil.parse(filename).name,
                     originalFileLocation: '/' + filename,
                     spec: doc,
                 });
-                yield updateOpenApiFiles();
+                await updateOpenApiFiles();
                 regenerateNav = true;
                 category = 'openApi';
             }
@@ -275,8 +266,8 @@ const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
         case 'css':
         case 'js':
         case 'staticFile': {
-            if (yield isFileSizeValid(filePath, 5)) {
-                yield fse.copy(filePath, targetPath);
+            if (await isFileSizeValid(filePath, 5)) {
+                await fse.copy(filePath, targetPath);
             }
             else {
                 console.error(Chalk.red(`🚨 The file at ${filename} is too big. The maximum file size is 5 mb.`));
@@ -286,9 +277,9 @@ const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
     }
     if (regenerateNav) {
         // TODO: Instead of re-generating the entire nav, optimize by just updating the specific page that changed.
-        yield updateGeneratedNav();
+        await updateGeneratedNav();
     }
     callback();
     return category;
-});
+};
 export default listener;

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

@@ -1,18 +1,9 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { resolveAllImports as baseResolveAllImports } from '@mintlify/common';
 import { getProcessedSnippets } from './getSnippets.js';
-export const resolveAllImports = (fileWithImports) => __awaiter(void 0, void 0, void 0, function* () {
-    const snippets = yield getProcessedSnippets();
-    return yield baseResolveAllImports({
+export const resolveAllImports = async (fileWithImports) => {
+    const snippets = await getProcessedSnippets();
+    return await baseResolveAllImports({
         snippets,
         fileWithImports,
     });
-});
+};

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

@@ -1,43 +1,34 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import fse from 'fs-extra';
 import { join } from 'path';
 import { NEXT_PROPS_PATH } from '../../constants.js';
 import { generateNav } from './generate.js';
 import { getDocsState } from './getDocsState.js';
 import { readJsonFile } from './utils.js';
-export const updateGeneratedNav = () => __awaiter(void 0, void 0, void 0, function* () {
-    const { pagesAcc, docsConfig } = yield getDocsState();
-    const generatedDocsNav = yield generateNav(pagesAcc, docsConfig);
+export const updateGeneratedNav = async () => {
+    const { pagesAcc, docsConfig } = await getDocsState();
+    const generatedDocsNav = await generateNav(pagesAcc, docsConfig);
     const targetDocsPath = join(NEXT_PROPS_PATH, 'generatedDocsNav.json');
-    yield fse.outputFile(targetDocsPath, JSON.stringify(generatedDocsNav, null, 2), {
+    await fse.outputFile(targetDocsPath, JSON.stringify(generatedDocsNav, null, 2), {
         flag: 'w',
     });
-});
-export const updateOpenApiFiles = (providedOpenApiFiles) => __awaiter(void 0, void 0, void 0, function* () {
+};
+export const updateOpenApiFiles = async (providedOpenApiFiles) => {
     if (providedOpenApiFiles == undefined) {
-        const { openApiFiles } = yield getDocsState();
+        const { openApiFiles } = await getDocsState();
         providedOpenApiFiles = openApiFiles;
     }
     const targetPath = join(NEXT_PROPS_PATH, 'openApiFiles.json');
-    yield fse.outputFile(targetPath, JSON.stringify(providedOpenApiFiles, null, 2), {
+    await fse.outputFile(targetPath, JSON.stringify(providedOpenApiFiles, null, 2), {
         flag: 'w',
     });
-});
-export const upsertOpenApiFile = (openApiFile) => __awaiter(void 0, void 0, void 0, function* () {
+};
+export const upsertOpenApiFile = async (openApiFile) => {
     const sourcePath = join(NEXT_PROPS_PATH, 'openApiFiles.json');
     let existingOpenApiFiles = [];
     try {
-        existingOpenApiFiles = (yield readJsonFile(sourcePath));
+        existingOpenApiFiles = (await readJsonFile(sourcePath));
     }
-    catch (_a) { }
+    catch { }
     const existingIndex = existingOpenApiFiles.findIndex((file) => file.originalFileLocation === openApiFile.originalFileLocation);
     if (existingIndex >= 0) {
         existingOpenApiFiles[existingIndex] = openApiFile;
@@ -45,7 +36,7 @@ export const upsertOpenApiFile = (openApiFile) => __awaiter(void 0, void 0, void
     else {
         existingOpenApiFiles.push(openApiFile);
     }
-    yield fse.outputFile(sourcePath, JSON.stringify(existingOpenApiFiles, null, 2), {
+    await fse.outputFile(sourcePath, JSON.stringify(existingOpenApiFiles, null, 2), {
         flag: 'w',
     });
-});
+};

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

@@ -1,27 +1,18 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { promises as _promises } from 'fs';
 import fse from 'fs-extra';
 const { stat } = _promises;
 export const getFileExtension = (filename) => {
     return filename.substring(filename.lastIndexOf('.') + 1, filename.length) || filename;
 };
-export const isFileSizeValid = (path, maxFileSizeInMb) => __awaiter(void 0, void 0, void 0, function* () {
+export const isFileSizeValid = async (path, maxFileSizeInMb) => {
     const maxFileSizeBytes = maxFileSizeInMb * 1000000;
-    const stats = yield stat(path);
+    const stats = await stat(path);
     return stats.size <= maxFileSizeBytes;
-});
+};
 export function isError(obj) {
     return Object.prototype.toString.call(obj) === '[object Error]';
 }
-export const readJsonFile = (path) => __awaiter(void 0, void 0, void 0, function* () {
-    const file = yield fse.readFile(path, 'utf-8');
+export const readJsonFile = async (path) => {
+    const file = await fse.readFile(path, 'utf-8');
     return JSON.parse(file);
-});
+};

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;
+};