@mintlify/previewing 4.0.822 → 4.0.823

package/dist/local-preview/listener/generateDependentSnippets.d.ts

@@ -1,2 +1,2 @@
 import type { FindAndRemoveImportsResponse } from '@mintlify/common';
-export declare const generateDependentSnippets: (changedFilename: string, newImportData: FindAndRemoveImportsResponse) => Promise<string[]>;
+export declare const generateDependentSnippets: (changedFilename: string, newImportData: FindAndRemoveImportsResponse, snippetPatterns?: string[]) => Promise<string[]>;

package/dist/local-preview/listener/generateDependentSnippets.js

@@ -4,7 +4,7 @@ import { join } from 'path';
 import { NEXT_PUBLIC_PATH } from '../../constants.js';
 import { getOriginalSnippets } from './getSnippets.js';
 import { resolveAllImports } from './resolveAllImports.js';
-const findAllDependents = async (initialFileWithSlash, allSnippets, processedDataCache) => {
+const findAllDependents = async (initialFileWithSlash, allSnippets, processedDataCache, snippetPatterns) => {
     const affected = new Set([initialFileWithSlash]);
     const queue = [initialFileWithSlash];
     while (queue.length > 0) {
@@ -20,7 +20,7 @@ const findAllDependents = async (initialFileWithSlash, allSnippets, processedDat
                 processedDataCache.set(potentialDependentFile, processedData);
             }
             const importsCurrentFile = Object.keys(processedData.importMap).some((importPath) => {
-                const resolvedPath = resolveSnippetImportPath(importPath, potentialDependentFile);
+                const resolvedPath = resolveSnippetImportPath(importPath, potentialDependentFile, snippetPatterns);
                 return resolvedPath === currentSourceFile;
             });
             if (importsCurrentFile) {
@@ -33,11 +33,11 @@ const findAllDependents = async (initialFileWithSlash, allSnippets, processedDat
     }
     return affected;
 };
-export const generateDependentSnippets = async (changedFilename, newImportData) => {
+export const generateDependentSnippets = async (changedFilename, newImportData, snippetPatterns) => {
     const processedDataCache = new Map();
-    const allOriginalSnippets = await getOriginalSnippets();
+    const allOriginalSnippets = await getOriginalSnippets(snippetPatterns);
     const updatedSnippetFileKey = optionallyAddLeadingSlash(changedFilename);
-    const affectedSnippets = await findAllDependents(updatedSnippetFileKey, allOriginalSnippets, processedDataCache);
+    const affectedSnippets = await findAllDependents(updatedSnippetFileKey, allOriginalSnippets, processedDataCache, snippetPatterns);
     const snippetPromises = Array.from(affectedSnippets).map(async (filename) => {
         const cachedData = processedDataCache.get(filename);
         if (cachedData)
@@ -66,7 +66,7 @@ export const generateDependentSnippets = async (changedFilename, newImportData)
     const graph = {};
     snippets.forEach((item) => {
         graph[item.filename] = Object.keys(item.importMap)
-            .map((dep) => resolveSnippetImportPath(dep, item.filename))
+            .map((dep) => resolveSnippetImportPath(dep, item.filename, snippetPatterns))
             .filter((resolvedDep) => resolvedDep != null);
     });
     const sortedSnippets = topologicalSort(graph).reverse();
@@ -78,7 +78,7 @@ export const generateDependentSnippets = async (changedFilename, newImportData)
     for (const currentSnippet of orderedSnippets) {
         let processedTree = currentSnippet.tree;
         if (currentSnippet.filename !== updatedSnippetFileKey && hasImports(currentSnippet)) {
-            processedTree = await resolveAllImports(currentSnippet);
+            processedTree = await resolveAllImports(currentSnippet, snippetPatterns);
         }
         const targetFilename = optionallyRemoveLeadingSlash(currentSnippet.filename);
         const targetPath = join(NEXT_PUBLIC_PATH, targetFilename);

package/dist/local-preview/listener/generatePagesWithImports.d.ts

@@ -1 +1 @@
-export declare const generatePagesWithImports: (updatedSnippets: Set<string>) => Promise<void>;
+export declare const generatePagesWithImports: (updatedSnippets: Set<string>, snippetPatterns?: string[]) => Promise<void>;

package/dist/local-preview/listener/generatePagesWithImports.js

@@ -1,4 +1,4 @@
-import { findAndRemoveImports, optionallyRemoveLeadingSlash, resolveAllImports, resolveSnippetImportPath, stringifyTree, SNIPPET_EXTENSIONS, } from '@mintlify/common';
+import { findAndRemoveImports, optionallyRemoveLeadingSlash, resolveAllImports, resolveSnippetImportPath, stringifyTree, SNIPPET_EXTENSIONS, isSnippetPath, } from '@mintlify/common';
 import { preparseMdxTree, getFileListSync } from '@mintlify/prebuild';
 import { promises as _promises } from 'fs';
 import { outputFile } from 'fs-extra';
@@ -6,11 +6,11 @@ import { join } from 'path';
 import { CMD_EXEC_PATH, NEXT_PROPS_PATH } from '../../constants.js';
 import { getProcessedSnippets } from './getSnippets.js';
 const { readFile } = _promises;
-export const generatePagesWithImports = async (updatedSnippets) => {
-    const snippets = await getProcessedSnippets();
+export const generatePagesWithImports = async (updatedSnippets, snippetPatterns) => {
+    const snippets = await getProcessedSnippets(snippetPatterns);
     const pageFilenames = getFileListSync(CMD_EXEC_PATH).filter((file) => SNIPPET_EXTENSIONS.some((ext) => file.endsWith(ext)) &&
         !file.startsWith('_snippets/') &&
-        !file.startsWith('snippets/'));
+        !isSnippetPath(file, snippetPatterns));
     await Promise.all(pageFilenames.map(async (pageFilename) => {
         const sourcePath = join(CMD_EXEC_PATH, pageFilename);
         const contentStr = (await readFile(sourcePath)).toString();
@@ -18,13 +18,14 @@ export const generatePagesWithImports = async (updatedSnippets) => {
             const tree = await preparseMdxTree(contentStr, CMD_EXEC_PATH, sourcePath);
             const importsResponse = await findAndRemoveImports(tree);
             if (Object.keys(importsResponse.importMap).some((importPath) => {
-                const resolvedPath = resolveSnippetImportPath(importPath, pageFilename);
+                const resolvedPath = resolveSnippetImportPath(importPath, pageFilename, snippetPatterns);
                 return (resolvedPath != null &&
                     updatedSnippets.has(optionallyRemoveLeadingSlash(resolvedPath)));
             })) {
                 const content = await resolveAllImports({
                     snippets,
                     fileWithImports: { ...importsResponse, filename: pageFilename },
+                    snippetPatterns,
                 });
                 const targetPath = join(NEXT_PROPS_PATH, pageFilename);
                 await outputFile(targetPath, stringifyTree(content), {

package/dist/local-preview/listener/getSnippets.d.ts

@@ -1,3 +1,3 @@
 import { type FileType } from '@mintlify/common';
-export declare const getProcessedSnippets: () => Promise<FileType[]>;
-export declare const getOriginalSnippets: () => Promise<FileType[]>;
+export declare const getProcessedSnippets: (snippetPatterns?: string[]) => Promise<FileType[]>;
+export declare const getOriginalSnippets: (snippetPatterns?: string[]) => Promise<FileType[]>;

package/dist/local-preview/listener/getSnippets.js

@@ -1,11 +1,11 @@
-import { optionallyAddLeadingSlash, SNIPPET_EXTENSIONS } from '@mintlify/common';
+import { optionallyAddLeadingSlash, SNIPPET_EXTENSIONS, isSnippetPath, } from '@mintlify/common';
 import { getFileListSync, preparseMdxTree } from '@mintlify/prebuild';
 import { promises as _promises } from 'fs';
 import { join } from 'path';
 import { CMD_EXEC_PATH, NEXT_PUBLIC_PATH } from '../../constants.js';
 const { readFile } = _promises;
-const getSnippetBase = async (BASE_DIR) => {
-    const snippetFilenames = getFileListSync(BASE_DIR).filter((file) => SNIPPET_EXTENSIONS.some((ext) => file.endsWith(ext)) && file.startsWith('snippets/'));
+const getSnippetBase = async (BASE_DIR, snippetPatterns) => {
+    const snippetFilenames = getFileListSync(BASE_DIR).filter((file) => SNIPPET_EXTENSIONS.some((ext) => file.endsWith(ext)) && isSnippetPath(file, snippetPatterns));
     const promises = snippetFilenames.map(async (snippetFilename) => {
         try {
             const tree = await preparseMdxTree((await readFile(join(BASE_DIR, snippetFilename))).toString(), BASE_DIR, join(BASE_DIR, snippetFilename));
@@ -21,5 +21,5 @@ const getSnippetBase = async (BASE_DIR) => {
     });
     return (await Promise.all(promises)).filter(Boolean);
 };
-export const getProcessedSnippets = () => getSnippetBase(NEXT_PUBLIC_PATH);
-export const getOriginalSnippets = () => getSnippetBase(CMD_EXEC_PATH);
+export const getProcessedSnippets = (snippetPatterns) => getSnippetBase(NEXT_PUBLIC_PATH, snippetPatterns);
+export const getOriginalSnippets = (snippetPatterns) => getSnippetBase(CMD_EXEC_PATH, snippetPatterns);

package/dist/local-preview/listener/index.js

@@ -19,6 +19,7 @@ import { updateCustomLanguages, updateGeneratedNav, updateOpenApiFiles, upsertOp
 import { isFileSizeValid, shouldRegenerateNavForPage } from './utils.js';
 const { readFile } = _promises;
 const frontmatterHashes = new Map();
+let previousSnippetPatternsJson = null;
 const getMintIgnoreGlobs = () => {
     const mintIgnorePath = pathUtil.join(CMD_EXEC_PATH, '.mintignore');
     if (fse.existsSync(mintIgnorePath)) {
@@ -27,8 +28,23 @@ const getMintIgnoreGlobs = () => {
     }
     return [];
 };
+const getSnippetPatterns = () => {
+    const docsConfigPath = pathUtil.join(CMD_EXEC_PATH, 'docs.json');
+    if (fse.existsSync(docsConfigPath)) {
+        try {
+            const configContent = fse.readFileSync(docsConfigPath, 'utf-8');
+            const config = JSON.parse(configContent);
+            return config.snippets;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    return undefined;
+};
 const listener = (callback, options = {}) => {
     const mintIgnoreGlobs = getMintIgnoreGlobs();
+    previousSnippetPatternsJson = JSON.stringify(getSnippetPatterns() ?? []);
     chokidar
         .watch(CMD_EXEC_PATH, {
         ignoreInitial: true,
@@ -76,7 +92,8 @@ const onUnlinkEvent = async (filename, options) => {
         return;
     }
     try {
-        const potentialCategory = getFileCategory(filename);
+        const snippetPatterns = getSnippetPatterns();
+        const potentialCategory = getFileCategory(filename, snippetPatterns);
         const targetPath = getTargetPath(potentialCategory, filename);
         if (potentialCategory === 'page' ||
             potentialCategory === 'snippet' ||
@@ -163,7 +180,8 @@ const validateConfigFiles = async () => {
  */
 const onUpdateEvent = async (filename, callback, options = {}) => {
     const filePath = pathUtil.join(CMD_EXEC_PATH, filename);
-    const potentialCategory = getFileCategory(filename);
+    const snippetPatterns = getSnippetPatterns();
+    const potentialCategory = getFileCategory(filename, snippetPatterns);
     const targetPath = getTargetPath(potentialCategory, filename);
     let regenerateNav = false;
     let category = potentialCategory === 'potentialYamlOpenApiSpec' ||
@@ -177,7 +195,7 @@ const onUpdateEvent = async (filename, callback, options = {}) => {
             const tree = await preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
             const importsResponse = await findAndRemoveImports(tree);
             if (hasImports(importsResponse)) {
-                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }));
+                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }, snippetPatterns));
             }
             // set suppressErrLog true here to avoid double logging errors already logged in preparseMdxTree
             const { pageContent } = await createPage(filename, contentStr, CMD_EXEC_PATH, [], [], true);
@@ -195,17 +213,29 @@ const onUpdateEvent = async (filename, callback, options = {}) => {
             const tree = await preparseMdxTree(contentStr, CMD_EXEC_PATH, filePath);
             const importsResponse = await findAndRemoveImports(tree);
             if (hasImports(importsResponse)) {
-                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }));
+                contentStr = stringifyTree(await resolveAllImports({ ...importsResponse, filename }, snippetPatterns));
             }
             await fse.outputFile(targetPath, contentStr, {
                 flag: 'w',
             });
-            const updatedSnippets = await generateDependentSnippets(filename, importsResponse);
-            await generatePagesWithImports(new Set(updatedSnippets));
+            const updatedSnippets = await generateDependentSnippets(filename, importsResponse, snippetPatterns);
+            await generatePagesWithImports(new Set(updatedSnippets), snippetPatterns);
             break;
         }
         case 'mintConfig':
         case 'docsConfig': {
+            if (potentialCategory === 'docsConfig') {
+                const currentJson = JSON.stringify(snippetPatterns ?? []);
+                if (previousSnippetPatternsJson !== null && currentJson !== previousSnippetPatternsJson) {
+                    previousSnippetPatternsJson = currentJson;
+                    addChangeLog(_jsx(InfoLog, { message: "Snippet patterns changed. Rebuilding..." }));
+                    await fse.emptyDir(NEXT_PUBLIC_PATH);
+                    await fse.emptyDir(NEXT_PROPS_PATH);
+                    await prebuild(CMD_EXEC_PATH, options);
+                    break;
+                }
+                previousSnippetPatternsJson = currentJson;
+            }
             regenerateNav = true;
             try {
                 const { mintConfig, openApiFiles, docsConfig } = await getDocsState();

package/dist/local-preview/listener/resolveAllImports.d.ts

@@ -1,3 +1,3 @@
 import type { FileWithImports } from '@mintlify/common';
 import type { Root } from 'mdast';
-export declare const resolveAllImports: (fileWithImports: FileWithImports) => Promise<Root>;
+export declare const resolveAllImports: (fileWithImports: FileWithImports, snippetPatterns?: string[]) => Promise<Root>;

package/dist/local-preview/listener/resolveAllImports.js

@@ -1,9 +1,10 @@
 import { resolveAllImports as baseResolveAllImports } from '@mintlify/common';
 import { getProcessedSnippets } from './getSnippets.js';
-export const resolveAllImports = async (fileWithImports) => {
-    const snippets = await getProcessedSnippets();
+export const resolveAllImports = async (fileWithImports, snippetPatterns) => {
+    const snippets = await getProcessedSnippets(snippetPatterns);
     return await baseResolveAllImports({
         snippets,
         fileWithImports,
+        snippetPatterns,
     });
 };