mintlify 1.0.7 → 1.0.8

package/README.md

@@ -1,10 +1,6 @@
 # Mintlify CLI
 
-To test changes locally run:
-
-`npm run build`
-then
-`npm i -g .`
+The Mintlify CLI is used to automate migrations.
 
 ## Installation
 
@@ -13,3 +9,23 @@ then
 If you installed a local version, you may need to uninstall it with
 
 `npm uninstall -g mintlify` before installing the published version.
+
+## Local development & testing
+
+To test changes locally run:
+
+`npm run local`
+
+## Commands
+
+### Migrations
+
+We support automated migrations from ReadMe, GitBook, and Docusaurus.
+
+`mintlify scrape-page <url>` - Scrapes the page at the URL provided and creates a corresponding MDX file
+
+`mintlify scrape-section <url>` - Scrapes the section at the URL provided and creates the MDX files within that section
+
+#### Options
+
+`--overwrite` - By default if an existing file with the same path name is detected, the file will not be overwritten by the scraper. Use this option to force an overwrite.

package/bin/constants.js

@@ -0,0 +1,8 @@
+import path from "path";
+import * as url from "url";
+// package installation location
+export const INSTALL_PATH = url.fileURLToPath(new URL(".", import.meta.url));
+// command execution location
+export const CMD_EXEC_PATH = process.cwd();
+export const CLIENT_PATH = path.join(INSTALL_PATH, "mint", "client");
+//# sourceMappingURL=constants.js.map

package/bin/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B,gCAAgC;AAChC,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE7E,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC"}

package/bin/dev/getOpenApiContext.js

@@ -0,0 +1,46 @@
+export const extractMethodAndEndpoint = (api) => {
+    const methodRegex = /^get|post|put|delete|patch/i;
+    const trimmed = api.trim();
+    const foundMethod = trimmed.match(methodRegex);
+    const endIndexOfMethod = foundMethod
+        ? api.indexOf(foundMethod[0]) + foundMethod[0].length
+        : 0;
+    return {
+        method: foundMethod ? foundMethod[0].toUpperCase() : undefined,
+        endpoint: api.substring(endIndexOfMethod).trim(),
+    };
+};
+export const getOpenApiOperationMethodAndEndpoint = (openApiObj, openApiMetaField) => {
+    const { endpoint, method } = extractMethodAndEndpoint(openApiMetaField);
+    const path = (openApiObj === null || openApiObj === void 0 ? void 0 : openApiObj.paths) && openApiObj.paths[endpoint];
+    if (path == null) {
+        return {};
+    }
+    let operation;
+    if (method) {
+        operation = path[method.toLowerCase()];
+    }
+    else {
+        const firstOperationKey = Object.keys(path)[0];
+        operation = path[firstOperationKey];
+    }
+    return {
+        operation,
+        method,
+        endpoint,
+    };
+};
+export const getOpenApiTitleAndDescription = (openApiObj, openApiMetaField) => {
+    if (openApiObj == null || !openApiMetaField || openApiMetaField == null) {
+        return {};
+    }
+    const { operation } = getOpenApiOperationMethodAndEndpoint(openApiObj, openApiMetaField);
+    if (operation == null) {
+        return {};
+    }
+    return {
+        title: operation.summary,
+        description: operation.description,
+    };
+};
+//# sourceMappingURL=getOpenApiContext.js.map

package/bin/dev/getOpenApiContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOpenApiContext.js","sourceRoot":"","sources":["../../src/dev/getOpenApiContext.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,EAAE;IAC9C,MAAM,WAAW,GAAG,6BAA6B,CAAC;IAClD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAE/C,MAAM,gBAAgB,GAAG,WAAW;QAClC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM;QACrD,CAAC,CAAC,CAAC,CAAC;IAEN,OAAO;QACL,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS;QAC9D,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE;KACjD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,UAAU,EACV,gBAAgB,EAChB,EAAE;IACF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;IAExE,MAAM,IAAI,GAAG,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,KAAI,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7D,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,IAAI,SAAS,CAAC;IACd,IAAI,MAAM,EAAE;QACV,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;KACxC;SAAM;QACL,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;KACrC;IAED,OAAO;QACL,SAAS;QACT,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE;IAC5E,IAAI,UAAU,IAAI,IAAI,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,IAAI,IAAI,EAAE;QACvE,OAAO,EAAE,CAAC;KACX;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,oCAAoC,CACxD,UAAU,EACV,gBAAgB,CACjB,CAAC;IAEF,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IAED,OAAO;QACL,KAAK,EAAE,SAAS,CAAC,OAAO;QACxB,WAAW,EAAE,SAAS,CAAC,WAAW;KACnC,CAAC;AACJ,CAAC,CAAC"}

