@mintlify/common 1.0.1308 → 1.0.1310

package/dist/mdx/builtInComponents.d.ts

@@ -0,0 +1,2 @@
+export declare const BUILD_RENAMED_COMPONENTS: readonly string[];
+export declare const isBuiltInComponent: (name: string) => boolean;

package/dist/mdx/builtInComponents.js

@@ -0,0 +1,3 @@
+import { allowedComponents } from './utils.js';
+export const BUILD_RENAMED_COMPONENTS = ['Example', 'Snippet'];
+export const isBuiltInComponent = (name) => allowedComponents.includes(name) || BUILD_RENAMED_COMPONENTS.includes(name);

package/dist/mdx/builtInComponents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/mdx/builtInComponents.test.js

@@ -0,0 +1,20 @@
+import { BUILD_RENAMED_COMPONENTS, isBuiltInComponent } from './builtInComponents.js';
+import { remarkFrames } from './plugins/remark/remarkFrames.js';
+import { coreRemark } from './remark.js';
+import { allowedComponents } from './utils.js';
+describe('isBuiltInComponent', () => {
+    it('accepts every component remarkMdxRemoveUnknownJsx keeps', () => {
+        expect(allowedComponents.filter((name) => !isBuiltInComponent(name))).toEqual([]);
+        expect(isBuiltInComponent('Color.Row')).toBe(true);
+        expect(isBuiltInComponent('Color.Nope')).toBe(false);
+        expect(isBuiltInComponent('Missing')).toBe(false);
+    });
+    it('accepts tags the build rewrites before removing unknown JSX', () => {
+        const tree = coreRemark().parse('<Example>\n  x\n</Example>\n');
+        remarkFrames()(tree);
+        const [node] = tree.children;
+        expect(BUILD_RENAMED_COMPONENTS).toEqual(['Example', 'Snippet']);
+        expect((node === null || node === void 0 ? void 0 : node.name) && allowedComponents.includes(node.name)).toBe(true);
+        expect(BUILD_RENAMED_COMPONENTS.every(isBuiltInComponent)).toBe(true);
+    });
+});

package/dist/mdx/index.d.ts

@@ -15,4 +15,6 @@ export * from './getCodeStyling.js';
 export * from './getCodeRanges.js';
 export * from './replaceVariables.js';
 export * from './componentIds.js';
+export * from './builtInComponents.js';
+export { collectPatternNames, visitReferences } from './estreeReferences.js';
 export * from './islands/index.js';

package/dist/mdx/index.js

@@ -15,4 +15,6 @@ export * from './getCodeStyling.js';
 export * from './getCodeRanges.js';
 export * from './replaceVariables.js';
 export * from './componentIds.js';
+export * from './builtInComponents.js';
+export { collectPatternNames, visitReferences } from './estreeReferences.js';
 export * from './islands/index.js';

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

