@mintlify/scraping 4.0.70 → 4.0.72

package/__test__/generateOpenApiPagesForDocsConfig.test.ts

@@ -0,0 +1,149 @@
+import { OpenAPI } from 'openapi-types';
+import { describe, it, expect } from 'vitest';
+
+import { DEFAULT_API_GROUP_NAME } from '../src/openapi/common.js';
+import { generateOpenApiPagesForDocsConfig } from '../src/openapi/generateOpenApiPagesForDocsConfig.js';
+
+describe('generateOpenApiPagesForDocsConfig', () => {
+  it('should throw error for empty paths', async () => {
+    const emptyDoc: OpenAPI.Document = {
+      openapi: '3.0.0',
+      info: {
+        title: 'Test API',
+        version: '1.0.0',
+      },
+      paths: {},
+    };
+
+    await expect(generateOpenApiPagesForDocsConfig(emptyDoc)).rejects.toThrow('No paths defined.');
+  });
+
+  it('should generate navigation structure for simple API', async () => {
+    const simpleDoc: OpenAPI.Document = {
+      openapi: '3.0.0',
+      info: {
+        title: 'Test API',
+        version: '1.0.0',
+      },
+      paths: {
+        '/users': {
+          get: {
+            operationId: 'getUsers',
+            summary: 'Get Users',
+            responses: {
+              '200': {
+                description: 'Successful response',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    const result = await generateOpenApiPagesForDocsConfig(simpleDoc);
+
+    // Check nav structure
+    expect(result.nav).toHaveLength(1);
+    expect(result.nav[0]).toHaveProperty('group', DEFAULT_API_GROUP_NAME);
+    expect(result.nav[0]).toHaveProperty('pages');
+
+    // Check decorated nav structure
+    expect(result.decoratedNav).toHaveLength(1);
+    expect(result.decoratedNav[0]).toHaveProperty('group', DEFAULT_API_GROUP_NAME);
+    expect(result.decoratedNav[0]).toHaveProperty('pages');
+  });
+
+  it('should handle custom group names', async () => {
+    const docWithTags: OpenAPI.Document = {
+      openapi: '3.0.0',
+      info: {
+        title: 'Test API',
+        version: '1.0.0',
+      },
+      paths: {
+        '/users': {
+          get: {
+            operationId: 'getUsers',
+            summary: 'Get Users',
+            tags: ['Users'],
+            responses: {
+              '200': {
+                description: 'Successful response',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    const result = await generateOpenApiPagesForDocsConfig(docWithTags);
+
+    // Check that the group name matches the tag
+    expect(result.nav).toHaveLength(1);
+    expect(result.nav[0]).toHaveProperty('group', 'Users');
+  });
+
+  it('should handle multiple paths and methods', async () => {
+    const complexDoc: OpenAPI.Document = {
+      openapi: '3.0.0',
+      info: {
+        title: 'Test API',
+        version: '1.0.0',
+      },
+      paths: {
+        '/users': {
+          get: {
+            operationId: 'getUsers',
+            summary: 'Get Users',
+            tags: ['Users'],
+            responses: {
+              '200': {
+                description: 'Successful response',
+              },
+            },
+          },
+          post: {
+            operationId: 'createUser',
+            summary: 'Create User',
+            tags: ['Users'],
+            responses: {
+              '201': {
+                description: 'User created',
+              },
+            },
+          },
+        },
+        '/products': {
+          get: {
+            operationId: 'getProducts',
+            summary: 'Get Products',
+            tags: ['Products'],
+            responses: {
+              '200': {
+                description: 'Successful response',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    const result = await generateOpenApiPagesForDocsConfig(complexDoc);
+
+    // Should have two groups (Users and Products)
+    expect(result.nav).toHaveLength(2);
+
+    // Check that pages were generated for all operations
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const allPages = result.nav.flatMap((group) => (group as any).pages);
+    expect(allPages).toHaveLength(3); // getUsers, createUser, getProducts
+  });
+
+  it('should handle URL input', async () => {
+    const validUrl = new URL('https://api.example.com/openapi.json');
+
+    // Mock fetch implementation would be needed for this test
+    // This is just to show the structure
+    await expect(generateOpenApiPagesForDocsConfig(validUrl)).rejects.toThrow();
+  });
+});

package/__test__/getOpenApiDefinition.test.ts

@@ -3,7 +3,7 @@ import yaml from 'js-yaml';
 import { OpenAPI } from 'openapi-types';
 import { describe, it, expect, beforeEach, vi } from 'vitest';
 
-import { getOpenApiDefinition } from '../src/openapi/generateOpenApiPages.js';
+import { getOpenApiDefinition } from '../src/openapi/common.js';
 
 vi.mock('fs/promises');
 vi.mock('node-fetch');

package/__test__/prepareStringToBeValidFilename.test.ts

@@ -1,4 +1,4 @@
-import { prepareStringToBeValidFilename } from '../src/openapi/generateOpenApiPages.js';
+import { prepareStringToBeValidFilename } from '../src/openapi/common.js';
 
 describe('prepareStringToBeValidFilename', () => {
   it('should replace spaces with dashes', () => {

package/bin/index.d.ts

@@ -1 +1,2 @@
 export { generateOpenApiPages } from './openapi/generateOpenApiPages.js';
+export { generateOpenApiPagesForDocsConfig } from './openapi/generateOpenApiPagesForDocsConfig.js';

package/bin/index.js

@@ -1,2 +1,3 @@
 export { generateOpenApiPages } from './openapi/generateOpenApiPages.js';
+export { generateOpenApiPagesForDocsConfig } from './openapi/generateOpenApiPagesForDocsConfig.js';
 //# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,iCAAiC,EAAE,MAAM,gDAAgD,CAAC"}

package/bin/openapi/common.d.ts

@@ -0,0 +1,26 @@
+import type { DecoratedNavigationPage, NavigationEntry } from '@mintlify/models';
+import { OpenAPI, OpenAPIV3 } from 'openapi-types';
+export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL) => Promise<{
+    document: OpenAPI.Document;
+    isUrl: boolean;
+}>;
+export declare const generateUniqueFilenameWithoutExtension: (pages: NavigationEntry[], base: string) => string;
+export declare const createOpenApiFrontmatter: (filename: string, openApiMetaTag: string, version?: string) => Promise<void>;
+export declare const prepareStringToBeValidFilename: (str?: string) => string | undefined;
+export type GenerateOpenApiPagesOptions = {
+    openApiFilePath?: string;
+    version?: string;
+    writeFiles?: boolean;
+    outDir?: string;
+    outDirBasePath?: string;
+    overwrite?: boolean;
+};
+export type OpenApiPageGenerationResult<N, DN> = {
+    nav: N;
+    decoratedNav: DN;
+    spec: OpenAPI.Document;
+    pagesAcc: Record<string, DecoratedNavigationPage>;
+    isUrl: boolean;
+};
+export declare function processOpenApiPath<N, DN>(path: string, pathItemObject: OpenAPIV3.PathItemObject, schema: OpenAPI.Document, nav: N, decoratedNav: DN, writePromises: Promise<void>[], pagesAcc: Record<string, DecoratedNavigationPage>, options: GenerateOpenApiPagesOptions, findNavGroup: (nav: any, groupName?: string) => any): void;
+export declare const DEFAULT_API_GROUP_NAME = "API Reference";

package/bin/openapi/common.js

@@ -0,0 +1,112 @@
+import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, } from '@mintlify/common';
+import { outputFile } from 'fs-extra';
+import fse from 'fs-extra';
+import fs from 'fs/promises';
+import yaml from 'js-yaml';
+import { OpenAPIV3 } from 'openapi-types';
+import path, { join, parse, resolve } from 'path';
+import { fetchOpenApi } from '../utils/network.js';
+export const getOpenApiDefinition = async (pathOrDocumentOrUrl) => {
+    if (typeof pathOrDocumentOrUrl === 'string') {
+        if (pathOrDocumentOrUrl.startsWith('http://')) {
+            // This is an invalid location either for a file or a URL
+            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
+        }
+        else {
+            try {
+                const url = new URL(pathOrDocumentOrUrl);
+                pathOrDocumentOrUrl = url;
+            }
+            catch {
+                const pathname = path.join(process.cwd(), pathOrDocumentOrUrl.toString());
+                const file = await fs.readFile(pathname, 'utf-8');
+                pathOrDocumentOrUrl = yaml.load(file);
+            }
+        }
+    }
+    const isUrl = pathOrDocumentOrUrl instanceof URL;
+    if (pathOrDocumentOrUrl instanceof URL) {
+        if (pathOrDocumentOrUrl.protocol !== 'https:') {
+            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
+        }
+        pathOrDocumentOrUrl = await fetchOpenApi(pathOrDocumentOrUrl);
+    }
+    return { document: pathOrDocumentOrUrl, isUrl };
+};
+// returns a filename that is unique within the given array of pages
+export const generateUniqueFilenameWithoutExtension = (pages, base) => {
+    let filename = base;
+    if (pages.includes(filename)) {
+        let extension = 1;
+        filename = `${base}-${extension}`;
+        while (pages.includes(filename)) {
+            extension += 1;
+            filename = `${base}-${extension}`;
+        }
+    }
+    return filename;
+};
+export const createOpenApiFrontmatter = async (filename, openApiMetaTag, version) => {
+    const data = `---
+openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}
+---`;
+    await outputFile(filename, data);
+};
+export const prepareStringToBeValidFilename = (str) => str
+    ? str
+        .replaceAll(' ', '-')
+        .replace(/\{.*?\}/g, '-') // remove path parameters
+        .replace(/^-/, '')
+        .replace(/-$/, '')
+        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
+        .replaceAll(/--/g, '-') // replace double hyphens
+        .toLowerCase()
+    : undefined;
+export function processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, options, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+findNavGroup) {
+    const openApiFilePathFromRoot = options.openApiFilePath
+        ? optionallyAddLeadingSlash(options.openApiFilePath)
+        : undefined;
+    Object.values(OpenAPIV3.HttpMethods).forEach((method) => {
+        if (method in pathItemObject) {
+            const operation = pathItemObject[method];
+            const groupName = operation?.tags?.[0];
+            const title = prepareStringToBeValidFilename(operation?.summary) ??
+                `${method}-${prepareStringToBeValidFilename(path)}`;
+            const folder = prepareStringToBeValidFilename(groupName) ?? '';
+            const base = join(options.outDir ?? '', folder, title);
+            const navGroup = findNavGroup(nav, groupName);
+            const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
+            const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
+            const openapiMetaTag = `${openApiFilePathFromRoot ? `${openApiFilePathFromRoot} ` : ''}${method} ${path}`;
+            const { title: titleTag, description } = getOpenApiTitleAndDescription([
+                {
+                    filename: options.openApiFilePath
+                        ? parse(options.openApiFilePath).name
+                        : 'filler-filename',
+                    spec: schema,
+                    originalFileLocation: options.openApiFilePath,
+                },
+            ], openapiMetaTag);
+            navGroup.push(filenameWithoutExtension);
+            const page = {
+                openapi: openapiMetaTag,
+                href: resolve('/', filenameWithoutExtension),
+                title: titleTag ?? slugToTitle(filenameWithoutExtension),
+                description,
+                version: options.version,
+            };
+            decoratedNavGroup.push(page);
+            pagesAcc[filenameWithoutExtension] = page;
+            const targetPath = options.outDirBasePath
+                ? join(options.outDirBasePath, `${filenameWithoutExtension}.mdx`)
+                : `${filenameWithoutExtension}.mdx`;
+            if (options.writeFiles && (!fse.pathExistsSync(targetPath) || options.overwrite)) {
+                writePromises.push(createOpenApiFrontmatter(targetPath, openapiMetaTag, options.version));
+            }
+        }
+    });
+}
+export const DEFAULT_API_GROUP_NAME = 'API Reference';
+//# sourceMappingURL=common.js.map

package/bin/openapi/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/openapi/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EACzB,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAW,SAAS,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,EACK,EAAE;IAC3D,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,yDAAyD;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,mBAAmB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,KAAwB,EACxB,IAAY,EACJ,EAAE;IACV,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,SAAS,IAAI,CAAC,CAAC;YACf,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EAC3C,QAAgB,EAChB,cAAsB,EACtB,OAAgB,EAChB,EAAE;IACF,MAAM,IAAI,GAAG;WACJ,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;IAC9D,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAY,EAAE,EAAE,CAC7D,GAAG;IACD,CAAC,CAAC,GAAG;SACA,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAClD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,4BAA4B;SAC1D,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAChD,WAAW,EAAE;IAClB,CAAC,CAAC,SAAS,CAAC;AAmBhB,MAAM,UAAU,kBAAkB,CAChC,IAAY,EACZ,cAAwC,EACxC,MAAwB,EACxB,GAAM,EACN,YAAgB,EAChB,aAA8B,EAC9B,QAAiD,EACjD,OAAoC;AACpC,8DAA8D;AAC9D,YAAmD;IAEnD,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe;QACrD,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,eAAe,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,MAAM,IAAI,cAAc,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;gBAClD,GAAG,MAAM,IAAI,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACxF,MAAM,cAAc,GAAG,GACrB,uBAAuB,CAAC,CAAC,CAAC,GAAG,uBAAuB,GAAG,CAAC,CAAC,CAAC,EAC5D,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,6BAA6B,CACpE;gBACE;oBACE,QAAQ,EAAE,OAAO,CAAC,eAAe;wBAC/B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI;wBACrC,CAAC,CAAC,iBAAiB;oBACrB,IAAI,EAAE,MAAM;oBACZ,oBAAoB,EAAE,OAAO,CAAC,eAAe;iBAC9C;aACF,EACD,cAAc,CACf,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACxC,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;gBAC5C,KAAK,EAAE,QAAQ,IAAI,WAAW,CAAC,wBAAwB,CAAC;gBACxD,WAAW;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;YACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;gBACjE,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjF,aAAa,CAAC,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAC5F,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC"}

package/bin/openapi/generateOpenApiPages.d.ts

@@ -1,21 +1,4 @@
-import type { DecoratedNavigation, Navigation, DecoratedNavigationPage } from '@mintlify/models';
+import type { DecoratedNavigation, Navigation } from '@mintlify/models';
 import { OpenAPI } from 'openapi-types';
-export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL) => Promise<{
-    document: OpenAPI.Document;
-    isUrl: boolean;
-}>;
-export declare const generateOpenApiPages: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL, opts?: {
-    openApiFilePath?: string | undefined;
-    version?: string | undefined;
-    writeFiles?: boolean;
-    outDir?: string;
-    outDirBasePath?: string;
-    overwrite?: boolean;
-}) => Promise<{
-    nav: Navigation;
-    decoratedNav: DecoratedNavigation;
-    spec: OpenAPI.Document;
-    pagesAcc: Record<string, DecoratedNavigationPage>;
-    isUrl: boolean;
-}>;
-export declare const prepareStringToBeValidFilename: (str?: string) => string | undefined;
+import { GenerateOpenApiPagesOptions, OpenApiPageGenerationResult } from './common.js';
+export declare function generateOpenApiPages(pathOrDocumentOrUrl: string | OpenAPI.Document | URL, opts?: GenerateOpenApiPagesOptions): Promise<OpenApiPageGenerationResult<Navigation, DecoratedNavigation>>;

package/bin/openapi/generateOpenApiPages.js

@@ -1,43 +1,6 @@
-import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, validate, } from '@mintlify/common';
-import fse, { outputFile } from 'fs-extra';
-import fs from 'fs/promises';
-import yaml from 'js-yaml';
-import { OpenAPIV3 } from 'openapi-types';
-import { join, resolve, parse } from 'path';
-import path from 'path';
-import { fetchOpenApi } from '../utils/network.js';
-export const getOpenApiDefinition = async (pathOrDocumentOrUrl) => {
-    if (typeof pathOrDocumentOrUrl === 'string') {
-        if (pathOrDocumentOrUrl.startsWith('http://')) {
-            // This is an invalid location either for a file or a URL
-            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
-        }
-        else {
-            try {
-                const url = new URL(pathOrDocumentOrUrl);
-                pathOrDocumentOrUrl = url;
-            }
-            catch {
-                const pathname = path.join(process.cwd(), pathOrDocumentOrUrl.toString());
-                const file = await fs.readFile(pathname, 'utf-8');
-                pathOrDocumentOrUrl = yaml.load(file);
-            }
-        }
-    }
-    const isUrl = pathOrDocumentOrUrl instanceof URL;
-    if (pathOrDocumentOrUrl instanceof URL) {
-        if (pathOrDocumentOrUrl.protocol !== 'https:') {
-            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
-        }
-        pathOrDocumentOrUrl = await fetchOpenApi(pathOrDocumentOrUrl);
-    }
-    return { document: pathOrDocumentOrUrl, isUrl };
-};
-export const generateOpenApiPages = async (pathOrDocumentOrUrl, opts) => {
-    const { openApiFilePath, version, writeFiles, outDir, outDirBasePath } = opts ?? {};
-    const openApiFilePathFromRoot = openApiFilePath
-        ? optionallyAddLeadingSlash(openApiFilePath)
-        : undefined;
+import { validate } from '@mintlify/common';
+import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, } from './common.js';
+export async function generateOpenApiPages(pathOrDocumentOrUrl, opts) {
     const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
     const { schema } = await validate(document);
     if (schema?.paths === undefined || Object.keys(schema.paths).length === 0) {
@@ -51,44 +14,7 @@ export const generateOpenApiPages = async (pathOrDocumentOrUrl, opts) => {
         if (!pathItemObject || typeof pathItemObject !== 'object') {
             return;
         }
-        const typedPathItemObject = pathItemObject;
-        Object.values(OpenAPIV3.HttpMethods).forEach((method) => {
-            if (method in typedPathItemObject) {
-                const operation = typedPathItemObject[method];
-                const groupName = operation?.tags?.[0];
-                const title = prepareStringToBeValidFilename(operation?.summary) ??
-                    `${method}-${prepareStringToBeValidFilename(path)}`;
-                const folder = prepareStringToBeValidFilename(groupName) ?? '';
-                const base = join(outDir ?? '', folder, title);
-                const navGroup = findNavGroup(nav, groupName);
-                const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
-                const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
-                const openapiMetaTag = `${openApiFilePathFromRoot ? `${openApiFilePathFromRoot} ` : ''}${method} ${path}`;
-                const { title: titleTag, description } = getOpenApiTitleAndDescription([
-                    {
-                        filename: openApiFilePath ? parse(openApiFilePath).name : 'filler-filename',
-                        spec: schema,
-                        originalFileLocation: openApiFilePath,
-                    },
-                ], openapiMetaTag);
-                navGroup.push(filenameWithoutExtension);
-                const page = {
-                    openapi: openapiMetaTag,
-                    href: resolve('/', filenameWithoutExtension),
-                    title: titleTag ?? slugToTitle(filenameWithoutExtension),
-                    description,
-                    version,
-                };
-                decoratedNavGroup.push(page);
-                pagesAcc[filenameWithoutExtension] = page;
-                const targetPath = outDirBasePath
-                    ? join(outDirBasePath, `${filenameWithoutExtension}.mdx`)
-                    : `${filenameWithoutExtension}.mdx`;
-                if (writeFiles && (!fse.pathExistsSync(targetPath) || opts?.overwrite)) {
-                    writePromises.push(createOpenApiFrontmatter(targetPath, openapiMetaTag, version));
-                }
-            }
-        });
+        processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
     });
     await Promise.all(writePromises);
     return {
@@ -98,12 +24,8 @@ export const generateOpenApiPages = async (pathOrDocumentOrUrl, opts) => {
         pagesAcc,
         isUrl,
     };
-};
-// returns the group with the given group name, or the top-level group if no group name is provided
-const findNavGroup = (nav, groupName) => {
-    if (groupName === undefined) {
-        groupName = 'API Reference';
-    }
+}
+const findNavGroup = (nav, groupName = DEFAULT_API_GROUP_NAME) => {
     const group = nav.find((fileOrGroup) => typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName);
     if (group === undefined) {
         const newGroup = {
@@ -117,33 +39,4 @@ const findNavGroup = (nav, groupName) => {
         return group.pages;
     }
 };
-// returns a filename that is unique within the given array of pages
-const generateUniqueFilenameWithoutExtension = (pages, base) => {
-    let filename = base;
-    if (pages.includes(filename)) {
-        let extension = 1;
-        filename = `${base}-${extension}`;
-        while (pages.includes(filename)) {
-            extension += 1;
-            filename = `${base}-${extension}`;
-        }
-    }
-    return filename;
-};
-const createOpenApiFrontmatter = async (filename, openApiMetaTag, version) => {
-    const data = `---
-openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}
----`;
-    await outputFile(filename, data);
-};
-export const prepareStringToBeValidFilename = (str) => str
-    ? str
-        .replaceAll(' ', '-')
-        .replace(/\{.*?\}/g, '-') // remove path parameters
-        .replace(/^-/, '')
-        .replace(/-$/, '')
-        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
-        .replaceAll(/--/g, '-') // replace double hyphens
-        .toLowerCase()
-    : undefined;
 //# sourceMappingURL=generateOpenApiPages.js.map

package/bin/openapi/generateOpenApiPages.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EACzB,WAAW,EACX,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAS1B,OAAO,GAAG,EAAE,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAW,SAAS,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,EACK,EAAE;IAC3D,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,yDAAyD;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,mBAAmB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,mBAAuC,EAAE,KAAK,EAAE,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,EACpD,IAOC,EAOA,EAAE;IACH,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACpF,MAAM,uBAAuB,GAAG,eAAe;QAC7C,CAAC,CAAC,yBAAyB,CAAC,eAAe,CAAC;QAC5C,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAE5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,YAAY,GAAwB,EAAE,CAAC;IAC7C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAC7D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;QAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC1D,OAAO;QACT,CAAC;QACD,MAAM,mBAAmB,GAAG,cAA0C,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACtD,IAAI,MAAM,IAAI,mBAAmB,EAAE,CAAC;gBAClC,MAAM,SAAS,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;gBAC9C,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;oBAClD,GAAG,MAAM,IAAI,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtD,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;gBAE/C,MAAM,QAAQ,GAAG,YAAY,CAAkB,GAAG,EAAE,SAAS,CAAC,CAAC;gBAC/D,MAAM,iBAAiB,GAAG,YAAY,CAA2B,YAAY,EAAE,SAAS,CAAC,CAAC;gBAE1F,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACxF,MAAM,cAAc,GAAG,GACrB,uBAAuB,CAAC,CAAC,CAAC,GAAG,uBAAuB,GAAG,CAAC,CAAC,CAAC,EAC5D,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;gBACpB,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,6BAA6B,CACpE;oBACE;wBACE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB;wBAC3E,IAAI,EAAE,MAA0B;wBAChC,oBAAoB,EAAE,eAAe;qBACtC;iBACF,EACD,cAAc,CACf,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACxC,MAAM,IAAI,GAA4B;oBACpC,OAAO,EAAE,cAAc;oBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;oBAC5C,KAAK,EAAE,QAAQ,IAAI,WAAW,CAAC,wBAAwB,CAAC;oBACxD,WAAW;oBACX,OAAO;iBACR,CAAC;gBACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7B,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;gBAC1C,MAAM,UAAU,GAAG,cAAc;oBAC/B,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;oBACzD,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;gBACtC,IAAI,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;oBACvE,aAAa,CAAC,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,mGAAmG;AACnG,MAAM,YAAY,GAAG,CACnB,GAAyB,EACzB,SAAkB,EACI,EAAE;IACxB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,SAAS,GAAG,eAAe,CAAC;IAC9B,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC9E,CAAC;IACnB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC;AAEF,oEAAoE;AACpE,MAAM,sCAAsC,GAAG,CAAC,KAAwB,EAAE,IAAY,EAAU,EAAE;IAChG,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,SAAS,IAAI,CAAC,CAAC;YACf,QAAQ,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,KAAK,EACpC,QAAgB,EAChB,cAAsB,EACtB,OAAgB,EAChB,EAAE;IACF,MAAM,IAAI,GAAG;WACJ,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;IAC9D,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAY,EAAE,EAAE,CAC7D,GAAG;IACD,CAAC,CAAC,GAAG;SACA,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAClD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,4BAA4B;SAC1D,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAChD,WAAW,EAAE;IAClB,CAAC,CAAC,SAAS,CAAC"}
+{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,YAAY,GAAwB,EAAE,CAAC;IAC7C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;QAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC1D,OAAO;QACT,CAAC;QACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AACD,MAAM,YAAY,GAAG,CACnB,GAAyB,EACzB,YAAoB,sBAAsB,EACpB,EAAE;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC9E,CAAC;IACnB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}

package/bin/openapi/generateOpenApiPagesForDocsConfig.d.ts

@@ -0,0 +1,4 @@
+import { DecoratedGroupsConfig, GroupsConfig } from '@mintlify/validation';
+import { OpenAPI } from 'openapi-types';
+import { GenerateOpenApiPagesOptions, OpenApiPageGenerationResult } from './common.js';
+export declare function generateOpenApiPagesForDocsConfig(pathOrDocumentOrUrl: string | OpenAPI.Document | URL, opts?: GenerateOpenApiPagesOptions): Promise<OpenApiPageGenerationResult<GroupsConfig, DecoratedGroupsConfig>>;

package/bin/openapi/generateOpenApiPagesForDocsConfig.js

@@ -0,0 +1,42 @@
+import { validate } from '@mintlify/common';
+import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, } from './common.js';
+export async function generateOpenApiPagesForDocsConfig(pathOrDocumentOrUrl, opts) {
+    const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
+    const { schema } = await validate(document);
+    if (schema?.paths === undefined || Object.keys(schema.paths).length === 0) {
+        throw new Error('No paths defined.');
+    }
+    const nav = [];
+    const decoratedNav = [];
+    const writePromises = [];
+    const pagesAcc = {};
+    Object.entries(schema.paths).forEach(([path, pathItemObject]) => {
+        if (!pathItemObject || typeof pathItemObject !== 'object') {
+            return;
+        }
+        processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
+    });
+    await Promise.all(writePromises);
+    return {
+        nav,
+        decoratedNav,
+        spec: schema,
+        pagesAcc,
+        isUrl,
+    };
+}
+const findNavGroup = (nav, groupName = DEFAULT_API_GROUP_NAME) => {
+    const group = nav.find((fileOrGroup) => typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName);
+    if (group === undefined || !('pages' in group)) {
+        const newGroup = {
+            group: groupName,
+            pages: [],
+        };
+        nav.push(newGroup);
+        return newGroup.pages;
+    }
+    else {
+        return group.pages;
+    }
+};
+//# sourceMappingURL=generateOpenApiPagesForDocsConfig.js.map

package/bin/openapi/generateOpenApiPagesForDocsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateOpenApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,iCAAiC,CACrD,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,YAAY,GAA0B,EAAE,CAAC;IAC/C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;QAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC1D,OAAO;QACT,CAAC;QACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,CACnB,GAAyC,EACzC,YAAoB,sBAAsB,EACN,EAAE;IACtC,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC/F,CAAC;IACF,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}