package/bin/dev/index.js

@@ -0,0 +1,164 @@
+import { existsSync } from "fs";
+import { promises as _promises } from "fs";
+import fse from "fs-extra";
+import { isInternetAvailable } from "is-internet-available";
+import path from "path";
+import shell from "shelljs";
+import SwaggerParser from "@apidevtools/swagger-parser";
+import { createPage, injectNav } from "./injectNav.js";
+import { CMD_EXEC_PATH, CLIENT_PATH, INSTALL_PATH } from "../constants.js";
+const { readdir, readFile } = _promises;
+const getFileList = async (dirName, og = dirName) => {
+    let files = [];
+    const items = await readdir(dirName, { withFileTypes: true });
+    for (const item of items) {
+        if (item.isDirectory()) {
+            files = [...files, ...(await getFileList(`${dirName}/${item.name}`, og))];
+        }
+        else {
+            const path = `${dirName}/${item.name}`;
+            const name = path.replace(og, "");
+            files.push({ path, isSymbolicLink: item.isSymbolicLink(), name });
+        }
+    }
+    return files;
+};
+const copyFiles = async () => {
+    shell.cd(CMD_EXEC_PATH);
+    const markdownFiles = [];
+    const staticFiles = [];
+    const allFilesInDocsFolder = await getFileList(CMD_EXEC_PATH);
+    const promises = [];
+    let openApi = undefined;
+    allFilesInDocsFolder.forEach((file) => {
+        promises.push((async () => {
+            const extension = file.name.substring(file.name.lastIndexOf(".") + 1, file.name.length) || file.name;
+            if (extension &&
+                (extension === "mdx" || extension === "md" || extension === "tsx")) {
+                markdownFiles.push(file.name);
+            }
+            else if (extension &&
+                (extension === "json" || extension === "yaml" || extension === "yml")) {
+                try {
+                    const fileContent = await readFile(file.path);
+                    fse.outputFileSync("openapi", fileContent.toString("utf-8"));
+                    const api = await SwaggerParser.validate("openapi");
+                    openApi = Buffer.from(JSON.stringify(api, null, 2), "utf-8");
+                }
+                catch (_a) {
+                    // not valid openApi
+                }
+            }
+            if (!file.name.endsWith("mint.config.json") ||
+                !file.name.endsWith("mint.json")) {
+                // all other files
+                staticFiles.push(file.name);
+            }
+        })());
+    });
+    await Promise.all(promises);
+    fse.removeSync("openapi");
+    const configTargetPath = path.join(CLIENT_PATH, "src", "mint.json");
+    fse.removeSync(configTargetPath);
+    let configObj = null;
+    let configPath = null;
+    if (existsSync(path.join(CMD_EXEC_PATH, "mint.config.json"))) {
+        configPath = path.join(CMD_EXEC_PATH, "mint.config.json");
+    }
+    if (existsSync(path.join(CMD_EXEC_PATH, "mint.json"))) {
+        configPath = path.join(CMD_EXEC_PATH, "mint.json");
+    }
+    while (configPath && !existsSync(configTargetPath)) {
+        await fse.remove(configTargetPath);
+        await fse.copy(configPath, configTargetPath);
+    }
+    const configContents = await readFile(configPath);
+    configObj = JSON.parse(configContents.toString());
+    const openApiTargetPath = path.join(CLIENT_PATH, "src", "openapi.json");
+    let openApiObj = null;
+    if (openApi) {
+        await fse.outputFile(openApiTargetPath, Buffer.from(openApi), {
+            flag: "w",
+        });
+        openApiObj = JSON.parse(openApi.toString());
+    }
+    else {
+        fse.outputFileSync(openApiTargetPath, "{}", { flag: "w" });
+    }
+    let pages = {};
+    const mdPromises = [];
+    markdownFiles.forEach(async (filename) => {
+        mdPromises.push((async () => {
+            const sourcePath = path.join(CMD_EXEC_PATH, filename);
+            const pagesDir = path.join(CLIENT_PATH, "src", "pages");
+            const targetPath = path.join(pagesDir, filename);
+            await fse.remove(targetPath);
+            await fse.copy(sourcePath, targetPath);
+            const fileContent = await readFile(sourcePath);
+            const contentStr = fileContent.toString();
+            const page = createPage(filename, contentStr, openApiObj);
+            pages = Object.assign(Object.assign({}, pages), page);
+        })());
+    });
+    await Promise.all(mdPromises);
+    injectNav(pages, configObj);
+    staticFiles.forEach(async (filename) => {
+        const sourcePath = path.join(CMD_EXEC_PATH, filename);
+        const publicDir = path.join(CLIENT_PATH, "public");
+        const targetPath = path.join(publicDir, filename);
+        await fse.remove(targetPath);
+        await fse.copy(sourcePath, targetPath);
+    });
+};
+const gitExists = () => {
+    let doesGitExist = true;
+    try {
+        shell.exec("git --version", { silent: true });
+    }
+    catch (e) {
+        doesGitExist = false;
+    }
+    return doesGitExist;
+};
+const dev = async () => {
+    shell.cd(INSTALL_PATH);
+    // TODO error messages
+    if (!existsSync(path.join(INSTALL_PATH, "mint"))) {
+        shell.exec("mkdir mint");
+    }
+    shell.cd("mint");
+    let runYarn = true;
+    const gitInstalled = gitExists();
+    if (!existsSync(path.join(INSTALL_PATH, "mint", ".git")) && gitInstalled) {
+        shell.exec("git init", { silent: true });
+        shell.exec("git remote add -f mint-origin https://github.com/mintlify/mint.git", { silent: true });
+    }
+    const internet = await isInternetAvailable();
+    let pullOutput = null;
+    if (internet && gitInstalled) {
+        shell.exec("git config core.sparseCheckout true", { silent: true });
+        shell.exec('echo "client/" >> .git/info/sparse-checkout', { silent: true });
+        pullOutput = shell.exec("git pull mint-origin main", {
+            silent: true,
+        }).stdout;
+        shell.exec("git config core.sparseCheckout false", { silent: true });
+        shell.exec("rm .git/info/sparse-checkout", { silent: true });
+    }
+    if (pullOutput === "Already up to date.\n") {
+        runYarn = false;
+    }
+    shell.cd(CLIENT_PATH);
+    if (runYarn) {
+        shell.exec("yarn", { silent: true });
+    }
+    // TODO check for mint.json before copying over files
+    await copyFiles();
+    run();
+};
+const run = () => {
+    shell.cd(CLIENT_PATH);
+    shell.exec("npm run dev");
+    open("https://localhost:3000");
+};
+export default dev;
+//# sourceMappingURL=index.js.map

