fumadocs-core 13.0.3 → 13.0.5

package/dist/chunk-NREWOIVI.js

@@ -0,0 +1,19 @@
+// src/utils/use-debounce.ts
+import { useRef, useState } from "react";
+function useDebounce(value, delayMs = 1e3) {
+  const [debouncedValue, setDebouncedValue] = useState(value);
+  const timer = useRef();
+  if (delayMs === 0) return value;
+  if (value !== debouncedValue && timer.current?.value !== value) {
+    if (timer.current) clearTimeout(timer.current.handler);
+    const handler = window.setTimeout(() => {
+      setDebouncedValue(value);
+    }, delayMs);
+    timer.current = { value, handler };
+  }
+  return debouncedValue;
+}
+
+export {
+  useDebounce
+};

package/dist/search/client.js

@@ -1,7 +1,10 @@
+import {
+  useDebounce
+} from "../chunk-NREWOIVI.js";
 import "../chunk-MLKGABMK.js";
 
 // src/search/client.ts
-import { useEffect, useState } from "react";
+import { useState } from "react";
 import useSWR from "swr";
 async function fetchDocs(api, query, locale, tag) {
   if (query.length === 0) return "empty";
@@ -25,18 +28,6 @@ function useDocsSearch(locale, tag, api = "/api/search", delayMs = 100) {
   );
   return { search, setSearch, query };
 }
-function useDebounce(value, delayMs = 1e3) {
-  const [debouncedValue, setDebouncedValue] = useState(value);
-  useEffect(() => {
-    const handler = setTimeout(() => {
-      setDebouncedValue(value);
-    }, delayMs);
-    return () => {
-      clearTimeout(handler);
-    };
-  }, [value, delayMs]);
-  return debouncedValue;
-}
 export {
   useDocsSearch
 };

package/dist/search/server.d.ts

@@ -41,6 +41,7 @@ declare function createSearchAPI<T extends 'simple' | 'advanced'>(type: T, optio
 declare function createI18nSearchAPI<T extends 'simple' | 'advanced'>(type: T, options: T extends 'simple' ? ToI18n<SimpleOptions> : ToI18n<AdvancedOptions>): SearchAPI;
 interface Index {
     title: string;
+    description?: string;
     content: string;
     url: string;
     keywords?: string;
@@ -49,9 +50,10 @@ declare function initSearchAPI({ indexes, language }: SimpleOptions): SearchAPI;
 interface AdvancedIndex {
     id: string;
     title: string;
+    description?: string;
     keywords?: string;
     /**
-     * Required if `tag` is enabled
+     * Required if tag filter is enabled
      */
     tag?: string;
     /**

package/dist/search/server.js

@@ -63,6 +63,14 @@ function initSearchAPI({ indexes, language }) {
             tokenize: "forward",
             resolution: 9
           },
+          {
+            field: "description",
+            tokenize: "strict",
+            context: {
+              depth: 1,
+              resolution: 9
+            }
+          },
           {
             field: "content",
             tokenize: "strict",
@@ -82,6 +90,7 @@ function initSearchAPI({ indexes, language }) {
     for (const page of items) {
       index.add({
         title: page.title,
+        description: page.description,
         url: page.url,
         content: page.content,
         keywords: page.keywords
@@ -146,6 +155,16 @@ function initSearchAPIAdvanced({
         tag: page.tag,
         url: page.url
       });
+      if (page.description) {
+        index.add({
+          id: page.id + (id++).toString(),
+          page_id: page.id,
+          tag: page.tag,
+          type: "text",
+          url: page.url,
+          content: page.description
+        });
+      }
       for (const heading of data.headings) {
         index.add({
           id: page.id + (id++).toString(),

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

@@ -15,6 +15,12 @@ interface Options extends SearchOptions {
      * @defaultValue true
      */
     allowEmpty?: boolean;
+    /**
+     * Delay to debounce (in ms)
+     *
+     * @defaultValue 300
+     */
+    delay?: number;
 }
 declare function groupResults(hits: Hit<BaseIndex>[]): SortedResult[];
 declare function searchDocs(index: SearchIndex, query: string, options?: SearchOptions): Promise<SortedResult[]>;
@@ -25,6 +31,6 @@ interface UseAlgoliaSearch {
         keepPreviousData: true;
     }>;
 }
-declare function useAlgoliaSearch(index: SearchIndex, { allowEmpty, ...options }?: Options): UseAlgoliaSearch;
+declare function useAlgoliaSearch(index: SearchIndex, { allowEmpty, delay, ...options }?: Options): UseAlgoliaSearch;
 
 export { type Options, groupResults, searchDocs, useAlgoliaSearch };

package/dist/search-algolia/client.js

@@ -1,3 +1,6 @@
+import {
+  useDebounce
+} from "../chunk-NREWOIVI.js";
 import "../chunk-MLKGABMK.js";
 
 // src/search-algolia/client.ts
@@ -41,13 +44,14 @@ async function searchDocs(index, query, options) {
   });
   return groupResults(result.hits);
 }
