@tanstack/react-router 0.0.1-beta.275 → 0.0.1-beta.277

package/build/types/Matches.d.ts

@@ -55,6 +55,9 @@ export declare function useMatches<T = RouteMatch[]>(opts?: {
 export declare function useParentMatches<T = RouteMatch[]>(opts?: {
     select?: (matches: RouteMatch[]) => T;
 }): T;
+export declare function useLoaderDeps<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>, TStrict extends boolean = true, TRouteMatch extends RouteMatch<TRouteTree, TFrom> = RouteMatch<TRouteTree, TFrom>, TSelected = Required<TRouteMatch>['loaderDeps']>(opts: StrictOrFrom<TFrom> & {
+    select?: (match: TRouteMatch) => TSelected;
+}): TStrict extends true ? TSelected : TSelected | undefined;
 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 = Required<TRouteMatch>['loaderData']>(opts: StrictOrFrom<TFrom> & {
     select?: (match: TRouteMatch) => TSelected;
 }): TStrict extends true ? TSelected : TSelected | undefined;

package/build/types/RouterProvider.d.ts

@@ -3,7 +3,7 @@ import { NavigateOptions, ResolveRelativePath, ToOptions } from './link';
 import { ParsedLocation } from './location';
 import { AnyRoute } from './route';
 import { RouteById, RoutePaths } from './routeInfo';
-import { BuildNextOptions, RegisteredRouter, Router, RouterOptions, RouterState } from './router';
+import { RegisteredRouter, Router, RouterOptions, RouterState } from './router';
 import { NoInfer } from './utils';
 import { MatchRouteOptions } from './Matches';
 import { RouteMatch } from './Matches';
@@ -20,7 +20,7 @@ export interface MatchLocation {
 }
 export type NavigateFn<TRouteTree extends AnyRoute> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TMaskFrom extends RoutePaths<TRouteTree> = TFrom, TMaskTo extends string = ''>(opts: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<void>;
 export type MatchRouteFn<TRouteTree extends AnyRoute> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string = '', TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<TRouteTree, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>['types']['allParams'];
-export type BuildLocationFn<TRouteTree extends AnyRoute> = (opts: BuildNextOptions) => ParsedLocation;
+export type BuildLocationFn<TRouteTree extends AnyRoute> = (opts: ToOptions<TRouteTree>) => ParsedLocation;
 export type InjectedHtmlEntry = string | (() => Promise<string> | string);
 export declare let 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;

package/build/types/route.d.ts

@@ -59,7 +59,7 @@ type BeforeLoadFn<TFullSearchSchema extends Record<string, any>, TParentRoute ex
     context: TParentRoute['types']['allContext'];
     location: ParsedLocation;
     navigate: NavigateFn<AnyRoute>;
-    buildLocation: BuildLocationFn<AnyRoute>;
+    buildLocation: BuildLocationFn<TParentRoute>;
     cause: 'preload' | 'enter' | 'stay';
 }) => Promise<TRouteContext> | TRouteContext | void;
 export type UpdatableRouteOptions<TFullSearchSchema extends Record<string, any>> = MetaOptions & {
@@ -134,25 +134,28 @@ export type RouteConstraints = {
     TChildren: unknown;
     TRouteTree: AnyRoute;
 };
-export declare class RouteApi<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>, TFullSearchSchema extends Record<string, any> = TRoute['types']['fullSearchSchema'], TAllParams extends AnyPathParams = TRoute['types']['allParams'], TAllContext extends Record<string, any> = TRoute['types']['allContext'], TLoaderData extends any = TRoute['types']['loaderData']> {
+export declare class RouteApi<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>, TFullSearchSchema extends Record<string, any> = TRoute['types']['fullSearchSchema'], TAllParams extends AnyPathParams = TRoute['types']['allParams'], TAllContext extends Record<string, any> = TRoute['types']['allContext'], TLoaderDeps extends Record<string, any> = TRoute['types']['loaderDeps'], TLoaderData extends any = TRoute['types']['loaderData']> {
     id: TId;
     constructor({ id }: {
         id: TId;
     });
     useMatch: <TSelected = TAllContext>(opts?: {
-        select?: ((search: TAllContext) => TSelected) | undefined;
+        select?: ((s: TAllContext) => TSelected) | undefined;
     } | undefined) => TSelected;
     useRouteContext: <TSelected = TAllContext>(opts?: {
-        select?: ((search: TAllContext) => TSelected) | undefined;
+        select?: ((s: TAllContext) => TSelected) | undefined;
     } | undefined) => TSelected;
     useSearch: <TSelected = TFullSearchSchema>(opts?: {
-        select?: ((search: TFullSearchSchema) => TSelected) | undefined;
+        select?: ((s: TFullSearchSchema) => TSelected) | undefined;
     } | undefined) => TSelected;
     useParams: <TSelected = TAllParams>(opts?: {
-        select?: ((search: TAllParams) => TSelected) | undefined;
+        select?: ((s: TAllParams) => TSelected) | undefined;
+    } | undefined) => TSelected;
+    useLoaderDeps: <TSelected = TLoaderDeps>(opts?: {
+        select?: ((s: TLoaderDeps) => TSelected) | undefined;
     } | undefined) => TSelected;
     useLoaderData: <TSelected = TLoaderData>(opts?: {
-        select?: ((search: TLoaderData) => TSelected) | undefined;
+        select?: ((s: TLoaderData) => TSelected) | undefined;
     } | undefined) => TSelected;
 }
 export declare class 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>, TSearchSchema extends RouteConstraints['TSearchSchema'] = {}, TFullSearchSchema extends RouteConstraints['TFullSearchSchema'] = ResolveFullSearchSchema<TParentRoute, TSearchSchema>, TParams extends RouteConstraints['TParams'] = Expand<Record<ParsePathParams<TPath>, string>>, TAllParams extends RouteConstraints['TAllParams'] = ResolveAllParams<TParentRoute, TParams>, TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext, TAllContext extends Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>> = Expand<Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>>, TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext, TLoaderDeps extends Record<string, any> = {}, TLoaderData extends any = unknown, TChildren extends RouteConstraints['TChildren'] = unknown, TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute> {
@@ -205,6 +208,9 @@ export declare class Route<TParentRoute extends RouteConstraints['TParentRoute']
     useParams: <TSelected = TAllParams>(opts?: {
         select?: ((search: TAllParams) => TSelected) | undefined;
     } | undefined) => TSelected;
+    useLoaderDeps: <TSelected = TLoaderDeps>(opts?: {
+        select?: ((s: TLoaderDeps) => TSelected) | undefined;
+    } | undefined) => TSelected;
     useLoaderData: <TSelected = TLoaderData>(opts?: {
         select?: ((search: TLoaderData) => TSelected) | undefined;
     } | undefined) => TSelected;

package/build/types/router.d.ts

@@ -9,6 +9,7 @@ import { AnyRouteMatch, RouteMatch } from './Matches';
 import { ParsedLocation } from './location';
 import { SearchSerializer, SearchParser } from './searchParams';
 import { BuildLocationFn, CommitLocationOptions, InjectedHtmlEntry, MatchRouteFn, NavigateFn } from './RouterProvider';
+import { ToOptions } from './link';
 declare global {
     interface Window {
         __TSR_DEHYDRATED__?: HydrationCtx;
@@ -169,7 +170,7 @@ export declare class Router<TRouteTree extends AnyRoute = AnyRoute, TDehydrated
     load: (opts?: {
         invalidate?: boolean;
     }) => Promise<void>;
-    preloadRoute: (navigateOpts?: BuildNextOptions) => Promise<RouteMatch<AnyRoute, any>[]>;
+    preloadRoute: (navigateOpts?: ToOptions<TRouteTree>) => Promise<RouteMatch<AnyRoute, any>[]>;
     matchRoute: MatchRouteFn<TRouteTree>;
     injectHtml: (html: string | (() => Promise<string> | string)) => Promise<void>;
     dehydrateData: <T>(key: any, getData: T | (() => T | Promise<T>)) => () => T | undefined;

package/build/umd/index.development.js

@@ -1071,6 +1071,14 @@
       }
     });
   }
+  function useLoaderDeps(opts) {
+    return useMatch({
+      ...opts,
+      select: s => {
+        return typeof opts.select === 'function' ? opts.select(s?.loaderDeps) : s?.loaderDeps;
+      }
+    });
+  }
   function useLoaderData(opts) {
     return useMatch({
       ...opts,
@@ -1497,6 +1505,12 @@
         from: this.id
       });
     };
+    useLoaderDeps = opts => {
+      return useLoaderDeps({
+        ...opts,
+        from: this.id
+      });
+    };
     useLoaderData = opts => {
       return useLoaderData({
         ...opts,
@@ -1583,6 +1597,12 @@
         from: this.id
       });
     };
+    useLoaderDeps = opts => {
+      return useLoaderDeps({
+        ...opts,
+        from: this.id
+      });
+    };
     useLoaderData = opts => {
       return useLoaderData({
         ...opts,
@@ -3328,6 +3348,7 @@
   exports.useLayoutEffect = useLayoutEffect$1;
   exports.useLinkProps = useLinkProps;
   exports.useLoaderData = useLoaderData;
+  exports.useLoaderDeps = useLoaderDeps;
   exports.useMatch = useMatch;
   exports.useMatchRoute = useMatchRoute;
   exports.useMatches = useMatches;