@tanstack/react-router 0.0.1-beta.235 → 0.0.1-beta.236

package/build/types/Matches.d.ts

@@ -45,7 +45,13 @@ export type MakeMatchRouteOptions<TRouteTree extends AnyRoute = RegisteredRouter
     children?: ((params?: RouteByPath<TRouteTree, ResolveRelativePath<TFrom, NoInfer<TTo>>>['types']['allParams']) => ReactNode) | React.ReactNode;
 };
 export declare function MatchRoute<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TMaskFrom extends RoutePaths<TRouteTree> = '/', TMaskTo extends string = ''>(props: MakeMatchRouteOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>): any;
-export declare function useMatch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMatchState = RouteMatch<TRouteTree, TFrom>>(opts: StrictOrFrom<TFrom>): TStrict extends true ? TRouteMatchState : TRouteMatchState | undefined;
+export declare function useMatch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMatchState = RouteMatch<TRouteTree, TFrom>, TSelected = TRouteMatchState>(opts: StrictOrFrom<TFrom> & {
+    select?: (match: TRouteMatchState) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
 export declare const matchesContext: React.Context<RouteMatch<AnyRoute, any>[]>;
-export declare function useMatches(): RouteMatch[];
-export declare function useLoaderData<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMatch extends RouteMatch<TRouteTree, TFrom> = RouteMatch<TRouteTree, TFrom>>(opts: StrictOrFrom<TFrom>): TStrict extends true ? TRouteMatch['loaderData'] : TRouteMatch['loaderData'] | undefined;
+export declare function useMatches<T = RouteMatch[]>(opts?: {
+    select?: (matches: RouteMatch[]) => T;
+}): T;
+export declare function useLoaderData<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMatch extends RouteMatch<TRouteTree, TFrom> = RouteMatch<TRouteTree, TFrom>, TSelected = TRouteMatch['loaderData']>(opts: StrictOrFrom<TFrom> & {
+    select?: (match: TRouteMatch) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;

package/build/types/RouterProvider.d.ts

@@ -26,6 +26,9 @@ export type InjectedHtmlEntry = string | (() => Promise<string> | string);
 export declare const routerContext: React.Context<Router<any, Record<string, any>>>;
 export declare function RouterProvider<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TDehydrated extends Record<string, any> = Record<string, any>>({ router, ...rest }: RouterProps<TRouteTree, TDehydrated>): React.JSX.Element;
 export declare function getRouteMatch<TRouteTree extends AnyRoute>(state: RouterState<TRouteTree>, id: string): undefined | RouteMatch<TRouteTree>;
+export declare function useRouterState<TSelected = RouterState<RegisteredRouter['routeTree']>>(opts?: {
+    select: (state: RouterState<RegisteredRouter['routeTree']>) => TSelected;
+}): TSelected;
 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']>;

package/build/types/route.d.ts

@@ -180,11 +180,21 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
     addChildren: <TNewChildren extends AnyRoute[]>(children: TNewChildren) => Route<TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchSchema, TFullSearchSchema, TParams, TAllParams, TRouteContext, TAllContext, TRouterContext, TNewChildren, TRouteTree, AnyRoute>;
     update: (options: UpdatableRouteOptions<TFullSearchSchema, TAllParams, Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>>, TLoaderData>) => this;
     static __onInit: (route: any) => void;
-    useMatch: () => TAllContext;
-    useRouteContext: () => TAllContext;
-    useSearch: () => TFullSearchSchema;
-    useParams: () => TAllParams;
-    useLoaderData: () => TLoaderData;
+    useMatch: <TSelected = TAllContext>(opts?: {
+        select?: ((search: TAllContext) => TSelected) | undefined;
+    } | undefined) => TSelected;
+    useRouteContext: <TSelected = TAllContext>(opts?: {
+        select?: ((search: TAllContext) => TSelected) | undefined;
+    } | undefined) => TSelected;
+    useSearch: <TSelected = TFullSearchSchema>(opts?: {
+        select?: ((search: TFullSearchSchema) => TSelected) | undefined;
+    } | undefined) => TSelected;
+    useParams: <TSelected = TAllParams>(opts?: {
+        select?: ((search: TAllParams) => TSelected) | undefined;
+    } | undefined) => TSelected;
+    useLoaderData: <TSelected = TLoaderData>(opts?: {
+        select?: ((search: TLoaderData) => TSelected) | undefined;
+    } | undefined) => TSelected;
 }
 export type AnyRootRoute = RootRoute<any, any, any>;
 export declare function rootRouteWithContext<TRouterContext extends {}>(): <TSearchSchema extends Record<string, any> = {}, TRouteContext extends RouteContext = RouteContext, TLoaderData extends unknown = unknown>(options?: Omit<RouteOptions<AnyRoute, "__root__", "", TSearchSchema, TSearchSchema, {}, {}, TRouteContext, Assign<TRouterContext, TRouteContext>, TLoaderData>, "path" | "id" | "getParentRoute" | "stringifyParams" | "parseParams" | "caseSensitive"> | undefined) => RootRoute<TSearchSchema, TRouteContext, TRouterContext, unknown>;
@@ -232,11 +242,21 @@ export declare function createRouteMask<TRouteTree extends AnyRoute, TFrom exten
     routeTree: TRouteTree;
 } & ToSubOptions<TRouteTree, TFrom, TTo>): RouteMask<TRouteTree>;
 export type RouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext, TLoaderData extends any = unknown> = {
-    useMatch: () => TAllContext;
-    useRouteContext: () => TAllContext;
-    useSearch: () => TFullSearchSchema;
-    useParams: () => TAllParams;
-    useLoaderData: () => TLoaderData;
+    useMatch: <TSelected = TAllContext>(opts?: {
+        select?: (search: TAllContext) => TSelected;
+    }) => TSelected;
+    useRouteContext: <TSelected = TAllContext>(opts?: {
+        select?: (search: TAllContext) => TSelected;
+    }) => TSelected;
+    useSearch: <TSelected = TFullSearchSchema>(opts?: {
+        select?: (search: TFullSearchSchema) => TSelected;
+    }) => TSelected;
+    useParams: <TSelected = TAllParams>(opts?: {
+        select?: (search: TAllParams) => TSelected;
+    }) => TSelected;
+    useLoaderData: <TSelected = TLoaderData>(opts?: {
+        select?: (search: TLoaderData) => TSelected;
+    }) => TSelected;
 };
 export type ErrorRouteProps<TFullSearchSchema extends Record<string, any> = AnySearchSchema, TAllParams extends AnyPathParams = AnyPathParams, TAllContext extends Record<string, any> = AnyContext> = {
     error: unknown;

package/build/types/router.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 /// <reference types="node" />
 import { RouterHistory } from '@tanstack/history';
+import { Store } from '@tanstack/store';
 import { AnySearchSchema, AnyRoute, AnyContext, AnyPathParams, RouteMask } from './route';
 import { FullSearchSchema, RoutesById, RoutesByPath } from './routeInfo';
 import { PickAsRequired, Updater, NonNullableUpdater } from './utils';
@@ -56,8 +57,10 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TDehydrated extends
 }
 export interface RouterState<TRouteTree extends AnyRoute = AnyRoute> {
     status: 'pending' | 'idle';
+    isLoading: boolean;
+    isTransitioning: boolean;
     matches: RouteMatch<TRouteTree>[];
-    pendingMatches: RouteMatch<TRouteTree>[];
+    pendingMatches?: RouteMatch<TRouteTree>[];
     location: ParsedLocation<FullSearchSchema<TRouteTree>>;
     resolvedLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
     lastUpdated: number;
@@ -122,7 +125,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     pendingMatches: AnyRouteMatch[];
     injectedHtml: InjectedHtmlEntry[];
     dehydratedData?: TDehydrated;
-    state: RouterState<TRouteTree>;
+    __store: Store<RouterState<TRouteTree>>;
     options: PickAsRequired<RouterOptions<TRouteTree, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
     history: RouterHistory;
     latestLocation: ParsedLocation;
@@ -133,8 +136,8 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     flatRoutes: AnyRoute[];
     constructor(options: RouterConstructorOptions<TRouteTree, TDehydrated>);
     startReactTransition: (fn: () => void) => void;
-    setState: (updater: NonNullableUpdater<RouterState<TRouteTree>>) => void;
     update: (newOptions: RouterConstructorOptions<TRouteTree, TDehydrated>) => void;
+    get state(): RouterState<TRouteTree>;
     buildRouteTree: () => void;
     subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
     emit: (routerEvent: RouterEvent) => void;

package/build/types/useParams.d.ts

@@ -2,4 +2,6 @@ import { AnyRoute } from './route';
 import { RouteIds, RouteById, AllParams } from './routeInfo';
 import { RegisteredRouter } from './router';
 import { StrictOrFrom } from './utils';
-export declare function useParams<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>>(_opts: StrictOrFrom<TFrom>): AllParams<TRouteTree> & RouteById<TRouteTree, TFrom>['types']['allParams'];
+export declare function useParams<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TDefaultSelected = AllParams<TRouteTree> & RouteById<TRouteTree, TFrom>['types']['allParams'], TSelected = TDefaultSelected>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TDefaultSelected) => TSelected;
+}): TSelected;

