fumadocs-core 15.8.0 → 15.8.2

package/README.md

@@ -2,4 +2,4 @@
 
 The core library for Fumadocs.
 
-📘 Learn More: [Documentation](https://fumadocs.vercel.app)
+📘 Learn More: [Documentation](https://fumadocs.dev)

package/dist/breadcrumb.js

@@ -1,9 +1,9 @@
+import {
+  findPath
+} from "./chunk-2IYQ7QMS.js";
 import {
   normalizeUrl
 } from "./chunk-PFNP6PEB.js";
-import {
-  findPath
-} from "./chunk-HV3YIUWE.js";
 import "./chunk-JSBRDJBE.js";
 
 // src/breadcrumb.tsx

package/dist/{chunk-HV3YIUWE.js → chunk-2IYQ7QMS.js}

@@ -1,4 +1,4 @@
-// src/utils/page-tree.tsx
+// src/page-tree/utils.ts
 function flattenTree(nodes) {
   const out = [];
   for (const node of nodes) {
@@ -36,16 +36,6 @@ function getPageTreeRoots(pageTree) {
   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 [];
@@ -102,7 +92,6 @@ export {
   flattenTree,
   findNeighbour,
   getPageTreeRoots,
-  separatePageTree,
   getPageTreePeers,
   findPath
 };

package/dist/chunk-CX7IQ5Z6.js

@@ -0,0 +1,21 @@
+import {
+  remarkHeading
+} from "./chunk-QMATWJ5F.js";
+
+// src/content/toc.ts
+import { remark } from "remark";
+function getTableOfContents(content, remarkPlugins) {
+  if (remarkPlugins) {
+    return remark().use(remarkPlugins).use(remarkHeading).process(content).then((result2) => {
+      if ("toc" in result2.data) return result2.data.toc;
+      return [];
+    });
+  }
+  const result = remark().use(remarkHeading).processSync(content);
+  if ("toc" in result.data) return result.data.toc;
+  return [];
+}
+
+export {
+  getTableOfContents
+};

package/dist/chunk-DDDU7USP.js

@@ -0,0 +1,19 @@
+// src/source/plugins/icon.ts
+function iconPlugin(resolveIcon) {
+  function replaceIcon(node) {
+    if (node.icon === void 0 || typeof node.icon === "string")
+      node.icon = resolveIcon(node.icon);
+    return node;
+  }
+  return {
+    transformPageTree: {
+      file: replaceIcon,
+      folder: replaceIcon,
+      separator: replaceIcon
+    }
+  };
+}
+
+export {
+  iconPlugin
+};

package/dist/chunk-HSBNG7QC.js

@@ -0,0 +1,42 @@
+// src/content/github.ts
+async function getGithubLastEdit({
+  repo,
+  token,
+  owner,
+  path,
+  sha,
+  options = {},
+  params: customParams = {}
+}) {
+  const headers = new Headers(options.headers);
+  const params = new URLSearchParams();
+  params.set("path", path);
+  params.set("page", "1");
+  params.set("per_page", "1");
+  if (sha) params.set("sha", sha);
+  for (const [key, value] of Object.entries(customParams)) {
+    params.set(key, value);
+  }
+  if (token) {
+    headers.append("authorization", token);
+  }
+  const res = await fetch(
+    `https://api.github.com/repos/${owner}/${repo}/commits?${params.toString()}`,
+    {
+      cache: "force-cache",
+      ...options,
+      headers
+    }
+  );
+  if (!res.ok)
+    throw new Error(
+      `Failed to fetch last edit time from Git ${await res.text()}`
+    );
+  const data = await res.json();
+  if (data.length === 0) return null;
+  return new Date(data[0].commit.committer.date);
+}
+
+export {
+  getGithubLastEdit
+};

package/dist/chunk-YVVDKJ2H.js

@@ -0,0 +1,34 @@
+// src/negotiation/index.ts
+import Negotiator from "negotiator";
+import { compile, match } from "path-to-regexp";
+function getNegotiator(request) {
+  const headers = {};
+  request.headers.forEach((value, key) => {
+    headers[key] = value;
+  });
+  return new Negotiator({ headers });
+}
+function rewritePath(source, destination) {
+  const matcher = match(source, { decode: false });
+  const compiler = compile(destination, { encode: false });
+  return {
+    rewrite(pathname) {
+      const result = matcher(pathname);
+      if (!result) return false;
+      return compiler(result.params);
+    }
+  };
+}
+function isMarkdownPreferred(request, options) {
+  const {
+    markdownMediaTypes = ["text/plain", "text/markdown", "text/x-markdown"]
+  } = options ?? {};
+  const mediaTypes = getNegotiator(request).mediaTypes();
+  return markdownMediaTypes.some((type) => mediaTypes.includes(type));
+}
+
+export {
+  getNegotiator,
+  rewritePath,
+  isMarkdownPreferred
+};

package/dist/{chunk-BDG7Y4PS.js → chunk-Z5V4JSQY.js}

@@ -30,13 +30,6 @@ function parseFilePath(path) {
     }
   };
 }
-function parseFolderPath(path) {
-  return {
-    dirname: dirname(path),
-    name: basename(path),
-    path
-  };
-}
 function splitPath(path) {
   return path.split("/").filter((p) => p.length > 0);
 }
@@ -69,7 +62,6 @@ export {
   extname,
   dirname,
   parseFilePath,
-  parseFolderPath,
   splitPath,
   joinPath,
   slash

package/dist/content/github.d.ts

@@ -0,0 +1,34 @@
+interface GetGithubLastCommitOptions {
+    /**
+     * Repository name, like "fumadocs"
+     */
+    repo: string;
+    /** Owner of repository */
+    owner: string;
+    /**
+     * Path to file
+     */
+    path: string;
+    /**
+     * GitHub access token
+     */
+    token?: string;
+    /**
+     * SHA or ref (branch or tag) name.
+     */
+    sha?: string;
+    /**
+     * Custom query parameters
+     */
+    params?: Record<string, string>;
+    options?: RequestInit;
+}
+/**
+ * Get the last edit time of a file using GitHub API
+ *
+ * By default, this will cache the result forever.
+ * Set `options.next.revalidate` to customise this.
+ */
+declare function getGithubLastEdit({ repo, token, owner, path, sha, options, params: customParams, }: GetGithubLastCommitOptions): Promise<Date | null>;
+
+export { type GetGithubLastCommitOptions, getGithubLastEdit };

package/dist/content/github.js

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

package/dist/{get-toc-Cr2URuiP.d.ts → content/toc.d.ts}

@@ -1,25 +1,20 @@
-import { ReactNode } from 'react';
 import { PluggableList } from 'unified';
 import { Compatible } from 'vfile';
+import { TOCItemType } from '../toc.js';
+import 'react';
 
-interface TOCItemType {
-    title: ReactNode;
-    url: string;
-    depth: number;
-}
-type TableOfContents = TOCItemType[];
 /**
  * Get Table of Contents from markdown/mdx document (using remark)
  *
  * @param content - Markdown content or file
  */
-declare function getTableOfContents(content: Compatible): TableOfContents;
+declare function getTableOfContents(content: Compatible): TOCItemType[];
 /**
  * Get Table of Contents from markdown/mdx document (using remark)
  *
  * @param content - Markdown content or file
  * @param remarkPlugins - remark plugins to be applied first
  */
-declare function getTableOfContents(content: Compatible, remarkPlugins: PluggableList): Promise<TableOfContents>;
+declare function getTableOfContents(content: Compatible, remarkPlugins: PluggableList): Promise<TOCItemType[]>;
 
-export { type TableOfContents as T, type TOCItemType as a, getTableOfContents as g };
+export { getTableOfContents };

package/dist/content/toc.js

@@ -0,0 +1,8 @@
+import {
+  getTableOfContents
+} from "../chunk-CX7IQ5Z6.js";
+import "../chunk-QMATWJ5F.js";
+import "../chunk-JSBRDJBE.js";
+export {
+  getTableOfContents
+};

package/dist/i18n/middleware.js

@@ -1,18 +1,14 @@
+import {
+  getNegotiator
+} from "../chunk-YVVDKJ2H.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
-  );
+  const languages = getNegotiator(request).languages(locales);
   return matchLocale(languages, locales, defaultLanguage);
 }
 var defaultFormat = (locale, path) => {

package/dist/mdx-plugins/index.js

@@ -1,11 +1,11 @@
-import {
-  flattenNode,
-  remarkHeading
-} from "../chunk-QMATWJ5F.js";
 import {
   defaultThemes,
   getHighlighter
 } from "../chunk-HN2NUUD2.js";
+import {
+  flattenNode,
+  remarkHeading
+} from "../chunk-QMATWJ5F.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/mdx-plugins/index.ts

package/dist/negotiation/index.d.ts

@@ -0,0 +1,19 @@
+import Negotiator from 'negotiator';
+
+declare function getNegotiator(request: Request): Negotiator;
+/**
+ * Rewrite incoming path matching the `source` pattern into the `destination` pattern.
+ *
+ * See [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp) for accepted pattern formats.
+ *
+ * @param source - the original pattern of incoming paths
+ * @param destination - the target pattern to convert into
+ */
+declare function rewritePath(source: string, destination: string): {
+    rewrite(pathname: string): string | false;
+};
+declare function isMarkdownPreferred(request: Request, options?: {
+    markdownMediaTypes?: string[];
+}): boolean;
+
+export { getNegotiator, isMarkdownPreferred, rewritePath };

package/dist/negotiation/index.js

@@ -0,0 +1,11 @@
+import {
+  getNegotiator,
+  isMarkdownPreferred,
+  rewritePath
+} from "../chunk-YVVDKJ2H.js";
+import "../chunk-JSBRDJBE.js";
+export {
+  getNegotiator,
+  isMarkdownPreferred,
+  rewritePath
+};

package/dist/page-tree/index.d.ts

@@ -0,0 +1,32 @@
+import { N as Node, I as Item, R as Root, F as Folder } from '../definitions-Q95-psoo.js';
+export { S as Separator } from '../definitions-Q95-psoo.js';
+import 'react';
+
+/**
+ * Flatten tree to an array of page nodes
+ */
+declare function flattenTree(nodes: Node[]): Item[];
+/**
+ * Get neighbours of a page, useful for implementing "previous & next" buttons
+ */
+declare function findNeighbour(tree: Root, url: string, options?: {
+    separateRoot?: boolean;
+}): {
+    previous?: Item;
+    next?: Item;
+};
+declare function getPageTreeRoots(pageTree: Root | Folder): (Root | Folder)[];
+/**
+ * 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;
+
+export { Folder, Item, Node, Root, findNeighbour, findPath, flattenTree, getPageTreePeers, getPageTreeRoots };

package/dist/page-tree/index.js

@@ -0,0 +1,15 @@
+import {
+  findNeighbour,
+  findPath,
+  flattenTree,
+  getPageTreePeers,
+  getPageTreeRoots
+} from "../chunk-2IYQ7QMS.js";
+import "../chunk-JSBRDJBE.js";
+export {
+  findNeighbour,
+  findPath,
+  flattenTree,
+  getPageTreePeers,
+  getPageTreeRoots
+};

package/dist/search/server.js

@@ -1,18 +1,18 @@
-import {
-  basename,
-  extname
-} from "../chunk-BDG7Y4PS.js";
 import {
   searchAdvanced,
   searchSimple
 } from "../chunk-XOFXGHS4.js";
 import "../chunk-ZMWYLUDP.js";
+import {
+  basename,
+  extname
+} from "../chunk-Z5V4JSQY.js";
 import {
   createContentHighlighter
 } from "../chunk-OTD7MV33.js";
 import {
   findPath
-} from "../chunk-HV3YIUWE.js";
+} from "../chunk-2IYQ7QMS.js";
 import "../chunk-JSBRDJBE.js";
 
 // src/search/server.ts

package/dist/server/index.d.ts

@@ -1,80 +1,16 @@
-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 '../definitions-Q95-psoo.js';
-export { d as PageTree } from '../definitions-Q95-psoo.js';
+export { GetGithubLastCommitOptions, getGithubLastEdit } from '../content/github.js';
 import { Metadata } from 'next';
 import { NextRequest } from 'next/server';
 import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
+export { getTableOfContents } from '../content/toc.js';
+export { TOCItemType, TableOfContents } from '../toc.js';
 export { SortedResult } from '../search/index.js';
+export { findNeighbour, findPath, flattenTree, getPageTreePeers, getPageTreeRoots } from '../page-tree/index.js';
+export { d as PageTree } from '../definitions-Q95-psoo.js';
+import '../i18n/index.js';
 import 'react';
 import 'unified';
 import 'vfile';
-import '../i18n/index.js';
-
-/**
- * Flatten tree to an array of page nodes
- */
-declare function flattenTree(nodes: Node[]): Item[];
-/**
- * Get neighbours of a page, useful for implementing "previous & next" buttons
- */
-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
- *
- * @deprecated it's useless
- */
-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 {
-    /**
-     * Repository name, like "fumadocs"
-     */
-    repo: string;
-    /** Owner of repository */
-    owner: string;
-    /**
-     * Path to file
-     */
-    path: string;
-    /**
-     * GitHub access token
-     */
-    token?: string;
-    /**
-     * SHA or ref (branch or tag) name.
-     */
-    sha?: string;
-    /**
-     * Custom query parameters
-     */
-    params?: Record<string, string>;
-    options?: RequestInit;
-}
-/**
- * Get the last edit time of a file using GitHub API
- *
- * By default, this will cache the result forever.
- * Set `options.next.revalidate` to customise this.
- */
-declare function getGithubLastEdit({ repo, token, owner, path, sha, options, params: customParams, }: GetGithubLastCommitOptions): Promise<Date | null>;
 
 interface ImageMeta {
     alt: string;
@@ -82,6 +18,9 @@ interface ImageMeta {
     width: number;
     height: number;
 }
+/**
+ * @deprecated Use the SEO features of your own React.js framework instead
+ */
 declare function createMetadataImage<S extends LoaderOutput<LoaderConfig>>(options: {
     source: S;
     /**
@@ -124,4 +63,4 @@ declare function createMetadataImage<S extends LoaderOutput<LoaderConfig>>(optio
     }) => Response | Promise<Response>) => (request: NextRequest, options: any) => Response | Promise<Response>;
 };
 
-export { type GetGithubLastCommitOptions, createMetadataImage, findNeighbour, findPath, flattenTree, getGithubLastEdit, getPageTreePeers, getPageTreeRoots, separatePageTree };
+export { createMetadataImage };

package/dist/server/index.js

@@ -1,72 +1,19 @@
 import {
-  remarkHeading
-} from "../chunk-QMATWJ5F.js";
+  getGithubLastEdit
+} from "../chunk-HSBNG7QC.js";
+import {
+  getTableOfContents
+} from "../chunk-CX7IQ5Z6.js";
+import "../chunk-QMATWJ5F.js";
 import {
   findNeighbour,
   findPath,
   flattenTree,
   getPageTreePeers,
-  getPageTreeRoots,
-  separatePageTree
-} from "../chunk-HV3YIUWE.js";
+  getPageTreeRoots
+} from "../chunk-2IYQ7QMS.js";
 import "../chunk-JSBRDJBE.js";
 
-// src/server/get-toc.ts
-import { remark } from "remark";
-function getTableOfContents(content, remarkPlugins) {
-  if (remarkPlugins) {
-    return remark().use(remarkPlugins).use(remarkHeading).process(content).then((result2) => {
-      if ("toc" in result2.data) return result2.data.toc;
-      return [];
-    });
-  }
-  const result = remark().use(remarkHeading).processSync(content);
-  if ("toc" in result.data) return result.data.toc;
-  return [];
-}
-
-// src/source/page-tree/definitions.ts
-var definitions_exports = {};
-
-// src/server/git-api.ts
-async function getGithubLastEdit({
-  repo,
-  token,
-  owner,
-  path,
-  sha,
-  options = {},
-  params: customParams = {}
-}) {
-  const headers = new Headers(options.headers);
-  const params = new URLSearchParams();
-  params.set("path", path);
-  params.set("page", "1");
-  params.set("per_page", "1");
-  if (sha) params.set("sha", sha);
-  for (const [key, value] of Object.entries(customParams)) {
-    params.set(key, value);
-  }
-  if (token) {
-    headers.append("authorization", token);
-  }
-  const res = await fetch(
-    `https://api.github.com/repos/${owner}/${repo}/commits?${params.toString()}`,
-    {
-      cache: "force-cache",
-      ...options,
-      headers
-    }
-  );
-  if (!res.ok)
-    throw new Error(
-      `Failed to fetch last edit time from Git ${await res.text()}`
-    );
-  const data = await res.json();
-  if (data.length === 0) return null;
-  return new Date(data[0].commit.committer.date);
-}
-
 // src/server/metadata.ts
 function createMetadataImage(options) {
   const { filename = "image.png", imageRoute = "/docs-og" } = options;
@@ -126,7 +73,6 @@ function createMetadataImage(options) {
   };
 }
 export {
-  definitions_exports as PageTree,
   createMetadataImage,
   findNeighbour,
   findPath,
@@ -134,6 +80,5 @@ export {
   getGithubLastEdit,
   getPageTreePeers,
   getPageTreeRoots,
-  getTableOfContents,
-  separatePageTree
+  getTableOfContents
 };