package/bin/dev/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dev/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE3E,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;AAExC,MAAM,WAAW,GAAG,KAAK,EAAE,OAAe,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE;IAC1D,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,KAAK,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,MAAM,WAAW,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;SAC3E;aAAM;YACL,MAAM,IAAI,GAAG,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;SACnE;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;IAC3B,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACxB,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,oBAAoB,GAAG,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,OAAO,GAAG,SAAS,CAAC;IACxB,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACpC,QAAQ,CAAC,IAAI,CACX,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,SAAS,GACb,IAAI,CAAC,IAAI,CAAC,SAAS,CACjB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CACjB,IAAI,IAAI,CAAC,IAAI,CAAC;YACjB,IACE,SAAS;gBACT,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK,CAAC,EAClE;gBACA,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC/B;iBAAM,IACL,SAAS;gBACT,CAAC,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,EACrE;gBACA,IAAI;oBACF,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC9C,GAAG,CAAC,cAAc,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;oBAC7D,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;oBACpD,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;iBAC9D;gBAAC,WAAM;oBACN,oBAAoB;iBACrB;aACF;YACD,IACE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;gBACvC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAChC;gBACA,kBAAkB;gBAClB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAE1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IACpE,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACjC,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE;QAC5D,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;KAC3D;IAED,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,EAAE;QACrD,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;KACpD;IAED,OAAO,UAAU,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QAClD,MAAM,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;KAC9C;IACD,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAClD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC;IAElD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,OAAO,EAAE;QACX,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAC5D,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;QACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;KAC7C;SAAM;QACL,GAAG,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;KAC5D;IACD,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACvC,UAAU,CAAC,IAAI,CACb,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEjD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEvC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC/C,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC1D,KAAK,mCACA,KAAK,GACL,IAAI,CACR,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAE5B,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AACF,MAAM,SAAS,GAAG,GAAG,EAAE;IACrB,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,IAAI;QACF,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC/C;IAAC,OAAO,CAAC,EAAE;QACV,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;IACrB,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;IACvB,sBAAsB;IACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,EAAE;QAChD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC1B;IACD,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,YAAY,GAAG,SAAS,EAAE,CAAC;IACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,YAAY,EAAE;QACxE,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CACR,oEAAoE,EACpE,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;KACH;IAED,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC7C,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,QAAQ,IAAI,YAAY,EAAE;QAC5B,KAAK,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,KAAK,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACnD,MAAM,EAAE,IAAI;SACb,CAAC,CAAC,MAAM,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC9D;IACD,IAAI,UAAU,KAAK,uBAAuB,EAAE;QAC1C,OAAO,GAAG,KAAK,CAAC;KACjB;IACD,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,IAAI,OAAO,EAAE;QACX,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KACtC;IACD,qDAAqD;IACrD,MAAM,SAAS,EAAE,CAAC;IAClB,GAAG,EAAE,CAAC;AACR,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,GAAG,EAAE;IACf,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,IAAI,CAAC,wBAAwB,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}

