Core: Upgrade to Orama v3

Author: fuma-nama

.changeset/quick-apes-show.md

@@ -0,0 +1,5 @@
+---
+'fumadocs-core': patch
+---
+
+Support to add custom serialization to `remarkStructure` via `data._string`

packages/core/src/mdx-plugins/remark-structure.ts

@@ -3,7 +3,7 @@ import type { Root } from 'mdast';
 import { remark } from 'remark';
 import remarkGfm from 'remark-gfm';
 import type { PluggableList, Transformer } from 'unified';
-import { visit, type Test } from 'unist-util-visit';
+import { visit } from 'unist-util-visit';
 import { flattenNode } from './remark-utils';
 
 interface Heading {
@@ -26,11 +26,22 @@ export interface StructuredData {
 
 export interface StructureOptions {
   /**
-   * Types to be scanned.
+   * Types to be scanned as content.
    *
-   * @defaultValue ['paragraph', 'blockquote', 'heading', 'tableCell']
+   * @defaultValue ['paragraph', 'blockquote', 'tableCell']
    */
-  types?: Test;
+  types?: string[];
+}
+
+declare module 'mdast' {
+  interface Data {
+    /**
+     * Get content of unserializable element
+     *
+     * Needed for `remarkStructure` to generate search index
+     */
+    _string?: string[];
+  }
 }
 
 const slugger = new Slugger();
@@ -60,14 +71,14 @@ export function remarkStructure({
       }
     }
 
-    visit(node, types, (element) => {
+    visit(node, (element) => {
       if (element.type === 'root') return;
-      const content = flattenNode(element).trim();
 
       if (element.type === 'heading') {
         element.data ||= {};
         element.data.hProperties ||= {};
         const properties = element.data.hProperties;
+        const content = flattenNode(element).trim();
         const id = properties.id ?? slugger.slug(content);
 
         data.headings.push({
@@ -79,7 +90,21 @@ export function remarkStructure({
         return 'skip';
       }
 
-      if (content.length > 0) {
+      if (element.data?._string) {
+        for (const content of element.data._string) {
+          data.contents.push({
+            heading: lastHeading,
+            content,
+          });
+        }
+
+        return 'skip';
+      }
+
+      if (types.includes(element.type)) {
+        const content = flattenNode(element).trim();
+        if (content.length === 0) return;
+
         data.contents.push({
           heading: lastHeading,
           content,

packages/core/src/search/client/static.ts

@@ -14,7 +14,7 @@ export interface StaticOptions {
    */
   from?: string;
 
-  initOrama?: (locale?: string) => Promise<Orama<unknown, never, never, never>>;
+  initOrama?: (locale?: string) => AnyOrama | Promise<AnyOrama>;
 }
 
 export interface StaticClient {
@@ -52,7 +52,7 @@ export function createStaticClient({
       for (const [k, v] of Object.entries(data.data)) {
         const db = await initOrama(k);
 
-        await load(db, v);
+        load(db, v);
         dbs.set(k, {
           type: v.type,
           db,
@@ -61,7 +61,7 @@ export function createStaticClient({
     } else {
       const db = await initOrama();
 
-      await load(db, data);
+      load(db, data);
       dbs.set('', {
         type: data.type,
         db,

packages/typescript/src/lib/remark-auto-type-table.tsx

@@ -151,6 +151,17 @@ export function remarkAutoTypeTable({
                 properties,
               }),
             ],
+            data: {
+              // for Fumadocs `remarkStructure`
+              _string: [
+                doc.name,
+                doc.description,
+                ...doc.entries.flatMap((entry) => [
+                  `${entry.name}: ${entry.type}`,
+                  entry.description,
+                ]),
+              ],
+            },
             children: [],
           };
         });