import { ReactNode } from 'react';

interface ID {
    /**
     * ID for the node, unique in all page trees (even across different locales)
     */
    $id?: string;
}
interface Root extends ID {
    name: ReactNode;
    children: Node[];
    /**
     * Another page tree that won't be displayed unless being opened.
     */
    fallback?: Root;
}
type Node = Item | Separator | Folder;
interface Item extends ID {
    /**
     * @internal
     */
    $ref?: {
        file: string;
    };
    type: 'page';
    name: ReactNode;
    url: string;
    /**
     * Whether the link should be treated as external (e.g. use HTML <a> tag).
     *
     * When unspecified, it depends on the value of `url`.
     */
    external?: boolean;
    description?: ReactNode;
    icon?: ReactNode;
}
interface Separator extends ID {
    type: 'separator';
    name?: ReactNode;
    icon?: ReactNode;
}
interface Folder extends ID {
    /**
     * @internal
     */
    $ref?: {
        metaFile?: string;
    };
    type: 'folder';
    name: ReactNode;
    description?: ReactNode;
    root?: boolean;
    defaultOpen?: boolean;
    collapsible?: boolean;
    index?: Item;
    icon?: ReactNode;
    children: Node[];
}

export type { Folder as F, Item as I, Node as N, Root as R, Separator as S };