fumadocs-core 12.4.1 → 12.5.0

package/dist/breadcrumb.d.ts

@@ -5,7 +5,17 @@ interface BreadcrumbItem {
     name: ReactNode;
     url?: string;
 }
-interface BreadcrumbOptions {
+interface BreadcrumbOptions extends SearchOptions {
+    /**
+     * Include the root itself in the breadcrumb items array
+     *
+     * @defaultValue false
+     */
+    includeRoot?: boolean;
+}
+declare function useBreadcrumb(url: string, tree: Root, options?: BreadcrumbOptions): BreadcrumbItem[];
+declare function getBreadcrumbItems(url: string, tree: Root, options?: BreadcrumbOptions): BreadcrumbItem[];
+interface SearchOptions {
     /**
      * Include the page itself in the breadcrumb items array
      *
@@ -19,7 +29,5 @@ interface BreadcrumbOptions {
      */
     includeSeparator?: boolean;
 }
-declare function useBreadcrumb(url: string, tree: Root, options?: BreadcrumbOptions): BreadcrumbItem[];
-declare function getBreadcrumbItems(url: string, tree: Root, options?: BreadcrumbOptions): BreadcrumbItem[];
 
 export { type BreadcrumbItem, type BreadcrumbOptions, getBreadcrumbItems, useBreadcrumb };

package/dist/breadcrumb.js

@@ -1,26 +1,33 @@
-import "./chunk-CWMXXUWU.js";
+import {
+  __objRest
+} from "./chunk-CWMXXUWU.js";
 
 // src/breadcrumb.tsx
 import { useMemo } from "react";
-function useBreadcrumb(url, tree, options = {}) {
+function useBreadcrumb(url, tree, options) {
   return useMemo(
     () => getBreadcrumbItems(url, tree, options),
     [tree, url, options]
   );
 }
 function getBreadcrumbItems(url, tree, options = {}) {
-  var _a, _b, _c;
-  return (_c = searchPath(tree.children, url, {
-    includePage: (_a = options.includePage) != null ? _a : true,
-    includeSeparator: (_b = options.includeSeparator) != null ? _b : false
-  })) != null ? _c : [];
+  var _b, _c;
+  const _a = options, { includeRoot } = _a, rest = __objRest(_a, ["includeRoot"]);
+  const path = (_b = searchPath(tree.children, url, rest)) != null ? _b : [];
+  if (includeRoot) {
+    path.unshift({
+      name: tree.name,
+      url: (_c = tree.children.find((p) => p.type === "page")) == null ? void 0 : _c.url
+    });
+  }
+  return path;
 }
 function searchPath(nodes, url, options) {
   var _a, _b;
+  const { includePage = true, includeSeparator = false } = options;
   let separator;
   for (const node of nodes) {
-    if (options.includeSeparator && node.type === "separator")
-      separator = node.name;
+    if (includeSeparator && node.type === "separator") separator = node.name;
     if (node.type === "folder") {
       if (((_a = node.index) == null ? void 0 : _a.url) === url) {
         const items2 = [];
@@ -45,7 +52,7 @@ function searchPath(nodes, url, options) {
     if (node.type === "page" && node.url === url) {
       const items = [];
       if (separator) items.push({ name: separator });
-      if (options.includePage)
+      if (includePage)
         items.push({
           name: node.name,
           url: node.url

package/dist/search/server.d.ts

@@ -22,7 +22,9 @@ interface SimpleOptions {
 interface AdvancedOptions {
     indexes: AdvancedIndex[] | Dynamic<AdvancedIndex>;
     /**
-     * Enabled custom tags
+     * Enable search tags for filtering results
+     *
+     * @defaultValue false
      */
     tag?: boolean;
     language?: string;
@@ -47,6 +49,7 @@ declare function initSearchAPI({ indexes, language }: SimpleOptions): SearchAPI;
 interface AdvancedIndex {
     id: string;
     title: string;
+    keywords?: string;
     /**
      * Required if `tag` is enabled
      */

package/dist/search/server.js

@@ -117,25 +117,30 @@ function initSearchAPIAdvanced({
   language,
   tag = false
 }) {
-  const store = ["id", "url", "content", "page_id", "type"];
+  const store = ["id", "url", "content", "page_id", "type", "keywords"];
   function getDocument() {
     return __async(this, null, function* () {
       const items = typeof indexes === "function" ? yield indexes() : indexes;
       const index = new Document({
         language,
         cache: 100,
-        tokenize: "forward",
         optimize: true,
-        context: {
-          depth: 2,
-          bidirectional: true,
-          resolution: 9
-        },
         document: {
           id: "id",
           tag: tag ? "tag" : void 0,
           store,
-          index: ["content"]
+          index: [
+            {
+              field: "content",
+              tokenize: "forward",
+              context: { depth: 2, bidirectional: true, resolution: 9 }
+            },
+            {
+              field: "keywords",
+              tokenize: "strict",
+              resolution: 9
+            }
+          ]
         }
       });
       for (const page of items) {
@@ -146,6 +151,7 @@ function initSearchAPIAdvanced({
           page_id: page.id,
           type: "page",
           content: page.title,
+          keywords: page.keywords,
           tag: page.tag,
           url: page.url
         });
@@ -185,8 +191,8 @@ function initSearchAPIAdvanced({
     const map = /* @__PURE__ */ new Map();
     for (const item of (_b = (_a = results[0]) == null ? void 0 : _a.result) != null ? _b : []) {
       if (item.doc.type === "page") {
-        if (!map.has(item.doc.page_id)) {
-          map.set(item.doc.page_id, []);
+        if (!map.has(item.doc.id)) {
+          map.set(item.doc.id, []);
         }
         continue;
       }

package/dist/search-algolia/client.d.ts

@@ -11,6 +11,8 @@ import 'unified';
 interface Options extends SearchOptions {
     /**
      * Use `empty` as result if query is empty
+     *
+     * @defaultValue true
      */
     allowEmpty?: boolean;
 }

package/dist/search-algolia/server.d.ts

@@ -14,32 +14,54 @@ interface DocumentRecord {
      */
     url: string;
     structured: StructuredData;
+    /**
+     * Tag to filter results
+     */
+    tag?: string;
     /**
      * Data to be added to each section index
      */
     extra_data?: object;
 }
 interface SyncOptions {
+    /**
+     * Index Name for documents
+     */
     document?: string;
+    /**
+     * Search indexes
+     */
     documents: DocumentRecord[];
 }
-declare function sync(client: SearchClient, { document, documents }: SyncOptions): Promise<void>;
+/**
+ * Update index settings and replace all objects
+ *
+ * @param client - Algolia Admin Client
+ * @param options - Index Options
+ */
+declare function sync(client: SearchClient, options: SyncOptions): Promise<void>;
 declare function setIndexSettings(index: SearchIndex): Promise<void>;
-declare function updateDocuments(index: SearchIndex, documents: DocumentRecord[]): Promise<void>;
-interface BaseIndex {
-    objectID: string;
-    title: string;
-    url: string;
+interface Section {
+    /**
+     * Heading content
+     */
     section?: string;
     /**
      * The anchor id
      */
     section_id?: string;
+    content: string;
+}
+declare function updateDocuments(index: SearchIndex, documents: DocumentRecord[]): Promise<void>;
+interface BaseIndex extends Section {
+    objectID: string;
+    title: string;
+    url: string;
+    tag?: string;
     /**
      * The id of page, used for distinct
      */
     page_id: string;
-    content: string;
 }
 
 export { type BaseIndex, type SyncOptions, setIndexSettings, sync, updateDocuments };

package/dist/search-algolia/server.js

@@ -4,9 +4,9 @@ import {
 } from "../chunk-CWMXXUWU.js";
 
 // src/search-algolia/server.ts
-import { randomUUID } from "crypto";
-function sync(_0, _1) {
-  return __async(this, arguments, function* (client, { document = "document", documents }) {
+function sync(client, options) {
+  return __async(this, null, function* () {
+    const { document = "document", documents } = options;
     const index = client.initIndex(document);
     yield setIndexSettings(index);
     yield updateDocuments(index, documents);
@@ -50,11 +50,12 @@ function updateDocuments(index, documents) {
   return __async(this, null, function* () {
     const objects = documents.flatMap((page) => {
       return getSections(page).map(
-        (section) => __spreadValues(__spreadValues({
-          objectID: `${page._id}-${randomUUID()}`,
+        (section, idx) => __spreadValues(__spreadValues({
+          objectID: `${page._id}-${idx.toString()}`,
           title: page.title,
           url: page.url,
-          page_id: page._id
+          page_id: page._id,
+          tag: page.tag
         }, section), page.extra_data)
       );
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "12.4.1",
+  "version": "12.5.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -120,8 +120,8 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
-    "@shikijs/rehype": "^1.10.1",
-    "@shikijs/transformers": "^1.10.1",
+    "@shikijs/rehype": "^1.10.3",
+    "@shikijs/transformers": "^1.10.3",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "negotiator": "^0.6.3",
@@ -131,7 +131,7 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "^1.10.1",
+    "shiki": "^1.10.3",
     "swr": "^2.2.5",
     "unist-util-visit": "^5.0.0"
   },
@@ -143,11 +143,11 @@
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "20.14.9",
+    "@types/node": "20.14.10",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "algoliasearch": "^4.24.0",
-    "next": "^14.2.4",
+    "next": "^14.2.5",
     "unified": "^11.0.5",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"