fumadocs-core 15.0.17 → 15.1.0

package/dist/breadcrumb.d.ts

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

package/dist/{page-tree-CfT5zlWh.d.ts → page-tree-9q98UqWL.d.ts}

@@ -15,6 +15,7 @@ interface Item {
     name: ReactNode;
     url: string;
     external?: boolean;
+    description?: ReactNode;
     icon?: ReactElement;
 }
 interface Separator {

package/dist/search/server.d.ts

@@ -7,7 +7,7 @@ import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
 import 'mdast';
 import 'unified';
 import 'react';
-import '../page-tree-CfT5zlWh.js';
+import '../page-tree-9q98UqWL.js';
 
 type AdvancedDocument = TypedDocument<Orama<typeof advancedSchema>>;
 declare const advancedSchema: {

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 } from '../page-tree-CfT5zlWh.js';
-export { p as PageTree } from '../page-tree-CfT5zlWh.js';
+import { N as Node, I as Item, R as Root, F as Folder } from '../page-tree-9q98UqWL.js';
+export { p as PageTree } from '../page-tree-9q98UqWL.js';
 export { S as SortedResult } from '../types-Ch8gnVgO.js';
 import { Metadata } from 'next';
 import { NextRequest } from 'next/server';
@@ -21,10 +21,13 @@ declare function flattenTree(tree: Node[]): Item[];
 /**
  * Get neighbours of a page, useful for implementing "previous & next" buttons
  */
-declare function findNeighbour(tree: Root, url: string): {
+declare function findNeighbour(tree: Root, url: string, options?: {
+    separateRoot?: boolean;
+}): {
     previous?: Item;
     next?: Item;
 };
+declare function getPageTreeRoots(pageTree: Root | Folder): (Root | Folder)[];
 /**
  * Separate the folder nodes of a root into multiple roots
  */
@@ -111,4 +114,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, separatePageTree };
+export { type GetGithubLastCommitOptions, createMetadataImage, findNeighbour, flattenTree, getGithubLastEdit, getPageTreeRoots, separatePageTree };

package/dist/server/index.js

@@ -1,7 +1,7 @@
-import "../chunk-WQMD6AUR.js";
 import {
   remarkHeading
 } from "../chunk-IYQ35KI2.js";
+import "../chunk-WQMD6AUR.js";
 import {
   createStyleTransformer,
   highlight
@@ -34,18 +34,34 @@ function flattenTree(tree) {
     return [node];
   });
 }
