fumadocs-core 13.4.10 → 14.0.0

package/dist/sidebar.js

@@ -19,11 +19,13 @@ function useSidebarContext() {
 }
 function SidebarProvider(props) {
   const [openInner, setOpenInner] = useState(false);
-  const [open, setOpen] = [
-    props.open ?? openInner,
-    props.onOpenChange ?? setOpenInner
-  ];
-  return /* @__PURE__ */ jsx(SidebarContext.Provider, { value: [open, setOpen], children: props.children });
+  return /* @__PURE__ */ jsx(
+    SidebarContext.Provider,
+    {
+      value: [props.open ?? openInner, props.onOpenChange ?? setOpenInner],
+      children: props.children
+    }
+  );
 }
 function SidebarTrigger({
   as,

package/dist/source/index.d.ts

@@ -1,8 +1,11 @@
 import { ReactElement } from 'react';
 import { I as I18nConfig } from '../config-inq6kP6y.js';
-import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-BTCDMLTU.js';
+import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-r8qjoUla.js';
 
 interface FileInfo {
+    /**
+     * The locale extension of file
+     */
     locale?: string;
     /**
      * Original path of file
@@ -76,20 +79,6 @@ interface LoaderOptions {
      * Configure i18n
      */
     i18n?: I18nConfig;
-    /**
-     * Accepted languages.
-     *
-     * A page tree will be built for each language.
-     *
-     * @deprecated Use `i18n` instead
-     */
-    languages?: string[];
-    /**
-     * Default locale when locale is not provided.
-     *
-     * @deprecated Use `i18n` instead
-     */
-    defaultLanguage?: string;
 }
 interface Source<Config extends SourceConfig> {
     /**
@@ -103,6 +92,7 @@ interface Page<Data = PageData> {
     slugs: string[];
     url: string;
     data: Data;
+    locale?: string | undefined;
 }
 interface Meta<Data = MetaData> {
     file: FileInfo;
@@ -114,7 +104,7 @@ interface LanguageEntry<Data = PageData> {
 }
 interface LoaderOutput<Config extends LoaderConfig> {
     pageTree: Config['i18n'] extends true ? Record<string, Root> : Root;
-    files: File[];
+    _i18n?: I18nConfig;
     /**
      * Get list of pages from language, empty if language hasn't specified
      *
@@ -126,17 +116,19 @@ interface LoaderOutput<Config extends LoaderConfig> {
      * @param language - If empty, the default language will be used
      */
     getPage: (slugs: string[] | undefined, language?: string) => Page<Config['source']['pageData']> | undefined;
+    getNodePage: (node: Item) => Page<Config['source']['pageData']> | undefined;
+    getNodeMeta: (node: Folder$1) => Meta<Config['source']['metaData']> | undefined;
     /**
      * generate static params for Next.js SSG
      */
     generateParams: <TSlug extends string = 'slug', TLang extends string = 'lang'>(slug?: TSlug, lang?: TLang) => (Record<TSlug, string[]> & Record<TLang, string>)[];
 }
-declare function createGetUrl(baseUrl: string): UrlFn;
+declare function createGetUrl(baseUrl: string, i18n?: I18nConfig): UrlFn;
 declare function getSlugs(info: FileInfo): string[];
 type InferSourceConfig<T> = T extends Source<infer Config> ? Config : never;
 declare function loader<Options extends LoaderOptions>(options: Options): LoaderOutput<{
     source: InferSourceConfig<Options['source']>;
-    i18n: Options['i18n'] extends I18nConfig ? true : Options['languages'] extends string[] ? true : false;
+    i18n: Options['i18n'] extends I18nConfig ? true : false;
 }>;
 
 interface MetaData {
@@ -145,6 +137,7 @@ interface MetaData {
     root?: boolean | undefined;
     pages?: string[] | undefined;
     defaultOpen?: boolean | undefined;
+    description?: string | undefined;
 }
 interface PageData {
     icon?: string | undefined;
@@ -160,9 +153,7 @@ type UrlFn = (slugs: string[], locale?: string) => string;
 interface MetaFile {
     file: FileInfo;
     format: 'meta';
-    data: {
-        data: MetaData;
-    };
+    data: MetaData;
 }
 interface PageFile {
     file: FileInfo;
@@ -215,11 +206,11 @@ declare namespace fileSystem {
 
 interface BuildPageTreeOptions {
     /**
-     * Attach the `folder.id` property
+     * Remove references to the file path of original nodes (`$ref`)
      *
      * @defaultValue false
      */
-    attachFolderIds?: boolean;
+    noRef?: boolean;
     attachFile?: (node: Item, file?: PageFile) => Item;
     attachFolder?: (node: Folder$1, folder: Folder, meta?: MetaFile) => Folder$1;
     attachSeparator?: (node: Separator) => Separator;

package/dist/source/index.js

@@ -1,3 +1,6 @@
+import {
+  removeUndefined
+} from "../chunk-2V6SCS43.js";
 import {
   slash
 } from "../chunk-UWEEHUJV.js";
@@ -145,7 +148,7 @@ function buildFolderNode(folder, isGlobalRoot, ctx) {
     resolvePath(folder.file.flattenedPath, "index"),
     "page"
   );
-  const metadata = meta?.data.data;
+  const metadata = meta?.data;
   const index = indexFile ? buildFileNode(indexFile, ctx) : void 0;
   let children;
   if (!meta) {
@@ -175,30 +178,27 @@ function buildFolderNode(folder, isGlobalRoot, ctx) {
     icon: ctx.options.resolveIcon?.(metadata?.icon) ?? index?.icon,
     root: metadata?.root,
     defaultOpen: metadata?.defaultOpen,
+    description: metadata?.description,
     index,
-    children
+    children,
+    $ref: !ctx.options.noRef ? {
+      metaFile: meta?.file.path
+    } : void 0
   };
-  if (ctx.options.attachFolderIds) {
-    node.id = folder.file.flattenedPath;
-  }
   return removeUndefined(
     ctx.options.attachFolder?.(node, folder, meta) ?? node
   );
 }
 function buildFileNode(file, ctx) {
-  let urlLocale;
   const localized = findLocalizedFile(file.file.flattenedPath, "page", ctx) ?? file;
-  const hideLocale = ctx.i18n?.hideLocale ?? "never";
-  if (hideLocale === "never") {
-    urlLocale = ctx.lang;
-  } else if (hideLocale === "default-locale" && ctx.lang !== ctx.i18n?.defaultLanguage) {
-    urlLocale = ctx.lang;
-  }
   const item = {
     type: "page",
     name: localized.data.data.title,
     icon: ctx.options.resolveIcon?.(localized.data.data.icon),
-    url: ctx.options.getUrl(localized.data.slugs, urlLocale)
+    url: ctx.options.getUrl(localized.data.slugs, ctx.lang),
+    $ref: !ctx.options.noRef ? {
+      file: localized.file.path
+    } : void 0
   };
   return removeUndefined(ctx.options.attachFile?.(item, file) ?? item);
 }
@@ -248,13 +248,6 @@ function pathToName(name, resolveGroup = false) {
   }
   return result.join("");
 }
-function removeUndefined(value) {
-  const obj = value;
-  Object.keys(obj).forEach((key) => {
-    if (obj[key] === void 0) delete obj[key];
-  });
-  return value;
-}
 
 // src/source/file-system.ts
 var file_system_exports = {};
@@ -329,9 +322,7 @@ function loadFiles(files, options) {
       });
     }
     if (file.type === "meta") {
-      storage.write(relativePath, file.type, {
-        data: file.data
-      });
+      storage.write(relativePath, file.type, file.data);
     }
   }
   for (const transformer of transformers) {
@@ -344,30 +335,47 @@ function loadFiles(files, options) {
 }
 
 // src/source/loader.ts
-function buildPageMap(storage, getUrl, languages = []) {
-  const map = /* @__PURE__ */ new Map();
+function indexPages(storage, getUrl, languages = []) {
+  const i18n = /* @__PURE__ */ new Map();
+  const pages = /* @__PURE__ */ new Map();
+  const metas = /* @__PURE__ */ new Map();
   const defaultMap = /* @__PURE__ */ new Map();
-  map.set("", defaultMap);
+  i18n.set("", defaultMap);
   for (const file of storage.list()) {
-    if (file.format !== "page" || file.file.locale) continue;
-    const page = fileToPage(file, getUrl);
-    defaultMap.set(page.slugs.join("/"), page);
-    for (const lang of languages) {
-      const langMap = map.get(lang) ?? /* @__PURE__ */ new Map();
-      const localized = storage.read(
-        `${file.file.flattenedPath}.${lang}`,
-        "page"
-      );
-      const localizedPage = fileToPage(localized ?? file, getUrl, lang);
-      langMap.set(localizedPage.slugs.join("/"), localizedPage);
-      map.set(lang, langMap);
+    if (file.format === "meta") metas.set(file.file.path, fileToMeta(file));
+    if (file.format === "page") {
+      const page = fileToPage(file, getUrl, file.file.locale);
+      pages.set(file.file.path, page);
+      if (file.file.locale) continue;
+      defaultMap.set(page.slugs.join("/"), page);
+      for (const lang of languages) {
+        const langMap = i18n.get(lang) ?? /* @__PURE__ */ new Map();
+        const localized = storage.read(
+          `${file.file.flattenedPath}.${lang}`,
+          "page"
+        );
+        const localizedPage = fileToPage(localized ?? file, getUrl, lang);
+        langMap.set(localizedPage.slugs.join("/"), localizedPage);
+        i18n.set(lang, langMap);
+      }
     }
   }
-  return map;
+  return {
+    i18n,
+    pathToPage: pages,
+    pathToMeta: metas
+  };
 }
-function createGetUrl(baseUrl) {
+function createGetUrl(baseUrl, i18n) {
   return (slugs, locale) => {
-    const paths = locale ? [locale, ...baseUrl.split("/"), ...slugs] : [...baseUrl.split("/"), ...slugs];
+    const hideLocale = i18n?.hideLocale ?? "never";
+    let urlLocale;
+    if (hideLocale === "never") {
+      urlLocale = locale;
+    } else if (hideLocale === "default-locale" && locale !== i18n?.defaultLanguage) {
+      urlLocale = locale;
+    }
+    const paths = urlLocale ? [urlLocale, ...baseUrl.split("/"), ...slugs] : [...baseUrl.split("/"), ...slugs];
     return `/${paths.filter((v) => v.length > 0).join("/")}`;
   };
 }
@@ -381,62 +389,47 @@ function getSlugs(info) {
   );
 }
 function loader(options) {
-  if (options.languages) {
-    console.warn(
-      "Fumadocs: It's highly recommended to use `i18n` config instead of passing `languages` to loader."
-    );
-    return createOutput({
-      ...options,
-      i18n: {
-        languages: options.languages,
-        defaultLanguage: options.defaultLanguage
-      }
-    });
-  }
   return createOutput(options);
 }
-function createOutput({
-  source,
-  icon: resolveIcon,
-  rootDir = "",
-  transformers,
-  baseUrl = "/",
-  slugs: slugsFn = getSlugs,
-  url: getUrl = createGetUrl(baseUrl),
-  pageTree: pageTreeOptions = {},
-  i18n
-}) {
+function createOutput(options) {
+  const {
+    source,
+    rootDir = "",
+    baseUrl = "/",
+    slugs: slugsFn = getSlugs,
+    url: getUrl = createGetUrl(baseUrl, options.i18n)
+  } = options;
   const storage = loadFiles(
     typeof source.files === "function" ? source.files(rootDir) : source.files,
     {
-      transformers,
+      transformers: options.transformers,
       rootDir,
       getSlugs: slugsFn
     }
   );
-  const i18nMap = buildPageMap(storage, getUrl, i18n?.languages);
+  const walker = indexPages(storage, getUrl, options.i18n?.languages);
   const builder = createPageTreeBuilder();
-  const pageTree = i18n === void 0 ? builder.build({
+  const pageTree = options.i18n === void 0 ? builder.build({
     storage,
-    resolveIcon,
+    resolveIcon: options.icon,
     getUrl,
-    ...pageTreeOptions
+    ...options.pageTree
   }) : builder.buildI18n({
     storage,
-    resolveIcon,
+    resolveIcon: options.icon,
     getUrl,
-    i18n,
-    ...pageTreeOptions
+    i18n: options.i18n,
+    ...options.pageTree
   });
   return {
+    _i18n: options.i18n,
     pageTree,
-    files: storage.list(),
-    getPages(language = i18n?.defaultLanguage ?? "") {
-      return Array.from(i18nMap.get(language)?.values() ?? []);
+    getPages(language = options.i18n?.defaultLanguage ?? "") {
+      return Array.from(walker.i18n.get(language)?.values() ?? []);
     },
     getLanguages() {
       const list = [];
-      for (const [language, pages] of i18nMap) {
+      for (const [language, pages] of walker.i18n) {
         if (language === "") continue;
         list.push({
           language,
@@ -445,12 +438,20 @@ function createOutput({
       }
       return list;
     },
-    getPage(slugs = [], language = i18n?.defaultLanguage ?? "") {
-      return i18nMap.get(language)?.get(slugs.join("/"));
+    getPage(slugs = [], language = options.i18n?.defaultLanguage ?? "") {
+      return walker.i18n.get(language)?.get(slugs.join("/"));
+    },
+    getNodeMeta(node) {
+      if (!node.$ref?.metaFile) return;
+      return walker.pathToMeta.get(node.$ref.metaFile);
+    },
+    getNodePage(node) {
+      if (!node.$ref?.file) return;
+      return walker.pathToPage.get(node.$ref.file);
     },
     // @ts-expect-error -- ignore this
     generateParams(slug, lang) {
-      if (i18n) {
+      if (options.i18n) {
         return this.getLanguages().flatMap(
           (entry) => entry.pages.map((page) => ({
             [slug ?? "slug"]: page.slugs,
@@ -458,18 +459,25 @@ function createOutput({
           }))
         );
       }
-      return Array.from(i18nMap.get("")?.values() ?? []).map((page) => ({
+      return Array.from(walker.i18n.get("")?.values() ?? []).map((page) => ({
         [slug ?? "slug"]: page.slugs
       }));
     }
   };
 }
+function fileToMeta(file) {
+  return {
+    file: file.file,
+    data: file.data
+  };
+}
 function fileToPage(file, getUrl, locale) {
   return {
     file: file.file,
     url: getUrl(file.data.slugs, locale),
     slugs: file.data.slugs,
-    data: file.data.data
+    data: file.data.data,
+    locale
   };
 }
 export {

package/dist/static-5GPJ7RUY.js

@@ -0,0 +1,60 @@
+import {
+  searchAdvanced,
+  searchSimple
+} from "./chunk-2ZSMGYVH.js";
+import "./chunk-2V6SCS43.js";
+import "./chunk-MLKGABMK.js";
+
+// src/search/client/static.ts
+import {
+  create,
+  load
+} from "@orama/orama";
+function createStaticClient({
+  from = "/api/search"
+}) {
+  const dbs = /* @__PURE__ */ new Map();
+  async function init() {
+    const res = await fetch(from);
+    if (!res.ok)
+      throw new Error(
+        `failed to fetch exported search indexes from ${from}, make sure the search database is exported and available for client.`
+      );
+    const data = await res.json();
+    if (data.type === "i18n") {
+      Object.entries(data.data).forEach(([k, v]) => {
+        const db = create({ schema: { _: "string" } });
+        load(db, v);
+        dbs.set(k, {
+          type: v.type,
+          db
+        });
+      });
+    } else {
+      const db = create({ schema: { _: "string" } });
+      load(db, data);
+      dbs.set("", {
+        type: data.type,
+        db
+      });
+    }
+  }
+  const get = init();
+  return {
+    async search(query, locale, tag) {
+      await get;
+      const cached = dbs.get(locale ?? "");
+      if (!cached) return [];
+      if (cached.type === "simple")
+        return searchSimple(cached, query);
+      return searchAdvanced(
+        cached.db,
+        query,
+        tag
+      );
+    }
+  };
+}
+export {
+  createStaticClient
+};

package/dist/toc.js

@@ -1,7 +1,7 @@
 "use client";
 import {
   useOnChange
-} from "./chunk-KGMG4N3Y.js";
+} from "./chunk-I5BWASD6.js";
 import "./chunk-MLKGABMK.js";
 
 // src/toc.tsx

package/dist/{search/shared.d.ts → types-Ch8gnVgO.d.ts}

@@ -5,4 +5,4 @@ interface SortedResult {
     content: string;
 }
 
-export type { SortedResult };
+export type { SortedResult as S };

package/dist/utils/use-on-change.d.ts

@@ -1,3 +1,8 @@
-declare function useOnChange<T>(value: T, onChange: (current: T, previous: T) => void): void;
+/**
+ * @param value - state to watch
+ * @param onChange - when the state changed
+ * @param isUpdated - a function that determines if the state is updated
+ */
+declare function useOnChange<T>(value: T, onChange: (current: T, previous: T) => void, isUpdated?: (prev: T, current: T) => boolean): void;
 
 export { useOnChange };

package/dist/utils/use-on-change.js

@@ -1,6 +1,6 @@
 import {
   useOnChange
-} from "../chunk-KGMG4N3Y.js";
+} from "../chunk-I5BWASD6.js";
 import "../chunk-MLKGABMK.js";
 export {
   useOnChange

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "13.4.10",
+  "version": "14.0.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -28,14 +28,14 @@
       "import": "./dist/search/client.js",
       "types": "./dist/search/client.d.ts"
     },
-    "./search/shared": {
-      "import": "./dist/search/shared.js",
-      "types": "./dist/search/shared.d.ts"
-    },
     "./search/server": {
       "import": "./dist/search/server.js",
       "types": "./dist/search/server.d.ts"
     },
+    "./search/algolia": {
+      "import": "./dist/search/algolia.js",
+      "types": "./dist/search/algolia.d.ts"
+    },
     "./server": {
       "import": "./dist/server/index.js",
       "types": "./dist/server/index.d.ts"
@@ -52,116 +52,57 @@
       "import": "./dist/link.js",
       "types": "./dist/link.d.ts"
     },
-    "./middleware": {
-      "import": "./dist/middleware.js",
-      "types": "./dist/middleware.d.ts"
-    },
     "./mdx-plugins": {
       "import": "./dist/mdx-plugins/index.js",
       "types": "./dist/mdx-plugins/index.d.ts"
     },
-    "./search-algolia/client": {
-      "import": "./dist/search-algolia/client.js",
-      "types": "./dist/search-algolia/client.d.ts"
-    },
-    "./search-algolia/server": {
-      "import": "./dist/search-algolia/server.js",
-      "types": "./dist/search-algolia/server.d.ts"
-    },
     "./i18n": {
       "import": "./dist/i18n/index.js",
       "types": "./dist/i18n/index.d.ts"
     }
   },
-  "typesVersions": {
-    "*": {
-      "sidebar": [
-        "./dist/sidebar.d.ts"
-      ],
-      "breadcrumb": [
-        "./dist/breadcrumb.d.ts"
-      ],
-      "toc": [
-        "./dist/toc.d.ts"
-      ],
-      "search/client": [
-        "./dist/search/client.d.ts"
-      ],
-      "search/shared": [
-        "./dist/search/shared.d.ts"
-      ],
-      "search/server": [
-        "./dist/search/server.d.ts"
-      ],
-      "server": [
-        "./dist/server/index.d.ts"
-      ],
-      "source": [
-        "./dist/source/index.d.ts"
-      ],
-      "link": [
-        "./dist/link.d.ts"
-      ],
-      "middleware": [
-        "./dist/middleware.d.ts"
-      ],
-      "utils/use-on-change": [
-        "./dist/utils/use-on-change.d.ts"
-      ],
-      "mdx-plugins": [
-        "./dist/mdx-plugins/index.d.ts"
-      ],
-      "search-algolia/client": [
-        "./dist/search-algolia/client.d.ts"
-      ],
-      "search-algolia/server": [
-        "./dist/search-algolia/server.d.ts"
-      ],
-      "i18n": [
-        "./dist/i18n/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist/*"
   ],
   "dependencies": {
-    "@formatjs/intl-localematcher": "^0.5.4",
-    "@shikijs/rehype": "^1.16.2",
-    "@shikijs/transformers": "^1.16.2",
-    "flexsearch": "0.7.21",
+    "@formatjs/intl-localematcher": "^0.5.5",
+    "@orama/orama": "^3.0.1",
+    "@shikijs/rehype": "^1.22.0",
+    "@shikijs/transformers": "^1.22.0",
     "github-slugger": "^2.0.0",
+    "hast-util-to-estree": "^3.1.0",
     "image-size": "^1.1.1",
-    "negotiator": "^0.6.3",
-    "npm-to-yarn": "^3.0.0",
-    "react-remove-scroll": "^2.5.10",
+    "negotiator": "^1.0.0",
+    "react-remove-scroll": "^2.6.0",
     "remark": "^15.0.0",
     "remark-gfm": "^4.0.0",
-    "remark-mdx": "^3.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "^1.16.2",
-    "swr": "^2.2.5",
+    "shiki": "^1.22.0",
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
-    "@algolia/client-search": "^4.24.0",
-    "@mdx-js/mdx": "^3.0.1",
+    "@algolia/client-search": "4.24.0",
+    "@mdx-js/mdx": "^3.1.0",
     "@types/estree-jsx": "^1.0.5",
-    "@types/flexsearch": "0.7.6",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "22.5.4",
-    "@types/react": "^18.3.5",
-    "@types/react-dom": "^18.3.0",
-    "algoliasearch": "^4.24.0",
-    "next": "^14.2.8",
+    "@types/node": "22.7.7",
+    "@types/react": "^18.3.11",
+    "@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",
+    "remark-mdx": "^3.1.0",
+    "remark-rehype": "^11.1.1",
     "unified": "^11.0.5",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"
   },
-  "peerDependencies": {
-    "next": ">= 14.1.0",
+  "optionalDependencies": {
+    "algoliasearch": "4.24.0",
+    "next": "15.0.0",
     "react": ">= 18",
     "react-dom": ">= 18"
   },