fumadocs-core 15.6.11 → 15.7.0

package/dist/breadcrumb.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { R as Root, N as Node } from './page-tree-bSt6K__E.js';
+import { R as Root, N as Node } from './definitions-Q95-psoo.js';
 
 interface BreadcrumbItem {
     name: ReactNode;

package/dist/chunk-HUTQC33E.js

@@ -0,0 +1,8 @@
+// src/i18n/index.ts
+function defineI18n(config) {
+  return config;
+}
+
+export {
+  defineI18n
+};

package/dist/chunk-KLUGJRZC.js

@@ -0,0 +1,72 @@
+// src/i18n/middleware.ts
+import { match as matchLocale } from "@formatjs/intl-localematcher";
+import Negotiator from "negotiator";
+import { NextResponse } from "next/server";
+var COOKIE = "FD_LOCALE";
+function getLocale(request, locales, defaultLanguage) {
+  const negotiatorHeaders = {};
+  request.headers.forEach((value, key) => {
+    negotiatorHeaders[key] = value;
+  });
+  const languages = new Negotiator({ headers: negotiatorHeaders }).languages(
+    locales
+  );
+  return matchLocale(languages, locales, defaultLanguage);
+}
+var defaultFormat = (locale, path) => {
+  return `/${locale}/${path}`;
+};
+function createI18nMiddleware({
+  languages,
+  defaultLanguage,
+  format = defaultFormat,
+  hideLocale = "never"
+}) {
+  function getUrl(request, pathname, locale) {
+    if (!locale) {
+      return new URL(
+        pathname.startsWith("/") ? pathname : `/${pathname}`,
+        request.url
+      );
+    }
+    return new URL(
+      format(locale, pathname.startsWith("/") ? pathname.slice(1) : pathname),
+      request.url
+    );
+  }
+  return (request) => {
+    const inputPath = `${request.nextUrl.pathname}${request.nextUrl.search}`;
+    const pathLocale = languages.find(
+      (locale) => inputPath.startsWith(`/${locale}/`) || inputPath === `/${locale}`
+    );
+    if (!pathLocale) {
+      if (hideLocale === "default-locale") {
+        return NextResponse.rewrite(
+          getUrl(request, inputPath, defaultLanguage)
+        );
+      }
+      const preferred = getLocale(request, languages, defaultLanguage);
+      if (hideLocale === "always") {
+        const locale = request.cookies.get(COOKIE)?.value ?? preferred;
+        return NextResponse.rewrite(getUrl(request, inputPath, locale));
+      }
+      return NextResponse.redirect(getUrl(request, inputPath, preferred));
+    }
+    if (hideLocale === "always") {
+      const path = inputPath.slice(`/${pathLocale}`.length);
+      const res = NextResponse.redirect(getUrl(request, path));
+      res.cookies.set(COOKIE, pathLocale);
+      return res;
+    }
+    if (hideLocale === "default-locale" && pathLocale === defaultLanguage) {
+      return NextResponse.redirect(
+        getUrl(request, inputPath.slice(`/${pathLocale}`.length))
+      );
+    }
+    return NextResponse.next();
+  };
+}
+
+export {
+  createI18nMiddleware
+};

package/dist/{chunk-3NX26V7I.js → chunk-NJLFLPV4.js}

@@ -106,8 +106,6 @@ async function highlight(code, options) {
 
 export {
   defaultThemes,
-  _highlight,
-  _renderHighlight,
   getHighlighter,
   highlight
 };

package/dist/{page-tree-bSt6K__E.d.ts → definitions-Q95-psoo.d.ts}

@@ -1,9 +1,13 @@
-import { ReactNode, ReactElement } from 'react';
+import { ReactNode } from 'react';
 
 interface Root {
     $id?: string;
     name: ReactNode;
     children: Node[];
+    /**
+     * Another page tree that won't be displayed unless being opened.
+     */
+    fallback?: Root;
 }
 type Node = Item | Separator | Folder;
 interface Item {
@@ -19,13 +23,13 @@ interface Item {
     url: string;
     external?: boolean;
     description?: ReactNode;
-    icon?: ReactElement;
+    icon?: ReactNode;
 }
 interface Separator {
     $id?: string;
     type: 'separator';
     name?: ReactNode;
-    icon?: ReactElement;
+    icon?: ReactNode;
 }
 interface Folder {
     $id?: string;
@@ -41,17 +45,17 @@ interface Folder {
     root?: boolean;
     defaultOpen?: boolean;
     index?: Item;
-    icon?: ReactElement;
+    icon?: ReactNode;
     children: Node[];
 }
 
-type pageTree_Folder = Folder;
-type pageTree_Item = Item;
-type pageTree_Node = Node;
-type pageTree_Root = Root;
-type pageTree_Separator = Separator;
-declare namespace pageTree {
-  export type { pageTree_Folder as Folder, pageTree_Item as Item, pageTree_Node as Node, pageTree_Root as Root, pageTree_Separator as Separator };
+type definitions_Folder = Folder;
+type definitions_Item = Item;
+type definitions_Node = Node;
+type definitions_Root = Root;
+type definitions_Separator = Separator;
+declare namespace definitions {
+  export type { definitions_Folder as Folder, definitions_Item as Item, definitions_Node as Node, definitions_Root as Root, definitions_Separator as Separator };
 }
 
-export { type Folder as F, type Item as I, type Node as N, type Root as R, type Separator as S, pageTree as p };
+export { type Folder as F, type Item as I, type Node as N, type Root as R, type Separator as S, definitions as d };

package/dist/highlight/client.d.ts

@@ -4,10 +4,15 @@ import 'shiki';
 import 'shiki/themes';
 import 'hast-util-to-jsx-runtime';
 
-declare function useShiki(code: string, { withPrerenderScript, loading, ...options }: HighlightOptions & {
+declare function useShiki(code: string, options: HighlightOptions & {
+    /**
+     * @deprecated no longer pre-rendered using scripts.
+     */
     withPrerenderScript?: boolean;
     /**
      * Displayed before highlighter is loaded.
+     *
+     * @deprecated use React `Suspense` fallback instead.
      */
     loading?: ReactNode;
 }, deps?: DependencyList): ReactNode;

package/dist/highlight/client.js

@@ -1,88 +1,28 @@
 "use client";
 import {
-  _highlight,
-  _renderHighlight,
   highlight
-} from "../chunk-3NX26V7I.js";
+} from "../chunk-NJLFLPV4.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/highlight/client.tsx
 import {
   use,
-  useEffect,
   useId,
-  useMemo,
-  useRef,
-  useState
+  useMemo
 } from "react";
-import { jsx } from "react/jsx-runtime";
-function useShiki(code, {
-  withPrerenderScript = false,
-  loading,
-  ...options
-}, deps) {
-  const markupId = useId();
-  const key = useMemo(
-    () => deps ? JSON.stringify(deps) : `${options.lang}:${code}`,
-    [code, deps, options.lang]
+var promises = {};
+function useShiki(code, options, deps) {
+  const id = useId();
+  const key = useMemo(() => {
+    const state = deps ? JSON.stringify(deps) : `${options.lang}:${code}`;
+    return `${id}:${state}`;
+  }, [code, deps, id, options.lang]);
+  return use(
+    promises[key] ??= highlight(code, {
+      ...options,
+      engine: options.engine ?? "js"
+    })
   );
-  const shikiOptions = {
-    ...options,
-    engine: options.engine ?? "js"
-  };
-  const currentTask = useRef({
-    key,
-    aborted: false
-  });
-  const [rendered, setRendered] = useState(() => {
-    const element = withPrerenderScript && typeof document !== "undefined" ? document.querySelector(`[data-markup-id="${markupId}"]`) : null;
-    const attr = element?.getAttribute("data-markup");
-    if (attr) {
-      const hast = JSON.parse(attr);
-      return renderHighlightWithMarkup(markupId, hast, shikiOptions, attr);
-    }
-    currentTask.current = void 0;
-    return loading;
-  });
-  useEffect(() => {
-    if (currentTask.current?.key === key) return;
-    if (currentTask.current) {
-      currentTask.current.aborted = true;
-    }
-    const task = {
-      key,
-      aborted: false
-    };
-    currentTask.current = task;
-    void highlight(code, shikiOptions).then((result) => {
-      if (!task.aborted) setRendered(result);
-    });
-  }, [key]);
-  if (typeof window === "undefined") {
-    return use(
-      _highlight(code, shikiOptions).then(
-        (tree) => renderHighlightWithMarkup(markupId, tree, shikiOptions)
-      )
-    );
-  }
-  return rendered;
-}
-function renderHighlightWithMarkup(id, tree, shikiOptions, rawAttr) {
-  const Pre = shikiOptions.components?.pre ?? "pre";
-  return _renderHighlight(tree, {
-    ...shikiOptions,
-    components: {
-      ...shikiOptions.components,
-      pre: (props) => /* @__PURE__ */ jsx(
-        Pre,
-        {
-          ...props,
-          "data-markup-id": id,
-          "data-markup": rawAttr ?? JSON.stringify(tree)
-        }
-      )
-    }
-  });
 }
 export {
   useShiki

package/dist/highlight/index.js

@@ -1,7 +1,7 @@
 import {
   getHighlighter,
   highlight
-} from "../chunk-3NX26V7I.js";
+} from "../chunk-NJLFLPV4.js";
 import "../chunk-JSBRDJBE.js";
 export {
   getHighlighter,

package/dist/i18n/index.d.ts

@@ -1,24 +1,14 @@
-import { NextMiddleware } from 'next/dist/server/web/types';
-
-interface MiddlewareOptions extends I18nConfig {
-    /**
-     * A function that adds the locale prefix to path name
-     */
-    format?: (locale: string, path: string) => string;
-}
-declare function createI18nMiddleware({ languages, defaultLanguage, format, hideLocale, }: MiddlewareOptions): NextMiddleware;
-
-interface I18nConfig {
+interface I18nConfig<Languages extends string = string> {
     /**
      * Supported locale codes.
      *
      * A page tree will be built for each language.
      */
-    languages: string[];
+    languages: Languages[];
     /**
      * Default locale if not specified
      */
-    defaultLanguage: string;
+    defaultLanguage: Languages;
     /**
      * Don't show the locale prefix on URL.
      *
@@ -38,5 +28,6 @@ interface I18nConfig {
      */
     parser?: 'dot' | 'dir';
 }
+declare function defineI18n<Languages extends string>(config: I18nConfig<Languages>): I18nConfig<Languages>;
 
-export { type I18nConfig, createI18nMiddleware };
+export { type I18nConfig, defineI18n };

package/dist/i18n/index.js

@@ -1,73 +1,7 @@
+import {
+  defineI18n
+} from "../chunk-HUTQC33E.js";
 import "../chunk-JSBRDJBE.js";
-
-// src/i18n/middleware.ts
-import { match as matchLocale } from "@formatjs/intl-localematcher";
-import Negotiator from "negotiator";
-import { NextResponse } from "next/server";
-var COOKIE = "FD_LOCALE";
-function getLocale(request, locales, defaultLanguage) {
-  const negotiatorHeaders = {};
-  request.headers.forEach((value, key) => {
-    negotiatorHeaders[key] = value;
-  });
-  const languages = new Negotiator({ headers: negotiatorHeaders }).languages(
-    locales
-  );
-  return matchLocale(languages, locales, defaultLanguage);
-}
-var defaultFormat = (locale, path) => {
-  return `/${locale}/${path}`;
-};
-function createI18nMiddleware({
-  languages,
-  defaultLanguage,
-  format = defaultFormat,
-  hideLocale = "never"
-}) {
-  function getUrl(request, pathname, locale) {
-    if (!locale) {
-      return new URL(
-        pathname.startsWith("/") ? pathname : `/${pathname}`,
-        request.url
-      );
-    }
-    return new URL(
-      format(locale, pathname.startsWith("/") ? pathname.slice(1) : pathname),
-      request.url
-    );
-  }
-  return (request) => {
-    const inputPath = `${request.nextUrl.pathname}${request.nextUrl.search}`;
-    const pathLocale = languages.find(
-      (locale) => inputPath.startsWith(`/${locale}/`) || inputPath === `/${locale}`
-    );
-    if (!pathLocale) {
-      if (hideLocale === "default-locale") {
-        return NextResponse.rewrite(
-          getUrl(request, inputPath, defaultLanguage)
-        );
-      }
-      const preferred = getLocale(request, languages, defaultLanguage);
-      if (hideLocale === "always") {
-        const locale = request.cookies.get(COOKIE)?.value ?? preferred;
-        return NextResponse.rewrite(getUrl(request, inputPath, locale));
-      }
-      return NextResponse.redirect(getUrl(request, inputPath, preferred));
-    }
-    if (hideLocale === "always") {
-      const path = inputPath.slice(`/${pathLocale}`.length);
-      const res = NextResponse.redirect(getUrl(request, path));
-      res.cookies.set(COOKIE, pathLocale);
-      return res;
-    }
-    if (hideLocale === "default-locale" && pathLocale === defaultLanguage) {
-      return NextResponse.redirect(
-        getUrl(request, inputPath.slice(`/${pathLocale}`.length))
-      );
-    }
-    return NextResponse.next();
-  };
-}
 export {
-  createI18nMiddleware
+  defineI18n
 };

package/dist/i18n/index.server.d.ts

@@ -0,0 +1,3 @@
+export { I18nConfig, defineI18n } from './index.js';
+export { createI18nMiddleware } from './middleware.js';
+import 'next/dist/server/web/types';

package/dist/i18n/index.server.js

@@ -0,0 +1,11 @@
+import {
+  createI18nMiddleware
+} from "../chunk-KLUGJRZC.js";
+import {
+  defineI18n
+} from "../chunk-HUTQC33E.js";
+import "../chunk-JSBRDJBE.js";
+export {
+  createI18nMiddleware,
+  defineI18n
+};

package/dist/i18n/middleware.d.ts

@@ -0,0 +1,12 @@
+import { I18nConfig } from './index.js';
+import { NextMiddleware } from 'next/dist/server/web/types';
+
+interface MiddlewareOptions extends I18nConfig {
+    /**
+     * A function that adds the locale prefix to path name
+     */
+    format?: (locale: string, path: string) => string;
+}
+declare function createI18nMiddleware({ languages, defaultLanguage, format, hideLocale, }: MiddlewareOptions): NextMiddleware;
+
+export { createI18nMiddleware };

package/dist/i18n/middleware.js

@@ -0,0 +1,7 @@
+import {
+  createI18nMiddleware
+} from "../chunk-KLUGJRZC.js";
+import "../chunk-JSBRDJBE.js";
+export {
+  createI18nMiddleware
+};

package/dist/mdx-plugins/index.js

@@ -9,7 +9,7 @@ import {
 import {
   defaultThemes,
   getHighlighter
-} from "../chunk-3NX26V7I.js";
+} from "../chunk-NJLFLPV4.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/mdx-plugins/index.ts

package/dist/search/server.d.ts

@@ -7,9 +7,8 @@ import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
 import 'mdast';
 import 'unified';
 import 'mdast-util-mdx-jsx';
-import 'next/dist/server/web/types';
 import 'react';
-import '../page-tree-bSt6K__E.js';
+import '../definitions-Q95-psoo.js';
 
 type AdvancedDocument = TypedDocument<Orama<typeof advancedSchema>>;
 declare const advancedSchema: {
@@ -28,13 +27,25 @@ declare const simpleSchema: {
     readonly keywords: "string";
 };
 
-type LocaleMap<O> = Record<string, Language | O>;
+type Awaitable<T> = T | Promise<T>;
+interface Options<S extends LoaderOutput<LoaderConfig>> extends Omit<AdvancedOptions, 'indexes'> {
+    localeMap?: {
+        [K in S extends LoaderOutput<infer C> ? C['i18n'] extends I18nConfig<infer Languages> ? Languages : string : string]?: Partial<AdvancedOptions> | Language;
+    };
+    buildIndex?: (page: InferPageType<S>) => Awaitable<AdvancedIndex>;
+}
+declare function createFromSource<S extends LoaderOutput<LoaderConfig>>(source: S, options?: Options<S>): SearchAPI;
+/**
+ * @deprecated Use `createFromSource(source, options)` instead.
+ */
+declare function createFromSource<S extends LoaderOutput<LoaderConfig>>(source: S, pageToIndexFn?: (page: InferPageType<S>) => Awaitable<AdvancedIndex>, options?: Omit<Options<S>, 'buildIndex'>): SearchAPI;
+
 type I18nOptions<O extends SimpleOptions | AdvancedOptions, Idx> = Omit<O, 'language' | 'indexes'> & {
     i18n: I18nConfig;
     /**
      * Map locale name from i18n config to Orama compatible `language` or options
      */
-    localeMap?: LocaleMap<Partial<O>>;
+    localeMap?: Record<string, Language | Partial<O> | undefined>;
     indexes: WithLocale<Idx>[] | Dynamic<WithLocale<Idx>>;
 };
 type I18nSimpleOptions = I18nOptions<SimpleOptions, Index>;
@@ -44,16 +55,6 @@ type WithLocale<T> = T & {
 };
 declare function createI18nSearchAPI<T extends 'simple' | 'advanced'>(type: T, options: T extends 'simple' ? I18nSimpleOptions : I18nAdvancedOptions): SearchAPI;
 
-interface Options<Page = unknown> extends Omit<AdvancedOptions, 'indexes'> {
-    localeMap?: LocaleMap<Partial<AdvancedOptions>>;
-    buildIndex?: (page: Page) => AdvancedIndex;
-}
-declare function createFromSource<S extends LoaderOutput<LoaderConfig>>(source: S, options?: Options<InferPageType<S>>): SearchAPI;
-/**
- * @deprecated Use `createFromSource(source, options)` instead.
- */
-declare function createFromSource<S extends LoaderOutput<LoaderConfig>>(source: S, pageToIndexFn?: (page: InferPageType<S>) => AdvancedIndex, options?: Omit<Options, 'buildIndex'>): SearchAPI;
-
 type SearchType = 'simple' | 'advanced';
 type ExportedData = (RawData & {
     type: SearchType;

package/dist/search/server.js

@@ -148,13 +148,17 @@ async function createDBSimple({
 }
 
 // src/search/orama/create-from-source.ts
-function pageToIndex(page) {
-  if (!("structuredData" in page.data)) {
+async function pageToIndex(page) {
+  let structuredData;
+  if ("structuredData" in page.data) {
+    structuredData = page.data.structuredData;
+  } else if ("load" in page.data && typeof page.data.load === "function") {
+    structuredData = (await page.data.load()).structuredData;
+  }
+  if (!structuredData)
     throw new Error(
       "Cannot find structured data from page, please define the page to index function."
     );
-  }
-  const structuredData = page.data.structuredData;
   return {
     title: page.data.title ?? basename(page.path, extname(page.path)),
     description: "description" in page.data ? page.data.description : void 0,
@@ -164,32 +168,53 @@ function pageToIndex(page) {
   };
 }
 function createFromSource(source, _buildIndexOrOptions = pageToIndex, _options) {
-  const options = {
+  const { buildIndex = pageToIndex, ...options } = {
     ...typeof _buildIndexOrOptions === "function" ? {
       buildIndex: _buildIndexOrOptions
     } : _buildIndexOrOptions,
     ..._options
   };
-  if (source._i18n) {
-    return createI18nSearchAPI("advanced", {
-      ...options,
-      i18n: source._i18n,
-      indexes: source.getLanguages().flatMap((entry) => {
-        return entry.pages.map((page) => {
-          return {
-            ...(options.buildIndex ?? pageToIndex)(page),
-            locale: entry.language
-          };
-        });
+  const i18n = source._i18n;
+  let server;
+  if (i18n) {
+    const indexes = source.getLanguages().flatMap((entry) => {
+      return entry.pages.map(async (page) => ({
+        ...await buildIndex(page),
+        locale: entry.language
+      }));
+    });
+    server = Promise.all(indexes).then(
+      (loaded) => createI18nSearchAPI("advanced", {
+        ...options,
+        i18n,
+        indexes: loaded
       })
+    );
+  } else {
+    const indexes = source.getPages().map(async (page) => {
+      return buildIndex(page);
     });
+    server = Promise.all(indexes).then(
+      (loaded) => createSearchAPI("advanced", {
+        ...options,
+        indexes: loaded
+      })
+    );
   }
-  return createSearchAPI("advanced", {
-    ...options,
-    indexes: source.getPages().map((page) => {
-      return (options.buildIndex ?? pageToIndex)(page);
-    })
-  });
+  return {
+    async export(...args) {
+      return (await server).export(...args);
+    },
+    async GET(...args) {
+      return (await server).GET(...args);
+    },
+    async search(...args) {
+      return (await server).search(...args);
+    },
+    async staticGET(...args) {
+      return (await server).staticGET(...args);
+    }
+  };
 }
 
 // src/search/orama/_stemmers.ts

package/dist/server/index.d.ts

@@ -1,6 +1,6 @@
 export { a as TOCItemType, T as TableOfContents, g as getTableOfContents } from '../get-toc-Cr2URuiP.js';
-import { N as Node, I as Item, R as Root, F as Folder } from '../page-tree-bSt6K__E.js';
-export { p as PageTree } from '../page-tree-bSt6K__E.js';
+import { N as Node, I as Item, R as Root, F as Folder } from '../definitions-Q95-psoo.js';
+export { d as PageTree } from '../definitions-Q95-psoo.js';
 import { Metadata } from 'next';
 import { NextRequest } from 'next/server';
 import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
@@ -9,12 +9,11 @@ import 'react';
 import 'unified';
 import 'vfile';
 import '../i18n/index.js';
-import 'next/dist/server/web/types';
 
 /**
  * Flatten tree to an array of page nodes
  */
-declare function flattenTree(tree: Node[]): Item[];
+declare function flattenTree(nodes: Node[]): Item[];
 /**
  * Get neighbours of a page, useful for implementing "previous & next" buttons
  */
@@ -27,6 +26,8 @@ declare function findNeighbour(tree: Root, url: string, options?: {
 declare function getPageTreeRoots(pageTree: Root | Folder): (Root | Folder)[];
 /**
  * Separate the folder nodes of a root into multiple roots
+ *
+ * @deprecated it's useless
  */
 declare function separatePageTree(pageTree: Root): Root[];
 /**