fumadocs-core 15.2.8 → 16.0.3

package/dist/server/index.d.ts

@@ -1,117 +0,0 @@
-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-BG3wP0gU.js';
-export { p as PageTree } from '../page-tree-BG3wP0gU.js';
-export { S as SortedResult } from '../types-Ch8gnVgO.js';
-import { Metadata } from 'next';
-import { NextRequest } from 'next/server';
-import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
-import 'react';
-import 'unified';
-import 'vfile';
-import '../config-inq6kP6y.js';
-
-/**
- * Flatten tree to an array of page nodes
- */
-declare function flattenTree(tree: 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
- */
-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[];
-
-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;
-    url: string;
-    width: number;
-    height: number;
-}
-declare function createMetadataImage<S extends LoaderOutput<LoaderConfig>>(options: {
-    source: S;
-    /**
-     * the route of your OG image generator.
-     *
-     * @example '/docs-og'
-     * @defaultValue '/docs-og'
-     */
-    imageRoute?: string;
-    /**
-     * The filename of generated OG Image
-     *
-     * @defaultValue 'image.png'
-     */
-    filename?: string;
-}): {
-    getImageMeta: (slugs: string[]) => ImageMeta;
-    /**
-     * Add image meta tags to metadata
-     */
-    withImage: (slugs: string[], metadata?: Metadata) => Metadata;
-    /**
-     * Generate static params for OG Image Generator
-     */
-    generateParams: () => {
-        slug: string[];
-        lang?: string;
-    }[];
-    /**
-     * create route handler for OG Image Generator
-     */
-    createAPI: (handler: (page: InferPageType<S>, request: NextRequest, options: {
-        params: {
-            slug: string[];
-            lang?: string;
-        } | Promise<{
-            slug: string[];
-            lang?: string;
-        }>;
-    }) => Response | Promise<Response>) => (request: NextRequest, options: any) => Response | Promise<Response>;
-};
-
-export { type GetGithubLastCommitOptions, createMetadataImage, findNeighbour, flattenTree, getGithubLastEdit, getPageTreePeers, getPageTreeRoots, separatePageTree };

package/dist/server/index.js

@@ -1,202 +0,0 @@
-import {
-  remarkHeading
-} from "../chunk-Y2774T3B.js";
-import "../chunk-MLKGABMK.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/utils/page-tree.tsx
-function flattenTree(tree) {
-  return tree.flatMap((node) => {
-    if (node.type === "separator") return [];
-    if (node.type === "folder") {
-      const child = flattenTree(node.children);
-      if (node.index) return [node.index, ...child];
-      return child;
-    }
-    return [node];
-  });
-}
-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 [];
-    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;
-    }
-  }
-}
-
-// src/server/page-tree.ts
-var page_tree_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;
-  function getImageMeta(slugs) {
-    return {
-      alt: "Banner",
-      url: `/${[...imageRoute.split("/"), ...slugs, filename].filter((v) => v.length > 0).join("/")}`,
-      width: 1200,
-      height: 630
-    };
-  }
-  return {
-    getImageMeta,
-    withImage(slugs, data) {
-      const imageData = getImageMeta(slugs);
-      return {
-        ...data,
-        openGraph: {
-          images: imageData,
-          ...data?.openGraph
-        },
-        twitter: {
-          images: imageData,
-          card: "summary_large_image",
-          ...data?.twitter
-        }
-      };
-    },
-    generateParams() {
-      return options.source.generateParams().map((params) => ({
-        ...params,
-        slug: [...params.slug, filename]
-      }));
-    },
-    createAPI(handler) {
-      return async (req, args) => {
-        const params = await args.params;
-        if (!params || !("slug" in params) || params.slug === void 0)
-          throw new Error(`Invalid params: ${JSON.stringify(params)}`);
-        const lang = "lang" in params && typeof params.lang === "string" ? params.lang : void 0;
-        const input = {
-          slug: Array.isArray(params.slug) ? params.slug : [params.slug],
-          lang
-        };
-        const page = options.source.getPage(
-          input.slug.slice(0, -1),
-          //remove filename
-          lang
-        );
-        if (!page)
-          return new Response(null, {
-            status: 404
-          });
-        return handler(page, req, { params: input });
-      };
-    }
-  };
-}
-export {
-  page_tree_exports as PageTree,
-  createMetadataImage,
-  findNeighbour,
-  flattenTree,
-  getGithubLastEdit,
-  getPageTreePeers,
-  getPageTreeRoots,
-  getTableOfContents,
-  separatePageTree
-};

package/dist/sidebar.d.ts

