@mintlify/previewing 4.0.10 → 4.0.11

package/dist/constants.js

@@ -2,24 +2,24 @@ import os from 'os';
 import path from 'path';
 import * as url from 'url';
 // Change this to bump to a newer version of mint's client
-export var TARGET_MINT_VERSION = 'v0.0.148';
+export const TARGET_MINT_VERSION = 'v0.0.148';
 // package installation location
-export var INSTALL_PATH = url.fileURLToPath(new URL('.', import.meta.url));
-export var HOME_DIR = os.homedir();
-export var DOT_MINTLIFY = path.join(HOME_DIR, '.mintlify');
-export var MINT_PATH = path.join(DOT_MINTLIFY, 'mint');
-export var VERSION_PATH = path.join(MINT_PATH, 'mint-version.txt');
-export var CLIENT_PATH = path.join(MINT_PATH, 'client');
-export var NEXT_SERVER_PATH = path.join(MINT_PATH, 'node_modules', 'next', 'dist', 'server', 'next-server.js');
-export var NEXT_STATIC_PATH = path.join(CLIENT_PATH, '.next', 'static');
-export var NEXT_CONFIG_PATH = path.join(CLIENT_PATH, '.next', 'required-server-files.json');
-export var NEXT_PUBLIC_PATH = path.join(CLIENT_PATH, 'public');
-export var NEXT_PROPS_PATH = path.join(CLIENT_PATH, 'src', '_props');
-export var TAR_URL = "https://mint-releases.b-cdn.net/mint-".concat(TARGET_MINT_VERSION.slice(1), ".tar.gz");
-export var TAR_PATH = path.join(DOT_MINTLIFY, "mint.tar.gz");
+export const INSTALL_PATH = url.fileURLToPath(new URL('.', import.meta.url));
+export const HOME_DIR = os.homedir();
+export const DOT_MINTLIFY = path.join(HOME_DIR, '.mintlify');
+export const MINT_PATH = path.join(DOT_MINTLIFY, 'mint');
+export const VERSION_PATH = path.join(MINT_PATH, 'mint-version.txt');
+export const CLIENT_PATH = path.join(MINT_PATH, 'client');
+export const NEXT_SERVER_PATH = path.join(MINT_PATH, 'node_modules', 'next', 'dist', 'server', 'next-server.js');
+export const NEXT_STATIC_PATH = path.join(CLIENT_PATH, '.next', 'static');
+export const NEXT_CONFIG_PATH = path.join(CLIENT_PATH, '.next', 'required-server-files.json');
+export const NEXT_PUBLIC_PATH = path.join(CLIENT_PATH, 'public');
+export const NEXT_PROPS_PATH = path.join(CLIENT_PATH, 'src', '_props');
+export const TAR_URL = `https://mint-releases.b-cdn.net/mint-${TARGET_MINT_VERSION.slice(1)}.tar.gz`;
+export const TAR_PATH = path.join(DOT_MINTLIFY, `mint.tar.gz`);
 // command execution location