-function findNeighbour(tree, url) {
-  const list = flattenTree(tree.children);
-  for (let i = 0; i < list.length; i++) {
-    if (list[i].url === url) {
-      return {
-        next: list[i + 1],
-        previous: list[i - 1]
-      };
+function findNeighbour(tree, url, options) {
+  const { separateRoot = true } = options ?? {};
+  const roots = separateRoot ? getPageTreeRoots(tree) : [tree];
+  const lists = roots.map((node) => flattenTree(node.children));
+  for (const list of lists) {
+    for (let i = 0; i < list.length; i++) {
+      if (list[i].url === url) {
+        return {
+          next: list[i + 1],
+          previous: list[i - 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 [];
@@ -162,6 +178,7 @@ export {
   findNeighbour,
   flattenTree,
   getGithubLastEdit,
+  getPageTreeRoots,
   getTableOfContents,
   highlight,
   separatePageTree

package/dist/source/index.d.ts

@@ -1,6 +1,6 @@
 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-CfT5zlWh.js';
+import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-9q98UqWL.js';
 
 interface FileInfo {
     /**
@@ -102,7 +102,16 @@ interface LanguageEntry<Data = PageData> {
 }
 interface LoaderOutput<Config extends LoaderConfig> {
     pageTree: Config['i18n'] extends true ? Record<string, Root> : Root;
-    getPageTree(locale?: string): Root;
+    getPageTree: (locale?: string) => Root;
+    getPageByHref: (href: string, options?: {
+        /**
+         * resolve relative file paths in `href` from specified directory
+         */
+        dir?: string;
+    }) => {
+        page: Page<Config['source']['pageData']>;
+        hash?: string;
+    } | undefined;
     _i18n?: I18nConfig;
     /**
      * Get list of pages from language, empty if language hasn't specified
@@ -141,6 +150,7 @@ interface MetaData {
 interface PageData {
     icon?: string | undefined;
     title?: string;
+    description?: string | undefined;
 }
 type InferPageType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Page<Config['source']['pageData']> : never;
 type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Meta<Config['source']['metaData']> : never;

package/dist/source/index.js

@@ -75,8 +75,8 @@ function resolveFolderItem(folder, item, ctx, idx, addedNodePaths) {
   } else if (isExtract) {
     filename = item.slice(extractPrefix.length);
   }
-  const path = resolvePath(folder.file.path, filename);
-  const itemNode = ctx.storage.readDir(path) ?? ctx.storage.read(path, "page");
+  const path2 = resolvePath(folder.file.path, filename);
+  const itemNode = ctx.storage.readDir(path2) ?? ctx.storage.read(path2, "page");
   if (!itemNode) return [];
   addedNodePaths.add(itemNode.file.path);
   if (isExcept) return [];
@@ -142,6 +142,7 @@ function buildFileNode(file, ctx) {
     $id: localized.file.path,
     type: "page",
     name: localized.data.data.title ?? pathToName(localized.file.name),
+    description: localized.data.data.description,
     icon: ctx.options.resolveIcon?.(localized.data.data.icon),
     url: ctx.options.getUrl(localized.data.slugs, ctx.lang),
     $ref: !ctx.options.noRef ? {
@@ -182,9 +183,9 @@ function createPageTreeBuilder() {
     }
   };
 }
-function findLocalizedFile(path, format, ctx) {
+function findLocalizedFile(path2, format, ctx) {
   if (!ctx.lang) return;
-  return ctx.storage.read(`${path}.${ctx.lang}`, format);
+  return ctx.storage.read(`${path2}.${ctx.lang}`, format);
 }
 function pathToName(name) {
   const result = [];
@@ -197,8 +198,8 @@ function pathToName(name) {
 }
 
 // src/source/path.ts
-function parseFilePath(path) {
-  const segments = splitPath(slash(path));
+function parseFilePath(path2) {
+  const segments = splitPath(slash(path2));
   const dirname = segments.slice(0, -1).join("/");
   const base = segments.at(-1) ?? "";
   const dotIdx = base.lastIndexOf(".");
@@ -213,8 +214,8 @@ function parseFilePath(path) {
     path: segments.join("/")
   };
 }
-function parseFolderPath(path) {
-  const segments = splitPath(slash(path));
+function parseFolderPath(path2) {
+  const segments = splitPath(slash(path2));
   const base = segments.at(-1) ?? "";
   const [name, locale] = getLocale(base);
   const flattenedPath = segments.join("/");
@@ -233,8 +234,8 @@ function getLocale(name) {
   if (/\d+/.exec(locale)) return [name];
   return [name.slice(0, sep), locale];
 }
-function normalizePath(path) {
-  const segments = splitPath(slash(path));
+function normalizePath(path2) {
+  const segments = splitPath(slash(path2));
   if (segments[0] === "." || segments[0] === "..")
     throw new Error("It must not start with './' or '../'");
   return segments.join("/");
@@ -259,19 +260,19 @@ var Storage = class {
    * @param path - flattened path
    * @param format - file format
    */
-  read(path, format) {
-    return this.files.get(`${path}.${format}`);
+  read(path2, format) {
+    return this.files.get(`${path2}.${format}`);
   }
-  readDir(path) {
-    return this.folders.get(path);
+  readDir(path2) {
+    return this.folders.get(path2);
   }
   root() {
     return this.rootFolder;
   }
-  write(path, format, data) {
+  write(path2, format, data) {
     const node = {
       format,
-      file: parseFilePath(path),
+      file: parseFilePath(path2),
       data
     };
     this.makeDir(node.file.dirname);
@@ -281,8 +282,8 @@ var Storage = class {
   list() {
     return [...this.files.values()];
   }
-  makeDir(path) {
-    const segments = splitPath(path);
+  makeDir(path2) {
+    const segments = splitPath(path2);
     for (let i = 0; i < segments.length; i++) {
       const segment = segments.slice(0, i + 1).join("/");
       if (this.folders.has(segment)) continue;
@@ -326,6 +327,7 @@ function loadFiles(files, options) {
 }
 
 // src/source/loader.ts
+import * as path from "node:path";
 function indexPages(storage, getUrl, i18n) {
   const defaultLanguage = i18n?.defaultLanguage ?? "";
   const map = /* @__PURE__ */ new Map();
@@ -355,6 +357,7 @@ function indexPages(storage, getUrl, i18n) {
   };
 }
 function createGetUrl(baseUrl, i18n) {
+  const baseSlugs = baseUrl.split("/");
   return (slugs, locale) => {
     const hideLocale = i18n?.hideLocale ?? "never";
     let urlLocale;
@@ -363,7 +366,8 @@ function createGetUrl(baseUrl, i18n) {
     } else if (hideLocale === "default-locale" && locale !== i18n?.defaultLanguage) {
       urlLocale = locale;
     }
-    const paths = urlLocale ? [urlLocale, ...baseUrl.split("/"), ...slugs] : [...baseUrl.split("/"), ...slugs];
+    const paths = [...baseSlugs, ...slugs];
+    if (urlLocale) paths.unshift(urlLocale);
     return `/${paths.filter((v) => v.length > 0).join("/")}`;
   };
 }
@@ -395,21 +399,50 @@ function createOutput(options) {
   );
   const walker = indexPages(storage, getUrl, options.i18n);
   const builder = createPageTreeBuilder();
-  const pageTree = options.i18n === void 0 ? builder.build({
-    storage,
-    resolveIcon: options.icon,
-    getUrl,
-    ...options.pageTree
-  }) : builder.buildI18n({
-    storage,
-    resolveIcon: options.icon,
-    getUrl,
-    i18n: options.i18n,
-    ...options.pageTree
-  });
+  let pageTree;
   return {
     _i18n: options.i18n,
-    pageTree,
+    get pageTree() {
+      if (options.i18n) {
+        pageTree ??= builder.buildI18n({
+          storage,
+          resolveIcon: options.icon,
+          getUrl,
+          i18n: options.i18n,
+          ...options.pageTree
+        });
+      } else {
+        pageTree ??= builder.build({
+          storage,
+          resolveIcon: options.icon,
+          getUrl,
+          ...options.pageTree
+        });
+      }
+      return pageTree;
+    },
+    set pageTree(v) {
+      pageTree = v;
+    },
+    getPageByHref(href, { dir = "" } = {}) {
+      const pages = Array.from(walker.pages.values());
+      const [value, hash] = href.split("#", 2);
+      if (value.startsWith(".") && (value.endsWith(".md") || value.endsWith(".mdx"))) {
+        const hrefPath = path.join(dir, value);
+        const target2 = pages.find((item) => item.file.path === hrefPath);
+        if (target2)
+          return {
+            page: target2,
+            hash
+          };
+      }
+      const target = pages.find((item) => item.url === value);
+      if (target)
+        return {
+          page: target,
+          hash
+        };
+    },
     getPages(language = options.i18n?.defaultLanguage ?? "") {
       const pages = [];
       for (const key of walker.pages.keys()) {
@@ -437,9 +470,9 @@ function createOutput(options) {
     },
     getPageTree(locale) {
       if (options.i18n) {
-        return pageTree[locale ?? options.i18n.defaultLanguage];
+        return this.pageTree[locale ?? options.i18n.defaultLanguage];
       }
-      return pageTree;
+      return this.pageTree;
     },
     getNodePage(node) {
       const ref = node.$ref?.file ?? node.$id;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "15.0.17",
+  "version": "15.1.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",