@mintlify/common 1.0.638 → 1.0.640

package/dist/getFileCategory.d.ts

@@ -17,4 +17,4 @@ export declare function isGatedFormat(params: {
     filePath?: undefined;
     ext: string;
 }): boolean;
-export declare const getFileCategory: (filePath: string) => PotentialFileCategory;
+export declare const getFileCategory: (filePath: string, snippetPatterns?: string[]) => PotentialFileCategory;

package/dist/getFileCategory.js

@@ -1,5 +1,6 @@
 import { parse } from 'path';
 import { SNIPPET_EXTENSIONS } from './mdx/snippets/constants.js';
+import { isSnippetPath } from './snippetPatterns.js';
 const excludedMdFiles = ['readme', 'license', 'contributing', 'contribute'];
 export const generatedStaticFiles = [
     'llms.txt',
@@ -73,7 +74,7 @@ export function isGatedFormat({ filePath, ext }) {
     ext = ext.startsWith('.') ? ext : `.${ext}`;
     return gatedStaticAssetExtensions.includes(ext.toLowerCase());
 }
-export const getFileCategory = (filePath) => {
+export const getFileCategory = (filePath, snippetPatterns) => {
     filePath = filePath.toLowerCase();
     const parsed = parse(filePath);
     if (parsed.base === 'mint.json') {
@@ -90,16 +91,16 @@ export const getFileCategory = (filePath) => {
     if (generatedStaticFiles.includes(parsed.base)) {
         return 'generatedStaticFile';
     }
-    if ((filePath.startsWith('_snippets/') || filePath.startsWith('snippets/')) &&
-        (SNIPPET_EXTENSIONS.some((ext) => extension === ext) || extension === '.md')) {
+    const hasSnippetExtension = SNIPPET_EXTENSIONS.some((ext) => extension === ext) || extension === '.md';
+    if (hasSnippetExtension) {
         if (filePath.startsWith('_snippets/')) {
             return 'snippet';
         }
-        else if (filePath.startsWith('snippets/')) {
+        if (isSnippetPath(filePath, snippetPatterns)) {
             return 'snippet-v2';
         }
     }
-    else if (extension === '.mdx') {
+    if (extension === '.mdx') {
         return 'page';
     }
     else if (extension === '.md') {

package/dist/index.d.ts

@@ -27,3 +27,4 @@ export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
 export * from './mintIgnore.js';
 export * from './getDisplayDomain.js';
+export * from './snippetPatterns.js';

package/dist/index.js

@@ -27,3 +27,4 @@ export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
 export * from './mintIgnore.js';
 export * from './getDisplayDomain.js';
+export * from './snippetPatterns.js';

package/dist/mdx/snippets/resolveAllImports.d.ts

@@ -3,4 +3,5 @@ import type { FileType, FileWithImports } from '../../types/mdx/index.js';
 export declare const resolveAllImports: (params: {
     snippets: FileType[];
     fileWithImports: FileWithImports;
+    snippetPatterns?: string[];
 }) => Promise<Root>;

package/dist/mdx/snippets/resolveAllImports.js

@@ -11,13 +11,13 @@ import { getExportMapFromTree } from './getExportMap.js';
 import { resolveImport } from './resolveImport/index.js';
 import { resolveSnippetImportPath } from './resolveSnippetImportPath.js';
 export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, function* () {
-    const { snippets, fileWithImports } = params;
+    const { snippets, fileWithImports, snippetPatterns } = params;
     let ast = fileWithImports.tree;
     const exportMap = getExportMapFromTree(ast);
     for (const source of Object.keys(fileWithImports.importMap)) {
-        const resolvedPath = resolveSnippetImportPath(source, fileWithImports.filename);
+        const resolvedPath = resolveSnippetImportPath(source, fileWithImports.filename, snippetPatterns);
         if (resolvedPath == null) {
-            console.log(`Invalid import path ${source} in ${fileWithImports.filename}. Import must resolve to a file in /snippets/.`);
+            console.log(`Invalid import path ${source} in ${fileWithImports.filename}. Import must resolve to a valid snippet location.`);
             continue;
         }
         const importedSnippet = snippets.find((snippet) => snippet.filename === resolvedPath);

package/dist/mdx/snippets/resolveSnippetImportPath.d.ts

@@ -1,9 +1,10 @@
 /**
  * Resolves an import path to an absolute path with leading slash.
- * Only allows imports that resolve to files in /snippets/.
+ * Only allows imports that resolve to files in valid snippet locations.
  *
  * @param source The import source path (e.g., '/snippets/foo.mdx' or '../snippets/bar.mdx')
  * @param importingFilePath The path of the file containing the import
+ * @param snippetPatterns Optional custom snippet patterns from docs.json config
  * @returns The resolved absolute path with leading slash, or null if invalid or not in snippets folder
  */
-export declare const resolveSnippetImportPath: (source: string, importingFilePath: string) => string | null;
+export declare const resolveSnippetImportPath: (source: string, importingFilePath: string, snippetPatterns?: string[]) => string | null;

package/dist/mdx/snippets/resolveSnippetImportPath.js

@@ -1,19 +1,18 @@
 import { posix } from 'path';
+import { isSnippetPath } from '../../snippetPatterns.js';
 const isRelativeImport = (source) => {
     return source.startsWith('./') || source.startsWith('../');
 };
-const isInSnippetsFolder = (resolvedPath) => {
-    return resolvedPath.startsWith('/snippets/');
-};
 /**
  * Resolves an import path to an absolute path with leading slash.
- * Only allows imports that resolve to files in /snippets/.
+ * Only allows imports that resolve to files in valid snippet locations.
  *
  * @param source The import source path (e.g., '/snippets/foo.mdx' or '../snippets/bar.mdx')
  * @param importingFilePath The path of the file containing the import
+ * @param snippetPatterns Optional custom snippet patterns from docs.json config
  * @returns The resolved absolute path with leading slash, or null if invalid or not in snippets folder
  */
-export const resolveSnippetImportPath = (source, importingFilePath) => {
+export const resolveSnippetImportPath = (source, importingFilePath, snippetPatterns) => {
     let resolvedPath;
     if (source.startsWith('/')) {
         resolvedPath = posix.normalize(source);
@@ -25,7 +24,7 @@ export const resolveSnippetImportPath = (source, importingFilePath) => {
     else {
         return null;
     }
-    if (!isInSnippetsFolder(resolvedPath)) {
+    if (!isSnippetPath(resolvedPath, snippetPatterns)) {
         return null;
     }
     return resolvedPath;

package/dist/snippetPatterns.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Default snippet patterns that are always included. Always includes the /snippets/ pattern.
+ */
+export declare const DEFAULT_SNIPPET_PATTERNS: string[];
+/**
+ * Checks if a file path matches the snippet patterns.
+ * Always includes the default /snippets/ pattern in addition to any custom patterns.
+ *
+ * @param filePath The path of the file to check (with or without leading slash)
+ * @param customPatterns Optional array of custom glob patterns from docs.json
+ * @returns True if the file matches any of the snippet patterns
+ */
+export declare function isSnippetPath(filePath: string, customPatterns?: string[]): boolean;

package/dist/snippetPatterns.js

@@ -0,0 +1,18 @@
+import { minimatch } from 'minimatch';
+/**
+ * Default snippet patterns that are always included. Always includes the /snippets/ pattern.
+ */
+export const DEFAULT_SNIPPET_PATTERNS = ['snippets/**'];
+/**
+ * Checks if a file path matches the snippet patterns.
+ * Always includes the default /snippets/ pattern in addition to any custom patterns.
+ *
+ * @param filePath The path of the file to check (with or without leading slash)
+ * @param customPatterns Optional array of custom glob patterns from docs.json
+ * @returns True if the file matches any of the snippet patterns
+ */
+export function isSnippetPath(filePath, customPatterns) {
+    const normalizedPath = filePath.startsWith('/') ? filePath.slice(1) : filePath;
+    const allPatterns = [...DEFAULT_SNIPPET_PATTERNS, ...(customPatterns !== null && customPatterns !== void 0 ? customPatterns : [])];
+    return allPatterns.some((pattern) => minimatch(normalizedPath, pattern, { nocase: true }));
+}