@mintlify/prebuild 1.0.1237 → 1.0.1239

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

@@ -1,4 +1,5 @@
 import { getAsyncApiDocumentFromUrl, optionallyAddLeadingSlash, isAllowedLocalSchemaUrl, } from '@mintlify/common';
+import { readObjectArrayProperty } from '@mintlify/common/divisions/iterateObjectArrayProperty';
 import { generateAsyncApiPagesForDocsConfig } from '@mintlify/scraping';
 import { divisions } from '@mintlify/validation';
 import * as path from 'path';
@@ -61,18 +62,18 @@ export const generateAsyncApiFromDocsConfig = async (navigation, asyncApiFiles,
             }
             const divisionNav = getDivisionNav(nav);
             if (divisionNav?.division) {
+                const rest = divisionNav.nav;
+                if ('group' in rest) {
+                    return {
+                        ...rest,
+                        pages: 'pages' in rest && Array.isArray(rest.pages)
+                            ? [...rest.pages, ...allGeneratedNav]
+                            : allGeneratedNav,
+                    };
+                }
                 return {
-                    [divisionNav.division]: divisionNav.name,
-                    ...divisionNav.nav,
-                    ...(divisionNav.division === 'group'
-                        ? {
-                            pages: 'pages' in nav && Array.isArray(nav.pages)
-                                ? [...nav.pages, ...allGeneratedNav]
-                                : allGeneratedNav,
-                        }
-                        : {
-                            groups: 'groups' in nav ? [...nav.groups, ...allGeneratedNav] : allGeneratedNav,
-                        }),
+                    ...rest,
+                    groups: 'groups' in rest ? [...rest.groups, ...allGeneratedNav] : allGeneratedNav,
                 };
             }
         }
@@ -96,23 +97,38 @@ export const generateAsyncApiFromDocsConfig = async (navigation, asyncApiFiles,
             newNav.pages = processedPages;
         }
         for (const division of ['groups', ...divisions]) {
-            if (division in newNav) {
-                const items = newNav[division];
-                newNav = {
-                    ...newNav,
-                    [division]: await Promise.all(items.map((item) => processNav(item))),
-                };
-            }
+            const items = readObjectArrayProperty(newNav, division);
+            if (!items)
+                continue;
+            newNav = Object.assign({}, newNav, {
+                [division]: await Promise.all(items.map((item) => processNav(item))),
+            });
         }
         return newNav;
     }
     const processedNavigation = await processNav(navigation);
+    if (!isTopLevelNavigation(processedNavigation)) {
+        throw new Error('AsyncAPI page generation produced a non-top-level navigation node');
+    }
     navigation = processedNavigation;
     return {
         newNav: processedNavigation,
         newAsyncApiFiles,
     };
 };
+const DIVISION_NODE_KEYS = [
+    'group',
+    'tab',
+    'anchor',
+    'version',
+    'language',
+    'dropdown',
+    'product',
+    'item',
+];
+function isTopLevelNavigation(value) {
+    return DIVISION_NODE_KEYS.every((key) => !(key in value));
+}
 function getDivisionNav(nav) {
     if ('asyncapi' in nav) {
         const { asyncapi: _, ...updatedNav } = nav;

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

@@ -1,4 +1,5 @@
 import { getOpenApiDocumentFromUrl, optionallyAddLeadingSlash, isAllowedLocalSchemaUrl, potentiallyParseOpenApiString, findNavGroup, findOpenApiPath, } 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';
 import { divisions, } from '@mintlify/validation';
@@ -75,20 +76,20 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
             });
             const divisionNav = getDivisionNav(nav);
             if (divisionNav?.division) {
+                const rest = divisionNav.nav;
+                if ('group' in rest) {
+                    return {
+                        ...rest,
+                        pages: 'pages' in rest && Array.isArray(rest.pages)
+                            ? [...rest.pages, ...navFromGeneratedOpenApiPages]
+                            : navFromGeneratedOpenApiPages,
+                    };
+                }
                 return {
-                    [divisionNav.division]: divisionNav.name,
-                    ...divisionNav.nav,
-                    ...(divisionNav.division === 'group'
-                        ? {
-                            pages: 'pages' in nav && Array.isArray(nav.pages)
-                                ? [...nav.pages, ...navFromGeneratedOpenApiPages]
-                                : navFromGeneratedOpenApiPages,
-                        }
-                        : {
-                            groups: 'groups' in nav
-                                ? [...nav.groups, ...navFromGeneratedOpenApiPages]
-                                : navFromGeneratedOpenApiPages,
-                        }),
+                    ...rest,
+                    groups: 'groups' in rest
+                        ? [...rest.groups, ...navFromGeneratedOpenApiPages]
+                        : navFromGeneratedOpenApiPages,
                 };
             }
         }
@@ -251,7 +252,7 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
             if (processed)
                 updated = processed;
         }
