fumadocs-core/dist/server/index.d.ts

The library for building a documentation website in Next.js

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';
import { Metadata } from 'next';
import { NextRequest } from 'next/server';
import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
export { SortedResult } from '../search/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;
    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, findPath, flattenTree, getGithubLastEdit, getPageTreePeers, getPageTreeRoots, separatePageTree };