package/bin/dev/injectNav.js

@@ -0,0 +1,97 @@
+// TODO - add types
+import fs from "fs-extra";
+import matter from "gray-matter";
+import path from "path";
+import { getOpenApiTitleAndDescription } from "./getOpenApiContext.js";
+import { slugToTitle } from "./slugToTitle.js";
+import { CLIENT_PATH } from "../constants.js";
+// End matter is front matter, but at the end
+const getIndexOfEndMatter = (fileContents) => {
+    const frontMatters = fileContents.match(/---\n(title:.+\n|description:.+\n|sidebarTitle:.+\n|api:.+\n|openapi:.+\n)+---$/m);
+    if (frontMatters) {
+        return fileContents.indexOf(frontMatters[0]);
+    }
+    return -1;
+};
+export const potentiallyRemoveEndMatter = (fileContents) => {
+    const endMatterIndex = getIndexOfEndMatter(fileContents);
+    if (endMatterIndex === -1) {
+        return fileContents;
+    }
+    return fileContents.substring(0, endMatterIndex);
+};
+const getMetadata = (fileContents) => {
+    const { data } = matter(fileContents);
+    if (Object.keys(data).length > 0) {
+        return data;
+    }
+    const startIndex = getIndexOfEndMatter(fileContents);
+    if (startIndex === -1) {
+        return {};
+    }
+    const fileContentFromFrontMatter = fileContents.substring(startIndex);
+    const { data: nonTopFrontMatter } = matter(fileContentFromFrontMatter);
+    return nonTopFrontMatter;
+};
+export const createPage = (path, content, openApiObj) => {
+    const slug = path.replace(/\.mdx?$/, "").substring(1);
+    let defaultTitle = slugToTitle(slug);
+    const metadata = getMetadata(content);
+    // Append data from OpenAPI if it exists
+    const { title, description } = getOpenApiTitleAndDescription(openApiObj, metadata === null || metadata === void 0 ? void 0 : metadata.openapi);
+    if (title) {
+        defaultTitle = title;
+    }
+    return {
+        [slug]: Object.assign(Object.assign({ title: defaultTitle, description }, metadata), { href: `/${slug}` }),
+    };
+};
+export const injectNav = (pages, configObj) => {
+    const targetPath = path.join(CLIENT_PATH, "src", "nav.json");
+    const createNav = (nav) => {
+        return {
+            group: nav.group,
+            pages: nav.pages.map((page) => {
+                if (typeof page === "string") {
+                    return pages[page];
+                }
+                return createNav(page);
+            }),
+        };
+    };
+    if ((configObj === null || configObj === void 0 ? void 0 : configObj.navigation) == null) {
+        return;
+    }
+    let navFile = configObj.navigation.map((nav) => createNav(nav));
+    const filterOutNullInPages = (pages) => {
+        const newPages = [];
+        pages.forEach((page) => {
+            if (page == null) {
+                return;
+            }
+            if (page === null || page === void 0 ? void 0 : page.pages) {
+                const newGroup = filterOutNullInGroup(page);
+                newPages.push(newGroup);
+            }
+            else {
+                newPages.push(page);
+            }
+        });
+        return newPages;
+    };
+    const filterOutNullInGroup = (group) => {
+        const newPages = filterOutNullInPages(group.pages);
+        const newGroup = Object.assign(Object.assign({}, group), { pages: newPages });
+        return newGroup;
+    };
+    const newNavFile = navFile.map((group) => {
+        return filterOutNullInGroup(group);
+    });
+    console.log({ targetPath });
+    console.log({ newNavFile });
+    fs.outputFileSync(targetPath, JSON.stringify(newNavFile, null, 2), {
+        flag: "w",
+    });
+    console.log(`⛵️ Navigation generated and injected`);
+};
+//# sourceMappingURL=injectNav.js.map

