@mintlify/prebuild 1.0.799 → 1.0.801

package/dist/prebuild/index.d.ts

@@ -1,10 +1,11 @@
 export interface PrebuildResult {
     fileImportsMap: Map<string, Set<string>>;
 }
-export declare const prebuild: (contentDirectoryPath: string, { localSchema, groups, disableOpenApi, }?: {
+export declare const prebuild: (contentDirectoryPath: string, { localSchema, groups, disableOpenApi, strict, }?: {
     localSchema?: boolean;
     groups?: string[];
     disableOpenApi?: boolean;
+    strict?: boolean;
 }) => Promise<PrebuildResult | undefined>;
 export * from './categorizeFilePaths.js';
 export * from '../createPage/index.js';

package/dist/prebuild/index.js

@@ -1,7 +1,7 @@
 import { getConfigPath, getMintIgnore } from '../utils.js';
 import { categorizeFilePaths } from './categorizeFilePaths.js';
 import { update } from './update/index.js';
-export const prebuild = async (contentDirectoryPath, { localSchema, groups, disableOpenApi, } = {}) => {
+export const prebuild = async (contentDirectoryPath, { localSchema, groups, disableOpenApi, strict, } = {}) => {
     if (process.env.IS_MULTI_TENANT === 'true') {
         console.log('Skipping prebuild in multi-tenant mode.');
         return;
@@ -26,6 +26,7 @@ export const prebuild = async (contentDirectoryPath, { localSchema, groups, disa
         groups,
         mintIgnore,
         disableOpenApi,
+        strict,
     });
     return { fileImportsMap };
 };

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

@@ -3,8 +3,8 @@ export declare class ConfigUpdater<T> {
     private type;
     constructor(type: ConfigType);
     getConfigType(): "mint" | "docs";
-    getConfig(configPath: string, onError?: (message: string) => void): Promise<T>;
-    validateConfigJsonString: (configContents: string, onError?: (message: string) => void) => Promise<{
+    getConfig(configPath: string, strict?: boolean, onError?: (message: string) => void): Promise<T>;
+    validateConfigJsonString: (configContents: string, strict?: boolean, onError?: (message: string) => void) => Promise<{
         data: T;
         warnings: import("zod").ZodIssue[];
         success: true;

package/dist/prebuild/update/ConfigUpdater.js

@@ -6,7 +6,7 @@ import { join } from 'path';
 const { readFile } = _promises;
 export class ConfigUpdater {
     constructor(type) {
-        this.validateConfigJsonString = async (configContents, onError) => {
+        this.validateConfigJsonString = async (configContents, strict, onError) => {
             const configObj = this.parseConfigJson(configContents, onError);
             const validationResults = this.type === 'mint' ? validateMintConfig(configObj) : validateDocsConfig(configObj);
             if (!validationResults.success) {
@@ -32,6 +32,9 @@ export class ConfigUpdater {
                 else {
                     console.warn(Chalk.yellow(warnMsg));
                     warnings.forEach((warning) => console.warn(Chalk.yellow(warning)));
+                    if (strict) {
+                        throw Error('Validation warnings treated as errors in strict mode');
+                    }
                 }
             }
             return { ...validationResults, data: validationResults.data };
@@ -91,9 +94,9 @@ export class ConfigUpdater {
     getConfigType() {
         return this.type;
     }
-    async getConfig(configPath, onError) {
+    async getConfig(configPath, strict, onError) {
         const configContents = await this.readConfigFile(configPath);
-        const validationResults = await this.validateConfigJsonString(configContents, onError);
+        const validationResults = await this.validateConfigJsonString(configContents, strict, onError);
         return validationResults.data;
     }
 }

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

@@ -82,31 +82,41 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
         if ('openapi' in nav && nav.openapi !== null) {
             const openapiProp = nav.openapi;
             if (typeof openapiProp === 'string') {
-                return openapiProp;
+                return { source: openapiProp, directory: undefined };
             }
             else if (Array.isArray(openapiProp) && openapiProp.length > 0) {
-                return openapiProp[0];
+                return { source: openapiProp[0], directory: undefined };
             }
             else if (typeof openapiProp === 'object' &&
                 'source' in openapiProp &&
                 typeof openapiProp.source === 'string') {
-                return openapiProp.source;
+                const directory = 'directory' in openapiProp && typeof openapiProp.directory === 'string'
+                    ? openapiProp.directory
+                    : undefined;
+                return {
+                    source: openapiProp.source,
+                    directory,
+                };
             }
         }
-        return undefined;
+        return { source: undefined, directory: undefined };
     }
     const skipBulkForNode = new Set();
     const skipBulkForNodeId = new Set();
     let numNodes = 0;
-    async function processNav(nav, inheritedOpenApi, openApiOwner) {
+    async function processNav(nav, inheritedOpenApi, inheritedDirectory, openApiOwner) {
         const nodeId = numNodes++;
-        const currentOpenApi = extractOpenApiFromNav(nav) ?? inheritedOpenApi;
-        const currentOpenApiOwner = extractOpenApiFromNav(nav) ? nodeId : openApiOwner;
+        const extracted = extractOpenApiFromNav(nav);
+        const currentOpenApi = extracted.source ?? inheritedOpenApi;
+        const currentDirectory = extracted.source
+            ? extracted.directory
+            : extracted.directory ?? inheritedDirectory;
+        const currentOpenApiOwner = extracted.source ? nodeId : openApiOwner;
         let newNav = nav;
         if ('pages' in newNav) {
             newNav.pages = await Promise.all(newNav.pages.map(async (page) => {
                 if (typeof page === 'object' && page !== null && 'group' in page) {
-                    return processNav(page, currentOpenApi, currentOpenApiOwner);
+                    return processNav(page, currentOpenApi, currentDirectory, currentOpenApiOwner);
                 }
                 if (typeof page !== 'string') {
                     return page;
@@ -152,7 +162,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
                             processOpenApiWebhook(endpoint, webhookObject, schema, tempNav, tempDecoratedNav, writePromises, pagesAcc, {
                                 openApiFilePath: openApiFile.originalFileLocation,
                                 writeFiles,
-                                outDir: DEFAULT_OUTPUT_DIR,
+                                outDir: currentDirectory ?? DEFAULT_OUTPUT_DIR,
                                 outDirBasePath: path.join(targetDir ?? '', 'src', '_props'),
                                 overwrite,
                                 localSchema,
@@ -170,7 +180,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
                             processOpenApiPath(endpoint, { [method.toLowerCase()]: opObject }, schema, tempNav, tempDecoratedNav, writePromises, pagesAcc, {
                                 openApiFilePath: openApiFile.originalFileLocation,
                                 writeFiles,
-                                outDir: DEFAULT_OUTPUT_DIR,
+                                outDir: currentDirectory ?? DEFAULT_OUTPUT_DIR,
                                 outDirBasePath: path.join(targetDir ?? '', 'src', '_props'),
                                 overwrite,
                                 localSchema,
@@ -209,7 +219,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
                 const items = newNav[division];
                 newNav = {
                     ...newNav,
-                    [division]: await Promise.all(items.map((item) => processNav(item, currentOpenApi, currentOpenApiOwner))),
+                    [division]: await Promise.all(items.map((item) => processNav(item, currentOpenApi, currentDirectory, currentOpenApiOwner))),
                 };
             }
         }
@@ -218,10 +228,10 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
         }
         return newNav;
     }
-    const navAfterExplicit = await processNav(navigation, undefined);
+    const navAfterExplicit = await processNav(navigation, undefined, undefined, undefined);
     async function generateBulkNav(node) {
         let updated = node;
-        if (extractOpenApiFromNav(updated) && !skipBulkForNode.has(updated)) {
+        if (extractOpenApiFromNav(updated).source && !skipBulkForNode.has(updated)) {
             const processed = await processOpenApiInNav(updated);
             if (processed)
                 updated = processed;

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

@@ -1,13 +1,14 @@
 import { AsyncAPIFile } from '@mintlify/common';
 import { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
 import { DocsConfig } from '@mintlify/validation';
-export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, }: {
+export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, }: {
     contentDirectoryPath: string;
     openApiFiles: OpenApiFile[];
     asyncApiFiles: AsyncAPIFile[];
     docsConfig?: DocsConfig;
     localSchema?: boolean;
     disableOpenApi?: boolean;
+    strict?: boolean;
 }): Promise<{
     docsConfig: DocsConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;

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

@@ -4,13 +4,13 @@ import { generateAsyncApiDivisions } from './generateAsyncApiDivisions.js';
 import { generateOpenApiDivisions } from './generateOpenApiDivisions.js';
 import { getCustomLanguages } from './getCustomLanguages.js';
 const NOT_CORRECT_PATH_ERROR = 'must be run in a directory where a docs.json file exists.';
-export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, }) {
+export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, }) {
     const configPath = await getConfigPath(contentDirectoryPath, 'docs');
     if (configPath == null && docsConfig == null) {
         throw Error(NOT_CORRECT_PATH_ERROR);
     }
     if (docsConfig == null && configPath) {
-        docsConfig = await DocsConfigUpdater.getConfig(configPath);
+        docsConfig = await DocsConfigUpdater.getConfig(configPath, strict);
     }
     if (docsConfig == null) {
         throw Error(NOT_CORRECT_PATH_ERROR);

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

@@ -14,8 +14,9 @@ type UpdateArgs = {
     groups?: string[];
     mintIgnore?: string[];
     disableOpenApi?: boolean;
+    strict?: boolean;
 };
-export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, }: UpdateArgs) => Promise<{
+export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, strict, }: UpdateArgs) => Promise<{
     name: string;
     $schema: string;
     theme: "mint";

package/dist/prebuild/update/index.js

@@ -12,8 +12,8 @@ import { writeAsyncApiFiles } from './write/writeAsyncApiFiles.js';
 import { writeFiles, writeFile } from './write/writeFiles.js';
 import { writeOpenApiData } from './write/writeOpenApiData.js';
 import { writeRssFiles } from './write/writeRssFiles.js';
-export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, }) => {
-    const mintConfigResult = await updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema);
+export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, strict, }) => {
+    const mintConfigResult = await updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema, strict);
     // we used the original mint config without openapi pages injected
     // because we will do it in `updateDocsConfigFile`, this will avoid duplicated openapi pages
     const docsConfig = mintConfigResult != null ? upgradeToDocsConfig(mintConfigResult.originalMintConfig) : undefined;
@@ -24,6 +24,7 @@ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFil
         docsConfig: docsConfigPath ? undefined : docsConfig,
         localSchema,
         disableOpenApi,
+        strict,
     });
     const pagePromises = readPageContents({
         contentDirectoryPath,

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

@@ -1,5 +1,5 @@
 import { DecoratedNavigationPage, MintConfig, OpenApiFile } from '@mintlify/models';
-export declare function updateMintConfigFile(contentDirectoryPath: string, openApiFiles: OpenApiFile[], localSchema?: boolean): Promise<{
+export declare function updateMintConfigFile(contentDirectoryPath: string, openApiFiles: OpenApiFile[], localSchema?: boolean, strict?: boolean): Promise<{
     mintConfig: MintConfig;
     originalMintConfig: MintConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;

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

@@ -1,12 +1,12 @@
 import { getConfigPath } from '../../../utils.js';
 import { MintConfigUpdater } from '../ConfigUpdater.js';
 import { generateOpenApiAnchorsOrTabs } from './generateOpenApiAnchorsOrTabs.js';
-export async function updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema) {
+export async function updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema, strict) {
     const configPath = await getConfigPath(contentDirectoryPath, 'mint');
     if (configPath == null) {
         return null;
     }
-    const mintConfig = await MintConfigUpdater.getConfig(configPath);
+    const mintConfig = await MintConfigUpdater.getConfig(configPath, strict);
     const { mintConfig: newMintConfig, pagesAcc, openApiFiles: newOpenApiFiles, } = await generateOpenApiAnchorsOrTabs(mintConfig, openApiFiles, undefined, localSchema);
     await MintConfigUpdater.writeConfigFile(newMintConfig);
     return {