@tanstack/react-router 0.0.1-beta.173 → 0.0.1-beta.175

package/build/types/index.d.ts

@@ -1,199 +1,5 @@
-/**
- * @tanstack/react-router/src/index.tsx
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-import { NoInfer } from '@tanstack/react-store';
 export { useStore } from '@tanstack/react-store';
-import * as _tanstack_router_core from '@tanstack/router-core';
-import { AnySearchSchema, AnyPathParams, AnyContext, RouteConstraints, AnyRoute, ResolveFullPath, ResolveId, ResolveFullSearchSchema, ParsePathParams, MergeParamsFromParent, RouteContext, UseLoaderResult, AnyRouteProps, RoutePaths, RegisteredRouter, LinkOptions, ToOptions, MatchRouteOptions, RouteByPath, ResolveRelativePath, NavigateOptions, RouterOptions, Router, RouteMatch, RouteIds, RouteById, ParseRoute, RoutesById, AllParams, ScrollRestorationOptions, DeferredPromise } from '@tanstack/router-core';
 export * from '@tanstack/router-core';
-import * as React from 'react';
-
-declare module '@tanstack/router-core' {
-    interface RegisterRouteComponent<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        RouteComponent: RouteComponent<RouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
-    }
-    interface RegisterErrorRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        ErrorRouteComponent: RouteComponent<ErrorRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
-    }
-    interface RegisterPendingRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        PendingRouteComponent: RouteComponent<PendingRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
-    }
-    interface Route<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TLoader = unknown, TSearchSchema extends RouteConstraints['TSearchSchema'] = {}, TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<TParentRoute, TSearchSchema>, TParams extends RouteConstraints['TParams'] = Record<ParsePathParams<TPath>, string>, TAllParams extends RouteConstraints['TAllParams'] = MergeParamsFromParent<TParentRoute['types']['allParams'], TParams>, TParentContext extends RouteConstraints['TParentContext'] = TParentRoute['types']['routeContext'], TAllParentContext extends RouteConstraints['TAllParentContext'] = TParentRoute['types']['context'], TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext, TAllContext extends RouteConstraints['TAllContext'] = MergeParamsFromParent<TParentRoute['types']['context'], TRouteContext>, TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext, TChildren extends RouteConstraints['TChildren'] = unknown, TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute> {
-        useMatch: <TSelected = TAllContext>(opts?: {
-            select?: (search: TAllContext) => TSelected;
-        }) => TSelected;
-        useLoader: <TSelected = TLoader>(opts?: {
-            select?: (search: TLoader) => TSelected;
-        }) => UseLoaderResult<TSelected>;
-        useContext: <TSelected = TAllContext>(opts?: {
-            select?: (search: TAllContext) => TSelected;
-        }) => TSelected;
-        useRouteContext: <TSelected = TRouteContext>(opts?: {
-            select?: (search: TRouteContext) => TSelected;
-        }) => TSelected;
-        useSearch: <TSelected = TFullSearchSchema>(opts?: {
-            select?: (search: TFullSearchSchema) => TSelected;
-        }) => TSelected;
-        useParams: <TSelected = TAllParams>(opts?: {
-            select?: (search: TAllParams) => TSelected;
-        }) => TSelected;
-    }
-    interface RegisterRouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        RouteProps: RouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
-    }
-    interface RegisterPendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        PendingRouteProps: PendingRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
-    }
-    interface RegisterErrorRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
-        ErrorRouteProps: ErrorRouteProps;
-    }
-}
-type RouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = {
-    useLoader: <TStrict extends boolean = true, TSelected = TLoader>(opts?: {
-        strict?: TStrict;
-        select?: (search: TLoader) => TSelected;
-    }) => TStrict extends true ? UseLoaderResult<TSelected> : UseLoaderResult<TSelected> | undefined;
-    useMatch: <TStrict extends boolean = true, TSelected = TAllContext>(opts?: {
-        strict?: TStrict;
-        select?: (search: TAllContext) => TSelected;
-    }) => TStrict extends true ? TSelected : TSelected | undefined;
-    useContext: <TStrict extends boolean = true, TSelected = TAllContext>(opts?: {
-        strict?: TStrict;
-        select?: (search: TAllContext) => TSelected;
-    }) => TStrict extends true ? TSelected : TSelected | undefined;
-    useRouteContext: <TStrict extends boolean = true, TSelected = TRouteContext>(opts?: {
-        strict?: TStrict;
-        select?: (search: TRouteContext) => TSelected;
-    }) => TStrict extends true ? TSelected : TSelected | undefined;
-    useSearch: <TStrict extends boolean = true, TSelected = TFullSearchSchema>(opts?: {
-        strict?: TStrict;
-        select?: (search: TFullSearchSchema) => TSelected;
-    }) => TStrict extends true ? TSelected : TSelected | undefined;
-    useParams: <TStrict extends boolean = true, TSelected = TAllParams>(opts?: {
-        strict?: TStrict;
-        select?: (search: TAllParams) => TSelected;
-    }) => TStrict extends true ? TSelected : TSelected | undefined;
-};
-type ErrorRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = {
-    error: unknown;
-    info: {
-        componentStack: string;
-    };
-} & Omit<RouteProps<unknown, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>, 'useLoader'>;
-type PendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = Omit<RouteProps<unknown, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>, 'useLoader'>;
-type ReactNode = any;
-type SyncRouteComponent<TProps> = ((props: TProps) => ReactNode) | React.LazyExoticComponent<(props: TProps) => ReactNode>;
-type AsyncRouteComponent<TProps> = SyncRouteComponent<TProps> & {
-    preload?: () => Promise<void>;
-};
-type ErrorRouteComponent = AsyncRouteComponent<ErrorRouteComponentProps>;
-type ErrorRouteComponentProps = {
-    error: Error;
-    info: {
-        componentStack: string;
-    };
-};
-type AnyRouteComponent = RouteComponent<AnyRouteProps>;
-type RouteComponent<TProps> = AsyncRouteComponent<TProps>;
-declare function lazyRouteComponent<T extends Record<string, any>, TKey extends keyof T = 'default'>(importer: () => Promise<T>, exportName?: TKey): T[TKey] extends (props: infer TProps) => any ? AsyncRouteComponent<TProps> : never;
-type LinkPropsOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = LinkOptions<RegisteredRouter['routeTree'], TFrom, TTo> & {
-    activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
-    inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
-    startTransition?: boolean;
-};
-type MakeUseMatchRouteOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = ToOptions<RegisteredRouter['routeTree'], TFrom, TTo> & MatchRouteOptions;
-type MakeMatchRouteOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = ToOptions<RegisteredRouter['routeTree'], TFrom, TTo> & MatchRouteOptions & {
-    children?: ((params?: RouteByPath<RegisteredRouter['routeTree'], ResolveRelativePath<TFrom, NoInfer<TTo>>>['types']['allParams']) => ReactNode) | React.ReactNode;
-};
-type MakeLinkPropsOptions<TFrom extends string = '/', TTo extends string = ''> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>;
-type MakeLinkOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = LinkPropsOptions<TFrom, TTo> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
-    children?: React.ReactNode | ((state: {
-        isActive: boolean;
-    }) => React.ReactNode);
-};
-type PromptProps = {
-    message: string;
-    condition?: boolean | any;
-    children?: ReactNode;
-};
-declare function useLinkProps<TFrom extends string = '/', TTo extends string = ''>(options: MakeLinkPropsOptions<TFrom, TTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
-interface LinkComponent<TProps extends Record<string, any> = {}> {
-    <TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''>(props: MakeLinkOptions<TFrom, TTo> & TProps & React.RefAttributes<HTMLAnchorElement>): ReactNode;
-}
-declare const Link: LinkComponent;
-declare function Navigate<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''>(props: NavigateOptions<RegisteredRouter['routeTree'], TFrom, TTo>): null;
-declare const matchIdsContext: React.Context<string[]>;
-declare const routerContext: React.Context<_tanstack_router_core.AnyRouter>;
-type RouterProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated>, 'context'> & {
-    router: Router<TRouteTree>;
-    context?: Partial<RouterOptions<TRouteTree, TDehydrated>['context']>;
-};
-declare function useRouterState<TSelected = RegisteredRouter['state']>(opts?: {
-    select: (state: RegisteredRouter['state']) => TSelected;
-}): TSelected;
-declare function RouterProvider<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>>({ router, ...rest }: RouterProps<TRouteTree, TDehydrated>): JSX.Element;
-declare function useRouter(): RegisteredRouter;
-declare function useMatches<T = RouteMatch[]>(opts?: {
-    select?: (matches: RouteMatch[]) => T;
-}): T;
-type StrictOrFrom<TFrom> = {
-    from: TFrom;
-    strict?: true;
-} | {
-    from?: never;
-    strict: false;
-};
-declare function useMatch<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TRouteMatchState = RouteMatch<RegisteredRouter['routeTree'], RouteById<RegisteredRouter['routeTree'], TFrom>>, TSelected = TRouteMatchState>(opts: StrictOrFrom<TFrom> & {
-    select?: (match: TRouteMatchState) => TSelected;
-}): TStrict extends true ? TRouteMatchState : TRouteMatchState | undefined;
-type RouteFromIdOrRoute<T> = T extends ParseRoute<RegisteredRouter['routeTree']> ? T : T extends RouteIds<RegisteredRouter['routeTree']> ? RoutesById<RegisteredRouter['routeTree']>[T] : T extends string ? RouteIds<RegisteredRouter['routeTree']> : never;
-declare function useLoader<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TLoader = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['loader'], TSelected = TLoader>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TLoader) => TSelected;
-}): TStrict extends true ? TSelected : TSelected | undefined;
-declare function useRouterContext<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TContext = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['context'], TSelected = TContext>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TContext) => TSelected;
-}): TStrict extends true ? TSelected : TSelected | undefined;
-declare function useRouteContext<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TRouteContext = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['routeContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TRouteContext) => TSelected;
-}): TStrict extends true ? TSelected : TSelected | undefined;
-declare function useSearch<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TSearch = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['fullSearchSchema'], TSelected = TSearch>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TSearch) => TSelected;
-}): TStrict extends true ? TSelected : TSelected | undefined;
-declare function useParams<TFrom extends RouteIds<RegisteredRouter['routeTree']> = '/', TDefaultSelected = AllParams<RegisteredRouter['routeTree']> & RouteById<RegisteredRouter['routeTree'], TFrom>['types']['allParams'], TSelected = TDefaultSelected>(opts: StrictOrFrom<TFrom> & {
-    select?: (search: TDefaultSelected) => TSelected;
-}): TSelected;
-declare function useNavigate<TDefaultFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/'>(defaultOpts?: {
-    from?: TDefaultFrom;
-}): <TFrom extends unknown = TDefaultFrom, TTo extends string = "">(opts?: NavigateOptions<any, TFrom, TTo> | undefined) => Promise<void>;
-declare function useMatchRoute(): <TFrom extends string = "/", TTo extends string = "">(opts: MakeUseMatchRouteOptions<TFrom, TTo>) => any;
-declare function MatchRoute<TFrom extends string = '/', TTo extends string = ''>(props: MakeMatchRouteOptions<TFrom, TTo>): any;
-declare function Outlet(): JSX.Element | null;
-declare function useInjectHtml(): (html: string | (() => Promise<string> | string)) => void;
-declare function useDehydrate(): <T>(key: any, data: T | (() => T | Promise<T>)) => () => T | undefined;
-declare function useHydrate(): <T = unknown>(key: any) => T;
-declare function ErrorComponent({ error }: {
-    error: any;
-}): JSX.Element;
-declare function useBlocker(message: string, condition?: boolean | any): void;
-declare function Block({ message, condition, children }: PromptProps): any;
-declare function shallow<T>(objA: T, objB: T): boolean;
-
-declare function useScrollRestoration(options?: ScrollRestorationOptions): void;
-declare function ScrollRestoration(props: ScrollRestorationOptions): null;
-
-type AwaitOptions<T> = {
-    promise: DeferredPromise<T>;
-};
-declare function useAwaited<T>({ promise }: AwaitOptions<T>): [T];
-declare function Await<T>(props: AwaitOptions<T> & {
-    children: (result: T) => JSX.Element;
-}): JSX.Element;
-
-export { AnyRouteComponent, AsyncRouteComponent, Await, AwaitOptions, Block, ErrorComponent, ErrorRouteComponent, ErrorRouteComponentProps, ErrorRouteProps, Link, LinkComponent, LinkPropsOptions, MakeLinkOptions, MakeLinkPropsOptions, MakeMatchRouteOptions, MakeUseMatchRouteOptions, MatchRoute, Navigate, Outlet, PendingRouteProps, PromptProps, RouteComponent, RouteFromIdOrRoute, RouteProps, RouterProps, RouterProvider, ScrollRestoration, SyncRouteComponent, lazyRouteComponent, matchIdsContext, routerContext, shallow, useAwaited, useBlocker, useDehydrate, useHydrate, useInjectHtml, useLinkProps, useLoader, useMatch, useMatchRoute, useMatches, useNavigate, useParams, useRouteContext, useRouter, useRouterContext, useRouterState, useScrollRestoration, useSearch };
+export * from './react';
+export * from './scroll-restoration';
+export * from './awaited';

package/build/types/react.d.ts

@@ -0,0 +1,173 @@
+import * as React from 'react';
+import { NoInfer } from '@tanstack/react-store';
+import { MatchRouteOptions, RegisteredRouter, RouterOptions, Router, RouteMatch, RouteByPath, AnyRoute, AnyRouteProps, LinkOptions, ToOptions, ResolveRelativePath, NavigateOptions, ResolveFullPath, ResolveId, AnySearchSchema, ParsePathParams, MergeParamsFromParent, RouteContext, AnyContext, UseLoaderResult, ResolveFullSearchSchema, RouteConstraints, RoutePaths, RoutesById, RouteIds, RouteById, ParseRoute, AllParams, AnyPathParams } from '@tanstack/router-core';
+declare module '@tanstack/router-core' {
+    interface RegisterRouteComponent<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        RouteComponent: RouteComponent<RouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
+    }
+    interface RegisterErrorRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        ErrorRouteComponent: RouteComponent<ErrorRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
+    }
+    interface RegisterPendingRouteComponent<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        PendingRouteComponent: RouteComponent<PendingRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>>;
+    }
+    interface Route<TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<TParentRoute, TPath>, TCustomId extends RouteConstraints['TCustomId'] = string, TId extends RouteConstraints['TId'] = ResolveId<TParentRoute, TCustomId, TPath>, TLoader = unknown, TSearchSchema extends RouteConstraints['TSearchSchema'] = {}, TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<TParentRoute, TSearchSchema>, TParams extends RouteConstraints['TParams'] = Record<ParsePathParams<TPath>, string>, TAllParams extends RouteConstraints['TAllParams'] = MergeParamsFromParent<TParentRoute['types']['allParams'], TParams>, TParentContext extends RouteConstraints['TParentContext'] = TParentRoute['types']['routeContext'], TAllParentContext extends RouteConstraints['TAllParentContext'] = TParentRoute['types']['context'], TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext, TAllContext extends RouteConstraints['TAllContext'] = MergeParamsFromParent<TParentRoute['types']['context'], TRouteContext>, TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext, TChildren extends RouteConstraints['TChildren'] = unknown, TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute> {
+        useMatch: <TSelected = TAllContext>(opts?: {
+            select?: (search: TAllContext) => TSelected;
+        }) => TSelected;
+        useLoader: <TSelected = TLoader>(opts?: {
+            select?: (search: TLoader) => TSelected;
+        }) => UseLoaderResult<TSelected>;
+        useContext: <TSelected = TAllContext>(opts?: {
+            select?: (search: TAllContext) => TSelected;
+        }) => TSelected;
+        useRouteContext: <TSelected = TRouteContext>(opts?: {
+            select?: (search: TRouteContext) => TSelected;
+        }) => TSelected;
+        useSearch: <TSelected = TFullSearchSchema>(opts?: {
+            select?: (search: TFullSearchSchema) => TSelected;
+        }) => TSelected;
+        useParams: <TSelected = TAllParams>(opts?: {
+            select?: (search: TAllParams) => TSelected;
+        }) => TSelected;
+    }
+    interface RegisterRouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        RouteProps: RouteProps<TLoader, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+    }
+    interface RegisterPendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        PendingRouteProps: PendingRouteProps<TFullSearchSchema, TAllParams, TRouteContext, TAllContext>;
+    }
+    interface RegisterErrorRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> {
+        ErrorRouteProps: ErrorRouteProps;
+    }
+}
+export type RouteProps<TLoader = unknown, TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = {
+    useLoader: <TStrict extends boolean = true, TSelected = TLoader>(opts?: {
+        strict?: TStrict;
+        select?: (search: TLoader) => TSelected;
+    }) => TStrict extends true ? UseLoaderResult<TSelected> : UseLoaderResult<TSelected> | undefined;
+    useMatch: <TStrict extends boolean = true, TSelected = TAllContext>(opts?: {
+        strict?: TStrict;
+        select?: (search: TAllContext) => TSelected;
+    }) => TStrict extends true ? TSelected : TSelected | undefined;
+    useContext: <TStrict extends boolean = true, TSelected = TAllContext>(opts?: {
+        strict?: TStrict;
+        select?: (search: TAllContext) => TSelected;
+    }) => TStrict extends true ? TSelected : TSelected | undefined;
+    useRouteContext: <TStrict extends boolean = true, TSelected = TRouteContext>(opts?: {
+        strict?: TStrict;
+        select?: (search: TRouteContext) => TSelected;
+    }) => TStrict extends true ? TSelected : TSelected | undefined;
+    useSearch: <TStrict extends boolean = true, TSelected = TFullSearchSchema>(opts?: {
+        strict?: TStrict;
+        select?: (search: TFullSearchSchema) => TSelected;
+    }) => TStrict extends true ? TSelected : TSelected | undefined;
+    useParams: <TStrict extends boolean = true, TSelected = TAllParams>(opts?: {
+        strict?: TStrict;
+        select?: (search: TAllParams) => TSelected;
+    }) => TStrict extends true ? TSelected : TSelected | undefined;
+};
+export type ErrorRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = {
+    error: unknown;
+    info: {
+        componentStack: string;
+    };
+} & Omit<RouteProps<unknown, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>, 'useLoader'>;
+export type PendingRouteProps<TFullSearchSchema extends AnySearchSchema = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TRouteContext extends AnyContext = AnyContext, TAllContext extends AnyContext = AnyContext> = Omit<RouteProps<unknown, TFullSearchSchema, TAllParams, TRouteContext, TAllContext>, 'useLoader'>;
+type ReactNode = any;
+export type SyncRouteComponent<TProps> = ((props: TProps) => ReactNode) | React.LazyExoticComponent<(props: TProps) => ReactNode>;
+export type AsyncRouteComponent<TProps> = SyncRouteComponent<TProps> & {
+    preload?: () => Promise<void>;
+};
+export type ErrorRouteComponent = AsyncRouteComponent<ErrorRouteComponentProps>;
+export type ErrorRouteComponentProps = {
+    error: Error;
+    info: {
+        componentStack: string;
+    };
+};
+export type AnyRouteComponent = RouteComponent<AnyRouteProps>;
+export type RouteComponent<TProps> = AsyncRouteComponent<TProps>;
+export declare function lazyRouteComponent<T extends Record<string, any>, TKey extends keyof T = 'default'>(importer: () => Promise<T>, exportName?: TKey): T[TKey] extends (props: infer TProps) => any ? AsyncRouteComponent<TProps> : never;
+export type LinkPropsOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = LinkOptions<RegisteredRouter['routeTree'], TFrom, TTo> & {
+    activeProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
+    inactiveProps?: React.AnchorHTMLAttributes<HTMLAnchorElement> | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>);
+    startTransition?: boolean;
+};
+export type MakeUseMatchRouteOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = ToOptions<RegisteredRouter['routeTree'], TFrom, TTo> & MatchRouteOptions;
+export type MakeMatchRouteOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = ToOptions<RegisteredRouter['routeTree'], TFrom, TTo> & MatchRouteOptions & {
+    children?: ((params?: RouteByPath<RegisteredRouter['routeTree'], ResolveRelativePath<TFrom, NoInfer<TTo>>>['types']['allParams']) => ReactNode) | React.ReactNode;
+};
+export type MakeLinkPropsOptions<TFrom extends string = '/', TTo extends string = ''> = LinkPropsOptions<TFrom, TTo> & React.AnchorHTMLAttributes<HTMLAnchorElement>;
+export type MakeLinkOptions<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''> = LinkPropsOptions<TFrom, TTo> & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
+    children?: React.ReactNode | ((state: {
+        isActive: boolean;
+    }) => React.ReactNode);
+};
+export type PromptProps = {
+    message: string;
+    condition?: boolean | any;
+    children?: ReactNode;
+};
+export declare function useLinkProps<TFrom extends string = '/', TTo extends string = ''>(options: MakeLinkPropsOptions<TFrom, TTo>): React.AnchorHTMLAttributes<HTMLAnchorElement>;
+export interface LinkComponent<TProps extends Record<string, any> = {}> {
+    <TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''>(props: MakeLinkOptions<TFrom, TTo> & TProps & React.RefAttributes<HTMLAnchorElement>): ReactNode;
+}
+export declare const Link: LinkComponent;
+export declare function Navigate<TFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/', TTo extends string = ''>(props: NavigateOptions<RegisteredRouter['routeTree'], TFrom, TTo>): null;
+export declare const matchIdsContext: React.Context<string[]>;
+export declare const routerContext: React.Context<import("@tanstack/router-core").AnyRouter>;
+export type RouterProps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>> = Omit<RouterOptions<TRouteTree, TDehydrated>, 'context'> & {
+    router: Router<TRouteTree>;
+    context?: Partial<RouterOptions<TRouteTree, TDehydrated>['context']>;
+};
+export declare function useRouterState<TSelected = RegisteredRouter['state']>(opts?: {
+    select: (state: RegisteredRouter['state']) => TSelected;
+}): TSelected;
+export declare function RouterProvider<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>>({ router, ...rest }: RouterProps<TRouteTree, TDehydrated>): JSX.Element;
+export declare function useRouter(): RegisteredRouter;
+export declare function useMatches<T = RouteMatch[]>(opts?: {
+    select?: (matches: RouteMatch[]) => T;
+}): T;
+type StrictOrFrom<TFrom> = {
+    from: TFrom;
+    strict?: true;
+} | {
+    from?: never;
+    strict: false;
+};
+export declare function useMatch<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TRouteMatchState = RouteMatch<RegisteredRouter['routeTree'], RouteById<RegisteredRouter['routeTree'], TFrom>>, TSelected = TRouteMatchState>(opts: StrictOrFrom<TFrom> & {
+    select?: (match: TRouteMatchState) => TSelected;
+}): TStrict extends true ? TRouteMatchState : TRouteMatchState | undefined;
+export type RouteFromIdOrRoute<T> = T extends ParseRoute<RegisteredRouter['routeTree']> ? T : T extends RouteIds<RegisteredRouter['routeTree']> ? RoutesById<RegisteredRouter['routeTree']>[T] : T extends string ? RouteIds<RegisteredRouter['routeTree']> : never;
+export declare function useLoader<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TLoader = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['loader'], TSelected = TLoader>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TLoader) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+export declare function useRouterContext<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TContext = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['context'], TSelected = TContext>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TContext) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+export declare function useRouteContext<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TRouteContext = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['routeContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TRouteContext) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+export declare function useSearch<TFrom extends RouteIds<RegisteredRouter['routeTree']>, TStrict extends boolean = true, TSearch = RouteById<RegisteredRouter['routeTree'], TFrom>['types']['fullSearchSchema'], TSelected = TSearch>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TSearch) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
+export declare function useParams<TFrom extends RouteIds<RegisteredRouter['routeTree']> = '/', TDefaultSelected = AllParams<RegisteredRouter['routeTree']> & RouteById<RegisteredRouter['routeTree'], TFrom>['types']['allParams'], TSelected = TDefaultSelected>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TDefaultSelected) => TSelected;
+}): TSelected;
+export declare function useNavigate<TDefaultFrom extends RoutePaths<RegisteredRouter['routeTree']> = '/'>(defaultOpts?: {
+    from?: TDefaultFrom;
+}): <TFrom extends unknown = TDefaultFrom, TTo extends string = "">(opts?: NavigateOptions<any, TFrom, TTo> | undefined) => Promise<void>;
+export declare function useMatchRoute(): <TFrom extends string = "/", TTo extends string = "">(opts: MakeUseMatchRouteOptions<TFrom, TTo>) => any;
+export declare function MatchRoute<TFrom extends string = '/', TTo extends string = ''>(props: MakeMatchRouteOptions<TFrom, TTo>): any;
+export declare function Outlet(): JSX.Element | null;
+export declare function useInjectHtml(): (html: string | (() => Promise<string> | string)) => void;
+export declare function useDehydrate(): <T>(key: any, data: T | (() => T | Promise<T>)) => () => T | undefined;
+export declare function useHydrate(): <T = unknown>(key: any) => T;
+export declare function ErrorComponent({ error }: {
+    error: any;
+}): JSX.Element;
+export declare function useBlocker(message: string, condition?: boolean | any): void;
+export declare function Block({ message, condition, children }: PromptProps): any;
+export declare function shallow<T>(objA: T, objB: T): boolean;
+export {};

package/build/types/scroll-restoration.d.ts

@@ -0,0 +1,3 @@
+import { ScrollRestorationOptions } from '@tanstack/router-core';
+export declare function useScrollRestoration(options?: ScrollRestorationOptions): void;
+export declare function ScrollRestoration(props: ScrollRestorationOptions): null;

package/build/umd/index.development.js

@@ -869,6 +869,8 @@
   //
 
   const componentTypes = ['component', 'errorComponent', 'pendingComponent'];
+  const visibilityChangeEvent = 'visibilitychange';
+  const focusEvent = 'focus';
   class Router {
     #unsubHistory;
     resetNextScroll = false;
@@ -945,12 +947,26 @@
       this.__store.setState(s => Object.assign(s, getInitialRouterState()));
     };
     mount = () => {
-      // If the router matches are empty, start loading the matches
-      // if (!this.state.matches.length) {
+      // addEventListener does not exist in React Native, but window does
+      // In the future, we might need to invert control here for more adapters
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (typeof window !== 'undefined' && window.addEventListener) {
+        window.addEventListener(visibilityChangeEvent, this.#onFocus, false);
+        window.addEventListener(focusEvent, this.#onFocus, false);
+      }
       this.safeLoad();
-      // }
+      return () => {
+        if (typeof window !== 'undefined' && window.removeEventListener) {
+          window.removeEventListener(visibilityChangeEvent, this.#onFocus);
+          window.removeEventListener(focusEvent, this.#onFocus);
+        }
+      };
+    };
+    #onFocus = () => {
+      if (this.options.refetchOnWindowFocus ?? true) {
+        this.reload();
+      }
     };
-
     update = opts => {
       this.options = {
         ...this.options,
@@ -1021,7 +1037,6 @@
         };
 
         // Cancel any pending matches
-        // this.cancelMatches()
 
         let pendingMatches;
         this.#emit({
@@ -1064,6 +1079,9 @@
           if (latestPromise = checkLatest()) {
             return latestPromise;
           }
+          const exitingMatchIds = this.state.matchIds.filter(id => !this.state.pendingMatchIds.includes(id));
+          const enteringMatchIds = this.state.pendingMatchIds.filter(id => !this.state.matchIds.includes(id));
+          const stayingMatchIds = this.state.matchIds.filter(id => this.state.pendingMatchIds.includes(id));
           this.__store.setState(s => ({
             ...s,
             status: 'idle',
@@ -1071,6 +1089,13 @@
             matchIds: s.pendingMatchIds,
             pendingMatchIds: []
           }));
+          [[exitingMatchIds, 'onLeave'], [enteringMatchIds, 'onEnter'], [stayingMatchIds, 'onTransition']].forEach(([matchIds, hook]) => {
+            matchIds.forEach(id => {
+              const match = this.getRouteMatch(id);
+              const route = this.getRoute(match.routeId);
+              route.options[hook]?.(match);
+            });
+          });
           this.#emit({
             type: 'onLoad',
             from: prevLocation,
@@ -1087,6 +1112,9 @@
         }
       });
       this.latestLoadPromise = promise;
+      this.latestLoadPromise.then(() => {
+        this.cleanMatches();
+      });
       return this.latestLoadPromise;
     };
     #mergeMatches = (prevMatchesById, nextMatches) => {
@@ -1131,7 +1159,7 @@
       const now = Date.now();
       const outdatedMatchIds = Object.values(this.state.matchesById).filter(match => {
         const route = this.getRoute(match.routeId);
-        return !this.state.matchIds.includes(match.id) && !this.state.pendingMatchIds.includes(match.id) && match.preloadInvalidAt < now && (route.options.gcMaxAge ? match.updatedAt + route.options.gcMaxAge < now : true);
+        return !this.state.matchIds.includes(match.id) && !this.state.pendingMatchIds.includes(match.id) && (match.preloadMaxAge > -1 ? match.updatedAt + match.preloadMaxAge < now : true) && (route.options.gcMaxAge ? match.updatedAt + route.options.gcMaxAge < now : true);
       }).map(d => d.id);
       if (outdatedMatchIds.length) {
         this.__store.setState(s => {
@@ -1219,8 +1247,8 @@
           params: routeParams,
           pathname: joinPaths([this.basepath, interpolatedPath]),
           updatedAt: Date.now(),
-          invalidAt: Infinity,
-          preloadInvalidAt: Infinity,
+          maxAge: -1,
+          preloadMaxAge: -1,
           routeSearch: {},
           search: {},
           status: hasLoaders ? 'pending' : 'success',
@@ -1316,11 +1344,13 @@
             paramsError: match.paramsError,
             searchError: match.searchError,
             params: match.params,
-            preloadInvalidAt: 0
+            preloadMaxAge: 0
           }));
         });
+      } else {
+        // If we're preloading, clean preload matches before we try and use them
+        this.cleanMatches();
       }
-      this.cleanMatches();
       let firstBadMatchIndex;
 
       // Check each match middleware to see if the route can be accessed
@@ -1382,8 +1412,7 @@
         matchPromises.push((async () => {
           const parentMatchPromise = matchPromises[index - 1];
           const route = this.getRoute(match.routeId);
-          if (match.isFetching || match.status === 'success' && !this.getIsInvalid({
-            matchId: match.id,
+          if (match.isFetching || match.status === 'success' && !isMatchInvalid(match, {
             preload: opts?.preload
           })) {
             return this.getRouteMatch(match.id)?.loadPromise;
@@ -1456,7 +1485,6 @@
         })());
       });
       await Promise.all(matchPromises);
-      this.cleanMatches();
     };
     reload = () => {
       return this.navigate({
@@ -1641,7 +1669,7 @@
     dehydrate = () => {
       return {
         state: {
-          dehydratedMatches: this.state.matches.map(d => pick(d, ['fetchedAt', 'invalid', 'invalidAt', 'id', 'loaderData', 'status', 'updatedAt']))
+          dehydratedMatches: this.state.matches.map(d => pick(d, ['fetchedAt', 'invalid', 'preloadMaxAge', 'maxAge', 'id', 'loaderData', 'status', 'updatedAt']))
         }
       };
     };
@@ -1880,7 +1908,6 @@
         ...next.state
       });
       this.resetNextScroll = location.resetScroll ?? true;
-      console.log('resetScroll', this.resetNextScroll);
       return this.latestLoadPromise;
     };
     getRouteMatch = id => {
@@ -1905,17 +1932,17 @@
       if (!match) return;
       const route = this.getRoute(match.routeId);
       const updatedAt = opts?.updatedAt ?? Date.now();
-      const preloadInvalidAt = updatedAt + (opts?.maxAge ?? route.options.preloadMaxAge ?? this.options.defaultPreloadMaxAge ?? 5000);
-      const invalidAt = updatedAt + (opts?.maxAge ?? route.options.maxAge ?? this.options.defaultMaxAge ?? Infinity);
+      const preloadMaxAge = opts?.maxAge ?? route.options.preloadMaxAge ?? this.options.defaultPreloadMaxAge ?? 5000;
+      const maxAge = opts?.maxAge ?? route.options.maxAge ?? this.options.defaultMaxAge ?? -1;
       this.setRouteMatch(id, s => ({
         ...s,
         error: undefined,
         status: 'success',
         isFetching: false,
-        updatedAt: Date.now(),
+        updatedAt: updatedAt,
         loaderData: functionalUpdate(updater, s.loaderData),
-        preloadInvalidAt,
-        invalidAt
+        preloadMaxAge,
+        maxAge
       }));
     };
     invalidate = async opts => {
@@ -1946,20 +1973,6 @@
         return this.reload();
       }
     };
-    getIsInvalid = opts => {
-      if (!opts?.matchId) {
-        return !!this.state.matches.find(d => this.getIsInvalid({
-          matchId: d.id,
-          preload: opts?.preload
-        }));
-      }
-      const match = this.getRouteMatch(opts?.matchId);
-      if (!match) {
-        return false;
-      }
-      const now = Date.now();
-      return match.invalid || (opts?.preload ? match.preloadInvalidAt : match.invalidAt) < now;
-    };
   }
 
   // Detect if we're in the DOM
@@ -2005,6 +2018,16 @@
       return imported[key || 'default'](...args);
     };
   }
+  function isMatchInvalid(match, opts) {
+    const now = Date.now();
+    if (match.invalid) {
+      return true;
+    }
+    if (opts?.preload) {
+      return match.preloadMaxAge < 0 ? false : match.updatedAt + match.preloadMaxAge < now;
+    }
+    return match.maxAge < 0 ? false : match.updatedAt + match.maxAge < now;
+  }
 
   const windowKey = 'window';
   const delimiter = '___';
@@ -2806,6 +2829,7 @@
   exports.interpolatePath = interpolatePath;
   exports.invariant = invariant;
   exports.isDehydratedDeferred = isDehydratedDeferred;
+  exports.isMatchInvalid = isMatchInvalid;
   exports.isPlainObject = isPlainObject;
   exports.isRedirect = isRedirect;
   exports.joinPaths = joinPaths;