fumadocs-core 14.1.0 → 14.2.0

package/dist/chunk-SHGL6VBO.js

@@ -0,0 +1,33 @@
+// src/utils/path.ts
+function splitPath(path) {
+  return path.split("/").filter((p) => p.length > 0);
+}
+function resolvePath(from, join) {
+  const v1 = splitPath(from), v2 = splitPath(join);
+  while (v2.length > 0) {
+    switch (v2[0]) {
+      case "..":
+        v1.pop();
+        break;
+      case ".":
+        break;
+      default:
+        v1.push(v2[0]);
+    }
+    v2.shift();
+  }
+  return v1.join("/");
+}
+function slash(path) {
+  const isExtendedLengthPath = path.startsWith("\\\\?\\");
+  if (isExtendedLengthPath) {
+    return path;
+  }
+  return path.replaceAll("\\", "/");
+}
+
+export {
+  splitPath,
+  resolvePath,
+  slash
+};

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 {
@@ -52,7 +53,7 @@ declare function transformerTab(): ShikiTransformer;
 
 interface RemarkImageOptions {
     /**
-     * Directory to resolve absolute image paths
+     * Directory or base URL to resolve absolute image paths
      */
     publicDir?: string;
     /**
@@ -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

@@ -2,13 +2,14 @@ import {
   flattenNode,
   remarkHeading
 } from "../chunk-4MNUWZIW.js";
+import {
+  resolvePath,
+  slash
+} from "../chunk-SHGL6VBO.js";
 import {
   createStyleTransformer,
   defaultThemes
 } from "../chunk-7CSWJQ5H.js";
-import {
-  slash
-} from "../chunk-UWEEHUJV.js";
 import "../chunk-MLKGABMK.js";
 
 // src/mdx-plugins/index.ts
@@ -550,57 +551,58 @@ function remarkImage({
     const promises = [];
     function getImportPath(src) {
       if (!src.startsWith("/")) return src;
-      if (file.path) {
-        const relative = path.relative(
-          path.dirname(file.path),
-          path.join(publicDir, src)
-        );
+      const to = path.join(publicDir, src);
+      if (file.dirname) {
+        const relative = slash(path.relative(file.dirname, to));
         return relative.startsWith("./") ? relative : `./${relative}`;
       }
-      return path.join(publicDir, src);
+      return slash(to);
     }
     visit(tree, "image", (node) => {
-      const src = decodeURI(node.url);
-      if (!src) return;
-      const isExternal = EXTERNAL_URL_REGEX.test(src);
+      const url = decodeURI(node.url);
+      if (!url) return;
+      const isExternal = EXTERNAL_URL_REGEX.test(url);
       if (isExternal && external || !useImport) {
-        promises.push(
-          getImageSize(src, publicDir).then((size) => {
-            if (!size.width || !size.height) return;
-            Object.assign(node, {
-              type: "mdxJsxFlowElement",
-              name: "img",
-              attributes: [
-                {
-                  type: "mdxJsxAttribute",
-                  name: "alt",
-                  value: node.alt ?? "image"
-                },
-                {
-                  type: "mdxJsxAttribute",
-                  name: "src",
-                  value: src
-                },
-                {
-                  type: "mdxJsxAttribute",
-                  name: "width",
-                  value: size.width.toString()
-                },
-                {
-                  type: "mdxJsxAttribute",
-                  name: "height",
-                  value: size.height.toString()
-                }
-              ]
-            });
-          })
-        );
+        const task = getImageSize(url, publicDir).then((size) => {
+          if (!size.width || !size.height) return;
+          Object.assign(node, {
+            type: "mdxJsxFlowElement",
+            name: "img",
+            attributes: [
+              {
+                type: "mdxJsxAttribute",
+                name: "alt",
+                value: node.alt ?? "image"
+              },
+              {
+                type: "mdxJsxAttribute",
+                name: "src",
+                value: url
+              },
+              {
+                type: "mdxJsxAttribute",
+                name: "width",
+                value: size.width.toString()
+              },
+              {
+                type: "mdxJsxAttribute",
+                name: "height",
+                value: size.height.toString()
+              }
+            ]
+          });
+        }).catch(() => {
+          console.error(
+            `[Remark Image] Failed obtain image size for ${url} with public directory ${publicDir}`
+          );
+        });
+        promises.push(task);
       } else if (!isExternal) {
         const variableName = `__img${importsToInject.length.toString()}`;
-        const hasBlur = placeholder === "blur" && VALID_BLUR_EXT.some((ext) => src.endsWith(ext));
+        const hasBlur = placeholder === "blur" && VALID_BLUR_EXT.some((ext) => url.endsWith(ext));
         importsToInject.push({
           variableName,
-          importPath: slash(getImportPath(src))
+          importPath: getImportPath(url)
         });
         Object.assign(node, {
           type: "mdxJsxFlowElement",
@@ -665,17 +667,20 @@ function remarkImage({
     }
   };
 }
-function resolveSrc(src, dir) {
-  return src.startsWith("/") || !path.isAbsolute(src) ? path.join(dir, src) : src;
-}
 async function getImageSize(src, dir) {
+  const isRelative = src.startsWith("/") || !path.isAbsolute(src);
+  let url;
   if (EXTERNAL_URL_REGEX.test(src)) {
-    const res = await fetch(src);
-    return sizeOf(
-      await res.arrayBuffer().then((buffer) => new Uint8Array(buffer))
-    );
+    url = src;
+  } else if (EXTERNAL_URL_REGEX.test(dir) && isRelative) {
+    const base = new URL(dir);
+    base.pathname = resolvePath(base.pathname, src);
+    url = base.toString();
+  } else {
+    return sizeOf(isRelative ? path.join(dir, src) : src);
   }
-  return sizeOf(resolveSrc(src, dir));
+  const buffer = await fetch(url).then((res) => res.arrayBuffer());
+  return sizeOf(new Uint8Array(buffer));
 }
 
 // src/mdx-plugins/remark-structure.ts

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/source/index.js

@@ -2,75 +2,14 @@ import {
   removeUndefined
 } from "../chunk-2V6SCS43.js";
 import {
-  slash
-} from "../chunk-UWEEHUJV.js";
+  resolvePath,
+  slash,
+  splitPath
+} from "../chunk-SHGL6VBO.js";
 import {
   __export
 } from "../chunk-MLKGABMK.js";
 
-// src/source/path.ts
-function parseFilePath(path) {
-  const segments = splitPath(slash(path));
-  const dirname = segments.slice(0, -1).join("/");
-  const base = segments.at(-1) ?? "";
-  const dotIdx = base.lastIndexOf(".");
-  const nameWithLocale = dotIdx !== -1 ? base.slice(0, dotIdx) : base;
-  const flattenedPath = [dirname, nameWithLocale].filter((p) => p.length > 0).join("/");
-  const [name, locale] = getLocale(nameWithLocale);
-  return {
-    dirname,
-    name,
-    flattenedPath,
-    locale,
-    path: segments.join("/")
-  };
-}
-function parseFolderPath(path) {
-  const segments = splitPath(slash(path));
-  const base = segments.at(-1) ?? "";
-  const [name, locale] = getLocale(base);
-  const flattenedPath = segments.join("/");
-  return {
-    dirname: segments.slice(0, -1).join("/"),
-    name,
-    flattenedPath,
-    locale,
-    path: flattenedPath
-  };
-}
-function getLocale(name) {
-  const sep = name.lastIndexOf(".");
-  if (sep === -1) return [name];
-  const locale = name.slice(sep + 1);
-  if (/\d+/.exec(locale)) return [name];
-  return [name.slice(0, sep), locale];
-}
-function normalizePath(path) {
-  const segments = splitPath(slash(path));
-  if (segments[0] === "." || segments[0] === "..")
-    throw new Error("It must not start with './' or '../'");
-  return segments.join("/");
-}
-function splitPath(path) {
-  return path.split("/").filter((p) => p.length > 0);
-}
-function resolvePath(from, join) {
-  const v1 = splitPath(from), v2 = splitPath(join);
-  while (v2.length > 0) {
-    switch (v2[0]) {
-      case "..":
-        v1.pop();
-        break;
-      case ".":
-        break;
-      default:
-        v1.push(v2[0]);
-    }
-    v2.shift();
-  }
-  return v1.join("/");
-}
-
 // src/source/page-tree-builder.ts
 var group = /^\((?<name>.+)\)$/;
 var link = /^(?:\[(?<icon>[^\]]+)])?\[(?<name>[^\]]+)]\((?<url>[^)]+)\)$/;
@@ -249,6 +188,50 @@ function pathToName(name, resolveGroup = false) {
   return result.join("");
 }
 
+// src/source/path.ts
+function parseFilePath(path) {
+  const segments = splitPath(slash(path));
+  const dirname = segments.slice(0, -1).join("/");
+  const base = segments.at(-1) ?? "";
+  const dotIdx = base.lastIndexOf(".");
+  const nameWithLocale = dotIdx !== -1 ? base.slice(0, dotIdx) : base;
+  const flattenedPath = [dirname, nameWithLocale].filter((p) => p.length > 0).join("/");
+  const [name, locale] = getLocale(nameWithLocale);
+  return {
+    dirname,
+    name,
+    flattenedPath,
+    locale,
+    path: segments.join("/")
+  };
+}
+function parseFolderPath(path) {
+  const segments = splitPath(slash(path));
+  const base = segments.at(-1) ?? "";
+  const [name, locale] = getLocale(base);
+  const flattenedPath = segments.join("/");
+  return {
+    dirname: segments.slice(0, -1).join("/"),
+    name,
+    flattenedPath,
+    locale,
+    path: flattenedPath
+  };
+}
+function getLocale(name) {
+  const sep = name.lastIndexOf(".");
+  if (sep === -1) return [name];
+  const locale = name.slice(sep + 1);
+  if (/\d+/.exec(locale)) return [name];
+  return [name.slice(0, sep), locale];
+}
+function normalizePath(path) {
+  const segments = splitPath(slash(path));
+  if (segments[0] === "." || segments[0] === "..")
+    throw new Error("It must not start with './' or '../'");
+  return segments.join("/");
+}
+
 // src/source/file-system.ts
 var file_system_exports = {};
 __export(file_system_exports, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "14.1.0",
+  "version": "14.2.0",
   "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,6 +91,7 @@
   "devDependencies": {
     "@algolia/client-search": "4.24.0",
     "@mdx-js/mdx": "^3.1.0",
+    "@oramacloud/client": "^1.3.18",
     "@types/estree-jsx": "^1.0.5",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
@@ -102,16 +107,20 @@
     "remark-rehype": "^11.1.1",
     "shiki-transformers": "^1.0.0",
     "unified": "^11.0.5",
-    "tsconfig": "0.0.0",
-    "eslint-config-custom": "0.0.0"
+    "eslint-config-custom": "0.0.0",
+    "tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "algoliasearch": "4.24.0",
+    "@oramacloud/client": "1.x.x",
     "next": "14.x.x || 15.x.x",
     "react": ">= 18",
     "react-dom": ">= 18"
   },
   "peerDependenciesMeta": {
+    "@oramacloud/client": {
+      "optional": true
+    },
     "algoliasearch": {
       "optional": true
     },

package/dist/chunk-UWEEHUJV.js

@@ -1,12 +0,0 @@
-// src/utils/slash.ts
-function slash(path) {
-  const isExtendedLengthPath = path.startsWith("\\\\?\\");
-  if (isExtendedLengthPath) {
-    return path;
-  }
-  return path.replaceAll("\\", "/");
-}
-
-export {
-  slash
-};