-export var CMD_EXEC_PATH = process.cwd();
-export var SUPPORTED_MEDIA_EXTENSIONS = [
+export const CMD_EXEC_PATH = process.cwd();
+export const SUPPORTED_MEDIA_EXTENSIONS = [
     'jpeg',
     'jpg',
     'jfif',

package/dist/local-preview/index.js

@@ -7,33 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 import { prebuild } from '@mintlify/prebuild';
 import Chalk from 'chalk';
 import express from 'express';
@@ -49,136 +22,95 @@ import tar from 'tar';
 import { CLIENT_PATH, DOT_MINTLIFY, CMD_EXEC_PATH, TARGET_MINT_VERSION, VERSION_PATH, MINT_PATH, NEXT_SERVER_PATH, NEXT_STATIC_PATH, NEXT_CONFIG_PATH, TAR_URL, TAR_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, } from '../constants.js';
 import { buildLogger, maybeFixMissingWindowsEnvVar } from '../util.js';
 import listener from './listener/index.js';
-var downloadTargetMint = function (logger) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                fse.emptyDirSync(MINT_PATH);
-                logger.text = 'Downloading Mintlify framework...';
-                return [4 /*yield*/, pipeline(got.stream(TAR_URL), fse.createWriteStream(TAR_PATH))];
-            case 1:
-                _a.sent();
-                logger.text = 'Extracting Mintlify framework...';
-                tar.x({
-                    sync: true,
-                    file: TAR_PATH,
-                    cwd: DOT_MINTLIFY,
-                });
-                fse.removeSync(TAR_PATH);
-                fse.writeFileSync(VERSION_PATH, TARGET_MINT_VERSION);
-                return [2 /*return*/];
-        }
-    });
-}); };
-var dev = function (argv) { return __awaiter(void 0, void 0, void 0, function () {
-    var logger, versionString, shouldDownload, hasInternet, err_1, errorText;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                logger = buildLogger('Preparing local Mintlify instance...');
-                return [4 /*yield*/, fse.ensureDir(DOT_MINTLIFY)];
-            case 1:
-                _a.sent();
-                return [4 /*yield*/, pathExists(VERSION_PATH)];
-            case 2:
-                versionString = (_a.sent())
-                    ? fse.readFileSync(VERSION_PATH, 'utf8')
-                    : null;
-                shouldDownload = versionString !== TARGET_MINT_VERSION;
-                if (!shouldDownload) return [3 /*break*/, 5];
-                return [4 /*yield*/, isOnline()];
-            case 3:
-                hasInternet = _a.sent();
-                if (!hasInternet) {
-                    logger.fail('Running mintlify dev afer updating requires an internet connection.');
-                    process.exit(1);
-                }
-                return [4 /*yield*/, downloadTargetMint(logger)];
-            case 4:
-                _a.sent();
-                _a.label = 5;
-            case 5:
-                // clear preexisting prebuild files
-                fse.emptyDirSync(NEXT_PUBLIC_PATH);
-                fse.emptyDirSync(NEXT_PROPS_PATH);
-                process.chdir(CLIENT_PATH);
-                _a.label = 6;
-            case 6:
-                _a.trys.push([6, 8, , 9]);
-                return [4 /*yield*/, prebuild(CMD_EXEC_PATH)];
-            case 7:
-                _a.sent();
-                return [3 /*break*/, 9];
-            case 8:
-                err_1 = _a.sent();
-                errorText = err_1 instanceof Error && err_1.message ? err_1.message : 'Prebuild step failed';
-                logger.fail(errorText);
-                process.exit(1);
-                return [3 /*break*/, 9];
-            case 9:
-                logger.succeed('Local Mintlify instance is ready. Launching your site...');
-                return [4 /*yield*/, run((argv === null || argv === void 0 ? void 0 : argv.port) || '3000')];
-            case 10:
-                _a.sent();
-                return [2 /*return*/];
-        }
+const downloadTargetMint = (logger) => __awaiter(void 0, void 0, void 0, function* () {
+    fse.emptyDirSync(MINT_PATH);
+    logger.text = 'Downloading Mintlify framework...';
+    yield pipeline(got.stream(TAR_URL), fse.createWriteStream(TAR_PATH));
+    logger.text = 'Extracting Mintlify framework...';
+    tar.x({
+        sync: true,
+        file: TAR_PATH,
+        cwd: DOT_MINTLIFY,
     });
-}); };
-var run = function (port) { return __awaiter(void 0, void 0, void 0, function () {
-    var Server, NextServer, config, handler, app, server, io, onChange, currentPort, hostname;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, import(pathToFileURL(NEXT_SERVER_PATH).href)];
-            case 1:
-                Server = (_a.sent()).default;
-                NextServer = Server.default;
-                return [4 /*yield*/, JSON.parse(fse.readFileSync(NEXT_CONFIG_PATH, 'utf8'))];
-            case 2:
-                config = (_a.sent()).config;
-                process.chdir(CLIENT_PATH);
-                app = express();
-                server = createServer(app);
-                io = new SocketServer(server);
-                onChange = function () {
-                    io.emit('reload');
-                };
-                // static files don't get served in minimalMode
-                app.use('/_next/static', express.static(NEXT_STATIC_PATH));
-                app.all('*', function (req, res) { return handler === null || handler === void 0 ? void 0 : handler(req, res); });
-                currentPort = parseInt(port, 10) || 3000;
-                hostname = process.env.HOSTNAME || 'localhost';
-                server.listen(currentPort, function () {
-                    var nextServer = new NextServer({
-                        hostname: hostname,
-                        port: currentPort,
-                        dir: CLIENT_PATH,
-                        dev: true,
-                        minimalMode: true,
-                        customServer: true,
-                        conf: config,
-                    });
-                    handler = nextServer.getRequestHandler();
-                    console.log("\uD83C\uDF3F ".concat(Chalk.green("Your local preview is available at http://localhost:".concat(port))));
-                    console.log("\uD83C\uDF3F ".concat(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();
-                    open("http://localhost:".concat(port));
-                    // exit with successful status
-                    var onExit = function () {
-                        process.exit(0);
-                    };
-                    process.on('SIGINT', onExit);
-                    process.on('SIGTERM', onExit);
-                });
-                listener(onChange);
-                return [2 /*return*/];
+    fse.removeSync(TAR_PATH);
+    fse.writeFileSync(VERSION_PATH, TARGET_MINT_VERSION);
+});
+const dev = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    const logger = buildLogger('Preparing local Mintlify instance...');
+    yield fse.ensureDir(DOT_MINTLIFY);
+    const versionString = (yield pathExists(VERSION_PATH))
+        ? fse.readFileSync(VERSION_PATH, 'utf8')
+        : null;
+    const shouldDownload = versionString !== TARGET_MINT_VERSION;
+    if (shouldDownload) {
+        const hasInternet = yield isOnline();
+        if (!hasInternet) {
+            logger.fail('Running mintlify dev afer updating requires an internet connection.');
+            process.exit(1);
         }
+        yield downloadTargetMint(logger);
+    }
+    // clear preexisting prebuild files
+    fse.emptyDirSync(NEXT_PUBLIC_PATH);
+    fse.emptyDirSync(NEXT_PROPS_PATH);
+    process.chdir(CLIENT_PATH);
+    try {
+        yield prebuild(CMD_EXEC_PATH);
+    }
+    catch (err) {
+        const errorText = err instanceof Error && err.message ? err.message : 'Prebuild step failed';
+        logger.fail(errorText);
+        process.exit(1);
+    }
+    logger.succeed('Local Mintlify instance is ready. Launching your site...');
+    yield run((argv === null || argv === void 0 ? void 0 : argv.port) || '3000');
+});
+const run = (port) => __awaiter(void 0, void 0, void 0, function* () {
+    const { default: Server } = yield import(pathToFileURL(NEXT_SERVER_PATH).href);
+    const NextServer = Server.default;
+    const { config } = yield JSON.parse(fse.readFileSync(NEXT_CONFIG_PATH, 'utf8'));
+    process.chdir(CLIENT_PATH);
+    let handler;
+    const app = express();
+    const server = createServer(app);
+    const io = new SocketServer(server);
+    const onChange = () => {
+        io.emit('reload');
+    };
+    // static files don't get served in minimalMode
+    app.use('/_next/static', express.static(NEXT_STATIC_PATH));
+    app.all('*', (req, res) => handler === null || handler === void 0 ? void 0 : handler(req, res));
+    const currentPort = parseInt(port, 10) || 3000;
+    const hostname = process.env.HOSTNAME || 'localhost';
+    server.listen(currentPort, () => {
+        const nextServer = new NextServer({
+            hostname,
+            port: currentPort,
+            dir: CLIENT_PATH,
+            dev: true,
+            minimalMode: true,
+            customServer: true,
+            conf: config,
+        });
+        handler = nextServer.getRequestHandler();
+        console.log(`🌿 ${Chalk.green(`Your local preview is available at http://localhost:${port}`)}`);
+        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();
+        open(`http://localhost:${port}`);
+        // exit with successful status
+        const onExit = () => {
+            process.exit(0);
+        };
+        process.on('SIGINT', onExit);
+        process.on('SIGTERM', onExit);
     });
-}); };
+    listener(onChange);
+});
 export default dev;

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

