@mintlify/prebuild 1.0.318 → 1.0.320

package/dist/prebuild/update/docsConfig/index.js

@@ -1,17 +1,19 @@
 import { getConfigPath } from '../../../utils.js';
 import { DocsConfigUpdater } from '../ConfigUpdater.js';
 import { generateOpenApiDivisions } from './generateOpenApiDivisions.js';
-export const validateDocsJson = DocsConfigUpdater.validateDocsConfigJson;
-export const writeDocsConfigFile = DocsConfigUpdater.writeConfigFile;
-export async function updateDocsConfigFile(contentDirectoryPath, openApiFiles) {
+export async function updateDocsConfigFile(contentDirectoryPath, openApiFiles, docsConfig) {
     const configPath = await getConfigPath(contentDirectoryPath, 'docs');
-    if (configPath == null) {
+    if (configPath == null && docsConfig == null) {
         throw Error('Must be run in a directory where a docs.json file exists.');
     }
-    const docsConfigContents = await DocsConfigUpdater.readConfigFile(configPath);
-    const validationResults = await DocsConfigUpdater.validateDocsConfigJson(docsConfigContents);
-    const { newDocsConfig: docsConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiDivisions(validationResults.data, openApiFiles);
-    await DocsConfigUpdater.writeConfigFile(docsConfig);
-    return { docsConfig, pagesAcc, openApiFiles: newOpenApiFiles };
+    if (docsConfig == null && configPath) {
+        docsConfig = await DocsConfigUpdater.getConfig(configPath);
+    }
+    if (docsConfig == null) {
+        throw Error('Must be run in a directory where a docs.json file exists.');
+    }
+    const { newDocsConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiDivisions(docsConfig, openApiFiles);
+    await DocsConfigUpdater.writeConfigFile(newDocsConfig);
+    return { docsConfig: newDocsConfig, pagesAcc, newOpenApiFiles };
 }
 export { generateOpenApiDivisions } from './generateOpenApiDivisions.js';

package/dist/prebuild/update/index.d.ts

@@ -1,8 +1,9 @@
-import type { ConfigType, OpenApiFile } from '@mintlify/models';
-export declare const update: (contentDirectoryPath: string, staticFilenames: string[], openApiFiles: OpenApiFile[], contentFilenames: string[], snippets: string[], snippetV2Filenames: string[], configType?: ConfigType) => Promise<import("@mintlify/models").MintConfig>;
+import type { OpenApiFile } from '@mintlify/models';
+export declare const update: (contentDirectoryPath: string, staticFilenames: string[], openApiFiles: OpenApiFile[], contentFilenames: string[], snippets: string[], snippetV2Filenames: string[], docsConfigPath?: string | null) => Promise<import("@mintlify/models").MintConfig>;
 export declare const writeMdxFilesWithNoImports: (mdxFilesWithNoImports: {
     targetPath: string;
     fileContent: string;
 }[]) => Promise<void>[];
 export * from './mintConfig/index.js';
 export * from './docsConfig/index.js';
+export * from './ConfigUpdater.js';

package/dist/prebuild/update/index.js

@@ -1,14 +1,18 @@
+import { upgradeToDocsConfig } from '@mintlify/validation';
 import { outputFile } from 'fs-extra';
+import { updateDocsConfigFile } from './docsConfig/index.js';
 import { updateMintConfigFile } from './mintConfig/index.js';
 import { readPageContents, readSnippetsV2Contents } from './read/readContent.js';
 import { resolveImportsAndWriteFiles } from './resolveImportsAndWriteFiles.js';
 import { updateFavicons } from './updateFavicons.js';
-import { updateGeneratedNav } from './updateGeneratedNav.js';
+import { updateGeneratedDocsNav, updateGeneratedNav } from './updateGeneratedNav.js';
 import { writeFiles } from './write/writeFiles.js';
 import { writeOpenApiFiles } from './write/writeOpenApiFiles.js';
-export const update = async (contentDirectoryPath, staticFilenames, openApiFiles, contentFilenames, snippets, snippetV2Filenames, configType = 'mint') => {
-    const { mintConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await updateMintConfigFile(contentDirectoryPath, openApiFiles);
-    const pagePromises = readPageContents(contentDirectoryPath, openApiFiles, contentFilenames, pagesAcc);
+export const update = async (contentDirectoryPath, staticFilenames, openApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath) => {
+    const { mintConfig } = await updateMintConfigFile(contentDirectoryPath, openApiFiles);
+    const docsConfig = upgradeToDocsConfig(mintConfig);
+    const { docsConfig: newDocsConfig, pagesAcc, newOpenApiFiles, } = await updateDocsConfigFile(contentDirectoryPath, openApiFiles, docsConfigPath ? undefined : docsConfig);
+    const pagePromises = readPageContents(contentDirectoryPath, newOpenApiFiles, contentFilenames, pagesAcc);
     const snippetV2Promises = readSnippetsV2Contents(contentDirectoryPath, snippetV2Filenames);
     const [snippetV2Contents, { mdxFilesWithNoImports, filesWithImports }] = await Promise.all([
         snippetV2Promises,
@@ -21,13 +25,8 @@ export const update = async (contentDirectoryPath, staticFilenames, openApiFiles
         ...writeMdxFilesWithNoImports(mdxFilesWithNoImports),
         ...writeFiles(contentDirectoryPath, 'public', [...staticFilenames, ...snippets]),
     ]);
-    if (configType === 'docs') {
-        // TODO: after merging the docs openapi PR
-        // await updateGeneratedDocsNav(pagesAcc, docsConfig.navigation);
-    }
-    else {
-        await updateGeneratedNav(pagesAcc, mintConfig.navigation);
-    }
+    await updateGeneratedDocsNav(pagesAcc, newDocsConfig.navigation);
+    await updateGeneratedNav(pagesAcc, mintConfig.navigation);
     return mintConfig;
 };
 export const writeMdxFilesWithNoImports = (mdxFilesWithNoImports) => {
@@ -40,3 +39,4 @@ export const writeMdxFilesWithNoImports = (mdxFilesWithNoImports) => {
 };
 export * from './mintConfig/index.js';
 export * from './docsConfig/index.js';
+export * from './ConfigUpdater.js';

package/dist/prebuild/update/mintConfig/index.d.ts

@@ -1,246 +1,4 @@
 import { DecoratedNavigationPage, MintConfig, OpenApiFile } from '@mintlify/models';
-export declare const validateMintJson: (configContents: string) => Promise<{
-    warnings: import("zod").ZodIssue[];
-    success: true;
-    data: {
-        name: string;
-        $schema: string;
-        favicon: string;
-        colors: {
-            primary: string;
-            light?: string | undefined;
-            dark?: string | undefined;
-            background?: {
-                light?: string | undefined;
-                dark?: string | undefined;
-            } | undefined;
-            anchors?: string | {
-                from: string;
-                to: string;
-                via?: string | undefined;
-            } | undefined;
-            ultraLight?: any;
-            ultraDark?: any;
-        };
-        navigation: import("@mintlify/models").NavigationGroup[];
-        mintlify?: string | undefined;
-        logo?: string | {
-            light: string;
-            dark: string;
-            href?: string | undefined;
-        } | undefined;
-        theme?: "venus" | "quill" | "prism" | undefined;
-        layout?: "topnav" | "sidenav" | "solidSidenav" | undefined;
-        openapi?: string | string[] | undefined;
-        topbar?: {
-            style?: "gradient" | "default" | undefined;
-        } | undefined;
-        sidebar?: {
-            items?: "container" | "card" | "border" | "undecorated" | undefined;
-        } | undefined;
-        rounded?: "default" | "sharp" | undefined;
-        api?: {
-            baseUrl?: string | string[] | undefined;
-            auth?: {
-                method?: "key" | "bearer" | "basic" | "cobo" | undefined;
-                name?: string | undefined;
-                inputPrefix?: string | undefined;
-            } | undefined;
-            playground?: {
-                mode: "show" | "simple" | "hide";
-                disableProxy?: boolean | undefined;
-            } | undefined;
-            request?: {
-                example?: {
-                    showOptionalParams?: boolean | undefined;
-                    languages?: string[] | undefined;
-                } | undefined;
-            } | undefined;
-            maintainOrder?: boolean | undefined;
-            paramFields?: {
-                expanded?: "all" | "topLevel" | "topLevelOneOfs" | "none" | undefined;
-            } | undefined;
-        } | undefined;
-        modeToggle?: {
-            default?: "light" | "dark" | undefined;
-            isHidden?: boolean | undefined;
-        } | undefined;
-        versions?: (string | {
-            name: string;
-            url?: string | undefined;
-            default?: true | undefined;
-            locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
-        })[] | undefined;
-        metadata?: Record<string, string> | undefined;
-        codeBlock?: {
-            mode?: "dark" | "auto" | undefined;
-        } | undefined;
-        eyebrow?: {
-            display?: "section" | "breadcrumbs" | undefined;
-        } | undefined;
-        topbarCtaButton?: {
-            name: string;
-            url: string;
-            type?: "link" | undefined;
-            style?: "pill" | "roundedRectangle" | undefined;
-            arrow?: boolean | undefined;
-        } | {
-            type: "github";
-            url: string;
-        } | undefined;
-        topbarLinks?: ({
-            name: string;
-            url: string;
-            type?: "link" | undefined;
-            style?: "pill" | "roundedRectangle" | undefined;
-            arrow?: boolean | undefined;
-        } | {
-            type: "github";
-            url: string;
-        })[] | undefined;
-        primaryTab?: {
-            name: string;
-            isDefaultHidden?: boolean | undefined;
-        } | undefined;
-        topAnchor?: {
-            name: string;
-            icon?: string | undefined;
-            iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-        } | undefined;
-        anchors?: {
-            name: string;
-            url: string;
-            icon?: string | undefined;
-            iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
-            color?: string | {
-                from: string;
-                to: string;
-                via?: string | undefined;
-            } | undefined;
-            isDefaultHidden?: boolean | undefined;
-            version?: string | undefined;
-            openapi?: string | undefined;
-        }[] | undefined;
-        tabs?: {
-            name: string;
-            url: string;
-            version?: string | undefined;
-            isDefaultHidden?: boolean | undefined;
-            openapi?: string | undefined;
-        }[] | undefined;
-        footer?: {
-            socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | {
-                type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter";
-                url: string;
-            }[] | undefined;
-            links?: {
-                links: {
-                    url: string;
-                    label: string;
-                }[];
-                title?: string | undefined;
-            }[] | undefined;
-        } | undefined;
-        background?: {
-            style?: "gradient" | "grid" | "windows" | undefined;
-        } | undefined;
-        backgroundImage?: string | undefined;
-        font?: {
-            family: string;
-            weight?: number | undefined;
-            url?: string | undefined;
-            format?: "woff" | "woff2" | undefined;
-        } | {
-            headings?: {
-                family: string;
-                weight?: number | undefined;
-                url?: string | undefined;
-                format?: "woff" | "woff2" | undefined;
-            } | undefined;
-            body?: {
-                family: string;
-                weight?: number | undefined;
-                url?: string | undefined;
-                format?: "woff" | "woff2" | undefined;
-            } | undefined;
-        } | undefined;
-        feedback?: {
-            thumbsRating?: boolean | undefined;
-            suggestEdit?: boolean | undefined;
-            raiseIssue?: boolean | undefined;
-        } | undefined;
-        analytics?: {
-            amplitude?: {
-                apiKey: string;
-            } | undefined;
-            clearbit?: {
-                publicApiKey: string;
-            } | undefined;
-            fathom?: {
-                siteId: string;
-            } | undefined;
-            ga4?: {
-                measurementId: string;
-            } | undefined;
-            gtm?: {
-                tagId: string;
-            } | undefined;
-            heap?: {
-                appId: string;
-            } | undefined;
-            hotjar?: {
-                hjid: string;
-                hjsv: string;
-            } | undefined;
-            koala?: {
-                publicApiKey: string;
-            } | undefined;
-            logrocket?: {
-                appId: string;
-            } | undefined;
-            mixpanel?: {
-                projectToken: string;
-            } | undefined;
-            pirsch?: {
-                id: string;
-            } | undefined;
-            posthog?: {
-                apiKey: string;
-                apiHost?: string | undefined;
-            } | undefined;
-            plausible?: {
-                domain: string;
-                server?: string | undefined;
-            } | undefined;
-            segment?: {
-                key: string;
-            } | undefined;
-        } | undefined;
-        integrations?: {
-            intercom?: string | undefined;
-            frontchat?: string | undefined;
-            osano?: string | undefined;
-        } | undefined;
-        isWhiteLabeled?: boolean | undefined;
-        search?: {
-            prompt?: string | undefined;
-            location?: "side" | "top" | undefined;
-        } | undefined;
-        redirects?: {
-            source: string;
-            destination: string;
-            permanent?: boolean | undefined;
-        }[] | undefined;
-        seo?: {
-            indexHiddenPages?: boolean | undefined;
-        } | undefined;
-        footerSocials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | {
-            type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter";
-            url: string;
-        }[] | undefined;
-    };
-}>;
-export declare const writeMintConfigFile: (config: MintConfig | import("@mintlify/validation").DocsConfig, targetDir?: string) => Promise<void>;
 export declare function updateMintConfigFile(contentDirectoryPath: string, openApiFiles: OpenApiFile[]): Promise<{
     mintConfig: MintConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;

package/dist/prebuild/update/mintConfig/index.js

@@ -1,17 +1,14 @@
 import { getConfigPath } from '../../../utils.js';
 import { MintConfigUpdater } from '../ConfigUpdater.js';
 import { generateOpenApiAnchorsOrTabs } from './generateOpenApiAnchorsOrTabs.js';
-export const validateMintJson = MintConfigUpdater.validateMintConfigJson;
-export const writeMintConfigFile = MintConfigUpdater.writeConfigFile;
 export async function updateMintConfigFile(contentDirectoryPath, openApiFiles) {
     const configPath = await getConfigPath(contentDirectoryPath, 'mint');
     if (configPath == null) {
         throw Error('Must be run in a directory where a mint.json file exists.');
     }
-    const mintConfigContents = await MintConfigUpdater.readConfigFile(configPath);
-    const validationResults = await MintConfigUpdater.validateMintConfigJson(mintConfigContents);
-    const { mintConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiAnchorsOrTabs(validationResults.data, openApiFiles);
-    await MintConfigUpdater.writeConfigFile(mintConfig);
-    return { mintConfig, pagesAcc, openApiFiles: newOpenApiFiles };
+    const mintConfig = await MintConfigUpdater.getConfig(configPath);
+    const { mintConfig: newMintConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiAnchorsOrTabs(mintConfig, openApiFiles);
+    await MintConfigUpdater.writeConfigFile(newMintConfig);
+    return { mintConfig: newMintConfig, pagesAcc, openApiFiles: newOpenApiFiles };
 }
 export { generateOpenApiAnchorsOrTabs, generateOpenApiAnchorOrTab, } from './generateOpenApiAnchorsOrTabs.js';