-        if ('pages' in updated) {
+        if ('pages' in updated && updated.pages) {
             const updatedPages = await Promise.all(updated.pages.map(async (p) => {
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
                 if (typeof p === 'object' && p !== null && 'group' in p) {
@@ -263,23 +264,38 @@ export const generateOpenApiFromDocsConfig = async (navigation, openApiFiles, pa
             updated.pages = updatedPages;
         }
         for (const division of ['groups', ...divisions]) {
-            if (division in updated) {
-                const items = updated[division];
-                updated = {
-                    ...updated,
-                    [division]: await Promise.all(items.map((child) => generateBulkNav(child))),
-                };
-            }
+            const items = readObjectArrayProperty(updated, division);
+            if (!items)
+                continue;
+            updated = Object.assign({}, updated, {
+                [division]: await Promise.all(items.map((child) => generateBulkNav(child))),
+            });
         }
         return updated;
     }
     const processedNavigation = await generateBulkNav(navAfterExplicit);
+    if (!isTopLevelNavigation(processedNavigation)) {
+        throw new Error('OpenAPI page generation produced a non-top-level navigation node');
+    }
     navigation = processedNavigation;
     return {
         newNav: processedNavigation,
         newOpenApiFiles,
     };
 };
+const DIVISION_NODE_KEYS = [
+    'group',
+    'tab',
+    'anchor',
+    'version',
+    'language',
+    'dropdown',
+    'product',
+    'item',
+];
+function isTopLevelNavigation(value) {
+    return DIVISION_NODE_KEYS.every((key) => !(key in value));
+}
 function getDivisionNav(nav) {
     if ('openapi' in nav) {
         const { openapi: _, ...updatedNav } = nav;

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

@@ -1,4 +1,4 @@
-import type { DecoratedNavigationPage } from '@mintlify/models';
+import { type DecoratedNavigationPage, type ResolvedSdkTarget, type SdkTarget } from '@mintlify/models';
 import { type SdkFormat, type SdkReference } from '@mintlify/scraping';
 import type { DocsConfig } from '@mintlify/validation';
 import { type LoadRemoteFileOptions } from './loadRemoteGraphqlSdl.js';
@@ -15,16 +15,52 @@ export type GeneratedSdkPage = {
     content: string;
     format: SdkFormat;
     source: string;
+    sdk?: ResolvedSdkTarget;
+    autogeneratedBySdk?: boolean;
+    generatedBody?: string;
 };
 export type GenerateSdkDivisionsResult = {
     newDocsConfig: DocsConfig;
     pagesAcc: Record<string, DecoratedNavigationPage>;
     generatedPages: GeneratedSdkPage[];
     generatedRoutes: string[];
+    inheritedSdkBySlug: Record<string, SdkConfig>;
 };
 export type SdkReferenceLoader = (config: SdkConfig) => Promise<SdkReference>;
-export declare function generateSdkDivisionsFromDocsConfig(docsConfig: DocsConfig, loadReference: SdkReferenceLoader): Promise<GenerateSdkDivisionsResult>;
+export type GenerateSdkDivisionsOptions = {
+    pageMetadataBySlug?: Record<string, {
+        sdk?: unknown;
+    }>;
+};
+export declare function navigationHasSdkConfig(value: unknown): boolean;
+export declare function generateSdkDivisionsFromDocsConfig(docsConfig: DocsConfig, loadReference: SdkReferenceLoader, options?: GenerateSdkDivisionsOptions): Promise<GenerateSdkDivisionsResult>;
+export declare function composeSdkFrontmatterPage(args: {
+    slug: string;
+    authorContent: string;
+    metadata: {
+        sdk?: unknown;
+        title?: unknown;
+        description?: unknown;
+        tag?: unknown;
+    };
+    loadReference: SdkReferenceLoader;
+    inherited?: SdkConfig;
+}): Promise<GeneratedSdkPage | undefined>;
+export declare function isSdkFrontmatterValue(value: unknown): boolean;
+export declare function readContainedMarkdown(contentRoot: string, slug: string): Promise<{
+    content: string;
+    extension: '.mdx' | '.md';
+} | undefined>;
+export type { SdkTarget };
 export declare const isRemoteSdkSource: (source: string) => boolean;
 export declare function loadSdkReferenceSource(config: SdkConfig, contentDirectoryPath: string, remoteOptions?: LoadRemoteFileOptions): Promise<SdkReference>;
+export declare function writeSdkFrontmatterPages({ contentDirectoryPath, inheritedSdkBySlug, pageMetadataBySlug, loadReference, targetDir, }: {
+    contentDirectoryPath: string;
+    inheritedSdkBySlug: Record<string, SdkConfig>;
+    pageMetadataBySlug: Record<string, {
+        sdk?: unknown;
+    }>;
+    loadReference: SdkReferenceLoader;
+    targetDir?: string;
+}): Promise<void>;
 export declare function writeSdkArtifacts(result: GenerateSdkDivisionsResult, targetDir?: string): Promise<void>;
-export {};