package/build/types/useSearch.d.ts

@@ -2,4 +2,6 @@ import { AnyRoute } from './route';
 import { RouteIds, RouteById } from './routeInfo';
 import { RegisteredRouter } from './router';
 import { StrictOrFrom } from './utils';
-export declare function useSearch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TSearch = RouteById<TRouteTree, TFrom>['types']['fullSearchSchema']>(opts: StrictOrFrom<TFrom>): TStrict extends true ? TSearch : TSearch | undefined;
+export declare function useSearch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TSearch = RouteById<TRouteTree, TFrom>['types']['fullSearchSchema'], TSelected = TSearch>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TSearch) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;

package/build/types/utils.d.ts

@@ -59,6 +59,8 @@ export type StrictOrFrom<TFrom> = {
     strict: false;
 };
 export type RouteFromIdOrRoute<T, TRouteTree extends AnyRoute = RegisteredRouter['routeTree']> = T extends ParseRoute<TRouteTree> ? T : T extends RouteIds<TRouteTree> ? RoutesById<TRouteTree>[T] : T extends string ? RouteIds<TRouteTree> : never;
-export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom>): TStrict extends true ? TSelected : TSelected | undefined;
+export declare function useRouteContext<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteContext = RouteById<TRouteTree, TFrom>['types']['allContext'], TSelected = TRouteContext>(opts: StrictOrFrom<TFrom> & {
+    select?: (search: TRouteContext) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
 export declare const useLayoutEffect: typeof React.useLayoutEffect;
 export declare function escapeJSON(jsonString: string): string;