import UrlPattern from "url-pattern";
import { RemoteIconData } from "../icons/icons";
interface IRouteDisplay {
    title: string;
    description: string;
    route: string;
    icon: RemoteIconData;
}
/**
 * a route display data for sending built route data to client. if your client uses remote-ui, it will draw a interactive button, listTile, etc, . automatically targets the route provided.
 */
export declare class RouteDisplay implements IRouteDisplay {
    description: string;
    icon: RemoteIconData;
    route: string;
    title: string;
    constructor(props: any);
    static fromSpec(spec: any, params: any): RouteDisplay;
}
export declare enum RouteType {
    LIST = 0,
    DETAIL = 1,
    HOME = 2,
    MIXED = 3
}
/**
 * @type:P the interface structure type of parameter. e.g. "/users/:id" will take param type { id: string }
 * @type:T the data type used for building route contents like, title, description, icon
 * @field:pattern a unique url  pattern for this route. e.g. "/users/:id"
 * @field:key use for loading template, or localized string (template formatted) automatically builds child's key. e.g. if key "menu/user" is provided, it will make title field's key as "menu/user/title" if no override key is provided
 * @field:params a parsed params value for built route input. e.g. if "/user/123" is provided, params will be { id : "123"}
 * @field:type a type of this route.
 * @function:dataFetcher a function for loading data T via provided params P.
 */
export interface IRouteSpec<P, T> {
    pattern: string;
    key: string;
    params?: P;
    type?: RouteType;
    dataFetcher?: (params: P) => Promise<T>;
    title: IDisplayFieldBuilder<P, T, string>;
    description?: IDisplayFieldBuilder<P, T, string>;
    icon?: IDisplayFieldBuilder<P, T, RemoteIconData>;
}
/**
 * a data container interface for building route's specific field. for example, title. (used along with function buildField)
 * @type:I input data type
 * @type:O output value type
 * @field:default a fallback string or default value if no template, key, builder is provided
 * @field:key use for loading template, or localized string (template formatted)
 * @field:template a mustache based template, data I from RouteSpec is filled automatically. use valid template. if template is not valid, fallback default value will be returned
 * @field:builder a builder function which takes I as input and returns O as output
 */
interface IDisplayFieldBuilder<P, I, O> {
    default: O;
    key?: string;
    template?: string;
    builder?: (data: IDisplayFieldBuilderInput<P, I>) => O;
}
interface IDisplayFieldBuilderInput<P, T> {
    data: T;
    params: P;
    key: string;
}
export declare class RouteSpec<P, T> implements IRouteSpec<P, T> {
    pattern: string;
    key: string;
    params: P;
    data: T;
    type: RouteType;
    dataFetcher: (params: P) => Promise<T>;
    title: IDisplayFieldBuilder<P, T, string>;
    description?: IDisplayFieldBuilder<P, T, string>;
    icon?: IDisplayFieldBuilder<P, T, RemoteIconData>;
    _compiledPattern: UrlPattern;
    constructor(props: IRouteSpec<P, T>);
    fetchData(): Promise<T>;
}
export declare class RouteInstance<P, T> extends RouteSpec<P, T> {
    data: T;
    constructor(props: IRouteSpec<P, T>);
    toDisplay(): Promise<RouteDisplay>;
    buildRoute(): string;
    buildTitle(): Promise<string>;
    buildDescription(): Promise<string>;
    buildIcon(): Promise<RemoteIconData>;
}
export {};