-function useAlgoliaSearch(index, { allowEmpty = true, ...options } = {}) {
+function useAlgoliaSearch(index, { allowEmpty = true, delay = 150, ...options } = {}) {
   const [search, setSearch] = useState("");
+  const debouncedValue = useDebounce(search, delay);
   const query = useSWR(
-    ["algolia-search", search, allowEmpty, options],
+    ["algolia-search", debouncedValue, allowEmpty, options],
     async () => {
-      if (allowEmpty && search.length === 0) return "empty";
-      return searchDocs(index, search, options);
+      if (allowEmpty && debouncedValue.length === 0) return "empty";
+      return searchDocs(index, debouncedValue, options);
     },
     {
       keepPreviousData: true

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

@@ -9,6 +9,7 @@ interface DocumentRecord {
      */
     _id: string;
     title: string;
+    description?: string;
     /**
      * URL to the page
      */
@@ -41,19 +42,8 @@ interface SyncOptions {
  */
 declare function sync(client: SearchClient, options: SyncOptions): Promise<void>;
 declare function setIndexSettings(index: SearchIndex): Promise<void>;
-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 {
+interface BaseIndex {
     objectID: string;
     title: string;
     url: string;
@@ -62,6 +52,15 @@ interface BaseIndex extends Section {
      * The id of page, used for distinct
      */
     page_id: string;
+    /**
+     * Heading content
+     */
+    section?: string;
+    /**
+     * Heading (anchor) id
+     */
+    section_id?: string;
+    content: string;
 }
 
 export { type BaseIndex, type SyncOptions, setIndexSettings, sync, updateDocuments };

package/dist/search-algolia/server.js

@@ -16,43 +16,38 @@ async function setIndexSettings(index) {
     attributesForFaceting: ["tag"]
   });
 }
-function getSections(page) {
+function toIndex(page) {
+  let id = 0;
+  const indexes = [];
   const scannedHeadings = /* @__PURE__ */ new Set();
-  return page.structured.contents.flatMap((p) => {
-    const heading = p.heading ? page.structured.headings.find((h) => p.heading === h.id) : null;
-    const section = {
-      section: heading?.content,
-      section_id: heading?.id,
-      content: p.content
+  function createIndex(section, sectionId, content) {
+    return {
+      objectID: `${page._id}-${(id++).toString()}`,
+      title: page.title,
+      url: page.url,
+      page_id: page._id,
+      tag: page.tag,
+      section,
+      section_id: sectionId,
+      content,
+      ...page.extra_data
     };
+  }
+  if (page.description)
+    indexes.push(createIndex(void 0, void 0, page.description));
+  page.structured.contents.forEach((p) => {
+    const heading = p.heading ? page.structured.headings.find((h) => p.heading === h.id) : null;
+    const index = createIndex(heading?.content, heading?.id, p.content);
     if (heading && !scannedHeadings.has(heading.id)) {
       scannedHeadings.add(heading.id);
-      return [
-        {
-          section: heading.content,
-          section_id: heading.id,
-          content: heading.content
-        },
-        section
-      ];
+      indexes.push(createIndex(heading.content, heading.id, heading.content));
     }
-    return section;
+    indexes.push(index);
   });
+  return indexes;
 }
 async function updateDocuments(index, documents) {
-  const objects = documents.flatMap((page) => {
-    return getSections(page).map(
-      (section, idx) => ({
-        objectID: `${page._id}-${idx.toString()}`,
-        title: page.title,
-        url: page.url,
-        page_id: page._id,
-        tag: page.tag,
-        ...section,
-        ...page.extra_data
-      })
-    );
-  });
+  const objects = documents.flatMap(toIndex);
   await index.replaceAllObjects(objects);
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "13.0.3",
+  "version": "13.0.5",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",