@mintlify/previewing 3.1.0 → 3.1.2

package/README.md

@@ -1,78 +1,17 @@
-<div align="center">
-  <a href="https://mintlify.com">
-    <img
-      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
-      alt="Mintlify Logo"
-      height="64"
-    />
-  </a>
-  <br />
-  <p>
-    <h3>
-      <b>
-        Mintlify CLI
-      </b>
-    </h3>
-  </p>
-  <p>
-    The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
-  </p>
-  <p>
+# @mintlify/previewing
 
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Unit Tests](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)
+Preview Mintlify docs locally.
 
-  </p>
-  <p>
-    <sub>
-      Built with ❤︎ by
-      <a href="https://mintlify.com">
-        Mintlify
-      </a>
-    </sub>
-  </p>
-</div>
-
-### 🚀 Installation
-
-Download the Mintlify CLI using the following command
-
-```
-npm i -g mintlify
-```
-
-### 👩‍💻 Development
-
-Run the following command at the root of your Mintlify application to preview changes locally.
-
-```
-mintlify dev
-```
-
-Note - `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
-
-### Custom Ports
-
-Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
+## 🚀 Installation
 
 ```
-mintlify dev --port 3333
+npm install @mintlify/previewing
 ```
 
-You will see an error like this if you try to run Mintlify in a port that's already taken:
-
-```
-Error: listen EADDRINUSE: address already in use :::3000
-```
-
-#### Troubleshooting
-
-Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
+## Community
 
-- Make sure you are running in a folder with a `mint.json` file.
-- Make sure you are using Node v18 or higher.
-- Run `mintlify install` to re-install dependencies.
-- Navigate to the `.mintlify` folder in your home directory and delete its contents.
+Join our Discord community if you have questions or just want to chat:
 
-### 🏃 Get Started
+[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)
 
-[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.
+_Built with 💚 by the Mintlify community._

package/dist/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const TARGET_MINT_VERSION = "v0.0.9";
+export declare const TARGET_MINT_VERSION = "v0.0.10";
 export declare const INSTALL_PATH: string;
 export declare const HOME_DIR: string;
 export declare const DOT_MINTLIFY: string;

package/dist/constants.js

@@ -1,32 +1,31 @@
-import path from "path";
-import * as url from "url";
-import os from "os";
+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 const TARGET_MINT_VERSION = "v0.0.9";
+export var TARGET_MINT_VERSION = 'v0.0.10';
 // package installation location
-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 VERSION_PATH = path.join(DOT_MINTLIFY, "mint", "mint-version.txt");
-export const CLIENT_PATH = path.join(DOT_MINTLIFY, "mint", "client");
-export const MINT_PATH = path.join(DOT_MINTLIFY, "mint");
+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 VERSION_PATH = path.join(DOT_MINTLIFY, 'mint', 'mint-version.txt');
+export var CLIENT_PATH = path.join(DOT_MINTLIFY, 'mint', 'client');
+export var MINT_PATH = path.join(DOT_MINTLIFY, 'mint');
 // command execution location
-export const CMD_EXEC_PATH = process.cwd();
-export const SUPPORTED_MEDIA_EXTENSIONS = [
-    "jpeg",
-    "jpg",
-    "jfif",
-    "pjpeg",
-    "pjp",
-    "png",
-    "svg",
-    "svgz",
-    "ico",
-    "webp",
-    "gif",
-    "apng",
-    "avif",
-    "bmp",
-    "mp4",
+export var CMD_EXEC_PATH = process.cwd();
+export var SUPPORTED_MEDIA_EXTENSIONS = [
+    'jpeg',
+    'jpg',
+    'jfif',
+    'pjpeg',
+    'pjp',
+    'png',
+    'svg',
+    'svgz',
+    'ico',
+    'webp',
+    'gif',
+    'apng',
+    'avif',
+    'bmp',
+    'mp4',
 ];
-//# sourceMappingURL=constants.js.map

package/dist/downloadImage.js

@@ -1,58 +1,106 @@
-import { existsSync, mkdirSync, createWriteStream } from "fs";
-import path from "path";
-import axios from "axios";
-import { getFileExtension } from "./util.js";
-import { SUPPORTED_MEDIA_EXTENSIONS } from "./constants.js";
-async function writeImageToFile(imageSrc, writePath, overwrite) {
-    // Avoid unnecessary downloads
-    if (existsSync(writePath) && !overwrite) {
-        return Promise.reject({
-            code: "EEXIST",
-        });
-    }
-    // Create the folders needed if they're missing
-    mkdirSync(path.dirname(writePath), { recursive: true });
-    const writer = createWriteStream(writePath);
-    try {
-        const response = await axios.get(imageSrc, {
-            responseType: "stream",
-        });
-        // wx prevents overwriting an image with the exact same name
-        // being created in the time we were downloading
-        response.data.pipe(writer, {
-            flag: "wx",
-        });
-        return new Promise((resolve, reject) => {
-            writer.on("finish", resolve);
-            writer.on("error", reject);
-        });
+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());
+    });
+};
+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 };
     }
-    catch (e) {
-        return Promise.reject({
-            code: "ENOTFOUND",
+};
+import axios from 'axios';
+import { existsSync, mkdirSync, createWriteStream } from 'fs';
+import path from 'path';
+import { SUPPORTED_MEDIA_EXTENSIONS } from './constants.js';
+import { getFileExtension } from './util.js';
+function writeImageToFile(imageSrc, writePath, overwrite) {
+    return __awaiter(this, void 0, void 0, function () {
+        var writer, response, e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // Avoid unnecessary downloads
+                    if (existsSync(writePath) && !overwrite) {
+                        return [2 /*return*/, Promise.reject({
+                                code: 'EEXIST',
+                            })];
+                    }
+                    // Create the folders needed if they're missing
+                    mkdirSync(path.dirname(writePath), { recursive: true });
+                    writer = createWriteStream(writePath);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, axios.get(imageSrc, {
+                            responseType: 'stream',
+                        })];
+                case 2:
+                    response = _a.sent();
+                    // wx prevents overwriting an image with the exact same name
+                    // being created in the time we were downloading
+                    response.data.pipe(writer, {
+                        flag: 'wx',
+                    });
+                    return [2 /*return*/, new Promise(function (resolve, reject) {
+                            writer.on('finish', resolve);
+                            writer.on('error', reject);
+                        })];
+                case 3:
+                    e_1 = _a.sent();
+                    return [2 /*return*/, Promise.reject({
+                            code: 'ENOTFOUND',
+                        })];
+                case 4: return [2 /*return*/];
+            }
         });
-    }
+    });
 }
 export function isValidImageSrc(src) {
     if (!src) {
         return false;
     }
     // We do not support downloading base64 in-line images.
-    if (src.startsWith("data:")) {
+    if (src.startsWith('data:')) {
         return false;
     }
-    const imageHref = removeMetadataFromImageSrc(src);
-    const ext = getFileExtension(imageHref);
+    var imageHref = removeMetadataFromImageSrc(src);
+    var ext = getFileExtension(imageHref);
     if (ext && !SUPPORTED_MEDIA_EXTENSIONS.includes(ext)) {
-        console.error("🚨 We do not support the file extension: " + ext);
+        console.error('🚨 We do not support the file extension: ' + ext);
         return false;
     }
     return true;
 }
 export function removeMetadataFromImageSrc(src) {
     // Part of the URL standard
-    const metadataSymbols = ["?", "#"];
-    metadataSymbols.forEach((dividerSymbol) => {
+    var metadataSymbols = ['?', '#'];
+    metadataSymbols.forEach(function (dividerSymbol) {
         // Some frameworks add metadata after the file extension, we need to remove that.
         src = src.split(dividerSymbol)[0];
     });
@@ -60,23 +108,32 @@ export function removeMetadataFromImageSrc(src) {
 }
 export function cleanImageSrc(src, origin) {
     // Add origin if the image tags are using relative sources
-    return src.startsWith("http") ? src : new URL(src, origin).href;
+    return src.startsWith('http') ? src : new URL(src, origin).href;
 }
-export default async function downloadImage(imageSrc, writePath, overwrite = false) {
-    await writeImageToFile(imageSrc, writePath, overwrite)
-        .then(() => {
-        console.log("🖼️ - " + writePath);
-    })
-        .catch((e) => {
-        if (e.code === "EEXIST") {
-            console.log(`❌ Skipping existing image ${writePath}`);
-        }
-        else if (e.code === "ENOTFOUND") {
-            console.error(`🚨 Cannot download the image, address not found ${imageSrc}`);
-        }
-        else {
-            console.error(e);
-        }
+export default function downloadImage(imageSrc, writePath, overwrite) {
+    if (overwrite === void 0) { overwrite = false; }
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, writeImageToFile(imageSrc, writePath, overwrite)
+                        .then(function () {
+                        console.log('🖼️ - ' + writePath);
+                    })
+                        .catch(function (e) {
+                        if (e.code === 'EEXIST') {
+                            console.log("\u274C Skipping existing image ".concat(writePath));
+                        }
+                        else if (e.code === 'ENOTFOUND') {
+                            console.error("\uD83D\uDEA8 Cannot download the image, address not found ".concat(imageSrc));
+                        }
+                        else {
+                            console.error(e);
+                        }
+                    })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
     });
 }
-//# sourceMappingURL=downloadImage.js.map

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-import dev from "./local-preview/index.js";
-import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
+import installDepsCommand from './local-preview/helper-commands/installDepsCommand.js';
+import dev from './local-preview/index.js';
 export { dev, installDepsCommand };

package/dist/index.js

@@ -1,4 +1,3 @@
-import dev from "./local-preview/index.js";
-import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
+import installDepsCommand from './local-preview/helper-commands/installDepsCommand.js';
+import dev from './local-preview/index.js';
 export { dev, installDepsCommand };
-//# sourceMappingURL=index.js.map

package/dist/local-preview/helper-commands/installDepsCommand.js

@@ -1,12 +1,51 @@
-import shell from "shelljs";
-import { CLIENT_PATH } from "../../constants.js";
-import { buildLogger, ensureYarn } from "../../util.js";
-const installDeps = async () => {
-    const logger = buildLogger("");
-    ensureYarn(logger);
-    shell.cd(CLIENT_PATH);
-    shell.exec("yarn");
-    logger.succeed("Dependencies installed.");
+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());
+    });
 };
+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 shell from 'shelljs';
+import { CLIENT_PATH } from '../../constants.js';
+import { buildLogger, ensureYarn } from '../../util.js';
+var installDeps = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var logger;
+    return __generator(this, function (_a) {
+        logger = buildLogger('');
+        ensureYarn(logger);
+        shell.cd(CLIENT_PATH);
+        shell.exec('yarn');
+        logger.succeed('Dependencies installed.');
+        return [2 /*return*/];
+    });
+}); };
 export default installDeps;
-//# sourceMappingURL=installDepsCommand.js.map

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

@@ -1,3 +1,3 @@
-import { ArgumentsCamelCase } from "yargs";
+import { ArgumentsCamelCase } from 'yargs';
 declare const dev: (argv: ArgumentsCamelCase) => Promise<void>;
 export default dev;