fumadocs-core 16.5.3 → 16.6.0

package/dist/mdx-plugins/remark-structure.js

@@ -1,8 +1,8 @@
-import { n as toMdxExport, t as flattenNode } from "../mdast-utils-gJMY143g.js";
+import { n as toMdxExport } from "../mdast-utils-gJMY143g.js";
 import { remarkHeading } from "./remark-heading.js";
 import { remark } from "remark";
-import remarkGfm from "remark-gfm";
 import { visit } from "unist-util-visit";
+import remarkGfm from "remark-gfm";
 import { toMarkdown } from "mdast-util-to-markdown";
 
 //#region src/mdx-plugins/remark-structure.ts
@@ -14,12 +14,8 @@ const remarkStructureDefaultOptions = {
 		"tableCell",
 		"mdxJsxFlowElement"
 	],
-	allowedMdxAttributes(node) {
-		switch (node.name) {
-			case "TypeTable":
-			case "Callout": return true;
-			default: return false;
-		}
+	mdxTypes(node) {
+		return node.children.length === 0;
 	},
 	exportAs: false
 };
@@ -28,16 +24,15 @@ const remarkStructureDefaultOptions = {
 *
 * By default, the output is stored into VFile (`vfile.data.structuredData`), you can specify `exportAs` to export it.
 */
-function remarkStructure({ types = remarkStructureDefaultOptions.types, stringify, allowedMdxAttributes = remarkStructureDefaultOptions.allowedMdxAttributes, exportAs = remarkStructureDefaultOptions.exportAs } = {}) {
-	if (Array.isArray(allowedMdxAttributes)) {
-		const arr = allowedMdxAttributes;
-		allowedMdxAttributes = (_node, attribute) => attribute.type === "mdxJsxAttribute" && arr.includes(attribute.name);
-	}
+function remarkStructure({ types = remarkStructureDefaultOptions.types, mdxTypes = remarkStructureDefaultOptions.mdxTypes, stringify: stringifyOptions, allowedMdxAttributes, exportAs = remarkStructureDefaultOptions.exportAs } = {}) {
 	if (Array.isArray(types)) {
 		const arr = types;
 		types = (node) => arr.includes(node.type);
 	}
-	stringify ??= defaultStringify({ filterMdxAttributes: allowedMdxAttributes });
+	const stringify = typeof stringifyOptions === "function" ? stringifyOptions : defaultStringifier({
+		filterMdxAttributes: Array.isArray(allowedMdxAttributes) ? (_node, attribute) => attribute.type === "mdxJsxAttribute" && allowedMdxAttributes.includes(attribute.name) : allowedMdxAttributes,
+		...stringifyOptions
+	});
 	return (tree, file) => {
 		const data = {
 			contents: [],
@@ -51,31 +46,38 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, stringif
 				data.contents.push(...frontmatter._openapi.structuredData.contents);
 			}
 		}
+		const stringifierCtx = { addContent(...content) {
+			for (const item of content) data.contents.push({
+				...item,
+				heading: item.heading ?? lastHeading
+			});
+		} };
 		visit(tree, (element) => {
-			if (element.type === "root" || !types(element)) return;
-			if (element.type === "heading") {
-				element.data ||= {};
-				element.data.hProperties ||= {};
-				const id = element.data.hProperties.id;
-				if (typeof id !== "string") {
-					console.warn("[remark-structure] hProperties.id is missing in heading node, it is required to generate heading data. You can add remark-heading prior to remark-structure to generate heading IDs.");
+			if (!types(element)) return;
+			switch (element.type) {
+				case "root": return;
+				case "mdxJsxFlowElement":
+				case "mdxJsxTextElement":
+					if (!mdxTypes(element)) return;
+					break;
+				case "heading": {
+					element.data ||= {};
+					element.data.hProperties ||= {};
+					const id = element.data.hProperties.id;
+					if (typeof id !== "string") {
+						console.warn("[remark-structure] hProperties.id is missing in heading node, it is required to generate heading data. You can add remark-heading prior to remark-structure to generate heading IDs.");
+						return "skip";
+					}
+					const content = stringify.call(this, element, stringifierCtx).trim();
+					if (content.length > 0) data.headings.push({
+						id,
+						content
+					});
+					lastHeading = id;
 					return "skip";
 				}
-				data.headings.push({
-					id,
-					content: flattenNode(element).trim()
-				});
-				lastHeading = id;
-				return "skip";
-			}
-			if (element.data?._string) {
-				for (const content of element.data._string) data.contents.push({
-					heading: lastHeading,
-					content
-				});
-				return "skip";
 			}
-			const content = stringify.call(this, element).trim();
+			const content = stringify.call(this, element, stringifierCtx).trim();
 			if (content.length > 0) data.contents.push({
 				heading: lastHeading,
 				content
@@ -92,37 +94,81 @@ function remarkStructure({ types = remarkStructureDefaultOptions.types, stringif
 function structure(content, remarkPlugins = [], options = {}) {
 	return remark().use(remarkGfm).use(remarkPlugins).use(remarkHeading).use(remarkStructure, options).processSync(content).data.structuredData;
 }
-function defaultStringify(config = {}) {
-	const { filterMdxAttributes } = config;
-	function modHandler(handler) {
-		return function(node, ...rest) {
-			if (node.data?._string) return node.data._string.join("\n");
+function defaultStringifier(config = {}) {
+	const { filterMdxAttributes, filterElement = (node) => {
+		switch (node.type) {
+			case "mdxJsxFlowElement":
+			case "mdxJsxTextElement":
+				switch (node.name) {
+					case "File":
+					case "TypeTable":
+					case "Callout":
+					case "Card": return true;
+				}
+				return "children-only";
+		}
+		return true;
+	} } = config;
+	function modHandler(handler, ctx) {
+		return function(node, parent, state, info) {
+			const { structuredData, _string } = node.data ?? {};
+			if (structuredData) ctx.addContent(...structuredData.contents);
+			if (_string) return typeof _string === "function" ? _string() : _string;
+			const visibility = filterElement(node);
+			if (visibility === false) return "";
 			switch (node.type) {
 				case "mdxJsxFlowElement":
-				case "mdxJsxTextElement": if (filterMdxAttributes) {
+				case "mdxJsxTextElement": {
+					if (visibility === "children-only") return node.type === "mdxJsxTextElement" ? state.containerPhrasing(node, info) : state.containerFlow(node, info);
+					const stringifiedAttributes = [];
+					for (const attr of node.attributes) {
+						if (attr.type === "mdxJsxExpressionAttribute") continue;
+						if (filterMdxAttributes && !filterMdxAttributes(node, attr)) continue;
+						const str = typeof attr.value === "string" ? attr.value : attr.value?.value;
+						if (!str) continue;
+						stringifiedAttributes.push({
+							...attr,
+							value: str
+						});
+					}
 					const temp = node.attributes;
-					node.attributes = node.attributes.filter((attr) => filterMdxAttributes(node, attr));
-					const s = handler(node, ...rest);
+					node.attributes = stringifiedAttributes;
+					const s = handler(node, parent, state, info);
 					node.attributes = temp;
 					return s;
 				}
-				default: return handler(node, ...rest);
+				default:
+					if (visibility === "children-only") return "children" in node ? state.containerFlow({
+						type: "root",
+						children: node.children
+					}, info) : "";
+					return handler(node, parent, state, info);
 			}
 		};
 	}
 	const handlers = {
-		...config.handlers,
+		link(node, _, state, info) {
+			return state.containerPhrasing(node, info);
+		},
+		heading(node, _, state, info) {
+			return state.containerPhrasing(node, info);
+		},
+		image() {
+			return "";
+		},
 		_custom(node, _, state, info) {
 			const handlers = state.handlers;
-			for (const k in handlers) handlers[k] = modHandler(handlers[k]);
+			for (const k in handlers) handlers[k] = modHandler(handlers[k], node.ctx);
 			return state.handle(node.root, void 0, state, info);
-		}
+		},
+		...config.handlers
 	};
-	return function(root) {
+	return function(root, ctx) {
 		const defaultExtensions = this.data("toMarkdownExtensions") ?? [];
 		return toMarkdown({
 			type: "_custom",
-			root
+			root,
+			ctx
 		}, {
 			...this.data("settings"),
 			...config,
@@ -133,4 +179,4 @@ function defaultStringify(config = {}) {
 }
 
 //#endregion
-export { defaultStringify, remarkStructure, remarkStructureDefaultOptions, structure };
+export { defaultStringifier, remarkStructure, remarkStructureDefaultOptions, structure };

package/dist/mixedbread-RiA_24CE.js

@@ -0,0 +1,58 @@
+import { r as __toESM } from "./chunk-CaR5F9JI.js";
+import { t as require_remove_markdown } from "./remove-markdown-CnXcUR-e.js";
+import Slugger from "github-slugger";
+
+//#region src/search/client/mixedbread.ts
+var import_remove_markdown = /* @__PURE__ */ __toESM(require_remove_markdown(), 1);
+const slugger = new Slugger();
+function extractHeadingTitle(text) {
+	const trimmedText = text.trim();
+	if (!trimmedText.startsWith("#")) return "";
+	const firstLine = trimmedText.split("\n")[0]?.trim();
+	if (firstLine) return (0, import_remove_markdown.default)(firstLine, { useImgAltText: false });
+	return "";
+}
+/**
+* @deprecated Use `createMixedbreadSearchAPI` from `fumadocs-core/search/mixedbread` instead.
+* This client-side approach exposes your API key in the browser.
+* The server-side approach keeps the key secure and uses `type: 'fetch'` on the client.
+*/
+async function search(query, options) {
+	const { client, storeIdentifier, tag } = options;
+	if (!query.trim()) return [];
+	return (await client.stores.search({
+		query,
+		store_identifiers: [storeIdentifier],
+		top_k: 10,
+		filters: {
+			key: "generated_metadata.tag",
+			operator: "eq",
+			value: tag
+		},
+		search_options: { return_metadata: true }
+	})).data.flatMap((item) => {
+		const metadata = item.generated_metadata;
+		const url = metadata.url || "#";
+		const title = metadata.title || "Untitled";
+		const chunkResults = [{
+			id: `${item.file_id}-${item.chunk_index}-page`,
+			type: "page",
+			content: title,
+			url
+		}];
+		const headingTitle = item.type === "text" ? extractHeadingTitle(item.text) : "";
+		if (headingTitle) {
+			slugger.reset();
+			chunkResults.push({
+				id: `${item.file_id}-${item.chunk_index}-heading`,
+				type: "heading",
+				content: headingTitle,
+				url: `${url}#${slugger.slug(headingTitle)}`
+			});
+		}
+		return chunkResults;
+	});
+}
+
+//#endregion
+export { search };

package/dist/{orama-cloud-ByznDyOk.js → orama-cloud-cgTJNLo0.js}

@@ -1,5 +1,5 @@
 import { createContentHighlighter } from "./search/index.js";
-import { t as removeUndefined } from "./remove-undefined-CJm9cyrC.js";
+import { t as removeUndefined } from "./remove-undefined-B_oBVupY.js";
 
 //#region src/search/client/orama-cloud.ts
 async function searchDocs(query, options) {
@@ -23,23 +23,22 @@ async function searchDocs(query, options) {
 			list.push({
 				id: hit.id,
 				type: "page",
-				content: doc.title,
-				contentWithHighlights: highlighter.highlight(doc.title),
+				content: highlighter.highlightMarkdown(doc.title),
 				url: doc.path
 			}, {
 				id: "page" + hit.id,
 				type: "text",
-				content: doc.content,
-				contentWithHighlights: highlighter.highlight(doc.content),
+				content: highlighter.highlightMarkdown(doc.content),
 				url: doc.path
 			});
 		}
 		return list;
 	}
-	const params = {
+	const result = await client.search({
 		datasources: [],
 		...extraParams,
 		term: query,
+		limit: 10,
 		where: removeUndefined({
 			tag,
 			...extraParams?.where
@@ -49,8 +48,7 @@ async function searchDocs(query, options) {
 			max_results: 7,
 			...extraParams?.groupBy
 		}
-	};
-	const result = await client.search(params);
+	});
 	if (!result || !result.groups) return list;
 	for (const item of result.groups) {
 		let addedHead = false;
@@ -60,23 +58,21 @@ async function searchDocs(query, options) {
 				list.push({
 					id: doc.page_id,
 					type: "page",
-					content: doc.title,
+					content: highlighter.highlightMarkdown(doc.title),
 					breadcrumbs: doc.breadcrumbs,
-					contentWithHighlights: highlighter.highlight(doc.title),
 					url: doc.url
 				});
 				addedHead = true;
 			}
 			list.push({
 				id: doc.id,
-				content: doc.content,
-				contentWithHighlights: highlighter.highlight(doc.content),
+				content: highlighter.highlightMarkdown(doc.content),
 				type: doc.content === doc.section ? "heading" : "text",
 				url: doc.section_id ? `${doc.url}#${doc.section_id}` : doc.url
 			});
 		}
 	}
-	return list;
+	return list.length > 80 ? list.slice(0, 80) : list;
 }
 
 //#endregion

package/dist/{orama-cloud-legacy-BbgJnf5f.js → orama-cloud-legacy-Caf8mcU9.js}

@@ -1,5 +1,5 @@
 import { createContentHighlighter } from "./search/index.js";
-import { t as removeUndefined } from "./remove-undefined-CJm9cyrC.js";
+import { t as removeUndefined } from "./remove-undefined-B_oBVupY.js";
 
 //#region src/search/client/orama-cloud-legacy.ts
 async function searchDocs(query, options) {
@@ -22,14 +22,12 @@ async function searchDocs(query, options) {
 			list.push({
 				id: hit.id,
 				type: "page",
-				content: doc.title,
-				contentWithHighlights: highlighter.highlight(doc.title),
+				content: highlighter.highlightMarkdown(doc.title),
 				url: doc.path
 			}, {
 				id: "page" + hit.id,
 				type: "text",
-				content: doc.content,
-				contentWithHighlights: highlighter.highlight(doc.content),
+				content: highlighter.highlightMarkdown(doc.content),
 				url: doc.path
 			});
 		}
@@ -58,17 +56,15 @@ async function searchDocs(query, options) {
 				list.push({
 					id: doc.page_id,
 					type: "page",
-					content: doc.title,
+					content: highlighter.highlightMarkdown(doc.title),
 					breadcrumbs: doc.breadcrumbs,
-					contentWithHighlights: highlighter.highlight(doc.title),
 					url: doc.url
 				});
 				addedHead = true;
 			}
 			list.push({
 				id: doc.id,
-				content: doc.content,
-				contentWithHighlights: highlighter.highlight(doc.content),
+				content: highlighter.highlightMarkdown(doc.content),
 				type: doc.content === doc.section ? "heading" : "text",
 				url: doc.section_id ? `${doc.url}#${doc.section_id}` : doc.url
 			});

package/dist/page-tree/index.d.ts

@@ -1,3 +1,3 @@
-import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "../definitions-DSNTbAwC.js";
-import { a as flattenTree, c as visit, i as findSiblings, n as findParent, o as getPageTreePeers, r as findPath, s as getPageTreeRoots, t as findNeighbour } from "../utils-IgHyYnrz.js";
+import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "../definitions-Cw2aM1Af.js";
+import { a as flattenTree, c as visit, i as findSiblings, n as findParent, o as getPageTreePeers, r as findPath, s as getPageTreeRoots, t as findNeighbour } from "../utils-5HX-8dF3.js";
 export { Folder, Item, Node, Root, Separator, findNeighbour, findParent, findPath, findSiblings, flattenTree, getPageTreePeers, getPageTreeRoots, visit };

package/dist/{path-B77y3W0_.d.ts → path-CDjb5iUO.d.ts}

@@ -1,4 +1,4 @@
-import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "./definitions-DSNTbAwC.js";
+import { a as Separator, i as Root, n as Item, r as Node, t as Folder } from "./definitions-Cw2aM1Af.js";
 import { I18nConfig } from "./i18n/index.js";
 import { SlugFn } from "./source/plugins/slugs.js";
 import { SerializedPageTree } from "./source/client/index.js";

package/dist/{mixedbread-Bx9drx9S.js → remove-markdown-CnXcUR-e.js}

@@ -1,5 +1,4 @@
-import { r as __toESM, t as __commonJSMin } from "./chunk-CaR5F9JI.js";
-import Slugger from "github-slugger";
+import { t as __commonJSMin } from "./chunk-CaR5F9JI.js";
 
 //#region ../../node_modules/.pnpm/remove-markdown@0.6.3/node_modules/remove-markdown/index.js
 var require_remove_markdown = /* @__PURE__ */ __commonJSMin(((exports, module) => {
@@ -38,52 +37,4 @@ var require_remove_markdown = /* @__PURE__ */ __commonJSMin(((exports, module) =
 }));
 
 //#endregion
-//#region src/search/client/mixedbread.ts
-var import_remove_markdown = /* @__PURE__ */ __toESM(require_remove_markdown(), 1);
-const slugger = new Slugger();
-function extractHeadingTitle(text) {
-	const trimmedText = text.trim();
-	if (!trimmedText.startsWith("#")) return "";
-	const firstLine = trimmedText.split("\n")[0]?.trim();
-	if (firstLine) return (0, import_remove_markdown.default)(firstLine, { useImgAltText: false });
-	return "";
-}
-async function search(query, options) {
-	const { client, storeIdentifier, tag } = options;
-	if (!query.trim()) return [];
-	return (await client.stores.search({
-		query,
-		store_identifiers: [storeIdentifier],
-		top_k: 10,
-		filters: {
-			key: "generated_metadata.tag",
-			operator: "eq",
-			value: tag
-		},
-		search_options: { return_metadata: true }
-	})).data.flatMap((item) => {
-		const metadata = item.generated_metadata;
-		const url = metadata.url || "#";
-		const title = metadata.title || "Untitled";
-		const chunkResults = [{
-			id: `${item.file_id}-${item.chunk_index}-page`,
-			type: "page",
-			content: title,
-			url
-		}];
-		const headingTitle = item.type === "text" ? extractHeadingTitle(item.text) : "";
-		if (headingTitle) {
-			slugger.reset();
-			chunkResults.push({
-				id: `${item.file_id}-${item.chunk_index}-heading`,
-				type: "heading",
-				content: headingTitle,
-				url: `${url}#${slugger.slug(headingTitle)}`
-			});
-		}
-		return chunkResults;
-	});
-}
-
-//#endregion
-export { search };
+export { require_remove_markdown as t };

package/dist/search/client.d.ts

@@ -1,9 +1,9 @@
-import "../definitions-DSNTbAwC.js";
-import "../utils-IgHyYnrz.js";
+import "../definitions-Cw2aM1Af.js";
+import "../utils-5HX-8dF3.js";
 import { BaseIndex } from "./algolia.js";
 import { SortedResult } from "./index.js";
-import "../create-i18n-Cv3Cocbs.js";
-import "../path-B77y3W0_.js";
+import "../create-i18n-DxSvCSv-.js";
+import "../path-CDjb5iUO.js";
 import "./server.js";
 import { DependencyList } from "react";
 import { AnyOrama } from "@orama/orama";
@@ -104,6 +104,11 @@ interface OramaCloudLegacyOptions {
 }
 //#endregion
 //#region src/search/client/mixedbread.d.ts
+/**
+ * @deprecated Use `createMixedbreadSearchAPI` from `fumadocs-core/search/mixedbread` instead.
+ * This client-side approach exposes your API key in the browser.
+ * The server-side approach keeps the key secure and uses `type: 'fetch'` on the client.
+ */
 interface MixedbreadOptions {
   /**
    * The identifier of the store to search in

package/dist/search/client.js

@@ -54,27 +54,27 @@ function useDocsSearch(clientOptions, deps) {
 			if (debouncedValue.length === 0 && !allowEmpty) return "empty";
 			switch (client.type) {
 				case "fetch": {
-					const { fetchDocs } = await import("../fetch-HotVeLLF.js");
+					const { fetchDocs } = await import("../fetch-D_OY-eAB.js");
 					return fetchDocs(debouncedValue, client);
 				}
 				case "algolia": {
-					const { searchDocs } = await import("../algolia-C7Crg8-5.js");
+					const { searchDocs } = await import("../algolia-CfKKhsrI.js");
 					return searchDocs(debouncedValue, client);
 				}
 				case "orama-cloud": {
-					const { searchDocs } = await import("../orama-cloud-ByznDyOk.js");
+					const { searchDocs } = await import("../orama-cloud-cgTJNLo0.js");
 					return searchDocs(debouncedValue, client);
 				}
 				case "orama-cloud-legacy": {
-					const { searchDocs } = await import("../orama-cloud-legacy-BbgJnf5f.js");
+					const { searchDocs } = await import("../orama-cloud-legacy-Caf8mcU9.js");
 					return searchDocs(debouncedValue, client);
 				}
 				case "mixedbread": {
-					const { search } = await import("../mixedbread-Bx9drx9S.js");
+					const { search } = await import("../mixedbread-RiA_24CE.js");
 					return search(debouncedValue, client);
 				}
 				case "static": {
-					const { search } = await import("../static-DTxK4eHk.js");
+					const { search } = await import("../static-BUXJwBmr.js");
 					return search(debouncedValue, client);
 				}
 				default: throw new Error("unknown search client");

package/dist/search/index.d.ts

@@ -10,6 +10,9 @@ interface SortedResult<Content = string> {
    * breadcrumbs to be displayed on UI
    */
   breadcrumbs?: Content[];
+  /**
+   * @deprecated it is now included in `content` as Markdown using `<mark />`.
+   */
   contentWithHighlights?: HighlightedText<Content>[];
 }
 type ReactSortedResult = SortedResult<ReactNode>;
@@ -22,6 +25,10 @@ interface HighlightedText<Content = string> {
 }
 declare function createContentHighlighter(query: string | RegExp): {
   highlight(content: string): HighlightedText[];
+  /**
+   * @param content - Markdown, it assumes the content is already sanitized & safe, no escape is performed.
+   */
+  highlightMarkdown(content: string): string;
 };
 //#endregion
 export { HighlightedText, ReactSortedResult, SortedResult, createContentHighlighter };

package/dist/search/index.js

@@ -1,3 +1,6 @@
+import { remark } from "remark";
+import { visit } from "unist-util-visit";
+
 //#region src/search/index.ts
 function escapeRegExp(input) {
 	return input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
@@ -11,32 +14,57 @@ function buildRegexFromQuery(q) {
 	return new RegExp(`(${escaped})`, "gi");
 }
 function createContentHighlighter(query) {
+	let processor = remark();
 	const regex = typeof query === "string" ? buildRegexFromQuery(query) : query;
-	return { highlight(content) {
-		if (!regex) return [{
-			type: "text",
-			content
-		}];
-		const out = [];
-		let i = 0;
-		for (const match of content.matchAll(regex)) {
-			if (i < match.index) out.push({
+	if (regex) processor = processor.use(remarkHighlight, regex);
+	return {
+		highlight(content) {
+			if (!regex) return [{
 				type: "text",
-				content: content.substring(i, match.index)
-			});
-			out.push({
+				content
+			}];
+			const out = [];
+			let i = 0;
+			for (const match of content.matchAll(regex)) {
+				if (i < match.index) out.push({
+					type: "text",
+					content: content.substring(i, match.index)
+				});
+				out.push({
+					type: "text",
+					content: match[0],
+					styles: { highlight: true }
+				});
+				i = match.index + match[0].length;
+			}
+			if (i < content.length) out.push({
 				type: "text",
-				content: match[0],
-				styles: { highlight: true }
+				content: content.substring(i)
 			});
-			i = match.index + match[0].length;
+			return out;
+		},
+		highlightMarkdown(content) {
+			if (!regex) return content;
+			return String(processor.processSync(content).value);
 		}
-		if (i < content.length) out.push({
-			type: "text",
-			content: content.substring(i)
+	};
+}
+function remarkHighlight(regex) {
+	return (tree) => {
+		visit(tree, "text", (node) => {
+			let out = "";
+			const content = node.value;
+			let i = 0;
+			for (const match of content.matchAll(regex)) {
+				if (i < match.index) out += content.substring(i, match.index);
+				out += `<mark>${match[0]}</mark>`;
+				i = match.index + match[0].length;
+			}
+			if (i < content.length) out += content.substring(i);
+			node.type = "html";
+			node.value = out;
 		});
-		return out;
-	} };
+	};
 }
 
 //#endregion