@mintlify/previewing 4.0.324 → 4.0.326

package/dist/local-preview/listener/generate.d.ts

@@ -1,2 +1,112 @@
 import type { DecoratedNavigationPage } from '@mintlify/models';
-export declare const generateNav: (pagesAcc?: Record<string, DecoratedNavigationPage>) => Promise<import("@mintlify/models").DecoratedNavigation>;
+export declare const generateNav: (pagesAcc: Record<string, DecoratedNavigationPage>) => Promise<{
+    generatedNav: import("@mintlify/models").DecoratedNavigation;
+    generatedDocsNav: {
+        global?: {
+            languages?: ({
+                language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
+                hidden?: boolean | undefined;
+            } & {
+                href: string;
+            })[] | undefined;
+            versions?: ({
+                version: string;
+                hidden?: boolean | undefined;
+            } & {
+                href: string;
+            })[] | undefined;
+            tabs?: ({
+                tab: string;
+                icon?: string | {
+                    name: string;
+                    style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+                } | undefined;
+                hidden?: boolean | undefined;
+            } & {
+                href: string;
+            })[] | undefined;
+            dropdowns?: ({
+                dropdown: string;
+                icon?: string | {
+                    name: string;
+                    style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+                } | undefined;
+                hidden?: boolean | undefined;
+            } & {
+                href: string;
+            })[] | undefined;
+            anchors?: ({
+                anchor: string;
+                icon?: string | {
+                    name: string;
+                    style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+                } | undefined;
+                color?: {
+                    light?: string | undefined;
+                    dark?: string | undefined;
+                } | undefined;
+                hidden?: boolean | undefined;
+            } & {
+                href: string;
+            })[] | undefined;
+        } | undefined;
+    } & ({
+        languages: any[];
+    } | {
+        versions: any[];
+    } | {
+        tabs: any[];
+    } | {
+        dropdowns: any[];
+    } | {
+        anchors: any[];
+    } | {
+        groups: ({
+            group: string;
+            icon?: string | {
+                name: string;
+                style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+            } | undefined;
+            hidden?: boolean | undefined;
+            root?: string | {
+                href: string;
+                title: string;
+                sidebarTitle?: string | undefined;
+                description?: string | undefined;
+                api?: string | undefined;
+                openapi?: string | undefined;
+                contentType?: string | undefined;
+                authMethod?: string | undefined;
+                auth?: string | undefined;
+                version?: string | undefined;
+                mode?: string | undefined;
+                hideFooterPagination?: boolean | undefined;
+                authors?: unknown;
+                lastUpdatedDate?: string | undefined;
+                createdDate?: string | undefined;
+                "openapi-schema"?: string | undefined;
+                icon?: string | {
+                    name: string;
+                    style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
+                } | undefined;
+                tag?: string | undefined;
+                url?: string | undefined;
+                hideApiMarker?: boolean | undefined;
+                noindex?: boolean | undefined;
+                isPublic?: boolean | undefined;
+            } | undefined;
+        } & ({
+            openapi: (string | string[] | {
+                source: string;
+                directory?: string | undefined;
+            }) & (string | string[] | {
+                source: string;
+                directory?: string | undefined;
+            } | undefined);
+        } | {
+            pages: any[];
+        }))[];
+    } | {
+        pages: any[];
+    });
+}>;

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

@@ -7,7 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { generateDecoratedMintNavigationFromPages, getConfigObj, categorizeFilePaths, createPage, } from '@mintlify/prebuild';
+import { generateDecoratedMintNavigationFromPages, getConfigObj, categorizeFilePaths, createPage, generateDecoratedDocsNavigationFromPages, } from '@mintlify/prebuild';
+import { upgradeToDocsConfig } from '@mintlify/validation';
 import { promises as _promises } from 'fs';
 import { join } from 'path';
 import { CMD_EXEC_PATH, NEXT_PROPS_PATH } from '../../constants.js';
