@mintlify/prebuild 1.0.753 → 1.0.754

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { AsyncAPIFile } from '@mintlify/common';
2
2
  import { OpenApiFile } from '@mintlify/models';
3
- export declare const categorizeFilePaths: (contentDirectoryPath: string, mintIgnore?: string[]) => Promise<{
3
+ export declare const categorizeFilePaths: (contentDirectoryPath: string, mintIgnore?: string[], disableOpenApi?: boolean) => Promise<{
4
4
  contentFilenames: string[];
5
5
  staticFilenames: string[];
6
6
  openApiFiles: OpenApiFile[];
@@ -5,7 +5,7 @@ import yaml from 'js-yaml';
5
5
  import * as path from 'path';
6
6
  import { getFileList } from '../fs/index.js';
7
7
  import { getFileExtension } from '../utils.js';
8
- export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = []) => {
8
+ export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = [], disableOpenApi) => {
9
9
  const allFilesInCmdExecutionPath = getFileList(contentDirectoryPath, contentDirectoryPath, mintIgnore);
10
10
  const contentFilenames = [];
11
11
  const staticFilenames = [];
@@ -40,7 +40,7 @@ export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = [])
40
40
  const isOpenApi = Object.keys(obj).includes('openapi');
41
41
  const isAsyncApi = Object.keys(obj).includes('asyncapi');
42
42
  const fileName = path.parse(filename).name;
43
- if (isOpenApi) {
43
+ if (isOpenApi && !disableOpenApi) {
44
44
  try {
45
45
  const openApiDocument = await openApiCheck(obj);
46
46
  if (openApiDocument) {
@@ -1,6 +1,7 @@
1
- export declare const prebuild: (contentDirectoryPath: string, { localSchema, groups }?: {
1
+ export declare const prebuild: (contentDirectoryPath: string, { localSchema, groups, disableOpenApi, }?: {
2
2
  localSchema?: boolean;
3
3
  groups?: string[];
4
+ disableOpenApi?: boolean;
4
5
  }) => Promise<void>;
5
6
  export * from './categorizeFilePaths.js';
6
7
  export * from '../createPage/index.js';
@@ -1,7 +1,7 @@
1
1
  import { getConfigPath, getMintIgnore } from '../utils.js';
2
2
  import { categorizeFilePaths } from './categorizeFilePaths.js';
3
3
  import { update } from './update/index.js';
4
- export const prebuild = async (contentDirectoryPath, { localSchema, groups } = {}) => {
4
+ export const prebuild = async (contentDirectoryPath, { localSchema, groups, disableOpenApi, } = {}) => {
5
5
  if (process.env.IS_MULTI_TENANT === 'true') {
6
6
  console.log('Skipping prebuild in multi-tenant mode.');
7
7
  return;
@@ -12,7 +12,7 @@ export const prebuild = async (contentDirectoryPath, { localSchema, groups } = {
12
12
  throw Error('must be run in a directory where a docs.json file exists.');
13
13
  }
14
14
  const mintIgnore = await getMintIgnore(contentDirectoryPath);
15
- const { contentFilenames, staticFilenames, openApiFiles, asyncApiFiles, snippets, snippetsV2 } = await categorizeFilePaths(contentDirectoryPath, mintIgnore);
15
+ const { contentFilenames, staticFilenames, openApiFiles, asyncApiFiles, snippets, snippetsV2 } = await categorizeFilePaths(contentDirectoryPath, mintIgnore, disableOpenApi);
16
16
  await update({
17
17
  contentDirectoryPath,
18
18
  staticFilenames,
@@ -25,6 +25,7 @@ export const prebuild = async (contentDirectoryPath, { localSchema, groups } = {
25
25
  localSchema,
26
26
  groups,
27
27
  mintIgnore,
28
+ disableOpenApi,
28
29
  });
29
30
  };
30
31
  export * from './categorizeFilePaths.js';
@@ -1,12 +1,13 @@
1
1
  import { AsyncAPIFile } from '@mintlify/common';
2
2
  import { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
3
3
  import { DocsConfig } from '@mintlify/validation';
4
- export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, }: {
4
+ export declare function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, }: {
5
5
  contentDirectoryPath: string;
6
6
  openApiFiles: OpenApiFile[];
7
7
  asyncApiFiles: AsyncAPIFile[];
8
8
  docsConfig?: DocsConfig;
9
9
  localSchema?: boolean;
10
+ disableOpenApi?: boolean;
10
11
  }): Promise<{
11
12
  docsConfig: DocsConfig;
12
13
  pagesAcc: Record<string, DecoratedNavigationPage>;
@@ -4,7 +4,7 @@ import { generateAsyncApiDivisions } from './generateAsyncApiDivisions.js';
4
4
  import { generateOpenApiDivisions } from './generateOpenApiDivisions.js';
5
5
  import { getCustomLanguages } from './getCustomLanguages.js';
6
6
  const NOT_CORRECT_PATH_ERROR = 'must be run in a directory where a docs.json file exists.';
7
- export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, }) {
7
+ export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles, asyncApiFiles, docsConfig, localSchema, disableOpenApi, }) {
8
8
  const configPath = await getConfigPath(contentDirectoryPath, 'docs');
9
9
  if (configPath == null && docsConfig == null) {
10
10
  throw Error(NOT_CORRECT_PATH_ERROR);
@@ -16,7 +16,9 @@ export async function updateDocsConfigFile({ contentDirectoryPath, openApiFiles,
16
16
  throw Error(NOT_CORRECT_PATH_ERROR);
17
17
  }
18
18
  const customLanguages = await getCustomLanguages({ config: docsConfig, contentDirectoryPath });
19
- const { newDocsConfig: docsConfigWithOpenApiPages, pagesAcc: pagesAccWithOpenApiPages, openApiFiles: newOpenApiFiles, } = await generateOpenApiDivisions(docsConfig, openApiFiles, undefined, localSchema);
19
+ const { newDocsConfig: docsConfigWithOpenApiPages, pagesAcc: pagesAccWithOpenApiPages, openApiFiles: newOpenApiFiles, } = !disableOpenApi
20
+ ? await generateOpenApiDivisions(docsConfig, openApiFiles, undefined, localSchema)
21
+ : { newDocsConfig: docsConfig, pagesAcc: {}, openApiFiles: openApiFiles };
20
22
  const { newDocsConfig, pagesAcc: pagesAccWithAsyncApiPages, asyncApiFiles: newAsyncApiFiles, } = await generateAsyncApiDivisions(docsConfigWithOpenApiPages, asyncApiFiles, undefined, localSchema);
21
23
  const pagesAcc = { ...pagesAccWithOpenApiPages, ...pagesAccWithAsyncApiPages };
22
24
  await DocsConfigUpdater.writeConfigFile(newDocsConfig);
@@ -13,8 +13,9 @@ type UpdateArgs = {
13
13
  localSchema?: boolean;
14
14
  groups?: string[];
15
15
  mintIgnore?: string[];
16
+ disableOpenApi?: boolean;
16
17
  };
17
- export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, }: UpdateArgs) => Promise<{
18
+ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, }: UpdateArgs) => Promise<{
18
19
  name: string;
19
20
  $schema: string;
20
21
  theme: "mint";
@@ -11,7 +11,7 @@ import { writeAsyncApiFiles } from './write/writeAsyncApiFiles.js';
11
11
  import { writeFiles, writeFile } from './write/writeFiles.js';
12
12
  import { writeOpenApiData } from './write/writeOpenApiData.js';
13
13
  import { writeRssFiles } from './write/writeRssFiles.js';
14
- export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, }) => {
14
+ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, }) => {
15
15
  const mintConfigResult = await updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema);
16
16
  // we used the original mint config without openapi pages injected
17
17
  // because we will do it in `updateDocsConfigFile`, this will avoid duplicated openapi pages
@@ -22,6 +22,7 @@ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFil
22
22
  asyncApiFiles,
23
23
  docsConfig: docsConfigPath ? undefined : docsConfig,
24
24
  localSchema,
25
+ disableOpenApi,
25
26
  });
26
27
  const pagePromises = readPageContents({
27
28
  contentDirectoryPath,