@@ -1,33 +0,0 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode, ElementType, ComponentPropsWithoutRef, ReactElement } from 'react';
-
-interface SidebarProviderProps {
-    open?: boolean;
-    onOpenChange?: (v: boolean) => void;
-    children: ReactNode;
-}
-declare function SidebarProvider(props: SidebarProviderProps): react_jsx_runtime.JSX.Element;
-type AsProps<T extends ElementType> = Omit<ComponentPropsWithoutRef<T>, 'as'> & {
-    as?: T;
-};
-type SidebarTriggerProps<T extends ElementType> = AsProps<T>;
-declare function SidebarTrigger<T extends ElementType = 'button'>({ as, ...props }: SidebarTriggerProps<T>): ReactElement;
-type SidebarContentProps<T extends ElementType> = AsProps<T> & {
-    /**
-     * Disable scroll blocking when the viewport width is larger than a certain number (in pixels)
-     *
-     * @deprecated use `removeScrollOn`
-     */
-    blockScrollingWidth?: number;
-    /**
-     * A media query.
-     *
-     * When the sidebar is opening and media query is matched, scrolling outside the sidebar will be blocked.
-     *
-     * @example (max-width: 1000px)
-     */
-    removeScrollOn?: string;
-};
-declare function SidebarList<T extends ElementType = 'aside'>({ as, blockScrollingWidth, removeScrollOn, ...props }: SidebarContentProps<T>): ReactElement;
-
-export { type SidebarContentProps, SidebarList, SidebarProvider, type SidebarProviderProps, SidebarTrigger, type SidebarTriggerProps };

package/dist/sidebar.js

@@ -1,89 +0,0 @@
-"use client";
-import "./chunk-MLKGABMK.js";
-
-// src/sidebar.tsx
-import {
-  createContext,
-  useContext,
-  useEffect,
-  useState,
-  useMemo
-} from "react";
-import { RemoveScroll } from "react-remove-scroll";
-import { jsx } from "react/jsx-runtime";
-var SidebarContext = createContext(null);
-function useSidebarContext() {
-  const ctx = useContext(SidebarContext);
-  if (!ctx) throw new Error("Missing sidebar provider");
-  return ctx;
-}
-function SidebarProvider(props) {
-  const [open, setOpen] = props.open === void 0 ? (
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    useState(false)
-  ) : [props.open, props.onOpenChange];
-  return /* @__PURE__ */ jsx(
-    SidebarContext.Provider,
-    {
-      value: useMemo(
-        () => ({ open, setOpen: setOpen ?? (() => void 0) }),
-        [open, setOpen]
-      ),
-      children: props.children
-    }
-  );
-}
-function SidebarTrigger({
-  as,
-  ...props
-}) {
-  const { open, setOpen } = useSidebarContext();
-  const As = as ?? "button";
-  return /* @__PURE__ */ jsx(
-    As,
-    {
-      "aria-label": "Toggle Sidebar",
-      "data-open": open,
-      onClick: () => {
-        setOpen(!open);
-      },
-      ...props
-    }
-  );
-}
-function SidebarList({
-  as,
-  blockScrollingWidth,
-  removeScrollOn = blockScrollingWidth ? `(width < ${blockScrollingWidth}px)` : void 0,
-  ...props
-}) {
-  const { open } = useSidebarContext();
-  const [isBlocking, setIsBlocking] = useState(false);
-  useEffect(() => {
-    if (!removeScrollOn) return;
-    const mediaQueryList = window.matchMedia(removeScrollOn);
-    const handleChange = () => {
-      setIsBlocking(mediaQueryList.matches);
-    };
-    handleChange();
-    mediaQueryList.addEventListener("change", handleChange);
-    return () => {
-      mediaQueryList.removeEventListener("change", handleChange);
-    };
-  }, [removeScrollOn]);
-  return /* @__PURE__ */ jsx(
-    RemoveScroll,
-    {
-      as: as ?? "aside",
-      "data-open": open,
-      enabled: Boolean(isBlocking && open),
-      ...props,
-      children: props.children
-    }
-  );
-}
-export {
-  SidebarList,
-  SidebarProvider,
-  SidebarTrigger
-};

package/dist/static-VESU2S64.js

@@ -1,61 +0,0 @@
-import {
-  searchAdvanced,
-  searchSimple
-} from "./chunk-WFUH5VBX.js";
-import "./chunk-KAOEMCTI.js";
-import "./chunk-MLKGABMK.js";
-
-// src/search/client/static.ts
-import { create, load } from "@orama/orama";
-function createStaticClient({
-  from = "/api/search",
-  initOrama = (locale) => create({ schema: { _: "string" }, language: locale })
-}) {
-  const dbs = /* @__PURE__ */ new Map();
-  async function init() {
-    const res = await fetch(from);
-    if (!res.ok)
-      throw new Error(
-        `failed to fetch exported search indexes from ${from}, make sure the search database is exported and available for client.`
-      );
-    const data = await res.json();
-    if (data.type === "i18n") {
-      for (const [k, v] of Object.entries(data.data)) {
-        const db = await initOrama(k);
-        load(db, v);
-        dbs.set(k, {
-          type: v.type,
-          db
-        });
-      }
-    } else {
-      const db = await initOrama();
-      load(db, data);
-      dbs.set("", {
-        type: data.type,
-        db
-      });
-    }
-  }
-  const get = init();
-  return {
-    async search(query, locale, tag) {
-      await get;
-      const cached = dbs.get(locale ?? "");
-      if (!cached) return [];
-      if (cached.type === "simple")
-        return searchSimple(
-          cached,
-          query
-        );
-      return searchAdvanced(
-        cached.db,
-        query,
-        tag
-      );
-    }
-  };
-}
-export {
-  createStaticClient
-};

package/dist/types-Ch8gnVgO.d.ts

@@ -1,8 +0,0 @@
-interface SortedResult {
-    id: string;
-    url: string;
-    type: 'page' | 'heading' | 'text';
-    content: string;
-}
-
-export type { SortedResult as S };