fumadocs-core 15.7.13 → 15.8.1

package/dist/search/server.js

@@ -1,15 +1,18 @@
+import {
+  basename,
+  extname
+} from "../chunk-BDG7Y4PS.js";
 import {
   searchAdvanced,
   searchSimple
-} from "../chunk-XMAVUWLD.js";
+} from "../chunk-XOFXGHS4.js";
 import "../chunk-ZMWYLUDP.js";
 import {
   createContentHighlighter
-} from "../chunk-CNWEGOUF.js";
+} from "../chunk-OTD7MV33.js";
 import {
-  basename,
-  extname
-} from "../chunk-BDG7Y4PS.js";
+  findPath
+} from "../chunk-HV3YIUWE.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/search/server.ts
@@ -45,10 +48,19 @@ import {
   create,
   insertMultiple
 } from "@orama/orama";
+var simpleSchema = {
+  url: "string",
+  title: "string",
+  breadcrumbs: "string[]",
+  description: "string",
+  content: "string",
+  keywords: "string"
+};
 var advancedSchema = {
   content: "string",
   page_id: "string",
   type: "string",
+  breadcrumbs: "string[]",
   tags: "enum[]",
   url: "string",
   embeddings: "vector[512]"
@@ -70,7 +82,8 @@ async function createDB({
   });
   const mapTo = [];
   items.forEach((page) => {
-    const tags = Array.isArray(page.tag) ? page.tag : page.tag ? [page.tag] : [];
+    const pageTag = page.tag ?? [];
+    const tags = Array.isArray(pageTag) ? pageTag : [pageTag];
     const data = page.structuredData;
     let id = 0;
     mapTo.push({
@@ -78,12 +91,14 @@ async function createDB({
       page_id: page.id,
       type: "page",
       content: page.title,
+      breadcrumbs: page.breadcrumbs,
       tags,
       url: page.url
     });
+    const nextId = () => `${page.id}-${id++}`;
     if (page.description) {
       mapTo.push({
-        id: `${page.id}-${(id++).toString()}`,
+        id: nextId(),
         page_id: page.id,
         tags,
         type: "text",
@@ -93,7 +108,7 @@ async function createDB({
     }
     for (const heading of data.headings) {
       mapTo.push({
-        id: `${page.id}-${(id++).toString()}`,
+        id: nextId(),
         page_id: page.id,
         type: "heading",
         tags,
@@ -103,7 +118,7 @@ async function createDB({
     }
     for (const content of data.contents) {
       mapTo.push({
-        id: `${page.id}-${(id++).toString()}`,
+        id: nextId(),
         page_id: page.id,
         tags,
         type: "text",
@@ -115,13 +130,6 @@ async function createDB({
   await insertMultiple(db, mapTo);
   return db;
 }
-var simpleSchema = {
-  url: "string",
-  title: "string",
-  description: "string",
-  content: "string",
-  keywords: "string"
-};
 async function createDBSimple({
   indexes,
   tokenizer,
@@ -141,6 +149,7 @@ async function createDBSimple({
     items.map((page) => ({
       title: page.title,
       description: page.description,
+      breadcrumbs: page.breadcrumbs,
       url: page.url,
       content: page.content,
       keywords: page.keywords
@@ -150,73 +159,77 @@ async function createDBSimple({
 }
 
 // src/search/orama/create-from-source.ts
-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;
+function defaultBuildIndex(source) {
+  function isBreadcrumbItem(item) {
+    return typeof item === "string" && item.length > 0;
   }
-  if (!structuredData)
-    throw new Error(
-      "Cannot find structured data from page, please define the page to index function."
+  return async (page) => {
+    let breadcrumbs;
+    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 pageTree = source.getPageTree(page.locale);
+    const path = findPath(
+      pageTree.children,
+      (node) => node.type === "page" && node.url === page.url
     );
-  return {
-    title: page.data.title ?? basename(page.path, extname(page.path)),
-    description: "description" in page.data ? page.data.description : void 0,
-    url: page.url,
-    id: page.url,
-    structuredData
+    if (path) {
+      breadcrumbs = [];
+      path.pop();
+      if (isBreadcrumbItem(pageTree.name)) {
+        breadcrumbs.push(pageTree.name);
+      }
+      for (const segment of path) {
+        if (!isBreadcrumbItem(segment.name)) continue;
+        breadcrumbs.push(segment.name);
+      }
+    }
+    return {
+      title: page.data.title ?? basename(page.path, extname(page.path)),
+      breadcrumbs,
+      description: page.data.description,
+      url: page.url,
+      id: page.url,
+      structuredData
+    };
   };
 }
-function createFromSource(source, _buildIndexOrOptions = pageToIndex, _options) {
-  const { buildIndex = pageToIndex, ...options } = {
+function createFromSource(source, _buildIndexOrOptions, _options) {
+  const { buildIndex = defaultBuildIndex(source), ...options } = {
     ...typeof _buildIndexOrOptions === "function" ? {
       buildIndex: _buildIndexOrOptions
     } : _buildIndexOrOptions,
     ..._options
   };
-  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);
+  if (source._i18n) {
+    return createI18nSearchAPI("advanced", {
+      ...options,
+      i18n: source._i18n,
+      indexes: async () => {
+        const indexes = source.getLanguages().flatMap((entry) => {
+          return entry.pages.map(async (page) => ({
+            ...await buildIndex(page),
+            locale: entry.language
+          }));
+        });
+        return Promise.all(indexes);
+      }
     });
-    server = Promise.all(indexes).then(
-      (loaded) => createSearchAPI("advanced", {
-        ...options,
-        indexes: loaded
-      })
-    );
   }
-  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);
+  return createSearchAPI("advanced", {
+    ...options,
+    indexes: async () => {
+      const indexes = source.getPages().map((page) => buildIndex(page));
+      return Promise.all(indexes);
     }
-  };
+  });
 }
 
 // src/search/orama/_stemmers.ts

package/dist/server/index.d.ts

@@ -4,7 +4,7 @@ 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';
-export { S as SortedResult } from '../shared-ORgOfXFw.js';
+export { SortedResult } from '../search/index.js';
 import 'react';
 import 'unified';
 import 'vfile';
@@ -34,6 +34,14 @@ declare function separatePageTree(pageTree: Root): Root[];
  * Get other page tree nodes that lives under the same parent
  */
 declare function getPageTreePeers(tree: Root, url: string): Item[];
+/**
+ * Search the path of a node in the tree matched by the matcher.
+ *
+ * @returns The path to the target node (from starting root), or null if the page doesn't exist
+ */
+declare function findPath(nodes: Node[], matcher: (node: Node) => boolean, options?: {
+    includeSeparator?: boolean;
+}): Node[] | null;
 
 interface GetGithubLastCommitOptions {
     /**
@@ -116,4 +124,4 @@ declare function createMetadataImage<S extends LoaderOutput<LoaderConfig>>(optio
     }) => Response | Promise<Response>) => (request: NextRequest, options: any) => Response | Promise<Response>;
 };
 
-export { type GetGithubLastCommitOptions, createMetadataImage, findNeighbour, flattenTree, getGithubLastEdit, getPageTreePeers, getPageTreeRoots, separatePageTree };
+export { type GetGithubLastCommitOptions, createMetadataImage, findNeighbour, findPath, flattenTree, getGithubLastEdit, getPageTreePeers, getPageTreeRoots, separatePageTree };

package/dist/server/index.js

@@ -1,6 +1,14 @@
 import {
   remarkHeading
 } from "../chunk-QMATWJ5F.js";
+import {
+  findNeighbour,
+  findPath,
+  flattenTree,
+  getPageTreePeers,
+  getPageTreeRoots,
+  separatePageTree
+} from "../chunk-HV3YIUWE.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/server/get-toc.ts
@@ -17,79 +25,6 @@ function getTableOfContents(content, remarkPlugins) {
   return [];
 }
 
-// src/utils/page-tree.tsx
-function flattenTree(nodes) {
-  const out = [];
-  for (const node of nodes) {
-    if (node.type === "folder") {
-      if (node.index) out.push(node.index);
-      out.push(...flattenTree(node.children));
-    } else if (node.type === "page") {
-      out.push(node);
-    }
-  }
-  return out;
-}
-function findNeighbour(tree, url, options) {
-  const { separateRoot = true } = options ?? {};
-  const roots = separateRoot ? getPageTreeRoots(tree) : [tree];
-  if (tree.fallback) roots.push(tree.fallback);
-  for (const root of roots) {
-    const list = flattenTree(root.children);
-    const idx = list.findIndex((item) => item.url === url);
-    if (idx === -1) continue;
-    return {
-      previous: list[idx - 1],
-      next: list[idx + 1]
-    };
-  }
-  return {};
-}
-function getPageTreeRoots(pageTree) {
-  const result = pageTree.children.flatMap((child) => {
-    if (child.type !== "folder") return [];
-    const roots = getPageTreeRoots(child);
-    if (child.root) roots.push(child);
-    return roots;
-  });
-  if (!("type" in pageTree)) result.push(pageTree);
-  return result;
-}
-function separatePageTree(pageTree) {
-  return pageTree.children.flatMap((child) => {
-    if (child.type !== "folder") return [];
-    return {
-      name: child.name,
-      url: child.index?.url,
-      children: child.children
-    };
-  });
-}
-function getPageTreePeers(tree, url) {
-  const parent = findParentFromTree(tree, url);
-  if (!parent) return [];
-  return parent.children.filter(
-    (item) => item.type === "page" && item.url !== url
-  );
-}
-function findParentFromTree(node, url) {
-  if ("index" in node && node.index?.url === url) {
-    return node;
-  }
-  for (const child of node.children) {
-    if (child.type === "folder") {
-      const parent = findParentFromTree(child, url);
-      if (parent) return parent;
-    }
-    if (child.type === "page" && child.url === url) {
-      return node;
-    }
-  }
-  if ("fallback" in node && node.fallback) {
-    return findParentFromTree(node.fallback, url);
-  }
-}
-
 // src/source/page-tree/definitions.ts
 var definitions_exports = {};
 
@@ -194,6 +129,7 @@ export {
   definitions_exports as PageTree,
   createMetadataImage,
   findNeighbour,
+  findPath,
   flattenTree,
   getGithubLastEdit,
   getPageTreePeers,

package/dist/source/index.d.ts

@@ -1,6 +1,46 @@
-import { ReactNode } from 'react';
-import { R as Root, I as Item, F as Folder, S as Separator } from '../definitions-Q95-psoo.js';
+import { I as Item, F as Folder, S as Separator, R as Root } from '../definitions-Q95-psoo.js';
 import { I18nConfig } from '../i18n/index.js';
+import { ReactNode } from 'react';
+
+interface FileInfo {
+    /**
+     * File path without extension
+     *
+     * @deprecated obtain it with `join(dirname, name)`
+     */
+    flattenedPath: string;
+    /**
+     * path of file (unparsed)
+     */
+    path: string;
+    /**
+     * File name without extension
+     */
+    name: string;
+    /**
+     * file extension from the last `.`, like `.md`
+     *
+     * empty string if no file extension
+     */
+    ext: string;
+    dirname: string;
+}
+interface FolderInfo {
+    /**
+     * Original path of folder
+     */
+    path: string;
+    /**
+     * folder name
+     */
+    name: string;
+    dirname: string;
+}
+declare function parseFilePath(path: string): FileInfo;
+/**
+ * @deprecated use `dirname` and `basename` directly.
+ */
+declare function parseFolderPath(path: string): FolderInfo;
 
 /**
  * In memory file system.
@@ -22,8 +62,8 @@ declare class FileSystem<File> {
 }
 
 interface LoadOptions {
-    transformers?: Transformer[];
     buildFile: (file: VirtualFile) => MetaFile | PageFile;
+    plugins?: LoaderPlugin[];
 }
 type ContentStorage<Page extends PageData = PageData, Meta extends MetaData = MetaData> = FileSystem<MetaFile<Meta> | PageFile<Page>>;
 interface MetaFile<Data extends MetaData = MetaData> {
@@ -41,7 +81,6 @@ interface PageFile<Data extends PageData = PageData> {
 }
 type Transformer = (context: {
     storage: ContentStorage;
-    options: LoadOptions;
 }) => void;
 /**
  * @returns a map of locale and its content storage.
@@ -50,45 +89,49 @@ type Transformer = (context: {
  */
 declare function loadFiles(files: VirtualFile[], options: LoadOptions, i18n: I18nConfig): Record<string, ContentStorage>;
 
-interface FileInfo {
+type LoaderPlugins<Page extends PageData, Meta extends MetaData> = LoaderPlugin<Page, Meta>[];
+interface LoaderPlugin<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     /**
-     * File path without extension
-     *
-     * @deprecated obtain it with `join(dirname, name)`
+     * transform the storage after loading
      */
-    flattenedPath: string;
+    transformStorage?: (context: {
+        storage: ContentStorage<Page, Meta>;
+    }) => void;
     /**
-     * path of file (unparsed)
+     * transform the generated page tree
      */
-    path: string;
+    transformPageTree?: PageTreeTransformer<Page, Meta>;
+}
+declare function buildPlugins<Page extends PageData, Meta extends MetaData>(plugins: LoaderPlugins<Page, Meta>): LoaderPlugin<Page, Meta>[];
+
+interface LegacyLoaderOptions {
     /**
-     * File name without extension
+     * We recommend you to use `plugins` instead
      */
-    name: string;
+    transformers?: Transformer[];
+}
+interface LegacyPageTreeOptions<Page extends PageData, Meta extends MetaData> {
     /**
-     * file extension from the last `.`, like `.md`
-     *
-     * empty string if no file extension
+     * @deprecated use `plugins` instead
      */
-    ext: string;
-    dirname: string;
-}
-interface FolderInfo {
+    attachFile?: (node: Item, file?: PageFile<Page>) => Item;
     /**
-     * Original path of folder
+     * @deprecated use `plugins` instead
      */
-    path: string;
+    attachFolder?: (node: Folder, folder: {
+        children: (PageFile<Page> | MetaFile<Meta>)[];
+    }, meta?: MetaFile<Meta>) => Folder;
     /**
-     * folder name
+     * @deprecated use `plugins` instead
      */
-    name: string;
-    dirname: string;
+    attachSeparator?: (node: Separator) => Separator;
+    /**
+     * We recommend you to use `plugins` instead
+     */
+    transformers?: PageTreeTransformer<Page, Meta>[];
 }
-declare function parseFilePath(path: string): FileInfo;
-/**
- * @deprecated use `dirname` and `basename` directly.
- */
-declare function parseFolderPath(path: string): FolderInfo;
+
+type IconResolver = (icon: string | undefined) => ReactNode;
 
 interface LoaderConfig {
     source: SourceConfig;
@@ -98,21 +141,23 @@ interface SourceConfig {
     pageData: PageData;
     metaData: MetaData;
 }
-interface LoaderOptions<T extends SourceConfig = SourceConfig, I18n extends I18nConfig | undefined = I18nConfig | undefined> {
+type LoaderOptions<Config extends SourceConfig = SourceConfig, I18n extends I18nConfig | undefined = I18nConfig | undefined> = BaseLoaderOptions<NoInfer<Config>> & {
+    source: Source<Config> | Source<Config>[];
+    /**
+     * Configure i18n
+     */
+    i18n?: I18n;
+};
+interface BaseLoaderOptions<Config extends SourceConfig> extends LegacyLoaderOptions {
     baseUrl: string;
-    icon?: NonNullable<BaseOptions['resolveIcon']>;
+    icon?: IconResolver;
     slugs?: (info: FileInfo) => string[];
     url?: UrlFn;
-    source: Source<T> | Source<T>[];
-    transformers?: Transformer[];
     /**
      * Additional options for page tree builder
      */
-    pageTree?: Partial<BaseOptions<T['pageData'], T['metaData']>>;
-    /**
-     * Configure i18n
-     */
-    i18n?: I18n;
+    pageTree?: Partial<BaseOptions> & LegacyPageTreeOptions<Config['pageData'], Config['metaData']>;
+    plugins?: LoaderPlugins<Config['pageData'], Config['metaData']>;
 }
 interface Source<Config extends SourceConfig> {
     /**
@@ -183,13 +228,19 @@ interface LoaderOutput<Config extends LoaderConfig> {
         page: Page<Config['source']['pageData']>;
         hash?: string;
     } | undefined;
+    /**
+     * @internal
+     */
     _i18n?: I18nConfig;
     /**
-     * Get list of pages from language
+     * Get a list of pages from specified language
      *
-     * @param language - If empty, the default language will be used
+     * @param language - If empty, list pages from all languages.
      */
     getPages: (language?: string) => Page<Config['source']['pageData']>[];
+    /**
+     * get each language and its pages, empty if i18n is not enabled.
+     */
     getLanguages: () => LanguageEntry<Config['source']['pageData']>[];
     /**
      * Get page with slugs
@@ -237,53 +288,36 @@ type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput
  */
 type UrlFn = (slugs: string[], locale?: string) => string;
 
-interface LegacyTransformerOptions<Page extends PageData, Meta extends MetaData> {
-    /**
-     * @deprecated use `transformers` instead
-     */
-    attachFile?: (node: Item, file?: PageFile<Page>) => Item;
-    /**
-     * @deprecated use `transformers` instead
-     */
-    attachFolder?: (node: Folder, folder: {
-        children: (PageFile<Page> | MetaFile<Meta>)[];
-    }, meta?: MetaFile<Meta>) => Folder;
-    /**
-     * @deprecated use `transformers` instead
-     */
-    attachSeparator?: (node: Separator) => Separator;
-}
-
 interface PageTreeBuilderContext<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     /**
      * @internal resolve paths without extensions
      */
     resolveName: (name: string, format: 'meta' | 'page') => string;
-    options: BaseOptions<Page, Meta>;
+    options: BaseOptions;
     transformers: PageTreeTransformer<Page, Meta>[];
-    builder: PageTreeBuilder<Page, Meta>;
+    builder: PageTreeBuilder;
     storage: ContentStorage<Page, Meta>;
     getUrl: UrlFn;
     storages?: Record<string, ContentStorage<Page, Meta>>;
     locale?: string;
     visitedPaths: Set<string>;
 }
-interface PageTreeTransformer<Page extends PageData = any, Meta extends MetaData = any> {
+interface PageTreeTransformer<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     name?: string;
     file?: (this: PageTreeBuilderContext<Page, Meta>, node: Item, filePath?: string) => Item;
     folder?: (this: PageTreeBuilderContext<Page, Meta>, node: Folder, folderPath: string, metaPath?: string) => Folder;
     separator?: (this: PageTreeBuilderContext<Page, Meta>, node: Separator) => Separator;
     root?: (this: PageTreeBuilderContext<Page, Meta>, node: Root) => Root;
 }
-interface BaseOptions<Page extends PageData = PageData, Meta extends MetaData = MetaData> extends LegacyTransformerOptions<Page, Meta> {
+interface BaseOptions {
+    id?: string;
     /**
      * Remove references to the file path of original nodes (`$ref`)
      *
      * @defaultValue false
      */
     noRef?: boolean;
-    transformers?: PageTreeTransformer<Page, Meta>[];
-    resolveIcon?: (icon: string | undefined) => ReactNode | undefined;
+    plugins?: LoaderPlugin[];
     /**
      * generate fallback page tree
      *
@@ -291,19 +325,17 @@ interface BaseOptions<Page extends PageData = PageData, Meta extends MetaData =
      */
     generateFallback?: boolean;
 }
-interface PageTreeBuilder<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
-    build: (options: BaseOptions<Page, Meta> & {
-        id?: string;
-        storage: ContentStorage<Page, Meta>;
+interface PageTreeBuilder {
+    build: (options: BaseOptions & {
+        storage: ContentStorage;
     }) => Root;
     /**
      * Build page tree and fallback to the default language if the localized page doesn't exist
      */
-    buildI18n: (options: BaseOptions<Page, Meta> & {
-        id?: string;
-        storages: Record<string, ContentStorage<Page, Meta>>;
+    buildI18n: (options: BaseOptions & {
+        storages: Record<string, ContentStorage>;
     }) => Record<string, Root>;
 }
 declare function createPageTreeBuilder(getUrl: UrlFn): PageTreeBuilder;
 
-export { type BaseOptions, type ContentStorage, type FileInfo, FileSystem, type FolderInfo, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type MetaFile, type Page, type PageData, type PageFile, type PageTreeBuilder, type PageTreeBuilderContext, type PageTreeTransformer, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };
+export { type BaseOptions, type ContentStorage, type FileInfo, FileSystem, type FolderInfo, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type LoaderPlugin, type LoaderPlugins, type Meta, type MetaData, type MetaFile, type Page, type PageData, type PageFile, type PageTreeBuilder, type PageTreeBuilderContext, type PageTreeTransformer, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, buildPlugins, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };