@tanstack/router-core 0.0.1-beta.3 → 0.0.1-beta.30

package/build/types/index.d.ts

@@ -14,36 +14,94 @@ export { default as invariant } from 'tiny-invariant';
 
 interface FrameworkGenerics {
 }
-declare type GetFrameworkGeneric<U> = U extends keyof FrameworkGenerics ? FrameworkGenerics[U] : any;
+type GetFrameworkGeneric<U> = U extends keyof FrameworkGenerics ? FrameworkGenerics[U] : any;
 
-declare type NoInfer<T> = [T][T extends any ? 0 : never];
-declare type IsAny<T, Y, N> = 1 extends 0 & T ? Y : N;
-declare type IsAnyBoolean<T> = 1 extends 0 & T ? true : false;
-declare type IsKnown<T, Y, N> = unknown extends T ? N : Y;
-declare type PickAsRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-declare type PickAsPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-declare type PickUnsafe<T, K> = K extends keyof T ? Pick<T, K> : never;
-declare type PickExtra<T, K> = Expand<{
+interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
+    matchId: string;
+    pathname: string;
+    params: TRouteInfo['allParams'];
+    parentMatch?: RouteMatch;
+    childMatches: RouteMatch[];
+    routeSearch: TRouteInfo['searchSchema'];
+    search: TRouteInfo['fullSearchSchema'];
+    status: 'idle' | 'loading' | 'success' | 'error';
+    updatedAt?: number;
+    error?: unknown;
+    isInvalid: boolean;
+    getIsInvalid: () => boolean;
+    loaderData: TRouteInfo['loaderData'];
+    routeLoaderData: TRouteInfo['routeLoaderData'];
+    isFetching: boolean;
+    invalidAt: number;
+    __: {
+        component?: GetFrameworkGeneric<'Component'>;
+        errorComponent?: GetFrameworkGeneric<'ErrorComponent'>;
+        pendingComponent?: GetFrameworkGeneric<'Component'>;
+        loadPromise?: Promise<void>;
+        componentsPromise?: Promise<void>;
+        dataPromise?: Promise<TRouteInfo['routeLoaderData']>;
+        onExit?: void | ((matchContext: {
+            params: TRouteInfo['allParams'];
+            search: TRouteInfo['fullSearchSchema'];
+        }) => void);
+        abortController: AbortController;
+        latestId: string;
+        validate: () => void;
+        notify: () => void;
+        resolve: () => void;
+    };
+    cancel: () => void;
+    load: (loaderOpts?: {
+        preload: true;
+        maxAge: number;
+        gcMaxAge: number;
+    } | {
+        preload?: false;
+        maxAge?: never;
+        gcMaxAge?: never;
+    }) => Promise<TRouteInfo['routeLoaderData']>;
+    fetch: (opts?: {
+        maxAge?: number;
+    }) => Promise<TRouteInfo['routeLoaderData']>;
+    invalidate: () => void;
+    hasLoaders: () => boolean;
+}
+declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
+    parentMatch?: RouteMatch<any, any>;
+    matchId: string;
+    params: TRouteInfo['allParams'];
+    pathname: string;
+}): RouteMatch<TAllRouteInfo, TRouteInfo>;
+
+type NoInfer<T> = [T][T extends any ? 0 : never];
+type IsAny<T, Y, N> = 1 extends 0 & T ? Y : N;
+type IsAnyBoolean<T> = 1 extends 0 & T ? true : false;
+type IsKnown<T, Y, N> = unknown extends T ? N : Y;
+type PickAsRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+type PickAsPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type PickUnsafe<T, K> = K extends keyof T ? Pick<T, K> : never;
+type PickExtra<T, K> = Expand<{
     [TKey in keyof K as string extends TKey ? never : TKey extends keyof T ? never : TKey]: K[TKey];
 }>;
