fumadocs-core 8.3.0 → 9.1.0

package/dist/breadcrumb.d.ts

@@ -1,4 +1,4 @@
-import { R as Root } from './page-tree-izSPERQk.js';
+import { R as Root } from './page-tree-mLHMYx2B.js';
 import 'react';
 
 interface BreadcrumbItem {

package/dist/{page-tree-izSPERQk.d.ts → page-tree-mLHMYx2B.d.ts}

@@ -20,6 +20,7 @@ interface Folder {
     type: 'folder';
     name: string;
     root?: boolean;
+    defaultOpen?: boolean;
     index?: Item;
     icon?: ReactElement;
     children: Node[];

package/dist/server/index.d.ts

@@ -1,7 +1,7 @@
 import { T as TableOfContents } from '../get-toc-YF_TdazL.js';
 export { a as TOCItemType, g as getTableOfContents } from '../get-toc-YF_TdazL.js';
-import { N as Node, I as Item, R as Root } from '../page-tree-izSPERQk.js';
-export { p as PageTree } from '../page-tree-izSPERQk.js';
+import { N as Node, I as Item, R as Root } from '../page-tree-mLHMYx2B.js';
+export { p as PageTree } from '../page-tree-mLHMYx2B.js';
 import 'react';
 
 /**

package/dist/source/index.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { R as Root } from '../page-tree-izSPERQk.js';
+import { R as Root } from '../page-tree-mLHMYx2B.js';
 
 interface LoadOptions {
     files: VirtualFile[];
@@ -93,6 +93,7 @@ interface MetaData {
     title?: string;
     root?: boolean;
     pages?: string[];
+    defaultOpen?: boolean;
 }
 interface PageData {
     icon?: string;
@@ -119,7 +120,7 @@ interface Folder<MD extends MetaData = MetaData, PD extends PageData = PageData>
     file: FileInfo;
     children: Node<MD, PD>[];
 }
-type Node<MD extends MetaData = MetaData, PD extends PageData = PageData> = Meta<MD> | Page<PD> | Folder;
+type Node<MD extends MetaData = MetaData, PD extends PageData = PageData> = Meta<MD> | Page<PD> | Folder<MD, PD>;
 /**
  * A virtual file system that solves inconsistent behaviours
  *
@@ -131,10 +132,17 @@ declare class Storage {
     private rootFolder;
     constructor();
     /**
-     * Read a file, it doesn't need an extension
      * @param path - flattened path
      */
-    read(path: string): Page | Meta | undefined;
+    private read;
+    /**
+     * @param path - flattened path
+     */
+    readPage(path: string): Page | undefined;
+    /**
+     * @param path - flattened path
+     */
+    readMeta(path: string): Meta | undefined;
     readDir(path: string): Folder | undefined;
     root(): Folder;
     write(path: string, file: Omit<Page, 'file'> | Omit<Meta, 'file'>): void;

package/dist/source/index.js

@@ -3,50 +3,41 @@ import {
 } from "../chunk-UWEEHUJV.js";
 import {
   __export,
-  __spreadProps,
   __spreadValues
 } from "../chunk-WEAGW6MQ.js";
 
 // src/source/path.ts
 import { parse } from "path";
-function parseFilePath(path) {
-  const parsed = parse(path);
-  const dir = slash(parsed.dir);
-  const flattenedPath = joinPaths([dir, parsed.name]);
+function parseFilePath(path2) {
+  const slashedPath = slash(path2);
+  const parsed = parse(slashedPath);
+  const flattenedPath = joinPaths([parsed.dir, parsed.name]);
   const [name, locale] = parsed.name.split(".");
   return {
-    dirname: dir,
+    dirname: parsed.dir,
     name,
     flattenedPath,
     locale,
-    path
+    path: slashedPath
   };
 }
-function isRelative(path, root) {
-  return path.startsWith(root);
-}
-function getRelativePath(path, root) {
-  if (!isRelative(path, root))
-    throw new Error("Invalid path");
-  return splitPath(path.substring(root.length)).join("/");
-}
-function parseFolderPath(path) {
-  const parsed = parse(path);
-  const dir = slash(parsed.dir);
+function parseFolderPath(path2) {
+  const slashedPath = slash(path2);
+  const parsed = parse(slashedPath);
   const [name, locale] = parsed.base.split(".");
   return {
-    dirname: dir,
+    dirname: parsed.dir,
     name,
-    flattenedPath: path,
+    flattenedPath: slashedPath,
     locale,
-    path
+    path: slashedPath
   };
 }
-function splitPath(path) {
-  return path.split("/").filter((p) => p.length > 0);
+function splitPath(path2) {
+  return path2.split("/").filter((p) => p.length > 0);
 }
 function joinPaths(paths, slashMode = "none") {
-  const joined = paths.flatMap((path) => splitPath(path)).join("/");
+  const joined = paths.flatMap((path2) => splitPath(path2)).join("/");
   switch (slashMode) {
     case "leading":
       return `/${joined}`;
@@ -78,58 +69,62 @@ function buildAll(nodes, ctx, skipIndex) {
       output.push(treeNode);
     }
     if (node.type === "folder") {
-      output.push(buildFolderNode(node, ctx));
+      output.push(buildFolderNode(node, false, ctx));
     }
   }
   return output;
 }
 function getFolderMeta(folder, ctx) {
   var _a;
-  let meta = ctx.storage.read(joinPaths([folder.file.path, "meta"]));
+  let meta = ctx.storage.readMeta(joinPaths([folder.file.path, "meta"]));
   if (ctx.lang) {
-    meta = (_a = ctx.storage.read(joinPaths([folder.file.path, `meta.${ctx.lang}`]))) != null ? _a : meta;
+    meta = (_a = ctx.storage.readMeta(joinPaths([folder.file.path, `meta.${ctx.lang}`]))) != null ? _a : meta;
+  }
+  return meta;
+}
+function resolveFolderItem(folder, item, ctx, addedNodePaths) {
+  var _a, _b, _c;
+  if (item === rest)
+    return "...";
+  const separateResult = separator.exec(item);
+  if (separateResult == null ? void 0 : separateResult.groups) {
+    return [
+      {
+        type: "separator",
+        name: separateResult.groups.name
+      }
+    ];
+  }
+  const extractResult = extractor.exec(item);
+  const path2 = joinPaths([
+    folder.file.path,
+    (_b = (_a = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _a.name) != null ? _b : item
+  ]);
+  const itemNode = (_c = ctx.storage.readDir(path2)) != null ? _c : ctx.storage.readPage(path2);
+  if (!itemNode)
+    return [];
+  addedNodePaths.add(itemNode.file.path);
+  if (itemNode.type === "folder") {
+    const node = buildFolderNode(itemNode, false, ctx);
+    return (extractResult == null ? void 0 : extractResult.groups) ? node.children : [node];
   }
-  if ((meta == null ? void 0 : meta.type) === "meta")
-    return meta;
+  return [buildFileNode(itemNode, ctx)];
 }
-function buildFolderNode(folder, ctx, root = false) {
+function buildFolderNode(folder, defaultIsRoot, ctx) {
   var _a, _b, _c, _d, _e;
-  const indexNode = folder.children.find(
-    (node) => node.type === "page" && node.file.name === "index"
+  const indexFile = ctx.storage.readPage(
+    joinPaths([folder.file.flattenedPath, "index"])
   );
-  const index = indexNode ? buildFileNode(indexNode, ctx) : void 0;
+  const index = indexFile ? buildFileNode(indexFile, ctx) : void 0;
   const meta = (_a = getFolderMeta(folder, ctx)) == null ? void 0 : _a.data;
   let children;
   if (!meta) {
-    children = buildAll(folder.children, ctx, !root);
+    children = buildAll(folder.children, ctx, !defaultIsRoot);
   } else {
-    const isRoot = (_b = meta.root) != null ? _b : root;
+    const isRoot = (_b = meta.root) != null ? _b : defaultIsRoot;
     const addedNodePaths = /* @__PURE__ */ new Set();
     const resolved = (_c = meta.pages) == null ? void 0 : _c.flatMap((item) => {
-      var _a2, _b2, _c2;
-      if (item === rest)
-        return "...";
-      const result = separator.exec(item);
-      if (result == null ? void 0 : result.groups) {
-        return {
-          type: "separator",
-          name: result.groups.name
-        };
-      }
-      const extractResult = extractor.exec(item);
-      const extractName = (_b2 = (_a2 = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _a2.name) != null ? _b2 : item;
-      const itemNode = (_c2 = ctx.storage.readDir(joinPaths([folder.file.path, extractName]))) != null ? _c2 : ctx.storage.read(joinPaths([folder.file.path, extractName]));
-      if (!itemNode)
-        return [];
-      addedNodePaths.add(itemNode.file.path);
-      if (itemNode.type === "folder") {
-        const node = buildFolderNode(itemNode, ctx);
-        return (extractResult == null ? void 0 : extractResult.groups) ? node.children : node;
-      }
-      if (itemNode.type === "page") {
-        return buildFileNode(itemNode, ctx);
-      }
-      return [];
+      return resolveFolderItem(folder, item, ctx, addedNodePaths);
     });
     const restNodes = buildAll(
       folder.children.filter((node) => !addedNodePaths.has(node.file.path)),
@@ -149,6 +144,7 @@ function buildFolderNode(folder, ctx, root = false) {
     name: (_e = (_d = meta == null ? void 0 : meta.title) != null ? _d : index == null ? void 0 : index.name) != null ? _e : pathToName(folder.file.name),
     icon: ctx.resolveIcon(meta == null ? void 0 : meta.icon),
     root: meta == null ? void 0 : meta.root,
+    defaultOpen: meta == null ? void 0 : meta.defaultOpen,
     index,
     children
   };
@@ -156,8 +152,10 @@ function buildFolderNode(folder, ctx, root = false) {
 function buildFileNode(page, ctx) {
   let localePage = page;
   if (ctx.lang) {
-    const result = ctx.storage.read(`${page.file.flattenedPath}.${ctx.lang}`);
-    if ((result == null ? void 0 : result.type) === "page")
+    const result = ctx.storage.readPage(
+      `${page.file.flattenedPath}.${ctx.lang}`
+    );
+    if (result)
       localePage = result;
   }
   return {
@@ -169,7 +167,7 @@ function buildFileNode(page, ctx) {
 }
 function build(ctx) {
   const root = ctx.storage.root();
-  const folder = buildFolderNode(root, ctx, true);
+  const folder = buildFolderNode(root, true, ctx);
   return {
     name: folder.name,
     children: folder.children
@@ -179,33 +177,38 @@ function createPageTreeBuilder({
   storage,
   resolveIcon = () => void 0
 }) {
-  const context = {
-    storage,
-    resolveIcon(icon) {
-      if (!icon)
-        return;
-      return resolveIcon(icon);
-    }
-  };
+  function getContext(builder, locale) {
+    return {
+      storage,
+      lang: locale,
+      resolveIcon(icon) {
+        if (!icon)
+          return;
+        return resolveIcon(icon);
+      },
+      builder
+    };
+  }
   return {
     build() {
-      return build(context);
+      return build(getContext(this));
     },
     buildI18n({ languages = [] } = {}) {
       const entries = languages.map((lang) => {
-        const tree = build(__spreadProps(__spreadValues({}, context), {
-          lang
-        }));
+        const tree = build(getContext(this, lang));
         return [lang, tree];
       });
       return Object.fromEntries(entries);
     }
   };
 }
-function pathToName(path) {
-  return path.slice(0, 1).toUpperCase() + path.slice(1);
+function pathToName(path2) {
+  return path2.slice(0, 1).toUpperCase() + path2.slice(1);
 }
 
+// src/source/load.ts
+import * as path from "path";
+
 // src/source/file-system.ts
 var file_system_exports = {};
 __export(file_system_exports, {
@@ -223,33 +226,50 @@ var Storage = class {
     this.folders.set("", this.rootFolder);
   }
   /**
-   * Read a file, it doesn't need an extension
    * @param path - flattened path
    */
-  read(path) {
-    return this.files.get(path);
+  read(path2, type) {
+    return this.files.get(`${path2}.${type}`);
+  }
+  /**
+   * @param path - flattened path
+   */
+  readPage(path2) {
+    const result = this.read(path2, "page");
+    if ((result == null ? void 0 : result.type) !== "page")
+      return;
+    return result;
   }
-  readDir(path) {
-    return this.folders.get(path);
+  /**
+   * @param path - flattened path
+   */
+  readMeta(path2) {
+    const result = this.read(path2, "meta");
+    if ((result == null ? void 0 : result.type) !== "meta")
+      return;
+    return result;
+  }
+  readDir(path2) {
+    return this.folders.get(path2);
   }
   root() {
     return this.rootFolder;
   }
-  write(path, file) {
+  write(path2, file) {
     var _a;
     const node = __spreadValues({
-      file: parseFilePath(path)
+      file: parseFilePath(path2)
     }, file);
     this.makeDir(node.file.dirname);
     (_a = this.readDir(node.file.dirname)) == null ? void 0 : _a.children.push(node);
-    this.files.set(node.file.flattenedPath, node);
+    this.files.set(`${node.file.flattenedPath}.${node.type}`, node);
   }
   list() {
     return [...this.files.values()];
   }
-  makeDir(path) {
+  makeDir(path2) {
     var _a;
-    const segments = splitPath(path);
+    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))
@@ -283,13 +303,17 @@ function load(options) {
 function buildStorage(options) {
   const storage = new Storage();
   for (const file of options.files) {
-    if (!isRelative(file.path, options.rootDir))
+    const relativePath = path.join(
+      path.relative(options.rootDir, path.join("./", path.dirname(file.path))),
+      path.basename(file.path)
+    );
+    const isRelative = !relativePath.startsWith("..") && !path.isAbsolute(relativePath);
+    if (!isRelative)
       continue;
-    const path = getRelativePath(file.path, options.rootDir);
     if (file.type === "page") {
-      const parsedPath = parseFilePath(path);
+      const parsedPath = parseFilePath(relativePath);
       const slugs = options.getSlugs(parsedPath);
-      storage.write(path, {
+      storage.write(relativePath, {
         slugs,
         url: options.getUrl(slugs, parsedPath.locale),
         type: file.type,
@@ -297,7 +321,7 @@ function buildStorage(options) {
       });
     }
     if (file.type === "meta") {
-      storage.write(path, {
+      storage.write(relativePath, {
         type: file.type,
         data: file.data
       });
@@ -338,6 +362,10 @@ function createGetUrl(baseUrl) {
     return joinPaths(paths, "leading");
   };
 }
+function getSlugs(info) {
+  const result = [...splitPath(info.dirname), info.name];
+  return result[result.length - 1] === "index" ? result.slice(0, -1) : result;
+}
 function loader(options) {
   return createOutput(options);
 }
@@ -348,10 +376,7 @@ function createOutput({
   rootDir = "",
   transformers,
   baseUrl = "/",
-  slugs = (info) => {
-    const result = [...info.dirname.split("/"), info.name].filter(Boolean);
-    return result[result.length - 1] === "index" ? result.slice(0, -1) : result;
-  },
+  slugs = getSlugs,
   url = createGetUrl(baseUrl)
 }) {
   const result = load({
@@ -376,8 +401,8 @@ function createOutput({
     },
     getPage(slugs_ = [], language = "") {
       var _a;
-      const path = slugs_.join("/");
-      return (_a = i18nMap.get(language)) == null ? void 0 : _a.find((page) => page.slugs.join("/") === path);
+      const path2 = slugs_.join("/");
+      return (_a = i18nMap.get(language)) == null ? void 0 : _a.find((page) => page.slugs.join("/") === path2);
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "8.3.0",
+  "version": "9.1.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -116,8 +116,8 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.0",
-    "@shikijs/rehype": "1.1.3",
-    "@shikijs/transformers": "1.1.3",
+    "@shikijs/rehype": "1.1.7",
+    "@shikijs/transformers": "1.1.7",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.0",
@@ -127,7 +127,7 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.0",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "1.1.3",
+    "shiki": "1.1.7",
     "swr": "^2.2.2",
     "unist-util-visit": "^5.0.0"
   },