@@ -5,6 +5,7 @@ import { type PackageImportOptions } from '../islands/packageImports.js';
 export type ResolveImportsWarning = {
     type: 'invalid-import-path' | 'missing-file' | 'import-resolution-error' | 'default-import-no-default-export' | 'export-collision' | 'undeclared-package' | 'package-import-conflict';
     message: string;
+    file?: string;
 };
 export declare const resolveAllImports: (params: {
     snippets: (FileType & {

package/dist/mdx/snippets/resolveAllImports.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { jsx, toJs } from 'estree-util-to-js';
 import { remove } from 'unist-util-remove';
 import { visit } from 'unist-util-visit';
+import { normalizeRelativePath } from '../../fs/normalizeRelativePath.js';
 import { MdxImportSpecifier } from '../../types/mdx/snippets/import.js';
 import { createImportNode, isDeclaredPackageImport, isNonHostBareImport, mergeImports, } from '../islands/packageImports.js';
 import { estreeIsProgram, isImportDeclaration, isMdxJsEsm } from '../utils.js';
@@ -109,6 +110,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
     var _a;
     var _b, _c, _d, _e;
     const { snippets, fileWithImports, onWarning, packages } = params;
+    const file = normalizeRelativePath(fileWithImports.filename);
     let ast = fileWithImports.tree;
     const kept = packages && /\.mdx?$/.test(fileWithImports.filename)
         ? takePackageReExports(ast, packages.packageNames)
@@ -125,7 +127,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
             }
             const message = `Package ${(_c = getSpecifierPackageName(source)) !== null && _c !== void 0 ? _c : source} imported in ${fileWithImports.filename} is not declared in package.json dependencies.`;
             if (onWarning) {
-                onWarning({ type: 'undeclared-package', message });
+                onWarning({ type: 'undeclared-package', message, file });
             }
             else {
                 console.log(message);
@@ -139,7 +141,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
         if (resolvedPath == null) {
             const message = `Invalid import path ${source} in ${fileWithImports.filename}. Only local imports are supported.`;
             if (onWarning) {
-                onWarning({ type: 'invalid-import-path', message });
+                onWarning({ type: 'invalid-import-path', message, file });
             }
             else {
                 console.log(message);
@@ -150,7 +152,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
         if (foundSnippet == undefined) {
             const message = `Could not find file ${resolvedPath} - imported from ${fileWithImports.filename}`;
             if (onWarning) {
-                onWarning({ type: 'missing-file', message });
+                onWarning({ type: 'missing-file', message, file });
             }
             else {
                 console.log(message);
@@ -178,7 +180,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
                 importedSnippet.tree.children.every((node) => node.type === 'yaml' || node.type === 'mdxjsEsm')) {
                 const message = `Default import "${specifier.name}" in ${fileWithImports.filename} will not render — ${resolvedPath} has no default export. Use a named import instead: import { ExportName } from '${source}'`;
                 if (onWarning) {
-                    onWarning({ type: 'default-import-no-default-export', message });
+                    onWarning({ type: 'default-import-no-default-export', message, file });
                 }
                 else {
                     console.log(message);
@@ -187,7 +189,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
             try {
                 const contentWithResolvedImport = yield resolveImport(specifier, ast, importedSnippet.tree, exportMap, (warning) => {
                     // the collision itself doesn't know which page it happened in, so add it here
-                    const located = Object.assign(Object.assign({}, warning), { message: `${warning.message} (in ${fileWithImports.filename}, importing ${resolvedPath})` });
+                    const located = Object.assign(Object.assign({}, warning), { message: `${warning.message} (in ${fileWithImports.filename}, importing ${resolvedPath})`, file });
                     if (onWarning) {
                         onWarning(located);
                     }
@@ -203,7 +205,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
             catch (err) {
                 const message = `Error resolving import "${specifier.name}" in ${fileWithImports.filename}: ${err instanceof Error ? err.message : String(err)}`;
                 if (onWarning) {
-                    onWarning({ type: 'import-resolution-error', message });
+                    onWarning({ type: 'import-resolution-error', message, file });
                 }
                 else {
                     console.log(message);
@@ -221,7 +223,7 @@ export const resolveAllImports = (params) => __awaiter(void 0, void 0, void 0, f
     for (const { local, first, second } of conflicts) {
         const message = `${local} is imported twice in ${fileWithImports.filename}, as ${first} and as ${second}. Snippets inlined into a page share its imports, so import one of them under another name.`;
         if (onWarning) {
-            onWarning({ type: 'package-import-conflict', message });
+            onWarning({ type: 'package-import-conflict', message, file });
         }
         else {
             console.log(message);

package/dist/mdx/snippets/resolveImport/index.d.ts

@@ -4,6 +4,7 @@ import { collectContextFromTree } from '../../plugins/remark/staticEvaluator.js'
 import { type OnExportCollision } from './exportCollision.js';
 export { type ExportCollisionWarning, type OnExportCollision } from './exportCollision.js';
 export { findExport } from './findExport.js';
+export { collectExportedNames } from './snippetDeclarations.js';
 export { injectToTopOfFileOfTree } from './injectToTopOfFile.js';
 /** What one page's imports have resolved so far. Pass the same state for every import of a page. */
 export interface ImportResolutionState {

package/dist/mdx/snippets/resolveImport/index.js

@@ -17,6 +17,7 @@ import { injectToTopOfFileOfTree } from './injectToTopOfFile.js';
 import { resolveComponentWithContent } from './resolveComponentWithContent.js';
 import { collectExportedNames, collectTopLevelBindingNames, declarationSource, exportedBindingName, injectBelowEagerDependencies, isolateExportedDeclarator, patternSiblingNames, prepareSnippetSiblings, } from './snippetDeclarations.js';
 export { findExport } from './findExport.js';
+export { collectExportedNames } from './snippetDeclarations.js';
 export { injectToTopOfFileOfTree } from './injectToTopOfFile.js';
 const VALID_SPECIFIERS = [
     MdxImportSpecifier.ImportSpecifier,