fumadocs-core 14.1.1 → 14.2.1

package/dist/{get-toc-CM4X3hbw.d.ts → get-toc-Dm1yr2Gr.d.ts}

@@ -11,6 +11,6 @@ type TableOfContents = TOCItemType[];
  *
  * @param content - Markdown content
  */
-declare function getTableOfContents(content: string): Promise<TableOfContents>;
+declare function getTableOfContents(content: string): TableOfContents;
 
 export { type TableOfContents as T, type TOCItemType as a, getTableOfContents as g };

package/dist/mdx-plugins/index.d.ts

@@ -3,8 +3,9 @@ import { Root } from 'hast';
 import { RehypeShikiOptions } from '@shikijs/rehype';
 import { Processor, Transformer } from 'unified';
 import { ShikiTransformer } from 'shiki';
-import { Root as Root$1, Heading } from 'mdast';
+import { Root as Root$1 } from 'mdast';
 export { a as StructureOptions, S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-mP51W1AN.js';
+export { R as RemarkHeadingOptions, r as remarkHeading } from '../remark-heading-BPCoYwjn.js';
 import 'unist-util-visit';
 
 interface CodeBlockIcon {
@@ -87,33 +88,6 @@ interface RemarkImageOptions {
  */
 declare function remarkImage({ placeholder, external, useImport, publicDir, }?: RemarkImageOptions): Transformer<Root$1, Root$1>;
 
-declare module 'mdast' {
-    interface HeadingData extends Data {
-        hProperties?: {
-            id?: string;
-        };
-    }
-}
-interface RemarkHeadingOptions {
-    slug?: (root: Root$1, heading: Heading, text: string) => string;
-    /**
-     * Allow custom headings ids
-     *
-     * @defaultValue true
-     */
-    customId?: boolean;
-    /**
-     * Attach an array of `TOCItemType` to `file.data.toc`
-     *
-     * @defaultValue true
-     */
-    generateToc?: boolean;
-}
-/**
- * Add heading ids and extract TOC
- */
-declare function remarkHeading({ slug: defaultSlug, customId, generateToc, }?: RemarkHeadingOptions): Transformer<Root$1, Root$1>;
-
 interface RemarkAdmonitionOptions {
     tag?: string;
     types?: string[];
@@ -139,4 +113,4 @@ interface RehypeTocOptions {
 }
 declare function rehypeToc(this: Processor, { exportToc }?: RehypeTocOptions): Transformer<Root, Root>;
 
-export { type CodeBlockIcon, type RehypeCodeOptions, type RehypeTocOptions, type RemarkAdmonitionOptions, type RemarkHeadingOptions, type RemarkImageOptions, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkHeading, remarkImage, transformerIcon, transformerTab };
+export { type CodeBlockIcon, type RehypeCodeOptions, type RehypeTocOptions, type RemarkAdmonitionOptions, type RemarkImageOptions, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkImage, transformerIcon, transformerTab };

package/dist/mdx-plugins/index.js

@@ -1,11 +1,11 @@
-import {
-  flattenNode,
-  remarkHeading
-} from "../chunk-4MNUWZIW.js";
 import {
   resolvePath,
   slash
 } from "../chunk-SHGL6VBO.js";
+import {
+  flattenNode,
+  remarkHeading
+} from "../chunk-4MNUWZIW.js";
 import {
   createStyleTransformer,
   defaultThemes

package/dist/orama-cloud-QNHGN6SO.js

@@ -0,0 +1,50 @@
+import {
+  removeUndefined
+} from "./chunk-2V6SCS43.js";
+import "./chunk-MLKGABMK.js";
+
+// src/search/client/orama-cloud.ts
+async function searchDocs(query, tag, options) {
+  const { client, params: extraParams = {} } = options;
+  const params = {
+    ...extraParams,
+    term: query,
+    where: removeUndefined({
+      tag,
+      ...extraParams.where
+    }),
+    groupBy: {
+      properties: ["page_id"],
+      maxResult: 7,
+      ...extraParams.groupBy
+    }
+  };
+  const result = await client.search(params);
+  if (!result) return [];
+  const list = [];
+  for (const item of result.groups ?? []) {
+    let addedHead = false;
+    for (const hit of item.result) {
+      const doc = hit.document;
+      if (!addedHead) {
+        list.push({
+          id: doc.page_id,
+          type: "page",
+          content: doc.title,
+          url: doc.url
+        });
+        addedHead = true;
+      }
+      list.push({
+        id: doc.id,
+        content: doc.content,
+        type: doc.content === doc.section ? "heading" : "text",
+        url: doc.section_id ? `${doc.url}#${doc.section_id}` : doc.url
+      });
+    }
+  }
+  return list;
+}
+export {
+  searchDocs
+};

package/dist/remark-heading-BPCoYwjn.d.ts

@@ -0,0 +1,31 @@
+import { Root, Heading } from 'mdast';
+import { Transformer } from 'unified';
+
+declare module 'mdast' {
+    interface HeadingData extends Data {
+        hProperties?: {
+            id?: string;
+        };
+    }
+}
+interface RemarkHeadingOptions {
+    slug?: (root: Root, heading: Heading, text: string) => string;
+    /**
+     * Allow custom headings ids
+     *
+     * @defaultValue true
+     */
+    customId?: boolean;
+    /**
+     * Attach an array of `TOCItemType` to `file.data.toc`
+     *
+     * @defaultValue true
+     */
+    generateToc?: boolean;
+}
+/**
+ * Add heading ids and extract TOC
+ */
+declare function remarkHeading({ slug: defaultSlug, customId, generateToc, }?: RemarkHeadingOptions): Transformer<Root, Root>;
+
+export { type RemarkHeadingOptions as R, remarkHeading as r };

package/dist/search/client.d.ts

@@ -1,6 +1,7 @@
 import { S as SortedResult } from '../types-Ch8gnVgO.js';
 import { SearchOptions } from '@algolia/client-search';
 import { SearchIndex } from 'algoliasearch/lite';
+import { OramaClient, ClientSearchParams } from '@oramacloud/client';
 
 interface FetchOptions {
     /**
@@ -20,6 +21,11 @@ interface AlgoliaOptions extends SearchOptions {
     index: SearchIndex;
 }
 
+interface OramaCloudOptions {
+    client: OramaClient;
+    params?: ClientSearchParams;
+}
+
 interface UseDocsSearch {
     search: string;
     setSearch: (v: string) => void;
@@ -35,7 +41,9 @@ type Client = ({
     type: 'static';
 } & StaticOptions) | ({
     type: 'algolia';
-} & AlgoliaOptions);
+} & AlgoliaOptions) | ({
+    type: 'orama-cloud';
+} & OramaCloudOptions);
 /**
  * @param client - search client
  * @param locale - Filter with locale
@@ -46,4 +54,4 @@ type Client = ({
  */
 declare function useDocsSearch(client: Client, locale?: string, tag?: string, delayMs?: number, allowEmpty?: boolean, key?: string): UseDocsSearch;
 
-export { useDocsSearch };
+export { type AlgoliaOptions, type FetchOptions, type OramaCloudOptions, type StaticOptions, useDocsSearch };

package/dist/search/client.js

@@ -33,8 +33,8 @@ function useDocsSearch(client, locale, tag, delayMs = 100, allowEmpty = false, k
   const debouncedValue = useDebounce(search, delayMs);
   const onStart = useRef2();
   const cacheKey = useMemo(() => {
-    return key ?? JSON.stringify([client, debouncedValue, locale, tag]);
-  }, [client, debouncedValue, locale, tag, key]);
+    return key ?? JSON.stringify([client.type, debouncedValue, locale, tag]);
+  }, [client.type, debouncedValue, locale, tag, key]);
   useOnChange(cacheKey, () => {
     const cached = cache.get(cacheKey);
     if (onStart.current) {
@@ -63,6 +63,10 @@ function useDocsSearch(client, locale, tag, delayMs = 100, allowEmpty = false, k
         const { searchDocs } = await import("../algolia-NTWLS6J3.js");
         return searchDocs(index, debouncedValue, tag, rest);
       }
+      if (client.type === "orama-cloud") {
+        const { searchDocs } = await import("../orama-cloud-QNHGN6SO.js");
+        return searchDocs(debouncedValue, tag, client);
+      }
       const { createStaticClient } = await import("../static-5GPJ7RUY.js");
       if (!staticClient) staticClient = createStaticClient(client);
       return staticClient.search(debouncedValue, locale, tag);

package/dist/search/orama-cloud.d.ts

@@ -0,0 +1,76 @@
+import { CloudManager } from '@oramacloud/client';
+import { S as StructuredData } from '../remark-structure-mP51W1AN.js';
+import '../remark-heading-BPCoYwjn.js';
+import 'mdast';
+import 'unified';
+import 'unist-util-visit';
+
+interface SyncOptions {
+    /**
+     * Index name to sync
+     */
+    index: string;
+    documents: OramaDocument[];
+    /**
+     * Deploy changes
+     *
+     * @defaultValue true
+     */
+    autoDeploy?: boolean;
+}
+type I18nSyncOptions = Omit<SyncOptions, 'index' | 'documents'> & {
+    /**
+     * Indexes to sync.
+     *
+     * Pairs of `locale`-`index`.
+     **/
+    indexes: Record<string, string>;
+    documents: {
+        locale: string;
+        items: OramaDocument[];
+    }[];
+};
+interface OramaDocument {
+    /**
+     * The ID of document, must be unique
+     */
+    id: string;
+    title: string;
+    description?: string;
+    /**
+     * URL to the page
+     */
+    url: string;
+    structured: StructuredData;
+    /**
+     * Tag to filter results
+     */
+    tag?: string;
+    /**
+     * Data to be added to each section index
+     */
+    extra_data?: object;
+}
+interface OramaIndex {
+    id: string;
+    title: string;
+    url: string;
+    tag?: string;
+    /**
+     * The id of page, used for `group by`
+     */
+    page_id: string;
+    /**
+     * Heading content
+     */
+    section?: string;
+    /**
+     * Heading (anchor) id
+     */
+    section_id?: string;
+    content: string;
+}
+declare function sync(cloudManager: CloudManager, options: SyncOptions): Promise<void>;
+declare function syncI18n(cloudManager: CloudManager, options: I18nSyncOptions): Promise<void>;
+
+export { type I18nSyncOptions, type OramaDocument, type OramaIndex, type SyncOptions, sync, syncI18n };

package/dist/search/orama-cloud.js

@@ -0,0 +1,52 @@
+import "../chunk-MLKGABMK.js";
+
+// src/search/orama-cloud.ts
+async function sync(cloudManager, options) {
+  const { autoDeploy = true } = options;
+  const index = cloudManager.index(options.index);
+  await index.snapshot(options.documents.flatMap(toIndex));
+  if (autoDeploy) await index.deploy();
+}
+async function syncI18n(cloudManager, options) {
+  const { autoDeploy = true } = options;
+  const tasks = options.documents.map(async (document) => {
+    const index = cloudManager.index(options.indexes[document.locale]);
+    await index.snapshot(document.items.flatMap(toIndex));
+    if (autoDeploy) await index.deploy();
+  });
+  await Promise.all(tasks);
+}
+function toIndex(page) {
+  let id = 0;
+  const indexes = [];
+  const scannedHeadings = /* @__PURE__ */ new Set();
+  function createIndex(section, sectionId, content) {
+    return {
+      id: `${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);
+      indexes.push(createIndex(heading.content, heading.id, heading.content));
+    }
+    indexes.push(index);
+  });
+  return indexes;
+}
+export {
+  sync,
+  syncI18n
+};

package/dist/server/index.d.ts

@@ -1,4 +1,4 @@
-export { a as TOCItemType, T as TableOfContents, g as getTableOfContents } from '../get-toc-CM4X3hbw.js';
+export { a as TOCItemType, T as TableOfContents, g as getTableOfContents } from '../get-toc-Dm1yr2Gr.js';
 import { N as Node, I as Item, R as Root } from '../page-tree-r8qjoUla.js';
 export { p as PageTree } from '../page-tree-r8qjoUla.js';
 export { S as SortedResult } from '../types-Ch8gnVgO.js';

package/dist/server/index.js

@@ -10,8 +10,8 @@ import "../chunk-MLKGABMK.js";
 
 // src/server/get-toc.ts
 import { remark } from "remark";
-async function getTableOfContents(content) {
-  const result = await remark().use(remarkHeading).process(content);
+function getTableOfContents(content) {
+  const result = remark().use(remarkHeading).processSync(content);
   if ("toc" in result.data) return result.data.toc;
   return [];
 }

package/dist/toc.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, RefObject, AnchorHTMLAttributes } from 'react';
-import { T as TableOfContents } from './get-toc-CM4X3hbw.js';
+import { T as TableOfContents } from './get-toc-Dm1yr2Gr.js';
 
 /**
  * The estimated active heading ID

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "14.1.1",
+  "version": "14.2.1",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -36,6 +36,10 @@
       "import": "./dist/search/algolia.js",
       "types": "./dist/search/algolia.d.ts"
     },
+    "./search/orama-cloud": {
+      "import": "./dist/search/orama-cloud.js",
+      "types": "./dist/search/orama-cloud.d.ts"
+    },
     "./server": {
       "import": "./dist/server/index.js",
       "types": "./dist/server/index.d.ts"
@@ -87,17 +91,18 @@
   "devDependencies": {
     "@algolia/client-search": "4.24.0",
     "@mdx-js/mdx": "^3.1.0",
+    "@oramacloud/client": "^1.3.19",
     "@types/estree-jsx": "^1.0.5",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "22.8.1",
+    "@types/node": "22.8.6",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
     "algoliasearch": "4.24.0",
     "mdast-util-mdx-jsx": "^3.1.3",
     "mdast-util-mdxjs-esm": "^2.0.1",
-    "next": "^15.0.0",
+    "next": "^15.0.2",
     "remark-mdx": "^3.1.0",
     "remark-rehype": "^11.1.1",
     "shiki-transformers": "^1.0.0",
@@ -106,12 +111,16 @@
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {
+    "@oramacloud/client": "1.x.x",
     "algoliasearch": "4.24.0",
     "next": "14.x.x || 15.x.x",
     "react": ">= 18",
     "react-dom": ">= 18"
   },
   "peerDependenciesMeta": {
+    "@oramacloud/client": {
+      "optional": true
+    },
     "algoliasearch": {
       "optional": true
     },