@@ -26,10 +27,14 @@ const createFilenamePageMetadataMap = (contentDirectoryPath_1, contentFilenames_
     return pagesAcc;
 });
 export const generateNav = (pagesAcc) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     const { contentFilenames, openApiFiles } = yield categorizeFilePaths(CMD_EXEC_PATH);
-    const [filenamePageMetadataMap, configObj] = yield Promise.all([
+    const [filenamePageMetadataMap, configObj, docsConfigObj] = yield Promise.all([
         createFilenamePageMetadataMap(CMD_EXEC_PATH, contentFilenames, openApiFiles, pagesAcc),
         getConfigObj(NEXT_PROPS_PATH, 'mint'),
+        getConfigObj(NEXT_PROPS_PATH, 'docs'),
     ]);
-    return generateDecoratedMintNavigationFromPages(filenamePageMetadataMap, configObj === null || configObj === void 0 ? void 0 : configObj.navigation);
+    const generatedNav = generateDecoratedMintNavigationFromPages(filenamePageMetadataMap, configObj === null || configObj === void 0 ? void 0 : configObj.navigation);
+    const generatedDocsNav = generateDecoratedDocsNavigationFromPages(filenamePageMetadataMap, (_a = docsConfigObj === null || docsConfigObj === void 0 ? void 0 : docsConfigObj.navigation) !== null && _a !== void 0 ? _a : upgradeToDocsConfig(configObj).navigation);
+    return { generatedNav, generatedDocsNav };
 });

package/dist/local-preview/listener/getDocsState.d.ts

@@ -1,6 +1,8 @@
 import type { DecoratedNavigationPage, MintConfig, OpenApiFile } from '@mintlify/models';
+import { DocsConfig } from '@mintlify/validation';
 export declare const getDocsState: () => Promise<{
     mintConfig: MintConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;
     openApiFiles: OpenApiFile[];
+    docsConfig: DocsConfig;
 }>;

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

@@ -7,15 +7,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { validateMintJson, generateOpenApiAnchorsOrTabs, categorizeFilePaths, } from '@mintlify/prebuild';
-import { promises as _promises } from 'fs';
+import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivisions, MintConfigUpdater, DocsConfigUpdater, } from '@mintlify/prebuild';
+import { upgradeToDocsConfig } from '@mintlify/validation';
+import fse from 'fs-extra';
 import { join } from 'path';
 import { CMD_EXEC_PATH, CLIENT_PATH } from '../../constants.js';
