@mintlify/prebuild 1.0.768 → 1.0.770

package/dist/prebuild/categorizeFilePaths.d.ts

@@ -1,6 +1,6 @@
 import { AsyncAPIFile } from '@mintlify/common';
 import { OpenApiFile } from '@mintlify/models';
-export declare const categorizeFilePaths: (contentDirectoryPath: string, mintIgnore?: string[], disableOpenApi?: boolean) => Promise<{
+export declare const categorizeFilePaths: (contentDirectoryPath: string, mintIgnore?: string[], disableOpenApi?: boolean, snippetPatterns?: string[]) => Promise<{
     contentFilenames: string[];
     staticFilenames: string[];
     openApiFiles: OpenApiFile[];

package/dist/prebuild/categorizeFilePaths.js

@@ -1,11 +1,11 @@
-import { openApiCheck } from '@mintlify/common';
+import { openApiCheck, isSnippetPath } from '@mintlify/common';
 import { validateAsyncApi } from '@mintlify/common';
 import { readFile } from 'fs/promises';
 import yaml from 'js-yaml';
 import * as path from 'path';
 import { getFileList } from '../fs/index.js';
 import { getFileExtension } from '../utils.js';
-export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = [], disableOpenApi) => {
+export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = [], disableOpenApi, snippetPatterns) => {
     const allFilesInCmdExecutionPath = getFileList(contentDirectoryPath, contentDirectoryPath, mintIgnore);
     const contentFilenames = [];
     const staticFilenames = [];
@@ -23,7 +23,7 @@ export const categorizeFilePaths = async (contentDirectoryPath, mintIgnore = [],
                     snippets.push(filename);
                     break;
                 }
-                if (filename.startsWith('/snippets/')) {
+                if (isSnippetPath(filename, snippetPatterns)) {
                     snippetsV2.push(filename);
                     break;
                 }

package/dist/prebuild/index.js

@@ -1,4 +1,4 @@
-import { getConfigPath, getMintIgnore } from '../utils.js';
+import { getConfigPath, getMintIgnore, getSnippetPatterns } from '../utils.js';
 import { categorizeFilePaths } from './categorizeFilePaths.js';
 import { update } from './update/index.js';
 export const prebuild = async (contentDirectoryPath, { localSchema, groups, disableOpenApi, } = {}) => {
@@ -11,8 +11,11 @@ export const prebuild = async (contentDirectoryPath, { localSchema, groups, disa
     if (mintConfigPath == null && docsConfigPath == null) {
         throw Error('must be run in a directory where a docs.json file exists.');
     }
-    const mintIgnore = await getMintIgnore(contentDirectoryPath);
-    const { contentFilenames, staticFilenames, openApiFiles, asyncApiFiles, snippets, snippetsV2 } = await categorizeFilePaths(contentDirectoryPath, mintIgnore, disableOpenApi);
+    const [mintIgnore, snippetPatterns] = await Promise.all([
+        getMintIgnore(contentDirectoryPath),
+        getSnippetPatterns(contentDirectoryPath),
+    ]);
+    const { contentFilenames, staticFilenames, openApiFiles, asyncApiFiles, snippets, snippetsV2 } = await categorizeFilePaths(contentDirectoryPath, mintIgnore, disableOpenApi, snippetPatterns);
     await update({
         contentDirectoryPath,
         staticFilenames,
@@ -26,6 +29,7 @@ export const prebuild = async (contentDirectoryPath, { localSchema, groups, disa
         groups,
         mintIgnore,
         disableOpenApi,
+        snippetPatterns,
     });
 };
 export * from './categorizeFilePaths.js';

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

@@ -343,6 +343,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -666,6 +667,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -989,6 +991,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1312,6 +1315,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1635,6 +1639,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1958,6 +1963,7 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -2281,4 +2287,5 @@ export declare const DocsConfigUpdater: ConfigUpdater<{
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 }>;

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

@@ -14,8 +14,9 @@ type UpdateArgs = {
     groups?: string[];
     mintIgnore?: string[];
     disableOpenApi?: boolean;
+    snippetPatterns?: string[];
 };
-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, snippetPatterns, }: UpdateArgs) => Promise<{
     name: string;
     $schema: string;
     theme: "mint";
@@ -338,6 +339,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -661,6 +663,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -984,6 +987,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1307,6 +1311,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1630,6 +1635,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -1953,6 +1959,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 } | {
     name: string;
     $schema: string;
@@ -2276,6 +2283,7 @@ export declare const update: ({ contentDirectoryPath, staticFilenames, openApiFi
     interaction?: {
         drilldown?: boolean | undefined;
     } | undefined;
+    snippets?: string[] | undefined;
 }>;
 export declare const writeMdxFilesWithNoImports: (mdxFilesWithNoImports: {
     targetPath: string;

package/dist/prebuild/update/index.js

@@ -11,7 +11,7 @@ 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, }) => {
+export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, groups, mintIgnore, disableOpenApi, snippetPatterns, }) => {
     const mintConfigResult = await updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema);
     // we used the original mint config without openapi pages injected
     // because we will do it in `updateDocsConfigFile`, this will avoid duplicated openapi pages
@@ -54,6 +54,7 @@ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFil
             pagesAcc,
             snippetsV2: snippetV2Contents,
             filesWithImports,
+            snippetPatterns,
         }),
         writeFile(newOpenApiFiles, 'src/_props/openApiFiles.json'),
         writeFile(customLanguages, 'src/_props/customLanguages.json'),

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

@@ -7,6 +7,7 @@ type ResolveImportsAndWriteFilesArgs = {
     pagesAcc: Record<string, DecoratedNavigationPage>;
     snippetsV2: FileType[];
     filesWithImports: FileWithImports[];
+    snippetPatterns?: string[];
 };
-export declare const resolveImportsAndWriteFiles: ({ openApiFiles, asyncApiFiles, pagesAcc, snippetsV2, filesWithImports, }: ResolveImportsAndWriteFilesArgs) => Promise<void>;
+export declare const resolveImportsAndWriteFiles: ({ openApiFiles, asyncApiFiles, pagesAcc, snippetsV2, filesWithImports, snippetPatterns, }: ResolveImportsAndWriteFilesArgs) => Promise<void>;
 export {};

package/dist/prebuild/update/resolveImportsAndWriteFiles.js

@@ -1,8 +1,8 @@
 import { resolveAllImports, hasImports, findAndRemoveImports, getDecoratedNavPageAndSlug, topologicalSort, stringifyTree, } from '@mintlify/common';
 import { outputFile } from 'fs-extra';
 import { join } from 'path';
-export const resolveImportsAndWriteFiles = async ({ openApiFiles, asyncApiFiles, pagesAcc, snippetsV2, filesWithImports, }) => {
-    const snippetsWithResolvedImports = await resolveImportsInSnippets(snippetsV2);
+export const resolveImportsAndWriteFiles = async ({ openApiFiles, asyncApiFiles, pagesAcc, snippetsV2, filesWithImports, snippetPatterns, }) => {
+    const snippetsWithResolvedImports = await resolveImportsInSnippets(snippetsV2, snippetPatterns);
     const writeSnippetsWithImportsPromises = await writeSnippets(snippetsWithResolvedImports);
     const pagesWithResolvedImports = await resolveImportsInPages({
         openApiFiles,
@@ -10,11 +10,12 @@ export const resolveImportsAndWriteFiles = async ({ openApiFiles, asyncApiFiles,
         snippetsWithResolvedImports,
         filesWithImports,
         pagesAcc,
+        snippetPatterns,
     });
     const writePagesPromise = writePages(pagesWithResolvedImports);
     await Promise.all([...writeSnippetsWithImportsPromises, ...writePagesPromise]);
 };
-const resolveImportsInSnippets = async (snippetsV2) => {
+const resolveImportsInSnippets = async (snippetsV2, snippetPatterns) => {
     const snippetsWithImportsPromises = snippetsV2.map(async (snippet) => ({
         ...(await findAndRemoveImports(snippet.tree)),
         filename: snippet.filename,
@@ -35,6 +36,7 @@ const resolveImportsInSnippets = async (snippetsV2) => {
             snippetWithImports.tree = await resolveAllImports({
                 snippets: orderedSnippetsWithImports,
                 fileWithImports: snippetWithImports,
+                snippetPatterns,
             });
         }
     }
@@ -46,11 +48,12 @@ const writeSnippets = async (snippetsWithImports) => snippetsWithImports.map(asy
         flag: 'w',
     });
 });
-const resolveImportsInPages = async ({ openApiFiles, asyncApiFiles, snippetsWithResolvedImports, filesWithImports, pagesAcc, }) => {
+const resolveImportsInPages = async ({ openApiFiles, asyncApiFiles, snippetsWithResolvedImports, filesWithImports, pagesAcc, snippetPatterns, }) => {
     const filesWithResolvedImportsPromises = filesWithImports.map(async (fileWithImports) => {
         const tree = await resolveAllImports({
             snippets: snippetsWithResolvedImports,
             fileWithImports,
+            snippetPatterns,
         });
         const contentStr = stringifyTree(tree);
         const { slug, pageMetadata } = getDecoratedNavPageAndSlug(fileWithImports.filename, contentStr, openApiFiles, asyncApiFiles);