-declare type PickRequired<T> = {
+type PickRequired<T> = {
     [K in keyof T as undefined extends T[K] ? never : K]: T[K];
 };
-declare type Expand<T> = T extends object ? T extends infer O ? {
+type Expand<T> = T extends object ? T extends infer O ? {
     [K in keyof O]: O[K];
 } : never : T;
-declare type Values<O> = O[ValueKeys<O>];
-declare type ValueKeys<O> = Extract<keyof O, PropertyKey>;
-declare type DeepAwaited<T> = T extends Promise<infer A> ? DeepAwaited<A> : T extends Record<infer A, Promise<infer B>> ? {
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => any ? I : never;
+type Values<O> = O[ValueKeys<O>];
+type ValueKeys<O> = Extract<keyof O, PropertyKey>;
+type DeepAwaited<T> = T extends Promise<infer A> ? DeepAwaited<A> : T extends Record<infer A, Promise<infer B>> ? {
     [K in A]: DeepAwaited<B>;
 } : T;
-declare type PathParamMask<TRoutePath extends string> = TRoutePath extends `${infer L}/:${infer C}/${infer R}` ? PathParamMask<`${L}/${string}/${R}`> : TRoutePath extends `${infer L}/:${infer C}` ? PathParamMask<`${L}/${string}`> : TRoutePath;
-declare type Timeout = ReturnType<typeof setTimeout>;
-declare type Updater<TPrevious, TResult = TPrevious> = TResult | ((prev?: TPrevious) => TResult);
-declare type PickExtract<T, U> = {
+type PathParamMask<TRoutePath extends string> = TRoutePath extends `${infer L}/$${infer C}/${infer R}` ? PathParamMask<`${L}/${string}/${R}`> : TRoutePath extends `${infer L}/$${infer C}` ? PathParamMask<`${L}/${string}`> : TRoutePath;
+type Timeout = ReturnType<typeof setTimeout>;
+type Updater<TPrevious, TResult = TPrevious> = TResult | ((prev?: TPrevious) => TResult);
+type PickExtract<T, U> = {
     [K in keyof T as T[K] extends U ? K : never]: T[K];
 };
-declare type PickExclude<T, U> = {
+type PickExclude<T, U> = {
     [K in keyof T as T[K] extends U ? never : K]: T[K];
 };
 /**
@@ -55,7 +113,16 @@ declare function replaceEqualDeep(prev: any, next: any): any;
 declare function last<T>(arr: T[]): T | undefined;
 declare function warning(cond: any, message: string): cond is true;
 declare function functionalUpdate<TResult>(updater: Updater<TResult>, previous: TResult): TResult;
+declare function pick<T, K extends keyof T>(parent: T, keys: K[]): Pick<T, K>;
 
+interface RegisterRouter {
+}
+type RegisteredRouter = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo, infer TRouterContext>;
+} ? Router<TRouteConfig, TAllRouteInfo, TRouterContext> : Router;
+type RegisteredAllRouteInfo = RegisterRouter extends {
+    router: Router<infer TRouteConfig, infer TAllRouteInfo, infer TRouterContext>;
+} ? TAllRouteInfo : AnyAllRouteInfo;
 interface LocationState {
 }
 interface Location<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
@@ -73,10 +140,10 @@ interface FromLocation {
     key?: string;
     hash?: string;
 }
-declare type SearchSerializer = (searchObj: Record<string, any>) => string;
-declare type SearchParser = (searchStr: string) => Record<string, any>;
-declare type FilterRoutesFn = <TRoute extends Route<any, RouteInfo>>(routeConfigs: TRoute[]) => TRoute[];
-interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
+type SearchSerializer = (searchObj: Record<string, any>) => string;
+type SearchParser = (searchStr: string) => Record<string, any>;
+type FilterRoutesFn = <TRoute extends Route<any, RouteInfo>>(routeConfigs: TRoute[]) => TRoute[];
+interface RouterOptions<TRouteConfig extends AnyRouteConfig, TRouterContext> {
     history?: BrowserHistory | MemoryHistory | HashHistory;
     stringifySearch?: SearchSerializer;
     parseSearch?: SearchParser;
@@ -85,35 +152,37 @@ interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
     defaultPreloadMaxAge?: number;
     defaultPreloadGcMaxAge?: number;
     defaultPreloadDelay?: number;
-    useErrorBoundary?: boolean;
-    defaultElement?: GetFrameworkGeneric<'Element'>;
-    defaultErrorElement?: GetFrameworkGeneric<'Element'>;
-    defaultCatchElement?: GetFrameworkGeneric<'Element'>;
-    defaultPendingElement?: GetFrameworkGeneric<'Element'>;
-    defaultPendingMs?: number;
-    defaultPendingMinMs?: number;
+    defaultComponent?: GetFrameworkGeneric<'Component'>;
+    defaultErrorComponent?: GetFrameworkGeneric<'ErrorComponent'>;
+    defaultPendingComponent?: GetFrameworkGeneric<'Component'>;
     defaultLoaderMaxAge?: number;
     defaultLoaderGcMaxAge?: number;
     caseSensitive?: boolean;
     routeConfig?: TRouteConfig;
     basepath?: string;
-    createRouter?: (router: Router<any, any>) => void;
+    useServerData?: boolean;
+    createRouter?: (router: Router<any, any, any>) => void;
     createRoute?: (opts: {
         route: AnyRoute;
-        router: Router<any, any>;
+        router: Router<any, any, any>;
     }) => void;
-    createElement?: (element: GetFrameworkGeneric<'SyncOrAsyncElement'>) => Promise<GetFrameworkGeneric<'Element'>>;
+    context?: TRouterContext;
+    loadComponent?: (component: GetFrameworkGeneric<'Component'>) => Promise<GetFrameworkGeneric<'Component'>>;
 }
 interface Action<TPayload = unknown, TResponse = unknown> {
-    submit: (submission?: TPayload) => Promise<TResponse>;
+    submit: (submission?: TPayload, actionOpts?: {
+        invalidate?: boolean;
+        multi?: boolean;
+    }) => Promise<TResponse>;
     current?: ActionState<TPayload, TResponse>;
     latest?: ActionState<TPayload, TResponse>;
-    pending: ActionState<TPayload, TResponse>[];
+    submissions: ActionState<TPayload, TResponse>[];
 }
 interface ActionState<TPayload = unknown, TResponse = unknown> {
     submittedAt: number;
     status: 'idle' | 'pending' | 'success' | 'error';
     submission: TPayload;
+    isMulti: boolean;
     data?: TResponse;
     error?: unknown;
 }
@@ -136,18 +205,15 @@ interface Loader<TFullSearchSchema extends AnySearchSchema = {}, TAllParams exte
     latest?: LoaderState<TFullSearchSchema, TAllParams>;
     pending: LoaderState<TFullSearchSchema, TAllParams>[];
 }
-interface LoaderState<TFullSearchSchema = unknown, TAllParams = unknown> {
+interface LoaderState<TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> {
     loadedAt: number;
     loaderContext: LoaderContext<TFullSearchSchema, TAllParams>;
 }
-interface RouterState {
+interface RouterState<TSearchObj extends AnySearchSchema = {}, TState extends LocationState = LocationState> {
     status: 'idle' | 'loading';
-    location: Location;
+    location: Location<TSearchObj, TState>;
     matches: RouteMatch[];
     lastUpdated: number;
-    loaderData: unknown;
-    currentAction?: ActionState;
-    latestAction?: ActionState;
     actions: Record<string, Action>;
     loaders: Record<string, Loader>;
     pending?: PendingState;
@@ -158,20 +224,21 @@ interface PendingState {
     location: Location;
     matches: RouteMatch[];
 }
-declare type Listener = (router: Router<any, any>) => void;
-declare type ListenerFn = () => void;
+type Listener = (router: Router<any, any, any>) => void;
+type ListenerFn = () => void;
 interface BuildNextOptions {
     to?: string | number | null;
     params?: true | Updater<Record<string, any>>;
     search?: true | Updater<unknown>;
     hash?: true | Updater<string>;
+    state?: LocationState;
     key?: string;
     from?: string;
     fromCurrent?: boolean;
     __preSearchFilters?: SearchFilter<any>[];
     __postSearchFilters?: SearchFilter<any>[];
 }
-declare type MatchCacheEntry = {
+type MatchCacheEntry = {
     gc: number;
     match: RouteMatch;
 };
@@ -186,33 +253,45 @@ interface MatchRouteOptions {
     pending: boolean;
     caseSensitive?: boolean;
 }
-interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
+interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated' | 'location'> {
+    matches: DehydratedRouteMatch[];
+}
+interface DehydratedRouter<TRouterContext = unknown> {
+    location: Router['location'];
+    state: DehydratedRouterState;
+    context: TRouterContext;
+}
+interface DehydratedRouteMatch extends Pick<RouteMatch<any, any>, 'matchId' | 'status' | 'routeLoaderData' | 'loaderData' | 'isInvalid' | 'invalidAt'> {
+}
+interface RouterContext {
+}
+interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown> {
+    types: {
+        RouteConfig: TRouteConfig;
+        AllRouteInfo: TAllRouteInfo;
+    };
     history: BrowserHistory | MemoryHistory | HashHistory;
-    options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
+    options: PickAsRequired<RouterOptions<TRouteConfig, TRouterContext>, 'stringifySearch' | 'parseSearch' | 'context'>;
     basepath: string;
-    allRouteInfo: TAllRouteInfo;
     listeners: Listener[];
-    location: Location;
+    location: Location<TAllRouteInfo['fullSearchSchema']>;
     navigateTimeout?: Timeout;
     nextAction?: 'push' | 'replace';
-    state: RouterState;
+    state: RouterState<TAllRouteInfo['fullSearchSchema']>;
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
-    navigationPromise: Promise<void>;
-    removeActionQueue: {
-        action: Action;
-        actionState: ActionState;
-    }[];
+    navigationPromise?: Promise<void>;
     startedLoadingAt: number;
     resolveNavigation: () => void;
     subscribe: (listener: Listener) => () => void;
+    reset: () => void;
     notify: () => void;
     mount: () => () => void;
     onFocus: () => void;
-    update: <TRouteConfig extends RouteConfig = RouteConfig>(opts?: RouterOptions<TRouteConfig>) => Router<TRouteConfig>;
+    update: <TRouteConfig extends RouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(opts?: RouterOptions<TRouteConfig, TRouterContext>) => Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
     buildNext: (opts: BuildNextOptions) => Location;
     cancelMatches: () => void;
-    loadLocation: (next?: Location) => Promise<void>;
+    load: (next?: Location) => Promise<void>;
     matchCache: Record<string, MatchCacheEntry>;
     cleanMatchCache: () => void;
     getRoute: <TId extends keyof TAllRouteInfo['routeInfoById']>(id: TId) => Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][TId]>;
@@ -225,8 +304,6 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
         strictParseParams?: boolean;
     }) => RouteMatch[];
     loadMatches: (resolvedMatches: RouteMatch[], loaderOpts?: {
-        withPending?: boolean;
-    } & ({
         preload: true;
         maxAge: number;
         gcMaxAge: number;
@@ -234,13 +311,16 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
         preload?: false;
         maxAge?: never;
         gcMaxAge?: never;
-    })) => Promise<void>;
+    }) => Promise<void>;
+    loadMatchData: (routeMatch: RouteMatch<any, any>) => Promise<Record<string, unknown>>;
     invalidateRoute: (opts: MatchLocation) => void;
     reload: () => Promise<void>;
     resolvePath: (from: string, path: string) => string;
     navigate: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo>) => Promise<void>;
     matchRoute: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(matchLocation: ToOptions<TAllRouteInfo, TFrom, TTo>, opts?: MatchRouteOptions) => boolean;
     buildLink: <TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'>(opts: LinkOptions<TAllRouteInfo, TFrom, TTo>) => LinkInfo;
+    dehydrate: () => DehydratedRouter<TRouterContext>;
+    hydrate: (dehydratedRouter: DehydratedRouter<TRouterContext>) => void;
     __: {
         buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
         parseLocation: (location: History['location'], previousLocation?: Location) => Location;
@@ -251,77 +331,12 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
         }) => Promise<void>;
     };
 }
-declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>>(userOptions?: RouterOptions<TRouteConfig>): Router<TRouteConfig, TAllRouteInfo>;
-
-interface RouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> extends Route<TAllRouteInfo, TRouteInfo> {
-    matchId: string;
-    pathname: string;
-    params: TRouteInfo['params'];
-    parentMatch?: RouteMatch;
-    childMatches: RouteMatch[];
-    routeSearch: TRouteInfo['searchSchema'];
-    search: TRouteInfo['fullSearchSchema'];
-    status: 'idle' | 'loading' | 'success' | 'error';
-    updatedAt?: number;
-    error?: unknown;
-    isInvalid: boolean;
-    getIsInvalid: () => boolean;
-    loaderData: TRouteInfo['loaderData'];
-    routeLoaderData: TRouteInfo['routeLoaderData'];
-    isFetching: boolean;
-    isPending: boolean;
-    invalidAt: number;
-    __: {
-        element?: GetFrameworkGeneric<'Element'>;
-        errorElement?: GetFrameworkGeneric<'Element'>;
-        catchElement?: GetFrameworkGeneric<'Element'>;
-        pendingElement?: GetFrameworkGeneric<'Element'>;
-        loadPromise?: Promise<void>;
-        loaderPromise?: Promise<void>;
-        elementsPromise?: Promise<void>;
-        dataPromise?: Promise<void>;
-        pendingTimeout?: Timeout;
-        pendingMinTimeout?: Timeout;
-        pendingMinPromise?: Promise<void>;
-        onExit?: void | ((matchContext: {
-            params: TRouteInfo['allParams'];
-            search: TRouteInfo['fullSearchSchema'];
-        }) => void);
-        abortController: AbortController;
-        latestId: string;
-        validate: () => void;
-        startPending: () => void;
-        cancelPending: () => void;
-        notify: () => void;
-        resolve: () => void;
-    };
-    cancel: () => void;
-    load: (loaderOpts?: {
-        withPending?: boolean;
-    } & ({
-        preload: true;
-        maxAge: number;
-        gcMaxAge: number;
-    } | {
-        preload?: false;
-        maxAge?: never;
-        gcMaxAge?: never;
-    })) => Promise<TRouteInfo['routeLoaderData']>;
-    fetch: (opts?: {
-        maxAge?: number;
-    }) => Promise<TRouteInfo['routeLoaderData']>;
-    invalidate: () => void;
-    hasLoaders: () => boolean;
-}
-declare function createRouteMatch<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(router: Router<any, any>, route: Route<TAllRouteInfo, TRouteInfo>, opts: {
-    matchId: string;
-    params: TRouteInfo['allParams'];
-    pathname: string;
-}): RouteMatch<TAllRouteInfo, TRouteInfo>;
+declare function createRouter<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>, TRouterContext = unknown>(userOptions?: RouterOptions<TRouteConfig, TRouterContext>): Router<TRouteConfig, TAllRouteInfo, TRouterContext>;
 
-interface AnyRoute extends Route<any, any> {
+interface AnyRoute extends Route<any, any, any> {
 }
-interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo> {
+interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo, TRouterContext = unknown> {
+    routeInfo: TRouteInfo;
     routeId: TRouteInfo['id'];
     routeRouteId: TRouteInfo['routeId'];
     routePath: TRouteInfo['path'];
@@ -329,15 +344,14 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     parentRoute?: AnyRoute;
     childRoutes?: AnyRoute[];
     options: RouteOptions;
-    router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>;
+    router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>;
     buildLink: <TTo extends string = '.'>(options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>, 'from'>) => LinkInfo;
     matchRoute: <TTo extends string = '.', TResolved extends string = ResolveRelativePath<TRouteInfo['id'], TTo>>(matchLocation: CheckRelativePath<TAllRouteInfo, TRouteInfo['fullPath'], NoInfer<TTo>> & Omit<ToOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>, 'from'>, opts?: MatchRouteOptions) => RouteInfoByPath<TAllRouteInfo, TResolved>['allParams'];
-    navigate: <TTo extends string = '.'>(options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['id'], TTo>, 'from'>) => Promise<void>;
+    navigate: <TTo extends string = '.'>(options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>, 'from'>) => Promise<void>;
     action: unknown extends TRouteInfo['actionResponse'] ? Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']> | undefined : Action<TRouteInfo['actionPayload'], TRouteInfo['actionResponse']>;
     loader: unknown extends TRouteInfo['routeLoaderData'] ? Action<LoaderContext<TRouteInfo['fullSearchSchema'], TRouteInfo['allParams']>, TRouteInfo['routeLoaderData']> | undefined : Loader<TRouteInfo['fullSearchSchema'], TRouteInfo['allParams'], TRouteInfo['routeLoaderData']>;
 }
-declare function createRoute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo>(routeConfig: RouteConfig, options: TRouteInfo['options'], parent: undefined | Route<TAllRouteInfo, any>, router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo>): Route<TAllRouteInfo, TRouteInfo>;
-declare function cascadeLoaderData(matches: RouteMatch<any, any>[]): void;
+declare function createRoute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRouteInfo extends AnyRouteInfo = RouteInfo, TRouterContext = unknown>(routeConfig: RouteConfig, options: TRouteInfo['options'], parent: undefined | Route<TAllRouteInfo, any>, router: Router<TAllRouteInfo['routeConfig'], TAllRouteInfo, TRouterContext>): Route<TAllRouteInfo, TRouteInfo, TRouterContext>;
 
 interface AnyAllRouteInfo {
     routeConfig: AnyRouteConfig;
@@ -346,6 +360,7 @@ interface AnyAllRouteInfo {
     routeInfoByFullPath: Record<string, AnyRouteInfo>;
     routeIds: any;
     routePaths: any;
+    fullSearchSchema: Record<string, any>;
 }
 interface DefaultAllRouteInfo {
     routeConfig: RouteConfig;
@@ -354,20 +369,25 @@ interface DefaultAllRouteInfo {
     routeInfoByFullPath: Record<string, RouteInfo>;
     routeIds: string;
     routePaths: string;
+    fullSearchSchema: AnySearchSchema;
 }
 interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig> extends RoutesInfoInner<TRouteConfig, ParseRouteConfig<TRouteConfig>> {
 }
-declare type ParseRouteConfig<TRouteConfig = AnyRouteConfig> = TRouteConfig extends AnyRouteConfig ? RouteConfigRoute<TRouteConfig> | ParseRouteChildren<TRouteConfig> : never;
-declare type ParseRouteChildren<TRouteConfig> = TRouteConfig extends AnyRouteConfigWithChildren<infer TChildren> ? unknown extends TChildren ? never : TChildren extends AnyRouteConfig[] ? Values<{
+type ParseRouteConfig<TRouteConfig = AnyRouteConfig> = TRouteConfig extends AnyRouteConfig ? RouteConfigRoute<TRouteConfig> | ParseRouteChildren<TRouteConfig> : never;
+type ParseRouteChildren<TRouteConfig> = TRouteConfig extends AnyRouteConfigWithChildren<infer TChildren> ? unknown extends TChildren ? never : TChildren extends AnyRouteConfig[] ? Values<{
     [TId in TChildren[number]['id']]: ParseRouteChild<TChildren[number], TId>;
 }> : never : never;
-declare type ParseRouteChild<TRouteConfig, TId> = TRouteConfig & {
+type ParseRouteChild<TRouteConfig, TId> = TRouteConfig & {
     id: TId;
 } extends AnyRouteConfig ? ParseRouteConfig<TRouteConfig> : never;
-declare type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<infer TId, infer TRouteId, infer TPath, infer TFullPath, infer TRouteLoaderData, infer TLoaderData, infer TActionPayload, infer TActionResponse, infer TParentSearchSchema, infer TSearchSchema, infer TFullSearchSchema, infer TParentParams, infer TParams, infer TAllParams, any> ? string extends TRouteId ? never : RouteInfo<TId, TRouteId, TPath, TFullPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams> : never;
-interface RoutesInfoInner<TRouteConfig extends AnyRouteConfig, TRouteInfo extends RouteInfo<string, string, any, any, any, any, any, any, any, any, any, any, any, any> = RouteInfo, TRouteInfoById = {
+type RouteConfigRoute<TRouteConfig> = TRouteConfig extends RouteConfig<infer TId, infer TRouteId, infer TPath, infer TFullPath, infer TParentRouteLoaderData, infer TRouteLoaderData, infer TParentLoaderData, infer TLoaderData, infer TActionPayload, infer TActionResponse, infer TParentSearchSchema, infer TSearchSchema, infer TFullSearchSchema, infer TParentParams, infer TParams, infer TAllParams, any> ? string extends TRouteId ? never : RouteInfo<TId, TRouteId, TPath, TFullPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams> : never;
+interface RoutesInfoInner<TRouteConfig extends AnyRouteConfig, TRouteInfo extends RouteInfo<string, string, any, any, any, any, any, any, any, any, any, any, any, any, any, any> = RouteInfo, TRouteInfoById = {
+    '/': TRouteInfo;
+} & {
     [TInfo in TRouteInfo as TInfo['id']]: TInfo;
 }, TRouteInfoByFullPath = {
+    '/': TRouteInfo;
+} & {
     [TInfo in TRouteInfo as TInfo['fullPath'] extends RootRouteId ? never : string extends TInfo['fullPath'] ? never : TInfo['fullPath']]: TInfo;
 }> {
     routeConfig: TRouteConfig;
@@ -376,15 +396,18 @@ interface RoutesInfoInner<TRouteConfig extends AnyRouteConfig, TRouteInfo extend
     routeInfoByFullPath: TRouteInfoByFullPath;
     routeIds: keyof TRouteInfoById;
     routePaths: keyof TRouteInfoByFullPath;
+    fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>;
 }
-interface AnyRouteInfo extends RouteInfo<any, any, any, any, any, any, any, any, any, any, any, any, any, any> {
+interface AnyRouteInfo extends RouteInfo<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any> {
 }
-interface RouteInfo<TId extends string = string, TRouteId extends string = string, TPath extends string = string, TFullPath extends string = string, TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}> {
+interface RouteInfo<TId extends string = string, TRouteId extends string = string, TPath extends string = string, TFullPath extends string = string, TParentRouteLoaderData extends AnyLoaderData = {}, TRouteLoaderData extends AnyLoaderData = {}, TParentLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends AnyPathParams = {}, TAllParams extends AnyPathParams = {}> {
     id: TId;
     routeId: TRouteId;
     path: TPath;
     fullPath: TFullPath;
+    parentRouteLoaderData: TParentRouteLoaderData;
     routeLoaderData: TRouteLoaderData;
+    parentLoaderData: TParentLoaderData;
     loaderData: TLoaderData;
     actionPayload: TActionPayload;
     actionResponse: TActionResponse;
@@ -393,42 +416,42 @@ interface RouteInfo<TId extends string = string, TRouteId extends string = strin
     parentParams: TParentParams;
     params: TParams;
     allParams: TAllParams;
-    options: RouteOptions<TRouteId, TPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
+    options: RouteOptions<TRouteId, TPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
 }
-declare type RoutesById<TAllRouteInfo extends AnyAllRouteInfo> = {
+type RoutesById<TAllRouteInfo extends AnyAllRouteInfo> = {
     [K in keyof TAllRouteInfo['routeInfoById']]: Route<TAllRouteInfo, TAllRouteInfo['routeInfoById'][K]>;
 };
-declare type RouteInfoById<TAllRouteInfo extends AnyAllRouteInfo, TId> = TId extends keyof TAllRouteInfo['routeInfoById'] ? IsAny<TAllRouteInfo['routeInfoById'][TId]['id'], RouteInfo, TAllRouteInfo['routeInfoById'][TId]> : never;
-declare type RouteInfoByPath<TAllRouteInfo extends AnyAllRouteInfo, TPath> = TPath extends keyof TAllRouteInfo['routeInfoByFullPath'] ? IsAny<TAllRouteInfo['routeInfoByFullPath'][TPath]['id'], RouteInfo, TAllRouteInfo['routeInfoByFullPath'][TPath]> : never;
+type RouteInfoById<TAllRouteInfo extends AnyAllRouteInfo, TId> = TId extends keyof TAllRouteInfo['routeInfoById'] ? IsAny<TAllRouteInfo['routeInfoById'][TId]['id'], RouteInfo, TAllRouteInfo['routeInfoById'][TId]> : never;
+type RouteInfoByPath<TAllRouteInfo extends AnyAllRouteInfo, TPath> = TPath extends keyof TAllRouteInfo['routeInfoByFullPath'] ? IsAny<TAllRouteInfo['routeInfoByFullPath'][TPath]['id'], RouteInfo, TAllRouteInfo['routeInfoByFullPath'][TPath]> : never;
 
 declare const rootRouteId: "__root__";
-declare type RootRouteId = typeof rootRouteId;
-declare type AnyLoaderData = {};
-declare type AnyPathParams = {};
-declare type AnySearchSchema = {};
+type RootRouteId = typeof rootRouteId;
+type AnyLoaderData = {};
+type AnyPathParams = {};
+type AnySearchSchema = {};
 interface RouteMeta {
 }
-declare type SearchSchemaValidator<TReturn, TParentSchema> = SearchSchemaValidatorObj<TReturn, TParentSchema> | SearchSchemaValidatorFn<TReturn, TParentSchema>;
-declare type SearchSchemaValidatorObj<TReturn, TParentSchema> = {
+type SearchSchemaValidator<TReturn, TParentSchema> = SearchSchemaValidatorObj<TReturn, TParentSchema> | SearchSchemaValidatorFn<TReturn, TParentSchema>;
+type SearchSchemaValidatorObj<TReturn, TParentSchema> = {
     parse?: SearchSchemaValidatorFn<TReturn, TParentSchema>;
 };
-declare type SearchSchemaValidatorFn<TReturn, TParentSchema> = (searchObj: Record<string, unknown>) => {} extends TParentSchema ? TReturn : keyof TReturn extends keyof TParentSchema ? {
+type SearchSchemaValidatorFn<TReturn, TParentSchema> = (searchObj: Record<string, unknown>) => {} extends TParentSchema ? TReturn : keyof TReturn extends keyof TParentSchema ? {
     error: 'Top level search params cannot be redefined by child routes!';
     keys: keyof TReturn & keyof TParentSchema;
 } : TReturn;
-declare type DefinedPathParamWarning = 'Path params cannot be redefined by child routes!';
-declare type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
+type DefinedPathParamWarning = 'Path params cannot be redefined by child routes!';
+type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
     [Key in keyof TParentParams]?: DefinedPathParamWarning;
 };
-declare type LoaderFn<TRouteLoaderData extends AnyLoaderData, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> = (loaderContext: LoaderContext<TFullSearchSchema, TAllParams>) => Promise<TRouteLoaderData>;
+type LoaderFn<TRouteLoaderData extends AnyLoaderData = {}, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> = (loaderContext: LoaderContext<TFullSearchSchema, TAllParams>) => TRouteLoaderData | Promise<TRouteLoaderData>;
 interface LoaderContext<TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> {
     params: TAllParams;
     search: TFullSearchSchema;
     signal?: AbortSignal;
 }
-declare type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (submission: TActionPayload) => TActionResponse | Promise<TActionResponse>;
-declare type UnloaderFn<TPath extends string> = (routeMatch: RouteMatch<any, RouteInfo<string, TPath>>) => void;
-declare type RouteOptions<TRouteId extends string = string, TPath extends string = string, TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = TSearchSchema, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}> = ({
+type ActionFn<TActionPayload = unknown, TActionResponse = unknown> = (submission: TActionPayload) => TActionResponse | Promise<TActionResponse>;
+type UnloaderFn<TPath extends string> = (routeMatch: RouteMatch<any, RouteInfo<string, TPath>>) => void;
+type RouteOptions<TRouteId extends string = string, TPath extends string = string, TParentRouteLoaderData extends AnyLoaderData = {}, TRouteLoaderData extends AnyLoaderData = {}, TParentLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = TSearchSchema, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}> = ({
     path: TPath;
 } | {
     id: TRouteId;
@@ -437,18 +460,18 @@ declare type RouteOptions<TRouteId extends string = string, TPath extends string
     validateSearch?: SearchSchemaValidator<TSearchSchema, TParentSearchSchema>;
     preSearchFilters?: SearchFilter<TFullSearchSchema>[];
     postSearchFilters?: SearchFilter<TFullSearchSchema>[];
-    pendingMs?: number;
-    pendingMinMs?: number;
-    element?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
-    errorElement?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
-    catchElement?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
-    pendingElement?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
+    component?: GetFrameworkGeneric<'Component'>;
+    errorComponent?: GetFrameworkGeneric<'ErrorComponent'>;
+    pendingComponent?: GetFrameworkGeneric<'Component'>;
     loader?: LoaderFn<TRouteLoaderData, TFullSearchSchema, TAllParams>;
     loaderMaxAge?: number;
     loaderGcMaxAge?: number;
     action?: ActionFn<TActionPayload, TActionResponse>;
-    useErrorBoundary?: boolean;
-    onMatch?: (matchContext: {
+    beforeLoad?: (opts: {
+        router: Router<any, any, unknown>;
+        match: RouteMatch;
+    }) => Promise<void> | void;
+    onLoaded?: (matchContext: {
         params: TAllParams;
         search: TFullSearchSchema;
     }) => void | undefined | ((match: {
@@ -467,39 +490,37 @@ declare type RouteOptions<TRouteId extends string = string, TPath extends string
     parseParams: (rawParams: IsAny<TPath, any, Record<ParsePathParams<TPath>, string>>) => TParams;
     stringifyParams: (params: TParams) => Record<ParsePathParams<TPath>, string>;
 }) & (PickUnsafe<TParentParams, ParsePathParams<TPath>> extends never ? {} : 'Cannot redefined path params in child routes!');
-declare type SearchFilter<T, U = T> = (prev: T) => U;
-interface RouteConfig<TId extends string = string, TRouteId extends string = string, TPath extends string = string, TFullPath extends string = string, TRouteLoaderData extends AnyLoaderData = AnyLoaderData, TLoaderData extends AnyLoaderData = AnyLoaderData, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams = {}, TKnownChildren = unknown> {
+type SearchFilter<T, U = T> = (prev: T) => U;
+interface RouteConfig<TId extends string = string, TRouteId extends string = string, TPath extends string = string, TFullPath extends string = string, TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData, TRouteLoaderData extends AnyLoaderData = AnyLoaderData, TParentLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = AnyLoaderData, TActionPayload = unknown, TActionResponse = unknown, TParentSearchSchema extends {} = {}, TSearchSchema extends AnySearchSchema = {}, TFullSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}, TParams extends AnyPathParams = {}, TAllParams extends AnyPathParams = {}, TKnownChildren = unknown> {
     id: TId;
     routeId: TRouteId;
     path: NoInfer<TPath>;
     fullPath: TFullPath;
-    options: RouteOptions<TRouteId, TPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
+    options: RouteOptions<TRouteId, TPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams>;
     children?: TKnownChildren;
     addChildren: IsAny<TId, any, <TNewChildren extends any>(children: TNewChildren extends AnyRouteConfig[] ? TNewChildren : {
         error: 'Invalid route detected';
         route: TNewChildren;
-    }) => RouteConfig<TId, TRouteId, TPath, TFullPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams, TNewChildren>>;
-    createChildren: IsAny<TId, any, <TNewChildren extends any>(cb: (createChildRoute: CreateRouteConfigFn<false, TId, TFullPath, TLoaderData, TFullSearchSchema, TAllParams>) => TNewChildren extends AnyRouteConfig[] ? TNewChildren : {
-        error: 'Invalid route detected';
-        route: TNewChildren;
-    }) => RouteConfig<TId, TRouteId, TPath, TFullPath, TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams, TNewChildren>>;
-    createRoute: CreateRouteConfigFn<false, TId, TFullPath, TLoaderData, TFullSearchSchema, TAllParams>;
+    }) => RouteConfig<TId, TRouteId, TPath, TFullPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, TLoaderData, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, TFullSearchSchema, TParentParams, TParams, TAllParams, TNewChildren>>;
+    createRoute: CreateRouteConfigFn<false, TId, TFullPath, TRouteLoaderData, TLoaderData, TFullSearchSchema, TAllParams>;
+    generate: GenerateFn<TRouteId, TPath, TParentRouteLoaderData, TParentLoaderData, TParentSearchSchema, TParentParams>;
 }
-declare type CreateRouteConfigFn<TIsRoot extends boolean = false, TParentId extends string = string, TParentPath extends string = string, TParentAllLoaderData extends AnyLoaderData = {}, TParentSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}> = <TRouteId extends string, TPath extends string, TRouteLoaderData extends AnyLoaderData, TActionPayload, TActionResponse, TSearchSchema extends AnySearchSchema = AnySearchSchema, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams> = AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams>, TKnownChildren extends RouteConfig[] = RouteConfig[], TResolvedId extends string = string extends TRouteId ? string extends TPath ? string : TPath : TRouteId>(options?: TIsRoot extends true ? Omit<RouteOptions<TRouteId, TPath, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, 'path'> & {
+type GenerateFn<TRouteId extends string = string, TPath extends string = string, TParentRouteLoaderData extends AnyLoaderData = AnyLoaderData, TParentLoaderData extends AnyLoaderData = {}, TParentSearchSchema extends {} = {}, TParentParams extends AnyPathParams = {}> = <TRouteLoaderData extends AnyLoaderData = AnyLoaderData, TActionPayload = unknown, TActionResponse = unknown, TSearchSchema extends AnySearchSchema = {}, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams> = AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams>>(options: Omit<RouteOptions<TRouteId, TPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, 'path'>) => void;
+type CreateRouteConfigFn<TIsRoot extends boolean = false, TParentId extends string = string, TParentPath extends string = string, TParentRouteLoaderData extends AnyLoaderData = {}, TParentLoaderData extends AnyLoaderData = {}, TParentSearchSchema extends AnySearchSchema = {}, TParentParams extends AnyPathParams = {}> = <TRouteId extends string, TPath extends string, TRouteLoaderData extends AnyLoaderData, TActionPayload, TActionResponse, TSearchSchema extends AnySearchSchema = AnySearchSchema, TParams extends Record<ParsePathParams<TPath>, unknown> = Record<ParsePathParams<TPath>, string>, TAllParams extends AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams> = AnyPathParams extends TParams ? Record<ParsePathParams<TPath>, string> : NoInfer<TParams>, TKnownChildren extends RouteConfig[] = RouteConfig[], TResolvedId extends string = string extends TRouteId ? string extends TPath ? string : TPath : TRouteId>(options?: TIsRoot extends true ? Omit<RouteOptions<TRouteId, TPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, 'path'> & {
     path?: never;
-} : RouteOptions<TRouteId, TPath, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, children?: TKnownChildren, isRoot?: boolean, parentId?: string, parentPath?: string) => RouteConfig<RoutePrefix<TParentId, TResolvedId>, TResolvedId, TPath, string extends TPath ? '' : RoutePath<RoutePrefix<TParentPath, TPath>>, TRouteLoaderData, Expand<TParentAllLoaderData & DeepAwaited<NoInfer<TRouteLoaderData>>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>, TKnownChildren>;
-declare type RoutePath<T extends string> = T extends RootRouteId ? '/' : TrimPathRight<`${T}`>;
-declare type RoutePrefix<TPrefix extends string, TId extends string> = string extends TId ? RootRouteId : TId extends string ? `${TPrefix}/${TId}` extends '/' ? '/' : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TId>}`>}` : never;
-interface AnyRouteConfig extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any> {
+} : RouteOptions<TRouteId, TPath, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>>, children?: TKnownChildren, isRoot?: boolean, parentId?: string, parentPath?: string) => RouteConfig<RoutePrefix<TParentId, TResolvedId>, TResolvedId, TPath, string extends TPath ? '' : RoutePath<RoutePrefix<TParentPath, TPath>>, TParentRouteLoaderData, TRouteLoaderData, TParentLoaderData, Expand<TParentLoaderData & NoInfer<TRouteLoaderData>>, TActionPayload, TActionResponse, TParentSearchSchema, TSearchSchema, Expand<TParentSearchSchema & TSearchSchema>, TParentParams, TParams, Expand<TParentParams & TAllParams>, TKnownChildren>;
+type RoutePath<T extends string> = T extends RootRouteId ? '/' : TrimPathRight<`${T}`>;
+type RoutePrefix<TPrefix extends string, TId extends string> = string extends TId ? RootRouteId : TId extends string ? `${TPrefix}/${TId}` extends '/' ? '/' : `/${TrimPathLeft<`${TrimPathRight<TPrefix>}/${TrimPath<TId>}`>}` : never;
+interface AnyRouteConfig extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any> {
 }
-interface AnyRouteConfigWithChildren<TChildren> extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any, any, TChildren> {
+interface AnyRouteConfigWithChildren<TChildren> extends RouteConfig<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TChildren> {
 }
-declare type TrimPath<T extends string> = '' extends T ? '' : TrimPathRight<TrimPathLeft<T>>;
-declare type TrimPathLeft<T extends string> = T extends `${RootRouteId}/${infer U}` ? TrimPathLeft<U> : T extends `/${infer U}` ? TrimPathLeft<U> : T;
-declare type TrimPathRight<T extends string> = T extends '/' ? '/' : T extends `${infer U}/` ? TrimPathRight<U> : T;
+type TrimPath<T extends string> = '' extends T ? '' : TrimPathRight<TrimPathLeft<T>>;
+type TrimPathLeft<T extends string> = T extends `${RootRouteId}/${infer U}` ? TrimPathLeft<U> : T extends `/${infer U}` ? TrimPathLeft<U> : T;
+type TrimPathRight<T extends string> = T extends '/' ? '/' : T extends `${infer U}/` ? TrimPathRight<U> : T;
 declare const createRouteConfig: CreateRouteConfigFn<true>;
 
-declare type LinkInfo = {
+type LinkInfo = {
     type: 'external';
     href: string;
 } | {
@@ -512,12 +533,12 @@ declare type LinkInfo = {
     isActive: boolean;
     disabled?: boolean;
 };
-declare type StartsWith<A, B> = A extends `${B extends string ? B : never}${infer _}` ? true : false;
-declare type CleanPath<T extends string> = T extends `${infer L}//${infer R}` ? CleanPath<`${CleanPath<L>}/${CleanPath<R>}`> : T extends `${infer L}//` ? `${CleanPath<L>}/` : T extends `//${infer L}` ? `/${CleanPath<L>}` : T;
-declare type Split<S, TIncludeTrailingSlash = true> = S extends unknown ? string extends S ? string[] : S extends string ? CleanPath<S> extends '' ? [] : TIncludeTrailingSlash extends true ? CleanPath<S> extends `${infer T}/` ? [...Split<T>, '/'] : CleanPath<S> extends `/${infer U}` ? Split<U> : CleanPath<S> extends `${infer T}/${infer U}` ? [...Split<T>, ...Split<U>] : [S] : CleanPath<S> extends `${infer T}/${infer U}` ? [...Split<T>, ...Split<U>] : S extends string ? [S] : never : never : never;
-declare type ParsePathParams<T extends string> = Split<T>[number] extends infer U ? U extends `:${infer V}` ? V : never : never;
-declare type Join<T> = T extends [] ? '' : T extends [infer L extends string] ? L : T extends [infer L extends string, ...infer Tail extends [...string[]]] ? CleanPath<`${L}/${Join<Tail>}`> : never;
-declare type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends string, TTo extends string, SplitPaths extends string[] = Split<AllPaths, false>> = TTo extends `..${infer _}` ? SplitPaths extends [
+type StartsWith<A, B> = A extends `${B extends string ? B : never}${infer _}` ? true : false;
+type CleanPath<T extends string> = T extends `${infer L}//${infer R}` ? CleanPath<`${CleanPath<L>}/${CleanPath<R>}`> : T extends `${infer L}//` ? `${CleanPath<L>}/` : T extends `//${infer L}` ? `/${CleanPath<L>}` : T;
+type Split<S, TIncludeTrailingSlash = true> = S extends unknown ? string extends S ? string[] : S extends string ? CleanPath<S> extends '' ? [] : TIncludeTrailingSlash extends true ? CleanPath<S> extends `${infer T}/` ? [...Split<T>, '/'] : CleanPath<S> extends `/${infer U}` ? Split<U> : CleanPath<S> extends `${infer T}/${infer U}` ? [...Split<T>, ...Split<U>] : [S] : CleanPath<S> extends `${infer T}/${infer U}` ? [...Split<T>, ...Split<U>] : S extends string ? [S] : never : never : never;
+type ParsePathParams<T extends string> = Split<T>[number] extends infer U ? U extends `$${infer V}` ? V : never : never;
+type Join<T> = T extends [] ? '' : T extends [infer L extends string] ? L : T extends [infer L extends string, ...infer Tail extends [...string[]]] ? CleanPath<`${L}/${Join<Tail>}`> : never;
+type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends string, TTo extends string, SplitPaths extends string[] = Split<AllPaths, false>> = TTo extends `..${infer _}` ? SplitPaths extends [
     ...Split<ResolveRelativePath<TFrom, TTo>, false>,
     ...infer TToRest
 ] ? `${CleanPath<Join<[
@@ -528,39 +549,40 @@ declare type RelativeToPathAutoComplete<AllPaths extends string, TFrom extends s
     ...Split<RestTTo, false>,
     ...infer RestPath
 ] ? `${TTo}${Join<RestPath>}` : never : './' | '../' | AllPaths;
-declare type NavigateOptionsAbsolute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = ToOptions<TAllRouteInfo, TFrom, TTo> & {
+type NavigateOptionsAbsolute<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = ToOptions<TAllRouteInfo, TFrom, TTo> & {
     replace?: boolean;
 };
-declare type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
+type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.', TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>> = {
     to?: ToPathOption<TAllRouteInfo, TFrom, TTo>;
     hash?: Updater<string>;
+    state?: LocationState;
     from?: TFrom;
 } & CheckPath<TAllRouteInfo, NoInfer<TResolvedTo>, {}> & SearchParamOptions<TAllRouteInfo, TFrom, TResolvedTo> & PathParamOptions<TAllRouteInfo, TFrom, TResolvedTo>;
-declare type SearchParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'], TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema']> = StartsWith<TFrom, TTo> extends true ? {
+type SearchParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'], TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema']> = StartsWith<TFrom, TTo> extends true ? {
     search?: SearchReducer<TFromSchema, TToSchema>;
 } : keyof PickRequired<TToSchema> extends never ? {
     search?: SearchReducer<TFromSchema, TToSchema>;
 } : {
     search: SearchReducer<TFromSchema, TToSchema>;
 };
-declare type SearchReducer<TFrom, TTo> = {
+type SearchReducer<TFrom, TTo> = {
     [TKey in keyof TTo]: TTo[TKey];
 } | ((current: TFrom) => TTo);
-declare type PathParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromParams = RouteInfoByPath<TAllRouteInfo, TFrom>['allParams'], TToParams = RouteInfoByPath<TAllRouteInfo, TTo>['allParams']> = StartsWith<TFrom, TTo> extends true ? {
+type PathParamOptions<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo, TFromParams = RouteInfoByPath<TAllRouteInfo, TFrom>['allParams'], TToParams = RouteInfoByPath<TAllRouteInfo, TTo>['allParams']> = StartsWith<TFrom, TTo> extends true ? {
     params?: ParamsReducer<TFromParams, TToParams>;
 } : AnyPathParams extends TToParams ? {
     params?: ParamsReducer<TFromParams, Record<string, never>>;
 } : {
     params: ParamsReducer<TFromParams, TToParams>;
 };
-declare type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo);
-declare type ToPathOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routePaths'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
-declare type ToIdOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routeIds'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo);
+type ToPathOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routePaths'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
+type ToIdOption<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = TTo | RelativeToPathAutoComplete<TAllRouteInfo['routeIds'], NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>;
 interface ActiveOptions {
     exact?: boolean;
     includeHash?: boolean;
 }
-declare type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo> & {
+type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TFrom extends ValidFromPath<TAllRouteInfo> = '/', TTo extends string = '.'> = NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo> & {
     target?: HTMLAnchorElement['target'];
     activeOptions?: ActiveOptions;
     preload?: false | 'intent';
@@ -569,22 +591,22 @@ declare type LinkOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRoute
     preloadDelay?: number;
     disabled?: boolean;
 };
-declare type CheckRelativePath<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo> = TTo extends string ? TFrom extends string ? ResolveRelativePath<TFrom, TTo> extends TAllRouteInfo['routePaths'] ? {} : {
+type CheckRelativePath<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo> = TTo extends string ? TFrom extends string ? ResolveRelativePath<TFrom, TTo> extends TAllRouteInfo['routePaths'] ? {} : {
     Error: `${TFrom} + ${TTo} resolves to ${ResolveRelativePath<TFrom, TTo>}, which is not a valid route path.`;
     'Valid Route Paths': TAllRouteInfo['routePaths'];
 } : {} : {};
-declare type CheckPath<TAllRouteInfo extends AnyAllRouteInfo, TPath, TPass> = Exclude<TPath, TAllRouteInfo['routePaths']> extends never ? TPass : CheckPathError<TAllRouteInfo, Exclude<TPath, TAllRouteInfo['routePaths']>>;
-declare type CheckPathError<TAllRouteInfo extends AnyAllRouteInfo, TInvalids> = Expand<{
+type CheckPath<TAllRouteInfo extends AnyAllRouteInfo, TPath, TPass> = Exclude<TPath, TAllRouteInfo['routePaths']> extends never ? TPass : CheckPathError<TAllRouteInfo, Exclude<TPath, TAllRouteInfo['routePaths']>>;
+type CheckPathError<TAllRouteInfo extends AnyAllRouteInfo, TInvalids> = Expand<{
     Error: `${TInvalids extends string ? TInvalids : never} is not a valid route path.`;
     'Valid Route Paths': TAllRouteInfo['routePaths'];
 }>;
-declare type CheckId<TAllRouteInfo extends AnyAllRouteInfo, TPath, TPass> = Exclude<TPath, TAllRouteInfo['routeIds']> extends never ? TPass : CheckIdError<TAllRouteInfo, Exclude<TPath, TAllRouteInfo['routeIds']>>;
-declare type CheckIdError<TAllRouteInfo extends AnyAllRouteInfo, TInvalids> = Expand<{
+type CheckId<TAllRouteInfo extends AnyAllRouteInfo, TPath, TPass> = Exclude<TPath, TAllRouteInfo['routeIds']> extends never ? TPass : CheckIdError<TAllRouteInfo, Exclude<TPath, TAllRouteInfo['routeIds']>>;
+type CheckIdError<TAllRouteInfo extends AnyAllRouteInfo, TInvalids> = Expand<{
     Error: `${TInvalids extends string ? TInvalids : never} is not a valid route ID.`;
     'Valid Route IDs': TAllRouteInfo['routeIds'];
 }>;
-declare type ResolveRelativePath<TFrom, TTo = '.'> = TFrom extends string ? TTo extends string ? TTo extends '.' ? TFrom : TTo extends `./` ? Join<[TFrom, '/']> : TTo extends `./${infer TRest}` ? ResolveRelativePath<TFrom, TRest> : TTo extends `/${infer TRest}` ? TTo : Split<TTo> extends ['..', ...infer ToRest] ? Split<TFrom> extends [...infer FromRest, infer FromTail] ? ToRest extends ['/'] ? Join<[...FromRest, '/']> : ResolveRelativePath<Join<FromRest>, Join<ToRest>> : never : Split<TTo> extends ['.', ...infer ToRest] ? ToRest extends ['/'] ? Join<[TFrom, '/']> : ResolveRelativePath<TFrom, Join<ToRest>> : CleanPath<Join<['/', ...Split<TFrom>, ...Split<TTo>]>> : never : never;
-declare type ValidFromPath<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = undefined | (string extends TAllRouteInfo['routePaths'] ? string : TAllRouteInfo['routePaths']);
+type ResolveRelativePath<TFrom, TTo = '.'> = TFrom extends string ? TTo extends string ? TTo extends '.' ? TFrom : TTo extends `./` ? Join<[TFrom, '/']> : TTo extends `./${infer TRest}` ? ResolveRelativePath<TFrom, TRest> : TTo extends `/${infer TRest}` ? TTo : Split<TTo> extends ['..', ...infer ToRest] ? Split<TFrom> extends [...infer FromRest, infer FromTail] ? ToRest extends ['/'] ? Join<[...FromRest, '/']> : ResolveRelativePath<Join<FromRest>, Join<ToRest>> : never : Split<TTo> extends ['.', ...infer ToRest] ? ToRest extends ['/'] ? Join<[TFrom, '/']> : ResolveRelativePath<TFrom, Join<ToRest>> : CleanPath<Join<['/', ...Split<TFrom>, ...Split<TTo>]>> : never : never;
+type ValidFromPath<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo> = undefined | (string extends TAllRouteInfo['routePaths'] ? string : TAllRouteInfo['routePaths']);
 
 interface Segment {
     type: 'pathname' | 'param' | 'wildcard';
@@ -609,4 +631,4 @@ declare const defaultStringifySearch: (search: Record<string, any>) => string;
 declare function parseSearchWith(parser: (str: string) => any): (searchStr: string) => AnySearchSchema;
 declare function stringifySearchWith(stringify: (search: any) => string): (search: Record<string, any>) => string;
 
-export { Action, ActionFn, ActionState, AllRouteInfo, AnyAllRouteInfo, AnyLoaderData, AnyPathParams, AnyRoute, AnyRouteConfig, AnyRouteConfigWithChildren, AnyRouteInfo, AnySearchSchema, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, DeepAwaited, DefaultAllRouteInfo, DefinedPathParamWarning, Expand, FilterRoutesFn, FrameworkGenerics, FromLocation, GetFrameworkGeneric, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, Loader, LoaderContext, LoaderFn, LoaderState, Location, LocationState, MatchCacheEntry, MatchLocation, MatchRouteOptions, NavigateOptionsAbsolute, NoInfer, ParentParams, ParsePathParams, ParseRouteConfig, PathParamMask, PendingState, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteMatch, RouteMeta, RouteOptions, Router, RouterOptions, RouterState, RoutesById, RoutesInfoInner, SearchFilter, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, Timeout, ToIdOption, ToOptions, ToPathOption, UnloaderFn, Updater, ValidFromPath, ValueKeys, Values, cascadeLoaderData, cleanPath, createRoute, createRouteConfig, createRouteMatch, createRouter, decode, defaultParseSearch, defaultStringifySearch, encode, functionalUpdate, interpolatePath, joinPaths, last, matchByPath, matchPathname, parsePathname, parseSearchWith, replaceEqualDeep, resolvePath, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, warning };
+export { Action, ActionFn, ActionState, AllRouteInfo, AnyAllRouteInfo, AnyLoaderData, AnyPathParams, AnyRoute, AnyRouteConfig, AnyRouteConfigWithChildren, AnyRouteInfo, AnySearchSchema, BuildNextOptions, CheckId, CheckIdError, CheckPath, CheckPathError, CheckRelativePath, DeepAwaited, DefaultAllRouteInfo, DefinedPathParamWarning, DehydratedRouter, DehydratedRouterState, Expand, FilterRoutesFn, FrameworkGenerics, FromLocation, GetFrameworkGeneric, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, Loader, LoaderContext, LoaderFn, LoaderState, Location, LocationState, MatchCacheEntry, MatchLocation, MatchRouteOptions, NavigateOptionsAbsolute, NoInfer, ParentParams, ParsePathParams, ParseRouteConfig, PathParamMask, PendingState, PickAsPartial, PickAsRequired, PickExclude, PickExtra, PickExtract, PickRequired, PickUnsafe, RegisterRouter, RegisteredAllRouteInfo, RegisteredRouter, RelativeToPathAutoComplete, ResolveRelativePath, RootRouteId, Route, RouteConfig, RouteConfigRoute, RouteInfo, RouteInfoById, RouteInfoByPath, RouteMatch, RouteMeta, RouteOptions, Router, RouterContext, RouterOptions, RouterState, RoutesById, RoutesInfoInner, SearchFilter, SearchParser, SearchSchemaValidator, SearchSchemaValidatorFn, SearchSchemaValidatorObj, SearchSerializer, Segment, Split, Timeout, ToIdOption, ToOptions, ToPathOption, UnionToIntersection, UnloaderFn, Updater, ValidFromPath, ValueKeys, Values, cleanPath, createRoute, createRouteConfig, createRouteMatch, createRouter, decode, defaultParseSearch, defaultStringifySearch, encode, functionalUpdate, interpolatePath, joinPaths, last, matchByPath, matchPathname, parsePathname, parseSearchWith, pick, replaceEqualDeep, resolvePath, rootRouteId, stringifySearchWith, trimPath, trimPathLeft, trimPathRight, warning };