@mintlify/link-rot 3.0.1442 → 3.0.1444

package/dist/graph.d.ts

@@ -8,7 +8,8 @@ export declare enum Wrapper {
     MD = "md",// ![]()
     SRC = "src",// <img src="" />
     HREF = "href",// <a href="" />
-    CARD = "card"
+    CARD = "card",// <Card to="" />
+    IMPORT = "import"
 }
 export declare enum EdgeType {
     CONTENT = "content",
@@ -26,6 +27,7 @@ export declare class MdxPath {
     pathType: PathType;
     anchorLink?: string;
     queryParams?: URLSearchParams;
+    pagePaths: MdxPath[];
     static getPathType(url: string): PathType;
     /**
      * Generate all the computed fields in an MdxPath

package/dist/graph.js

@@ -26,6 +26,7 @@ export var Wrapper;
     Wrapper["SRC"] = "src";
     Wrapper["HREF"] = "href";
     Wrapper["CARD"] = "card";
+    Wrapper["IMPORT"] = "import";
 })(Wrapper || (Wrapper = {}));
 export var EdgeType;
 (function (EdgeType) {
@@ -105,6 +106,7 @@ export class MdxPath {
         this.relativeDir = relativeDir;
         this.filename = filename;
         this.wrapper = wrapper;
+        this.pagePaths = [];
         this.relativeDir = normalizePath(relativeDir);
         const { path, pathType, anchorLink, queryParams } = this.constructParsedPath();
         this.path = path;
@@ -368,6 +370,7 @@ export class Graph {
         // Build resolution map for all internal paths
         Object.values(this.nodes).forEach((node) => {
             node.paths
+                .flatMap((path) => [path, ...path.pagePaths])
                 .filter((path) => path.pathType === PathType.INTERNAL)
                 .forEach((path) => {
                 const pathKey = path.toString();
@@ -403,11 +406,11 @@ export class Graph {
         if (this.fileResolutionMap.size === 0) {
             this.precomputeFileResolutions();
         }
-        const brokenLinks = [];
+        const brokenLinks = new Set();
         const nodeSet = new Set(Object.values(this.nodes).map((node) => node.toString()));
         const wildcardRedirects = [...this.redirectMap].filter(([source]) => /[:*]/.test(source));
         for (const node of Object.values(this.nodes)) {
-            for (const path of node.paths) {
+            for (const path of node.paths.flatMap((path) => [path, ...path.pagePaths])) {
                 if (path.pathType === PathType.INTERNAL) {
                     const pathString = path.toString();
                     const resolvedFiles = this.fileResolutionMap.get(pathString);
@@ -428,19 +431,23 @@ export class Graph {
                         }
                     }
                     if (!hasExistingFile && !hasValidRedirect) {
-                        brokenLinks.push(path);
+                        brokenLinks.add(path);
                     }
                     else if ((options === null || options === void 0 ? void 0 : options.checkAnchors) && path.anchorLink) {
                         const anchor = safeCleanHeadingId(path.anchorLink.slice(1));
                         const headingSlugs = this.getHeadingSlugsForPath(pathString, nodeSet);
                         if (headingSlugs && !headingSlugs.has(anchor)) {
-                            brokenLinks.push(path);
+                            brokenLinks.add(path);
                         }
                     }
                 }
             }
         }
-        return brokenLinks;
+        return Object.values(this.nodes)
+            .flatMap((node) => node.paths)
+            .filter((path) => brokenLinks.has(path) &&
+            (path.pagePaths.length === 0 ||
+                path.pagePaths.some((pagePath) => brokenLinks.has(pagePath))));
     }
     getBrokenRedirects() {
         const nodeSet = new Set(Object.values(this.nodes).map((node) => node.toString()));

package/dist/static-checking/getBrokenInternalLinks.d.ts

@@ -1,11 +1,12 @@
 import type { TableOfContentsSectionType } from '@mintlify/common';
 import type { Root } from 'mdast';
 import { Graph, Node } from '../graph.js';
+import { type SnippetReferences } from './getSnippetReferences.js';
 export declare const flattenTableOfContentsSlugs: (sections: TableOfContentsSectionType[]) => Set<string>;
 export declare const extractComponentAnchorIds: (tree: Root) => Set<string>;
 export declare const decorateGraphNodeFromPageContent: (graphNode: Node, content: string, options?: {
     checkSnippets?: boolean;
-}) => Promise<void>;
+}) => Promise<SnippetReferences>;
 export declare const buildGraph: (repoPath?: string, options?: {
     checkSnippets?: boolean;
     /** SSRF-safe fetch override for hosted spec and overlay URLs; supplied by server environments. */

package/dist/static-checking/getBrokenInternalLinks.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { cleanHeadingId, COMPONENTS_WITH_CLEANED_ID, COMPONENTS_WITHOUT_ID, coreRemark, extractImportSources, generateParamFieldId, isMintIgnored, preprocessCustomHeadingIds, remarkComponentIds, remarkExtractTableOfContents, } from '@mintlify/common';
+import { cleanHeadingId, COMPONENTS_WITH_CLEANED_ID, COMPONENTS_WITHOUT_ID, coreRemark, generateParamFieldId, isMintIgnored, preprocessCustomHeadingIds, remarkComponentIds, remarkExtractTableOfContents, } from '@mintlify/common';
 import { getMintIgnore } from '@mintlify/prebuild';
 import fs from 'fs-extra';
 import path from 'path';
@@ -18,6 +18,8 @@ import { getLinkPaths, getPagePaths } from '../prebuild.js';
 import { getNavigationHrefs } from './getNavigationHrefs.js';
 import { getOpenApiPagePaths } from './getOpenApiPagePaths.js';
 import { getRedirects } from './getRedirects.js';
+import { getSnippetReferences } from './getSnippetReferences.js';
+import { resolveSnippetLinksFromRenderingPages } from './resolveSnippetLinksFromRenderingPages.js';
 export const flattenTableOfContentsSlugs = (sections) => {
     const slugs = new Set();
     for (const section of sections) {
@@ -61,11 +63,6 @@ export const decorateGraphNodeFromPageContent = (graphNode, content, options) =>
     const mdxExtracts = {};
     const visitLinks = () => {
         return (tree) => {
-            if (options === null || options === void 0 ? void 0 : options.checkSnippets) {
-                for (const source of extractImportSources(tree)) {
-                    graphNode.addPath(source);
-                }
-            }
             visit(tree, (node) => {
                 var _a, _b;
                 if (node.type === 'link' || node.type === 'image') {
@@ -100,12 +97,19 @@ export const decorateGraphNodeFromPageContent = (graphNode, content, options) =>
         .use(remarkComponentIds)
         .use(remarkExtractTableOfContents, mdxExtracts);
     const tree = processor.parse(preprocessed);
+    const snippetReferences = getSnippetReferences(tree);
+    if (options === null || options === void 0 ? void 0 : options.checkSnippets) {
+        for (const source of snippetReferences.imported) {
+            graphNode.addPath(source, Wrapper.IMPORT);
+        }
+    }
     yield processor.run(tree);
     const tocSlugs = mdxExtracts.tableOfContents
         ? flattenTableOfContentsSlugs(mdxExtracts.tableOfContents)
         : new Set();
     const componentIds = extractComponentAnchorIds(tree);
     graphNode.headingSlugs = new Set([...tocSlugs, ...componentIds]);
+    return snippetReferences;
 });
 export const buildGraph = (repoPath, options) => __awaiter(void 0, void 0, void 0, function* () {
     const baseDir = repoPath ? repoPath : process.cwd();
@@ -136,6 +140,7 @@ export const buildGraph = (repoPath, options) => __awaiter(void 0, void 0, void
     }
     const allSitePages = getPagePaths(baseDir, mintIgnoreGlobs);
     const sitePages = allSitePages.filter((file) => !isMintIgnored(file, mintIgnoreGlobs));
+    const snippetReferencesByFile = new Map();
     const BUILD_GRAPH_CONCURRENCY = 8;
     let cursor = 0;
     const processNext = () => __awaiter(void 0, void 0, void 0, function* () {
@@ -148,9 +153,10 @@ export const buildGraph = (repoPath, options) => __awaiter(void 0, void 0, void
                 continue;
             const fileContent = fs.readFileSync(path.join(baseDir, filePath)).toString();
             try {
-                yield decorateGraphNodeFromPageContent(fileNode, fileContent, {
+                const snippetReferences = yield decorateGraphNodeFromPageContent(fileNode, fileContent, {
                     checkSnippets: options === null || options === void 0 ? void 0 : options.checkSnippets,
                 });
+                snippetReferencesByFile.set(filePath, snippetReferences);
             }
             catch (err) {
                 throw new Error(`Syntax error - Unable to parse ${filePath} - ${err}`);
@@ -158,6 +164,7 @@ export const buildGraph = (repoPath, options) => __awaiter(void 0, void 0, void
         }
     });
     yield Promise.all(Array.from({ length: Math.min(BUILD_GRAPH_CONCURRENCY, sitePages.length) }, processNext));
+    resolveSnippetLinksFromRenderingPages(graph, snippetReferencesByFile);
     return graph;
 });
 export const getBrokenInternalLinks = (repoPath, options) => __awaiter(void 0, void 0, void 0, function* () {

package/dist/static-checking/getSnippetReferences.d.ts

@@ -0,0 +1,6 @@
+import type { Root } from 'mdast';
+export type SnippetReferences = {
+    imported: string[];
+    rendered: string[];
+};
+export declare const getSnippetReferences: (tree: Root) => SnippetReferences;

package/dist/static-checking/getSnippetReferences.js

@@ -0,0 +1,42 @@
+import { estreeIsProgram, isImportDeclaration, isMdxJsEsm, isMdxJsxFlowElement, } from '@mintlify/common';
+import { visit } from 'unist-util-visit';
+import { removeLeadingSlash } from '../prebuild.js';
+const CONTENT_SPECIFIERS = ['ImportDefaultSpecifier', 'ImportNamespaceSpecifier'];
+const LEGACY_SNIPPET_COMPONENT = 'Snippet';
+const LEGACY_SNIPPET_DIRECTORY = '/_snippets/';
+export const getSnippetReferences = (tree) => {
+    const imported = [];
+    const rendered = [];
+    const contentImports = [];
+    const componentNames = new Set();
+    visit(tree, (node) => {
+        var _a;
+        if (isMdxJsEsm(node) && estreeIsProgram(node)) {
+            for (const bodyChild of node.data.estree.body) {
+                if (!isImportDeclaration(bodyChild) || typeof bodyChild.source.value !== 'string')
+                    continue;
+                const source = bodyChild.source.value;
+                imported.push(source);
+                for (const specifier of bodyChild.specifiers) {
+                    if (CONTENT_SPECIFIERS.includes(specifier.type)) {
+                        contentImports.push({ source, name: specifier.local.name });
+                    }
+                }
+            }
+            return;
+        }
+        if (!isMdxJsxFlowElement(node) || !node.name)
+            return;
+        componentNames.add(node.name);
+        if (node.name !== LEGACY_SNIPPET_COMPONENT)
+            return;
+        const file = (_a = node.attributes.find((attribute) => attribute.type === 'mdxJsxAttribute' && attribute.name === 'file')) === null || _a === void 0 ? void 0 : _a.value;
+        if (typeof file === 'string')
+            rendered.push(LEGACY_SNIPPET_DIRECTORY + removeLeadingSlash(file));
+    });
+    for (const { source, name } of contentImports) {
+        if (componentNames.has(name))
+            rendered.push(source);
+    }
+    return { imported, rendered };
+};

package/dist/static-checking/resolveSnippetLinksFromRenderingPages.d.ts

@@ -0,0 +1,3 @@
+import { Graph } from '../graph.js';
+import type { SnippetReferences } from './getSnippetReferences.js';
+export declare const resolveSnippetLinksFromRenderingPages: (graph: Graph, snippetReferencesByFile: Map<string, SnippetReferences>) => void;

package/dist/static-checking/resolveSnippetLinksFromRenderingPages.js

@@ -0,0 +1,55 @@
+import { resolveImportPath } from '@mintlify/common';
+import { sep as WINDOWS_SEPARATOR } from 'path/win32';
+import { MdxPath, Wrapper } from '../graph.js';
+import { removeLeadingSlash } from '../prebuild.js';
+const SNIPPET_DIRECTORIES = ['snippets/', '_snippets/'];
+const toKey = (file) => file.replaceAll(WINDOWS_SEPARATOR, '/');
+const isPageRelativeLink = ({ originalPath, wrapper }) => wrapper !== Wrapper.IMPORT && (originalPath.startsWith('.') || originalPath.startsWith('#'));
+export const resolveSnippetLinksFromRenderingPages = (graph, snippetReferencesByFile) => {
+    var _a, _b, _c;
+    const fileByKey = new Map([...snippetReferencesByFile.keys()].map((file) => [toKey(file), file]));
+    const resolveFiles = (sources, importingFile) => sources.flatMap((source) => {
+        const resolved = resolveImportPath(source, toKey(importingFile));
+        const file = resolved && fileByKey.get(removeLeadingSlash(resolved));
+        return file ? [file] : [];
+    });
+    const snippets = new Set();
+    for (const [file, { imported }] of snippetReferencesByFile) {
+        const key = toKey(file).toLowerCase();
+        if (SNIPPET_DIRECTORIES.some((directory) => key.startsWith(directory)))
+            snippets.add(file);
+        for (const importedFile of resolveFiles(imported, file))
+            snippets.add(importedFile);
+    }
+    const collectRenderedSnippets = (file, collected) => {
+        var _a, _b;
+        const rendered = (_b = (_a = snippetReferencesByFile.get(file)) === null || _a === void 0 ? void 0 : _a.rendered) !== null && _b !== void 0 ? _b : [];
+        for (const snippet of resolveFiles(rendered, file)) {
+            if (collected.has(snippet) || !snippets.has(snippet))
+                continue;
+            collected.add(snippet);
+            collectRenderedSnippets(snippet, collected);
+        }
+        return collected;
+    };
+    const renderedSnippetsByPage = new Map();
+    for (const file of snippetReferencesByFile.keys()) {
+        if (!snippets.has(file)) {
+            renderedSnippetsByPage.set(file, collectRenderedSnippets(file, new Set()));
+        }
+    }
+    for (const [page, renderedSnippets] of renderedSnippetsByPage) {
+        const pageNode = graph.getNode(page);
+        if (!pageNode)
+            continue;
+        for (const snippet of renderedSnippets) {
+            const snippetNode = graph.getNode(snippet);
+            for (const link of (_a = snippetNode === null || snippetNode === void 0 ? void 0 : snippetNode.paths.filter(isPageRelativeLink)) !== null && _a !== void 0 ? _a : []) {
+                link.pagePaths.push(new MdxPath(link.originalPath, pageNode.relativeDir, pageNode.filename, link.wrapper));
+            }
+            for (const slug of (_b = snippetNode === null || snippetNode === void 0 ? void 0 : snippetNode.headingSlugs) !== null && _b !== void 0 ? _b : []) {
+                (_c = pageNode.headingSlugs) === null || _c === void 0 ? void 0 : _c.add(slug);
+            }
+        }
+    }
+};