@mintlify/prebuild 1.0.317 → 1.0.318

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

@@ -0,0 +1,17 @@
+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) {
+    const configPath = await getConfigPath(contentDirectoryPath, 'docs');
+    if (configPath == 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 };
+}
+export { generateOpenApiDivisions } from './generateOpenApiDivisions.js';

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

@@ -5,3 +5,4 @@ export declare const writeMdxFilesWithNoImports: (mdxFilesWithNoImports: {
     fileContent: string;
 }[]) => Promise<void>[];
 export * from './mintConfig/index.js';
+export * from './docsConfig/index.js';

package/dist/prebuild/update/index.js

@@ -39,3 +39,4 @@ export const writeMdxFilesWithNoImports = (mdxFilesWithNoImports) => {
     });
 };
 export * from './mintConfig/index.js';
+export * from './docsConfig/index.js';

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

@@ -1,9 +1,9 @@
 import { getOpenApiDocumentFromUrl } from '@mintlify/common';
 import { generateOpenApiPages } from '@mintlify/scraping';
 import * as path from 'path';
-import { getOpenApiFilesFromMintConfig } from '../read/getOpenApiFilesFromMintConfig.js';
+import { getOpenApiFilesFromConfig } from '../read/getOpenApiFilesFromConfig.js';
 export const generateOpenApiAnchorsOrTabs = async (mintConfig, openApiFiles, targetDir) => {
-    const openapiFilesFromMintConfig = await getOpenApiFilesFromMintConfig(mintConfig);
+    const openapiFilesFromMintConfig = await getOpenApiFilesFromConfig('mint', mintConfig);
     openApiFiles.push(...openapiFilesFromMintConfig);
     const pagesAcc = {};
     const [anchorOpenApiInfo, tabOpenApiInfo] = await Promise.all([

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

@@ -1,9 +1,249 @@
 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>;
     openApiFiles: OpenApiFile[];
 }>;
-export declare const writeMintConfigFile: (deploymentConfig: MintConfig, targetDir?: string) => Promise<void>;
-export { validateMintJson } from './validateMintJson.js';
 export { generateOpenApiAnchorsOrTabs, generateOpenApiAnchorOrTab, } from './generateOpenApiAnchorsOrTabs.js';

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

@@ -1,40 +1,17 @@
-import { promises as _promises } from 'fs';
-import fse from 'fs-extra';
-import { join } from 'path';
 import { getConfigPath } from '../../../utils.js';
+import { MintConfigUpdater } from '../ConfigUpdater.js';
 import { generateOpenApiAnchorsOrTabs } from './generateOpenApiAnchorsOrTabs.js';
-import { validateMintJson } from './validateMintJson.js';
-const { readFile } = _promises;
+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 readMintConfigFile(configPath);
-    const validationResults = await validateMintJson(mintConfigContents);
+    const mintConfigContents = await MintConfigUpdater.readConfigFile(configPath);
+    const validationResults = await MintConfigUpdater.validateMintConfigJson(mintConfigContents);
     const { mintConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiAnchorsOrTabs(validationResults.data, openApiFiles);
-    await writeMintConfigFile(mintConfig);
+    await MintConfigUpdater.writeConfigFile(mintConfig);
     return { mintConfig, pagesAcc, openApiFiles: newOpenApiFiles };
 }
-const readMintConfigFile = async (configPath) => {
-    let configContents;
-    try {
-        configContents = await readFile(configPath, 'utf-8');
-    }
-    catch (err) {
-        throw Error(`Unable to read mint.json: ${err}`);
-    }
-    return configContents;
-};
-export const writeMintConfigFile = async (deploymentConfig, targetDir) => {
-    try {
-        await fse.outputFile(join(targetDir ?? '', 'src/_props/mint.json'), JSON.stringify(deploymentConfig, null, 2), {
-            flag: 'w',
-        });
-    }
-    catch (err) {
-        throw Error(`Unable to write mint.json: ${err}`);
-    }
-};
-export { validateMintJson } from './validateMintJson.js';
 export { generateOpenApiAnchorsOrTabs, generateOpenApiAnchorOrTab, } from './generateOpenApiAnchorsOrTabs.js';

package/dist/prebuild/update/read/getOpenApiFilesFromConfig.d.ts

@@ -0,0 +1,5 @@
+import type { ConfigType, MintConfig, OpenApiFile } from '@mintlify/models';
+import { DocsConfig } from '@mintlify/validation';
+type ConfigInput<T extends ConfigType> = T extends 'docs' ? DocsConfig : MintConfig;
+export declare const getOpenApiFilesFromConfig: <T extends ConfigType>(type: T, config: ConfigInput<T>) => Promise<OpenApiFile[]>;
+export {};

package/dist/prebuild/update/read/getOpenApiFilesFromConfig.js

@@ -0,0 +1,30 @@
+import { getOpenApiDocumentFromUrl } from '@mintlify/common';
+export const getOpenApiFilesFromConfig = async (type, config) => {
+    let openapi;
+    if (type === 'docs') {
+        openapi = config.api?.openapi;
+    }
+    else {
+        openapi = config.openapi;
+    }
+    const openApiFiles = [];
+    // Download OpenApi file if url is provided
+    async function addOpenApiFileFromUrl(openapi) {
+        const specFromUrl = await getOpenApiDocumentFromUrl(openapi);
+        openApiFiles.push({
+            filename: 'openapi-from-url',
+            spec: specFromUrl,
+        });
+    }
+    if (openapi) {
+        if (typeof openapi === 'string' && openapi.startsWith('https')) {
+            await addOpenApiFileFromUrl(openapi);
+        }
+        else if (typeof openapi === 'object' &&
+            'source' in openapi &&
+            openapi.source.startsWith('http')) {
+            await addOpenApiFileFromUrl(openapi.source);
+        }
+    }
+    return openApiFiles;
+};