@@ -1,14 +1,3 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 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) {
@@ -18,99 +7,37 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 import { generateDecoratedMintNavigationFromPages, getConfigObj, categorizeFiles, createPage, } from '@mintlify/prebuild';
 import { promises as _promises } from 'fs';
 import { outputFile } from 'fs-extra';
 import path from 'path';
 import { CMD_EXEC_PATH } from '../../constants.js';
-var readFile = _promises.readFile;
-var createFilenamePageMetadataMap = function (contentDirectoryPath, contentFilenames, openApiFiles, clientPath, writeFiles) {
-    if (writeFiles === void 0) { writeFiles = false; }
-    return __awaiter(void 0, void 0, void 0, function () {
-        var pagesAcc, contentPromises;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    pagesAcc = {};
-                    contentPromises = [];
-                    contentFilenames.forEach(function (filename) {
-                        contentPromises.push((function () { return __awaiter(void 0, void 0, void 0, function () {
-                            var sourcePath, contentStr, _a, slug, pageMetadata, pageContent, targetPath;
-                            var _b;
-                            return __generator(this, function (_c) {
-                                switch (_c.label) {
-                                    case 0:
-                                        sourcePath = path.join(contentDirectoryPath, filename);
-                                        return [4 /*yield*/, readFile(sourcePath)];
-                                    case 1:
-                                        contentStr = (_c.sent()).toString();
-                                        return [4 /*yield*/, createPage(filename, contentStr, contentDirectoryPath, openApiFiles)];
-                                    case 2:
-                                        _a = _c.sent(), slug = _a.slug, pageMetadata = _a.pageMetadata, pageContent = _a.pageContent;
-                                        if (!(clientPath && writeFiles)) return [3 /*break*/, 4];
-                                        targetPath = path.join(clientPath, 'src', '_props', filename);
-                                        return [4 /*yield*/, outputFile(targetPath, pageContent, {
-                                                flag: 'w',
-                                            })];
-                                    case 3:
-                                        _c.sent();
-                                        _c.label = 4;
-                                    case 4:
-                                        pagesAcc = __assign(__assign({}, pagesAcc), (_b = {}, _b[slug] = pageMetadata, _b));
-                                        return [2 /*return*/];
-                                }
-                            });
-                        }); })());
-                    });
-                    return [4 /*yield*/, Promise.all(contentPromises)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/, pagesAcc];
+const { readFile } = _promises;
+const createFilenamePageMetadataMap = (contentDirectoryPath, contentFilenames, openApiFiles, clientPath, writeFiles = false) => __awaiter(void 0, void 0, void 0, function* () {
+    let pagesAcc = {};
+    const contentPromises = [];
+    contentFilenames.forEach((filename) => {
+        contentPromises.push((() => __awaiter(void 0, void 0, void 0, function* () {
+            const sourcePath = path.join(contentDirectoryPath, filename);
+            const contentStr = (yield readFile(sourcePath)).toString();
+            const { slug, pageMetadata, pageContent } = yield createPage(filename, contentStr, contentDirectoryPath, openApiFiles);
+            if (clientPath && writeFiles) {
+                const targetPath = path.join(clientPath, 'src', '_props', filename);
+                yield outputFile(targetPath, pageContent, {
+                    flag: 'w',
+                });
             }
-        });
-    });
-};
-export var generateNav = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, contentFilenames, openApiFiles, _b, filenamePageMetadataMap, configObj;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0: return [4 /*yield*/, categorizeFiles(CMD_EXEC_PATH)];
-            case 1:
-                _a = _c.sent(), contentFilenames = _a.contentFilenames, openApiFiles = _a.openApiFiles;
-                return [4 /*yield*/, Promise.all([
-                        createFilenamePageMetadataMap(CMD_EXEC_PATH, contentFilenames, openApiFiles),
-                        getConfigObj(CMD_EXEC_PATH),
-                    ])];
-            case 2:
-                _b = _c.sent(), filenamePageMetadataMap = _b[0], configObj = _b[1];
-                return [2 /*return*/, generateDecoratedMintNavigationFromPages(filenamePageMetadataMap, configObj === null || configObj === void 0 ? void 0 : configObj.navigation)];
-        }
+            pagesAcc = Object.assign(Object.assign({}, pagesAcc), { [slug]: pageMetadata });
+        }))());
     });
-}); };
+    yield Promise.all(contentPromises);
+    return pagesAcc;
+});
+export const generateNav = () => __awaiter(void 0, void 0, void 0, function* () {
+    const { contentFilenames, openApiFiles } = yield categorizeFiles(CMD_EXEC_PATH);
+    const [filenamePageMetadataMap, configObj] = yield Promise.all([
+        createFilenamePageMetadataMap(CMD_EXEC_PATH, contentFilenames, openApiFiles),
+        getConfigObj(CMD_EXEC_PATH),
+    ]);
+    return generateDecoratedMintNavigationFromPages(filenamePageMetadataMap, configObj === null || configObj === void 0 ? void 0 : configObj.navigation);
+});