@mintlify/prebuild 1.0.1285 → 1.0.1287

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

@@ -1,7 +1,8 @@
+import type { OverlayRegistry } from '@mintlify/common';
 import type { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
 import { DocsConfig } from '@mintlify/validation';
 import type { InvalidSpecFile } from '../../invalidSpecFiles.js';
-export declare const generateOpenApiDivisions: (docsConfig: DocsConfig, openApiFiles: OpenApiFile[], targetDir?: string, localSchema?: boolean, invalidSpecFiles?: InvalidSpecFile[], graphqlPages?: Record<string, DecoratedNavigationPage>, deferWrites?: boolean) => Promise<{
+export declare const generateOpenApiDivisions: (docsConfig: DocsConfig, openApiFiles: OpenApiFile[], targetDir?: string, localSchema?: boolean, invalidSpecFiles?: InvalidSpecFile[], graphqlPages?: Record<string, DecoratedNavigationPage>, deferWrites?: boolean, overlayRegistry?: OverlayRegistry) => Promise<{
     newDocsConfig: DocsConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;
     openApiFiles: OpenApiFile[];

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

@@ -2,8 +2,8 @@ import fse from 'fs-extra';
 import { getOpenApiFilesFromConfig } from '../read/getOpenApiFilesFromConfig.js';
 import { assertNoGeneratedRouteCollisions } from './generatedRouteCollisions.js';
 import { generateOpenApiFromDocsConfig } from './generateOpenApiFromDocsConfig.js';
-export const generateOpenApiDivisions = async (docsConfig, openApiFiles, targetDir, localSchema, invalidSpecFiles, graphqlPages, deferWrites = false) => {
-    const openapiFilesFromDocsConfig = await getOpenApiFilesFromConfig('docs', docsConfig, localSchema);
+export const generateOpenApiDivisions = async (docsConfig, openApiFiles, targetDir, localSchema, invalidSpecFiles, graphqlPages, deferWrites = false, overlayRegistry) => {
+    const openapiFilesFromDocsConfig = await getOpenApiFilesFromConfig('docs', docsConfig, localSchema, overlayRegistry);
     openApiFiles.push(...openapiFilesFromDocsConfig);
     const pagesAcc = {};
     const writes = [];
@@ -14,6 +14,7 @@ export const generateOpenApiDivisions = async (docsConfig, openApiFiles, targetD
         targetDir,
         localSchema,
         invalidSpecFiles,
+        overlayRegistry,
         ...(planWrites
             ? {
                 writeFile: (filename, content) => {

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

@@ -1,3 +1,4 @@
+import { type OverlayRegistry } from '@mintlify/common';
 import type { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
 import { NavigationConfig } from '@mintlify/validation';
 import { type InvalidSpecFile } from '../../invalidSpecFiles.js';
@@ -9,6 +10,9 @@ export declare const generateOpenApiFromDocsConfig: (navigation: NavigationConfi
     invalidSpecFiles?: InvalidSpecFile[];
     mountPaths?: string[];
     writeFile?: (filename: string, content: string) => void | Promise<void>;
+    overlayRegistry?: OverlayRegistry;
+    /** SSRF-safe fetch override for hosted spec URLs; supplied by server environments. */
+    fetchRemoteDocument?: (url: string) => Promise<unknown>;
 }) => Promise<{
     newNav: NavigationConfig;
     newOpenApiFiles: OpenApiFile[];

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

@@ -1,4 +1,4 @@
-import { getOpenApiDocumentFromUrl, optionallyAddLeadingSlash, isAllowedLocalSchemaUrl, potentiallyParseOpenApiString, findNavGroup, findOpenApiPath, } from '@mintlify/common';
+import { getOpenApiDocumentFromUrl, optionallyAddLeadingSlash, isAllowedLocalSchemaUrl, potentiallyParseOpenApiString, findNavGroup, findOpenApiPath, resolveOverlaysForSpec, } from '@mintlify/common';
 import { readObjectArrayProperty } from '@mintlify/common/divisions/iterateObjectArrayProperty';
 import { generateOpenApiPagesForDocsConfig } from '@mintlify/scraping';
 import { processOpenApiPath, processOpenApiWebhook, } from '@mintlify/scraping/bin/openapi/common.js';
@@ -19,7 +19,7 @@ const getMountPathForPath = (candidatePath, mountPaths) => {
 };
 const resolveMountPath = (specPath, outputDir, mountPaths) => getMountPathForPath(specPath, mountPaths) || getMountPathForPath(outputDir, mountPaths);
 export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pagesAcc, opts) => {
-    const { overwrite, writeFiles, targetDir, localSchema, invalidSpecFiles, mountPaths = [], writeFile, } = opts;
+    const { overwrite, writeFiles, targetDir, localSchema, invalidSpecFiles, mountPaths = [], writeFile, overlayRegistry, fetchRemoteDocument, } = opts;
     const newOpenApiFiles = [];
     const openApiFilePromises = new Map();
     async function processOpenApiInNav(nav) {
@@ -31,7 +31,14 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
             }
             else if (Array.isArray(nav.openapi) && nav.openapi.length > 0) {
                 // TODO: handle multiple openapi files
-                openapi = nav.openapi[0];
+                const firstEntry = nav.openapi[0];
+                if (typeof firstEntry === 'string') {
+                    openapi = firstEntry;
+                }
+                else if (firstEntry != undefined) {
+                    openapi = firstEntry.source;
+                    outputDir = firstEntry.directory ?? DEFAULT_OUTPUT_DIR;
+                }
             }
             else if (typeof nav.openapi === 'object' && 'source' in nav.openapi) {
                 openapi = nav.openapi.source;
@@ -42,7 +49,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
             let openApiFile = undefined;
             if (isAllowedLocalSchemaUrl(openapi, localSchema)) {
                 if (!openApiFilePromises.has(openapi)) {
-                    const promise = createOpenApiFile(openapi);
+                    const promise = createOpenApiFile(openapi, overlayRegistry, fetchRemoteDocument);
                     openApiFilePromises.set(openapi, promise);
                     openApiFile = await promise;
                     newOpenApiFiles.push(openApiFile);
@@ -102,7 +109,14 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
                 return { source: openapiProp, directory: undefined };
             }
             else if (Array.isArray(openapiProp) && openapiProp.length > 0) {
-                return { source: openapiProp[0], directory: undefined };
+                const firstEntry = openapiProp[0];
+                if (typeof firstEntry === 'string') {
+                    return { source: firstEntry, directory: undefined };
+                }
+                if (firstEntry != undefined) {
+                    return { source: firstEntry.source, directory: firstEntry.directory };
+                }
+                return { source: undefined, directory: undefined };
             }
             else if (typeof openapiProp === 'object' &&
                 'source' in openapiProp &&
@@ -150,7 +164,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
                         if (openapiPath) {
                             if (isAllowedLocalSchemaUrl(openapiPath, localSchema)) {
                                 if (!openApiFilePromises.has(openapiPath)) {
-                                    const promise = createOpenApiFile(openapiPath);
+                                    const promise = createOpenApiFile(openapiPath, overlayRegistry, fetchRemoteDocument);
                                     openApiFilePromises.set(openapiPath, promise);
                                     openApiFile = await promise;
                                     newOpenApiFiles.push(openApiFile);
@@ -318,9 +332,12 @@ function getDivisionNav(nav) {
     }
     return undefined;
 }
-async function createOpenApiFile(openApiUrl) {
+async function createOpenApiFile(openApiUrl, overlayRegistry, fetchRemoteDocument) {
     try {
-        const document = await getOpenApiDocumentFromUrl(openApiUrl);
+        const overlays = overlayRegistry
+            ? await resolveOverlaysForSpec(overlayRegistry, openApiUrl)
+            : undefined;
+        const document = await getOpenApiDocumentFromUrl(openApiUrl, { overlays, fetchRemoteDocument });
         return {
             filename: openApiUrl,
             spec: document,

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

@@ -1,9 +1,9 @@
-import { AsyncAPIFile } from '@mintlify/common';
+import { AsyncAPIFile, type OverlayRegistry } from '@mintlify/common';
 import { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
 import type { SdkFormat } from '@mintlify/scraping';
 import { DocsConfig } from '@mintlify/validation';
 import type { InvalidSpecFile } from '../../invalidSpecFiles.js';
-export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, invalidSpecFiles, allowSourceRefs, }: {
+export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, invalidSpecFiles, allowSourceRefs, overlayRegistry, }: {
     contentDirectoryPath: string;
     openApiFiles: OpenApiFile[];
     asyncApiFiles: AsyncAPIFile[];
@@ -13,6 +13,7 @@ export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFile
     strict?: boolean;
     invalidSpecFiles?: InvalidSpecFile[];
     allowSourceRefs?: boolean;
+    overlayRegistry?: OverlayRegistry;
 }): Promise<{
     docsConfig: DocsConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;

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

@@ -54,7 +54,7 @@ async function scanSdkFrontmatterMetadata(contentDirectoryPath, navigation) {
     }));
     return metadataBySlug;
 }
-export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, invalidSpecFiles, allowSourceRefs, }) {
+export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, strict, invalidSpecFiles, allowSourceRefs, overlayRegistry, }) {
     const configPath = await getConfigPath(contentDirectoryPath, 'docs');
     if (configPath == null && docsConfig == null) {
         throw Error(NOT_CORRECT_PATH_ERROR);
@@ -71,7 +71,7 @@ export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles,
     const graphqlResult = await generateGraphqlDivisionsFromDocsConfig(docsConfig, (source) => loadGraphqlSdlSource(source, contentDirectoryPath));
     const { newDocsConfig: docsConfigWithGraphqlPages, pagesAcc: pagesAccWithGraphqlPages } = graphqlResult;
     const { newDocsConfig: docsConfigWithOpenApiPages, pagesAcc: pagesAccWithOpenApiPages, openApiFiles: newOpenApiFiles, flushWrites: flushOpenApiWrites, } = !disableOpenApi
-        ? await generateOpenApiDivisions(docsConfigWithGraphqlPages, openApiFiles, undefined, localSchema, invalidSpecFiles, pagesAccWithGraphqlPages, true)
+        ? await generateOpenApiDivisions(docsConfigWithGraphqlPages, openApiFiles, undefined, localSchema, invalidSpecFiles, pagesAccWithGraphqlPages, true, overlayRegistry)
         : {
             newDocsConfig: docsConfigWithGraphqlPages,
             pagesAcc: {},