-const { readFile } = _promises;
 export const getDocsState = () => __awaiter(void 0, void 0, void 0, function* () {
     const mintJsonPath = join(CMD_EXEC_PATH, 'mint.json');
-    const mintJsonFileContent = yield readFile(mintJsonPath, 'utf8');
-    const validationResults = yield validateMintJson(mintJsonFileContent);
+    const mintConfig = yield MintConfigUpdater.getConfig(mintJsonPath);
+    let docsConfig = upgradeToDocsConfig(mintConfig);
+    const docsJsonPath = join(CMD_EXEC_PATH, 'docs.json');
+    if (yield fse.pathExists(docsJsonPath)) {
+        docsConfig = yield DocsConfigUpdater.getConfig(docsJsonPath);
+    }
     const { openApiFiles } = yield categorizeFilePaths(CMD_EXEC_PATH);
-    return yield generateOpenApiAnchorsOrTabs(validationResults.data, openApiFiles, CLIENT_PATH);
+    const { mintConfig: newMintConfig } = yield generateOpenApiAnchorsOrTabs(mintConfig, openApiFiles, CLIENT_PATH);
+    const { newDocsConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = yield generateOpenApiDivisions(docsConfig, openApiFiles, CLIENT_PATH);
+    return {
+        mintConfig: newMintConfig,
+        pagesAcc,
+        openApiFiles: newOpenApiFiles,
+        docsConfig: newDocsConfig,
+    };
 });

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

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { findAndRemoveImports, hasImports, getFileCategory, openApiCheck } from '@mintlify/common';
-import { createPage, preparseMdx, writeMintConfigFile } from '@mintlify/prebuild';
+import { createPage, preparseMdx, MintConfigUpdater, DocsConfigUpdater } from '@mintlify/prebuild';
 import Chalk from 'chalk';
 import chokidar from 'chokidar';
 import { promises as _promises } from 'fs';
@@ -46,6 +46,7 @@ const onAddEvent = (filename, callback) => __awaiter(void 0, void 0, void 0, fun
                 console.log('New snippet detected: ', filename);
                 break;
             case 'mintConfig':
+            case 'docsConfig':
                 console.log('Config added');
                 break;
             case 'openApi':
@@ -78,6 +79,7 @@ const onChangeEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
                 console.log('Snippet edited: ', filename);
                 break;
             case 'mintConfig':
+            case 'docsConfig':
                 console.log('Config edited');
                 break;
             case 'openApi':
@@ -105,6 +107,7 @@ const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function*
         if (potentialCategory === 'page' ||
             potentialCategory === 'snippet' ||
             potentialCategory === 'mintConfig' ||
+            potentialCategory === 'docsConfig' ||
             potentialCategory === 'staticFile' ||
             potentialCategory === 'snippet-v2' ||
             potentialCategory === 'css' ||
@@ -122,6 +125,8 @@ const onUnlinkEvent = (filename) => __awaiter(void 0, void 0, void 0, function*
             case 'mintConfig':
                 console.error('⚠️ mint.json is required, but has been deleted. Exiting.');
                 process.exit(1);
+            case 'docsConfig':
+                console.error('⚠️ docs.json has been deleted.');
             case 'potentialJsonOpenApiSpec':
             case 'potentialYamlOpenApiSpec':
                 yield updateOpenApiFiles();
@@ -148,6 +153,8 @@ const getTargetPath = (potentialCategory, filePath) => {
             return pathUtil.join(NEXT_PROPS_PATH, filePath);
         case 'mintConfig':
             return pathUtil.join(NEXT_PROPS_PATH, 'mint.json');
+        case 'docsConfig':
+            return pathUtil.join(NEXT_PROPS_PATH, 'docs.json');
         case 'potentialYamlOpenApiSpec':
         case 'potentialJsonOpenApiSpec':
             return pathUtil.join(NEXT_PROPS_PATH, 'openApiFiles.json');
@@ -206,10 +213,12 @@ const onUpdateEvent = (filename, callback) => __awaiter(void 0, void 0, void 0,
             break;
         }
         case 'mintConfig':
+        case 'docsConfig':
             regenerateNav = true;
             try {
-                const { mintConfig, openApiFiles } = yield getDocsState();
-                yield writeMintConfigFile(mintConfig, CLIENT_PATH);
+                const { mintConfig, openApiFiles, docsConfig } = yield getDocsState();
+                yield MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                yield DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
                 yield updateOpenApiFiles(openApiFiles);
             }
             catch (err) {

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

@@ -15,11 +15,15 @@ import { generateNav } from './generate.js';
 import { getDocsState } from './getDocsState.js';
 export const updateGeneratedNav = () => __awaiter(void 0, void 0, void 0, function* () {
     const { pagesAcc } = yield getDocsState();
-    const generatedNav = yield generateNav(pagesAcc);
+    const { generatedNav, generatedDocsNav } = yield generateNav(pagesAcc);
     const targetPath = join(CLIENT_PATH, 'src', '_props', 'generatedNav.json');
     yield fse.outputFile(targetPath, JSON.stringify(generatedNav, null, 2), {
         flag: 'w',
     });
+    const targetDocsPath = join(CLIENT_PATH, 'src', '_props', 'generatedDocsNav.json');
+    yield fse.outputFile(targetDocsPath, JSON.stringify(generatedDocsNav, null, 2), {
+        flag: 'w',
+    });
 });
 export const updateOpenApiFiles = (providedOpenApiFiles) => __awaiter(void 0, void 0, void 0, function* () {
     if (providedOpenApiFiles == undefined) {