@tanstack/router-core 0.0.1-alpha.9 → 0.0.1-beta.10

package/build/types/index.d.ts

@@ -55,6 +55,73 @@ 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 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>;
+        loaderDataPromise?: 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>;
 
 interface LocationState {
 }
@@ -102,29 +169,55 @@ interface RouterOptions<TRouteConfig extends AnyRouteConfig> {
         route: AnyRoute;
         router: Router<any, any>;
     }) => void;
+    createElement?: (element: GetFrameworkGeneric<'SyncOrAsyncElement'>) => Promise<GetFrameworkGeneric<'Element'>>;
 }
 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;
 }
+interface Loader<TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}, TRouteLoaderData = AnyLoaderData> {
+    fetch: keyof PickRequired<TFullSearchSchema> extends never ? keyof TAllParams extends never ? (loaderContext: {
+        signal?: AbortSignal;
+    }) => Promise<TRouteLoaderData> : (loaderContext: {
+        params: TAllParams;
+        search?: TFullSearchSchema;
+        signal?: AbortSignal;
+    }) => Promise<TRouteLoaderData> : keyof TAllParams extends never ? (loaderContext: {
+        search: TFullSearchSchema;
+        params: TAllParams;
+        signal?: AbortSignal;
+    }) => Promise<TRouteLoaderData> : (loaderContext: {
+        search: TFullSearchSchema;
+        signal?: AbortSignal;
+    }) => Promise<TRouteLoaderData>;
+    current?: LoaderState<TFullSearchSchema, TAllParams>;
+    latest?: LoaderState<TFullSearchSchema, TAllParams>;
+    pending: LoaderState<TFullSearchSchema, TAllParams>[];
+}
+interface LoaderState<TFullSearchSchema = unknown, TAllParams = unknown> {
+    loadedAt: number;
+    loaderContext: LoaderContext<TFullSearchSchema, TAllParams>;
+}
 interface RouterState {
     status: 'idle' | 'loading';
     location: Location;
     matches: RouteMatch[];
     lastUpdated: number;
-    loaderData: unknown;
-    currentAction?: ActionState;
-    latestAction?: ActionState;
     actions: Record<string, Action>;
+    loaders: Record<string, Loader>;
     pending?: PendingState;
     isFetching: boolean;
     isPreloading: boolean;
@@ -133,7 +226,7 @@ interface PendingState {
     location: Location;
     matches: RouteMatch[];
 }
-declare type Listener = () => void;
+declare type Listener = (router: Router<any, any>) => void;
 declare type ListenerFn = () => void;
 interface BuildNextOptions {
     to?: string | number | null;
@@ -161,7 +254,13 @@ interface MatchRouteOptions {
     pending: boolean;
     caseSensitive?: boolean;
 }
+interface DehydratedRouterState extends Pick<RouterState, 'status' | 'location' | 'lastUpdated'> {
+    matches: DehydratedRouteMatch[];
+}
+interface DehydratedRouteMatch extends Pick<RouteMatch<any, any>, 'matchId' | 'status' | 'routeLoaderData' | 'loaderData' | 'isInvalid' | 'invalidAt'> {
+}
 interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>> {
+    history: BrowserHistory | MemoryHistory | HashHistory;
     options: PickAsRequired<RouterOptions<TRouteConfig>, 'stringifySearch' | 'parseSearch'>;
     basepath: string;
     allRouteInfo: TAllRouteInfo;
@@ -173,24 +272,17 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     routeTree: Route<TAllRouteInfo, RouteInfo>;
     routesById: RoutesById<TAllRouteInfo>;
     navigationPromise: Promise<void>;
-    removeActionQueue: {
-        action: Action;
-        actionState: ActionState;
-    }[];
     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>;
-    buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
-    parseLocation: (location: History['location'], previousLocation?: Location) => Location;
-    buildLocation: (dest: BuildNextOptions) => Location;
-    commitLocation: (next: Location, replace?: boolean) => Promise<void>;
     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]>;
@@ -216,70 +308,22 @@ interface Router<TRouteConfig extends AnyRouteConfig = RouteConfig, TAllRouteInf
     invalidateRoute: (opts: MatchLocation) => void;
     reload: () => Promise<void>;
     resolvePath: (from: string, path: string) => string;
-    _navigate: (location: BuildNextOptions & {
-        replace?: boolean;
-    }) => Promise<void>;
     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;
-}
-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: AnyPathParams;
-    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;
+    dehydrateState: () => DehydratedRouterState;
+    hydrateState: (state: DehydratedRouterState) => void;
     __: {
-        element?: GetFrameworkGeneric<'Element'>;
-        errorElement?: GetFrameworkGeneric<'Element'>;
-        catchElement?: GetFrameworkGeneric<'Element'>;
-        pendingElement?: GetFrameworkGeneric<'Element'>;
-        loadPromise?: Promise<void>;
-        loaderPromise?: Promise<void>;
-        importPromise?: 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;
+        buildRouteTree: (routeConfig: RouteConfig) => Route<TAllRouteInfo, AnyRouteInfo>;
+        parseLocation: (location: History['location'], previousLocation?: Location) => Location;
+        buildLocation: (dest: BuildNextOptions) => Location;
+        commitLocation: (next: Location, replace?: boolean) => Promise<void>;
+        navigate: (location: BuildNextOptions & {
+            replace?: boolean;
+        }) => Promise<void>;
     };
-    cancel: () => void;
-    load: (opts?: {
-        maxAge?: number;
-    }) => Promise<void>;
-    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>>(userOptions?: RouterOptions<TRouteConfig>): Router<TRouteConfig, TAllRouteInfo>;
 
 interface AnyRoute extends Route<any, any> {
 }
@@ -296,9 +340,9 @@ interface Route<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo, TRo
     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>;
     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;
 
 interface AnyAllRouteInfo {
     routeConfig: AnyRouteConfig;
@@ -381,11 +425,12 @@ declare type DefinedPathParamWarning = 'Path params cannot be redefined by child
 declare type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
     [Key in keyof TParentParams]?: DefinedPathParamWarning;
 };
-declare type LoaderFn<TRouteLoaderData extends AnyLoaderData, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> = (loaderContext: {
+declare type LoaderFn<TRouteLoaderData extends AnyLoaderData, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> = (loaderContext: LoaderContext<TFullSearchSchema, TAllParams>) => Promise<TRouteLoaderData>;
+interface LoaderContext<TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> {
     params: TAllParams;
     search: TFullSearchSchema;
     signal?: AbortSignal;
-}) => Promise<TRouteLoaderData>;
+}
 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 = {}> = ({
@@ -399,18 +444,6 @@ declare type RouteOptions<TRouteId extends string = string, TPath extends string
     postSearchFilters?: SearchFilter<TFullSearchSchema>[];
     pendingMs?: number;
     pendingMinMs?: number;
-} & ({
-    parseParams?: never;
-    stringifyParams?: never;
-} | {
-    parseParams: (rawParams: IsAny<TPath, any, Record<ParsePathParams<TPath>, string>>) => TParams;
-    stringifyParams: (params: TParams) => Record<ParsePathParams<TPath>, string>;
-}) & RouteLoaders<TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TFullSearchSchema, TAllParams> & {
-    import?: (opts: {
-        params: AnyPathParams;
-    }) => Promise<RouteLoaders<TRouteLoaderData, TLoaderData, TActionPayload, TActionResponse, TFullSearchSchema, TAllParams>>;
-} & (PickUnsafe<TParentParams, ParsePathParams<TPath>> extends never ? {} : 'Cannot redefined path params in child routes!');
-interface RouteLoaders<TRouteLoaderData extends AnyLoaderData = {}, TLoaderData extends AnyLoaderData = {}, TActionPayload = unknown, TActionResponse = unknown, TFullSearchSchema extends AnySearchSchema = {}, TAllParams extends AnyPathParams = {}> {
     element?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
     errorElement?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
     catchElement?: GetFrameworkGeneric<'SyncOrAsyncElement'>;
@@ -432,7 +465,13 @@ interface RouteLoaders<TRouteLoaderData extends AnyLoaderData = {}, TLoaderData
         search: TFullSearchSchema;
     }) => void;
     meta?: RouteMeta;
-}
+} & ({
+    parseParams?: never;
+    stringifyParams?: never;
+} | {
+    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> {
     id: TId;
@@ -480,7 +519,7 @@ declare type LinkInfo = {
 };
 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, TTrailing = true> = S extends unknown ? string extends S ? string[] : S extends string ? CleanPath<S> extends '' ? [] : TTrailing extends true ? CleanPath<S> extends `${infer T}/` ? [T, '/'] : CleanPath<S> extends `/${infer U}` ? ['/', U] : CleanPath<S> extends `${infer T}/${infer U}` ? [T, ...Split<U>] : [S] : CleanPath<S> extends `${infer T}/${infer U}` ? [T, ...Split<U>] : [S] : never : never;
+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 [
@@ -501,7 +540,7 @@ declare type ToOptions<TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteIn
     to?: ToPathOption<TAllRouteInfo, TFrom, TTo>;
     hash?: Updater<string>;
     from?: TFrom;
-} & CheckPath<TAllRouteInfo, NoInfer<TResolvedTo>> & SearchParamOptions<TAllRouteInfo, TFrom, TResolvedTo> & PathParamOptions<TAllRouteInfo, TFrom, TResolvedTo>;
+} & 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 ? {
     search?: SearchReducer<TFromSchema, TToSchema>;
 } : keyof PickRequired<TToSchema> extends never ? {
@@ -539,12 +578,17 @@ declare type CheckRelativePath<TAllRouteInfo extends AnyAllRouteInfo, TFrom, TTo
     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> = Exclude<TPath, TAllRouteInfo['routePaths']> extends never ? {} : CheckPathError<TAllRouteInfo, Exclude<TPath, TAllRouteInfo['routePaths']>>;
-declare type CheckPathError<TAllRouteInfo extends AnyAllRouteInfo, TInvalids> = {
+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<{
     Error: `${TInvalids extends string ? TInvalids : never} is not a valid route path.`;
     'Valid Route Paths': TAllRouteInfo['routePaths'];
-};
-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] ? ResolveRelativePath<Join<FromRest>, Join<ToRest>> : never : Split<TTo> extends ['.', ...infer ToRest] ? ResolveRelativePath<TFrom, Join<ToRest>> : CleanPath<Join<['/', ...Split<TFrom>, ...Split<TTo>]>> : never : never;
+}>;
+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<{
+    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']);
 
 interface Segment {
@@ -570,4 +614,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, CheckPath, CheckPathError, CheckRelativePath, DeepAwaited, DefaultAllRouteInfo, DefinedPathParamWarning, Expand, FilterRoutesFn, FrameworkGenerics, FromLocation, GetFrameworkGeneric, IsAny, IsAnyBoolean, IsKnown, LinkInfo, LinkOptions, ListenerFn, LoaderFn, 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, RouteLoaders, 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, 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, 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 };