package/bin/dev/injectNav.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectNav.js","sourceRoot":"","sources":["../../src/dev/injectNav.ts"],"names":[],"mappings":"AAAA,mBAAmB;AACnB,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,6BAA6B,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,6CAA6C;AAC7C,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAE;IACnD,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CACrC,kFAAkF,CACnF,CAAC;IACF,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;KAC9C;IAED,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,YAAoB,EAAE,EAAE;IACjE,MAAM,cAAc,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAEzD,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE;QACzB,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,YAAoB,EAAE,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IAEtC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACrD,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IAED,MAAM,0BAA0B,GAAG,YAAY,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;IACvE,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAY,EACZ,OAAe,EACf,UAAyB,EACzB,EAAE;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACtD,IAAI,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,wCAAwC;IACxC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,6BAA6B,CAC1D,UAAU,EACV,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAClB,CAAC;IACF,IAAI,KAAK,EAAE;QACT,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,OAAO;QACL,CAAC,IAAI,CAAC,gCAAI,KAAK,EAAE,YAAY,EAAE,WAAW,IAAK,QAAQ,KAAE,IAAI,EAAE,IAAI,IAAI,EAAE,GAAE;KAC5E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,SAAc,EAAE,EAAE;IACtD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE;QACxB,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC5B,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;iBACpB;gBAED,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC,CAAC;SACH,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,KAAI,IAAI,EAAE;QACjC,OAAO;KACR;IAED,IAAI,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,OAAO;aACR;YACD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;gBACf,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;gBAC5C,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aACzB;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,QAAQ,mCACT,KAAK,KACR,KAAK,EAAE,QAAQ,GAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5B,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5B,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;QACjE,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;AACtD,CAAC,CAAC"}

package/bin/dev/slugToTitle.js

@@ -0,0 +1,8 @@
+export const slugToTitle = (slug) => {
+    const slugArr = slug.split("/");
+    let defaultTitle = slugArr[slugArr.length - 1].split("-").join(" "); //replace all dashes
+    defaultTitle = defaultTitle.split("_").join(" "); //replace all underscores
+    defaultTitle = defaultTitle.charAt(0).toUpperCase() + defaultTitle.slice(1); //capitalize first letter
+    return defaultTitle;
+};
+//# sourceMappingURL=slugToTitle.js.map

package/bin/dev/slugToTitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugToTitle.js","sourceRoot":"","sources":["../../src/dev/slugToTitle.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,EAAE;IAClC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB;IACzF,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,yBAAyB;IAC3E,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,yBAAyB;IACtG,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}