import React, { ComponentType, Dispatch, AnchorHTMLAttributes, MouseEventHandler, ReactNode } from 'react'; import { UnionToIntersection } from '@karma.run/utility'; import { Key } from 'path-to-regexp'; export declare enum HistoryType { Push = "push", Replace = "replace" } export interface ScrollData { x: number; y: number; } export interface HistoryState { type: HistoryType; path: string; data?: any; scroll?: ScrollData | null; } export interface RouteContextState { readonly current: R | null; readonly next: R | null; readonly previous: R | null; readonly history: HistoryState | null; } export declare const RouteContext: React.Context> | null>; export declare type RouteDispatchContextState = Dispatch>; export declare const RouteDispatchContext: React.Context>> | null>; export declare enum RouteActionType { PushRoute = "pushRoute", ReplaceRoute = "replaceRoute", SetCurrentRoute = "setCurrentRoute", SyncFromBrowser = "syncFromBrowser" } export interface PushRouteAction { readonly type: RouteActionType.PushRoute; readonly route: R; } export declare function pushRoute(route: R): PushRouteAction; export interface ReplaceRouteAction { readonly type: RouteActionType.ReplaceRoute; readonly route: R; } export declare function replaceRoute(route: R): ReplaceRouteAction; export interface SetCurrentRouteAction { readonly type: RouteActionType.SetCurrentRoute; readonly route: R; } export declare function setCurrentRoute(route: R): SetCurrentRouteAction; export interface SyncFromBrowser { readonly type: RouteActionType.SyncFromBrowser; readonly route: R; } export declare function syncFromBrowser(route: R): SyncFromBrowser; export declare type RouteAction = PushRouteAction | ReplaceRouteAction | SetCurrentRouteAction | SyncFromBrowser; /** @deprecated Use route.path instead */ export declare function fullPathForRoute(route: RouteInstance): string; export declare function routeReducer(state: RouteContextState, action: RouteAction): RouteContextState; export interface RouteProviderProps { readonly initialRoute?: R | null; readonly handleNextRoute?: HandleNextRouteFn; readonly children?: ReactNode; } export interface LinkProps { readonly route?: R; } export interface LinkPropsWithAnchorAttributes extends LinkProps, AnchorHTMLAttributes { } export declare type LinkHOCCompatibleProps = { href?: string; onClick?: MouseEventHandler; }; export interface CreateRouteContextResult { readonly RouteProvider: ComponentType>; readonly Link: ComponentType>; useRoute(): RouteContextState; useRouteDispatch(): RouteDispatchContextState; matchRoute(url: string): R | null; routeLink

(Component: ComponentType

): ComponentType

>; } export declare type RouteResolveFn = (url: string) => R; export declare type HandleNextRouteFn = (route: R, dispatch: Dispatch>) => () => void; export declare function createRouteContext = RouteInstancesForRoutes>(routes: T): CreateRouteContextResult; export declare enum RouteParameterType { Required = "required", Optional = "optional", ZeroOrMore = "zeroOrMore", OneOrMore = "oneOrMore", Regexp = "regexp" } export interface RequiredRouteParameter { readonly type: RouteParameterType.Required; readonly key: K; } export interface OptionalRouteParameter { readonly type: RouteParameterType.Optional; readonly key: K; } export interface ZeroOrMoreRouteParameter { readonly type: RouteParameterType.ZeroOrMore; readonly key: K; } export interface OneOrMoreRouteParameter { readonly type: RouteParameterType.OneOrMore; readonly key: K; } export interface RegexpRouteParameter { readonly type: RouteParameterType.Regexp; readonly key: K; readonly regexp: RegExp; } export declare type RouteParameter = RequiredRouteParameter | OptionalRouteParameter | ZeroOrMoreRouteParameter | OneOrMoreRouteParameter | RegexpRouteParameter; export declare function required(key: K): RequiredRouteParameter; export declare function optional(key: K): OptionalRouteParameter; export declare function zeroOrMore(key: K): ZeroOrMoreRouteParameter; export declare function oneOrMore(key: K): OneOrMoreRouteParameter; export declare function regexp(key: K, regexp: RegExp): RegexpRouteParameter; export interface RouteInstance { type: T; params: ObjectForParams

; data: D; pathname: string; path: string; query?: Record; hash?: string; scroll?: ScrollData | null; } export interface Route { readonly type: T; readonly path: RoutePath

; readonly defaultData: D; create(params: ObjectForParams

, opts?: CreateOptions): RouteInstance; reverse(params: ObjectForParams

, query?: { [key: string]: string; }, hash?: string): string; match(path: string): ObjectForParams

| null; } export interface CreateOptions { data?: D; query?: { [key: string]: string; }; hash?: string; scroll?: ScrollData | null; } export declare function route(type: T, path: RoutePath

): Route; export declare function route(type: T, path: RoutePath

, defaultData: D): Route; export interface RoutePath

{ readonly path: string; readonly regexp: RegExp; readonly keys: Key[]; readonly params: P; reverse(params: ObjectForParams

, query?: Record, hash?: string): string; match(path: string): ObjectForParams

| null; } export declare function routePath

(template: TemplateStringsArray, ...params: P): RoutePath

; export declare type ObjectForParams

= UnionToIntersection<{ [K in keyof P]: P[K] extends RequiredRouteParameter | RegexpRouteParameter | OneOrMoreRouteParameter ? { [PK in P[K]['key']]: string; } : P[K] extends OptionalRouteParameter | ZeroOrMoreRouteParameter ? { [PK in P[K]['key']]?: string; } : {}; }[number]>; export declare function matchRoutes>(url: string | URL, routes: R): I | null; export declare type RouteInstancesForRoutes = { [K in keyof R]: R[K] extends Route ? RouteInstance : never; }[number]; //# sourceMappingURL=route.d.ts.map