import { Node as MarkdownAST } from 'unist';
import { Processor, Plugin as UnifiedPlugin, Settings as UnifiedSettings } from 'unified';
import { VFile } from 'vfile';
export interface Heading {
    title: string;
    id: string;
    depth: number;
    headings?: Heading[];
}
export interface PageMetadata {
    url: string;
    relativeUrl: undefined | string;
    relativePath: string;
    editUrl: string;
    title: string;
    headings: Heading[];
    frontmatter: Record<string, unknown>;
    pluginData: Record<string, unknown>;
    parentLabel: undefined | string;
}
export interface PageContent {
    meta: PageMetadata;
    sourceConfig: SourceConfig;
    source: string;
    vFile: VFile;
    ast: MarkdownAST;
    markdown: string;
    rendered: string;
    demos?: PageContent[];
    pluginData: Record<string, unknown>;
}
interface ContextOptions extends Omit<Options, 'plugins' | 'remarkPlugins' | 'rehypePlugins' | 'tocMaxDepth'> {
    tocMaxDepth: number;
}
export interface StaticAssetDefinition {
    fromPath: string;
    toPath: string;
}
export interface Context {
    remark: Processor;
    rehype: Processor;
    pages: PageContent[];
    staticAssets: StaticAssetDefinition[];
    options: ContextOptions;
}
export interface NestedPageMetadata {
    name: string;
    label: string;
    pages: PageMetadata[];
    children: NestedPageMetadata[];
}
export interface DocfyResult {
    content: PageContent[];
    staticAssets: StaticAssetDefinition[];
    nestedPageMetadata: NestedPageMetadata;
}
export interface SourceConfig {
    /**
     * The absolute path to where the files are located.
     */
    root: string;
    /**
     * Match files using the patterns the shell uses, like stars and stuff. It
     * uses Glob package.
     */
    pattern: string;
    /**
     * Pattern to ignore.
     */
    ignore?: string[];
    /**
     * Option to change how urls are generated.
     *
     * There are two ways URLs can ge generated.
     *
     * 1. "auto": Uses the folder structure to inform how the urls are generated.
     *    For example, if you have the folowing files:
     *      - install.md
     *      - components/
     *        - button.md
     *        - card.md
     *    The urls would look like this, (assuming urlPrefix is set to "docs").
     *      - docs/install
     *      - docs/components/buttons
     *      - docs/components/card
     *
     * 2. "manual": It uses frontmatter information to inform "subcategory" and
     *    "category" of the file, ignoring the original file location.
     *    The url schema is as follows:
     *    {category}/{subcategory}/{file-name}
     *
     *    If no category or subcategory is specified, all files will be at the root
     *    level.
     *
     *    This options is perfect for documenting monorepo projects while keeping
     *    documentation next to implementation.
     */
    urlSchema?: 'auto' | 'manual';
    /**
     * Option to prefix the urls.
     *
     * For example:
     * "docs" will generate urls like "/docs/something"
     * "blog" will generate urls like "/blog/something"
     */
    urlPrefix?: string;
    /**
     * Option to suffix the urls.
     *
     * For example:
     * ".html" will generate urls like "/something.html"
     */
    urlSuffix?: string;
    /**
     * Overwrite repository config for this source.
     */
    repository?: RepositoryConfig;
}
interface RepositoryConfig {
    /**
     *
     * The url to the Git Repository
     * Example: https://github.com/josemarluedke/docfy
     */
    url: string;
    /**
     * Branch used to edit your markdown when clicking on "Edit this page" button.
     * @default "master"
     */
    editBranch?: string;
}
export interface PluginOptions {
    [key: string]: unknown;
}
export type PluginHandler<T = PluginOptions | undefined | null> = (ctx: Context, options: T) => void;
export interface Plugin<T = PluginOptions | undefined | null> {
    runBefore?: PluginHandler<T>;
    runWithMdast?: PluginHandler<T>;
    runWithHast?: PluginHandler<T>;
    runAfter?: PluginHandler<T>;
}
export interface PluginWithOptions<T = PluginOptions> extends Plugin<T> {
    __options?: T;
}
export type PluginWithOptionsFunction<T = PluginOptions> = (options?: T) => PluginWithOptions<T>;
export type PluginList = (Plugin | PluginWithOptions<any> | PluginWithOptionsFunction<any>)[];
export interface SectionConfig {
    /**
     * Custom label for the section. If not provided, the folder name will be used.
     */
    label?: string;
    /**
     * Order of the section. Sections with lower order values appear first.
     * Sections without an order value will be sorted alphabetically and appear
     * after ordered sections.
     */
    order?: number;
}
export interface Options {
    /**
     * A list of Docfy plugins.
     */
    plugins?: PluginList;
    /**
     * Additional remark plugins
     *
     * Example:
     *
     * ```js
     * const hbs = require('remark-hbs');
     * const autolinkHeadings = require('remark-autolink-headings');
     *
     * const remarkPlugins = [
     *   [
     *     autolinkHeadings,
     *     {
     *       behavior: 'wrap'
     *     }
     *   ],
     *   hbs
     * ];
     * ```
     */
    remarkPlugins?: ([UnifiedPlugin, UnifiedSettings] | UnifiedPlugin)[];
    /**
     * Additional rehype plugins
     *
     * Example:
     *
     * ```js
     * const rehypePrism = require('@mapbox/rehype-prism');
     *
     * const rehypePlugins = [rehypePrism];
     * ```
     */
    rehypePlugins?: ([UnifiedPlugin, UnifiedSettings] | UnifiedPlugin)[];
    /**
     * The max depth of headings
     * @default 6
     */
    tocMaxDepth?: number;
    /**
     * The repository config
     */
    repository?: RepositoryConfig;
    /**
     * Labels to be used while generating nestedPageMetadata
     * @deprecated Use `sections` instead for more control over section ordering and labels
     */
    labels?: Record<string, string>;
    /**
     * Configuration for documentation sections (folders).
     * Allows you to set custom labels and control the order of sections.
     *
     * Example:
     * ```js
     * sections: {
     *   components: { label: 'Components', order: 1 },
     *   core: { label: '@docfy/core', order: 2 },
     *   docs: { label: 'Documentation' } // No order, will be alphabetically sorted
     * }
     * ```
     */
    sections?: Record<string, SectionConfig>;
    /**
     * The static asset path to be used in the their url.
     * Eg. staticAssetsPath: "/assets/docfy" and a static asset name as
     * "github-icon.png", the URL to be used for the image would be
     * "/assets/docfy/github-icon.png".
     *
     * @default "/assets/docfy"
     */
    staticAssetsPath?: string;
}
interface DocfyConfigSourceConfig extends Omit<SourceConfig, 'root'> {
    root?: string;
}
export interface DocfyConfig extends Options {
    sources: DocfyConfigSourceConfig[];
}
export {};