fumadocs-core 16.8.9 → 16.8.10

package/dist/{index-Ceg2efJm.d.ts → index-DvNKidQF.d.ts}

@@ -30,7 +30,10 @@ declare class FileSystem<File> {
 }
 //#endregion
 //#region src/source/storage/content.d.ts
-type ContentStorage<P = ContentStoragePageFile, M = ContentStorageMetaFile> = FileSystem<P | M>;
+type ContentStorage<P extends ContentStoragePageFile = ContentStoragePageFile, M extends ContentStorageMetaFile = ContentStorageMetaFile> = FileSystem<P | M> & {
+  /** always `undefined`, for inferring types only */$inferPage: P; /** always `undefined`, for inferring types only */
+  $inferMeta: M;
+};
 /** @internal */
 interface ContentStorageMetaFile<Type extends string | undefined = string | undefined, Data extends MetaData = MetaData> {
   type: Type;
@@ -125,7 +128,7 @@ declare class PageTreeBuilder {
 /**
  * a function to generate slugs, return `undefined` to fallback to default generation.
  */
-type SlugFn<S = ContentStorage> = (file: S extends ContentStorage<infer P, unknown> ? P : never) => string[] | undefined;
+type SlugFn<S extends ContentStorage = ContentStorage> = (file: S['$inferPage']) => string[] | undefined;
 /**
  * Generate slugs for pages if missing
  */

package/dist/mdx-plugins/remark-block-id.d.ts

@@ -0,0 +1,42 @@
+import { Transformer } from "unified";
+import { Root, RootContent } from "mdast";
+
+//#region src/mdx-plugins/remark-block-id.d.ts
+interface RemarkBlockIdOptions {
+  /**
+   * generate block ID.
+   */
+  generateId?: (ctx: {
+    node: RootContent;
+    text: string;
+  }) => string;
+  /**
+   * determine whether an ID should be generated for a given node.
+   *
+   * default: `true` for block nodes, otherwise `false`.
+   *
+   * @returns
+   * - `true`: generate an ID for the node.
+   * - `false`: skip the current node and look into its children.
+   * - `skip`: skip the current node and its children.
+   */
+  shouldGenerate?: (node: RootContent) => boolean | 'skip';
+  /**
+   * Add `data-block="<value>"` to updated nodes, pass `null` to disable.
+   *
+   * @default "default"
+   */
+  addDataAttribute?: string | null;
+}
+/**
+ * Generate ID for each block node in Markdown/MDX.
+ *
+ * Note: the uniqueness is only guaranteed per file.
+ */
+declare function remarkBlockId({
+  generateId,
+  addDataAttribute,
+  shouldGenerate
+}?: RemarkBlockIdOptions): Transformer<Root, Root>;
+//#endregion
+export { RemarkBlockIdOptions, remarkBlockId };

package/dist/mdx-plugins/remark-block-id.js

@@ -0,0 +1,41 @@
+import { t as flattenNode } from "../utils-pSG8hSr9.js";
+import Slugger from "github-slugger";
+import { visit } from "unist-util-visit";
+import { createHash } from "node:crypto";
+//#region src/mdx-plugins/remark-block-id.ts
+/**
+* Generate ID for each block node in Markdown/MDX.
+*
+* Note: the uniqueness is only guaranteed per file.
+*/
+function remarkBlockId({ generateId, addDataAttribute = "default", shouldGenerate = (node) => {
+	switch (node.type) {
+		case "mdxJsxFlowElement": return "skip";
+		case "paragraph":
+		case "image":
+		case "listItem": return true;
+		default: return false;
+	}
+} } = {}) {
+	return (tree) => {
+		const slugger = new Slugger();
+		visit(tree, (node) => {
+			if (node.type === "root" || node.data?.hProperties?.id) return;
+			const resolved = shouldGenerate(node);
+			if (resolved === false) return;
+			if (resolved === "skip") return "skip";
+			const text = flattenNode(node).trim();
+			if (text.length === 0) return;
+			const id = generateId ? slugger.slug(generateId({
+				node,
+				text
+			})) : slugger.slug(createHash("sha256").update(text).digest("base64url"));
+			node.data ??= {};
+			node.data.hProperties ??= {};
+			node.data.hProperties.id = id;
+			if (addDataAttribute) node.data.hProperties["data-block"] = addDataAttribute;
+		});
+	};
+}
+//#endregion
+export { remarkBlockId };

package/dist/search/flexsearch.d.ts

@@ -1,7 +1,7 @@
 import { t as Awaitable } from "../types-DpbpliNk.js";
 import { t as I18nConfig } from "../index-DaiDEfiL.js";
-import { m as SharedIndex, n as SearchAPI, t as QueryOptions } from "../server-CG7-_iKC.js";
-import { C as LoaderConfig, T as LoaderOutput } from "../index-Ceg2efJm.js";
+import { m as SharedIndex, n as SearchAPI, t as QueryOptions } from "../server-DZLj6URC.js";
+import { C as LoaderConfig, T as LoaderOutput } from "../index-DvNKidQF.js";
 import { DocumentData, DocumentOptions } from "flexsearch";
 
 //#region src/search/server/build-doc.d.ts

package/dist/search/mixedbread.d.ts

@@ -1,5 +1,5 @@
 import { r as SortedResult } from "../index-CnkxgKNd.js";
-import { n as SearchAPI } from "../server-CG7-_iKC.js";
+import { n as SearchAPI } from "../server-DZLj6URC.js";
 import Mixedbread from "@mixedbread/sdk";
 import { StoreSearchResponse } from "@mixedbread/sdk/resources/stores";
 

package/dist/search/server.d.ts

@@ -1,2 +1,2 @@
-import { a as AdvancedOptions, c as SimpleOptions, d as createSearchAPI, f as initAdvancedSearch, i as AdvancedIndex, l as createFromSource, n as SearchAPI, o as ExportedData, p as initSimpleSearch, r as SearchServer, s as Index, t as QueryOptions, u as createI18nSearchAPI } from "../server-CG7-_iKC.js";
+import { a as AdvancedOptions, c as SimpleOptions, d as createSearchAPI, f as initAdvancedSearch, i as AdvancedIndex, l as createFromSource, n as SearchAPI, o as ExportedData, p as initSimpleSearch, r as SearchServer, s as Index, t as QueryOptions, u as createI18nSearchAPI } from "../server-DZLj6URC.js";
 export { AdvancedIndex, AdvancedOptions, ExportedData, Index, QueryOptions, SearchAPI, SearchServer, SimpleOptions, createFromSource, createI18nSearchAPI, createSearchAPI, initAdvancedSearch, initSimpleSearch };

package/dist/{server-CG7-_iKC.d.ts → server-DZLj6URC.d.ts}

@@ -2,7 +2,7 @@ import { t as Awaitable } from "./types-DpbpliNk.js";
 import { i as StructuredData } from "./remark-structure-C2-K9_ko.js";
 import { t as I18nConfig } from "./index-DaiDEfiL.js";
 import { r as SortedResult } from "./index-CnkxgKNd.js";
-import { C as LoaderConfig, T as LoaderOutput } from "./index-Ceg2efJm.js";
+import { C as LoaderConfig, T as LoaderOutput } from "./index-DvNKidQF.js";
 import { Language, Orama, RawData, SearchParams, TypedDocument, create } from "@orama/orama";
 
 //#region src/search/orama/create-db.d.ts

package/dist/source/dynamic.d.ts

@@ -1,2 +1,2 @@
-import { b as dynamicLoader, v as DynamicLoader, y as DynamicLoaderConfig } from "../index-Ceg2efJm.js";
+import { b as dynamicLoader, v as DynamicLoader, y as DynamicLoaderConfig } from "../index-DvNKidQF.js";
 export { DynamicLoader, DynamicLoaderConfig, dynamicLoader };

package/dist/source/index.d.ts

@@ -1,2 +1,2 @@
-import { A as ResolvedLoaderConfig, B as PageTreeTransformer, C as LoaderConfig, D as LoaderPluginOption, E as LoaderPlugin, H as ContentStorageMetaFile, L as PageTreeBuilder, M as loader, O as Meta, P as getSlugs, R as PageTreeBuilderContext, S as InferPageType, T as LoaderOutput, U as ContentStoragePageFile, V as ContentStorage, W as FileSystem, _ as update, a as MetaData, c as SourceConfig, d as VirtualFile, f as _SourceUpdate_, g as source, h as multiple, i as DynamicSource, j as createGetUrl, k as Page, l as SourceUnion, m as isStaticSource, n as llms, o as PageData, p as isDynamicSource, r as path_d_exports, s as Source, t as LLMsConfig, u as StaticSource, w as LoaderOptions, x as InferMetaType, z as PageTreeOptions } from "../index-Ceg2efJm.js";
+import { A as ResolvedLoaderConfig, B as PageTreeTransformer, C as LoaderConfig, D as LoaderPluginOption, E as LoaderPlugin, H as ContentStorageMetaFile, L as PageTreeBuilder, M as loader, O as Meta, P as getSlugs, R as PageTreeBuilderContext, S as InferPageType, T as LoaderOutput, U as ContentStoragePageFile, V as ContentStorage, W as FileSystem, _ as update, a as MetaData, c as SourceConfig, d as VirtualFile, f as _SourceUpdate_, g as source, h as multiple, i as DynamicSource, j as createGetUrl, k as Page, l as SourceUnion, m as isStaticSource, n as llms, o as PageData, p as isDynamicSource, r as path_d_exports, s as Source, t as LLMsConfig, u as StaticSource, w as LoaderOptions, x as InferMetaType, z as PageTreeOptions } from "../index-DvNKidQF.js";
 export { ContentStorage, ContentStorageMetaFile, ContentStoragePageFile, DynamicSource, FileSystem, InferMetaType, InferPageType, LLMsConfig, LoaderConfig, LoaderOptions, LoaderOutput, LoaderPlugin, LoaderPluginOption, Meta, MetaData, Page, PageData, PageTreeBuilder, PageTreeBuilderContext, PageTreeOptions, PageTreeTransformer, path_d_exports as PathUtils, ResolvedLoaderConfig, Source, SourceConfig, SourceUnion, StaticSource, VirtualFile, _SourceUpdate_, createGetUrl, getSlugs, isDynamicSource, isStaticSource, llms, loader, multiple, source, update };

package/dist/source/llms.d.ts

@@ -1,2 +1,2 @@
-import { n as llms, t as LLMsConfig } from "../index-Ceg2efJm.js";
+import { n as llms, t as LLMsConfig } from "../index-DvNKidQF.js";
 export { LLMsConfig, llms };

package/dist/source/plugins/lucide-icons.d.ts

@@ -1,4 +1,4 @@
-import { E as LoaderPlugin } from "../../index-Ceg2efJm.js";
+import { E as LoaderPlugin } from "../../index-DvNKidQF.js";
 import { icons } from "lucide-react";
 
 //#region src/source/plugins/lucide-icons.d.ts

package/dist/source/plugins/slugs.d.ts

@@ -1,2 +1,2 @@
-import { F as slugsFromData, I as slugsPlugin, N as SlugFn, P as getSlugs } from "../../index-Ceg2efJm.js";
+import { F as slugsFromData, I as slugsPlugin, N as SlugFn, P as getSlugs } from "../../index-DvNKidQF.js";
 export { SlugFn, getSlugs, slugsFromData, slugsPlugin };

package/dist/source/plugins/status-badges.d.ts

@@ -1,5 +1,5 @@
 import { a as Separator$1, n as Item$1, t as Folder$1 } from "../../definitions-Cob-Q8-8.js";
-import { E as LoaderPlugin } from "../../index-Ceg2efJm.js";
+import { E as LoaderPlugin } from "../../index-DvNKidQF.js";
 import { ReactNode } from "react";
 
 //#region src/source/plugins/status-badges.d.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "16.8.9",
+  "version": "16.8.10",
   "description": "The React.js library for building a documentation website",
   "keywords": [
     "Docs",
@@ -42,6 +42,7 @@
     "./mdx-plugins/rehype-code.core": "./dist/mdx-plugins/rehype-code.core.js",
     "./mdx-plugins/rehype-toc": "./dist/mdx-plugins/rehype-toc.js",
     "./mdx-plugins/remark-admonition": "./dist/mdx-plugins/remark-admonition.js",
+    "./mdx-plugins/remark-block-id": "./dist/mdx-plugins/remark-block-id.js",
     "./mdx-plugins/remark-code-tab": "./dist/mdx-plugins/remark-code-tab.js",
     "./mdx-plugins/remark-directive-admonition": "./dist/mdx-plugins/remark-directive-admonition.js",
     "./mdx-plugins/remark-feedback-block": "./dist/mdx-plugins/remark-feedback-block.js",