@thepassle/app-tools/types/router/types.d.ts

Collection of tools I regularly use to build apps. Maybe they're useful to somebody else. Maybe not. Most of these are thin wrappers around native API's, like the native `<dialog>` element, `fetch` API, and `URLPattern`.

export interface Config {
    fallback?: string;
    plugins?: Plugin[];
    routes: RouteDefinition[];
}
export interface ShouldNavigateResult {
    redirect: string;
    condition: (() => boolean) | (() => Promise<boolean>);
}
export interface Plugin {
    name: string;
    shouldNavigate?: ((context: Context) => ShouldNavigateResult) | ((context: Context) => Promise<ShouldNavigateResult>);
    beforeNavigation?: (context: Context) => void;
    afterNavigation?: (context: Context) => void;
}
export interface Context {
    title?: string;
    query: Record<string, string>;
    params: Record<string, string>;
    url: URL;
    [key: string]: any;
}
export type Render<RenderResult> = (context: Context) => RenderResult;
export interface RouteDefinition<RenderResult = unknown> {
    path: string;
    title: string | ((context: Partial<Context>) => string);
    render?: Render<RenderResult>;
    plugins?: Plugin[];
}
/** @TODO URLPattern type */
export type Route = RouteDefinition & {
    urlPattern?: any;
};