@tanstack/react-router 0.0.1-beta.214 → 0.0.1-beta.216

package/src/route.ts

@@ -1,7 +1,7 @@
 import { HistoryLocation } from '@tanstack/history'
 import * as React from 'react'
 import invariant from 'tiny-invariant'
-import { useMatch } from './Matches'
+import { useLoaderData, useMatch } from './Matches'
 import { AnyRouteMatch } from './RouterProvider'
 import { NavigateOptions, ParsePathParams, ToSubOptions } from './link'
 import { ParsedLocation } from './location'
@@ -63,6 +63,7 @@ export type RouteOptions<
   TAllParams extends AnyPathParams = TParams,
   TRouteContext extends RouteContext = RouteContext,
   TAllContext extends Record<string, any> = AnyContext,
+  TLoaderData extends any = unknown,
 > = BaseRouteOptions<
   TParentRoute,
   TCustomId,
@@ -72,9 +73,17 @@ export type RouteOptions<
   TParams,
   TAllParams,
   TRouteContext,
-  TAllContext
+  TAllContext,
+  TLoaderData
 > &
-  NoInfer<UpdatableRouteOptions<TFullSearchSchema, TAllParams, TAllContext>>
+  NoInfer<
+    UpdatableRouteOptions<
+      TFullSearchSchema,
+      TAllParams,
+      TAllContext,
+      TLoaderData
+    >
+  >
 
 export type ParamsFallback<
   TPath extends string,
@@ -95,9 +104,18 @@ export type BaseRouteOptions<
   TAllParams = ParamsFallback<TPath, TParams>,
   TRouteContext extends RouteContext = RouteContext,
   TAllContext extends Record<string, any> = AnyContext,
+  TLoaderData extends any = unknown,
 > = RoutePathOptions<TCustomId, TPath> & {
   getParentRoute: () => TParentRoute
   validateSearch?: SearchSchemaValidator<TSearchSchema>
+  shouldReload?: (
+    match: LoaderFnContext<
+      TAllParams,
+      TFullSearchSchema,
+      TAllContext,
+      TRouteContext
+    >,
+  ) => any
 } & (keyof PickRequired<RouteContext> extends never
     ? // This async function is called before a route is loaded.
       // If an error is thrown here, the route's loader will not be called.
@@ -119,11 +137,12 @@ export type BaseRouteOptions<
           TRouteContext
         >
       }) & {
-    load?: RouteLoadFn<
+    loader?: RouteLoadFn<
       TAllParams,
       TFullSearchSchema,
       NoInfer<TAllContext>,
-      NoInfer<TRouteContext>
+      NoInfer<TRouteContext>,
+      TLoaderData
     >
   } & (
     | {
@@ -163,6 +182,7 @@ export type UpdatableRouteOptions<
   TFullSearchSchema extends Record<string, any>,
   TAllParams extends AnyPathParams,
   TAllContext extends AnyContext,
+  TLoaderData extends any = unknown,
 > = MetaOptions & {
   // test?: (args: TAllContext) => void
   // If true, this route will be matched as case-sensitive
@@ -170,7 +190,12 @@ export type UpdatableRouteOptions<
   // If true, this route will be forcefully wrapped in a suspense boundary
   wrapInSuspense?: boolean
   // The content to be rendered when the route is matched. If no component is provided, defaults to `<Outlet />`
-  component?: RouteComponent<TFullSearchSchema, TAllParams, TAllContext>
+  component?: RouteComponent<
+    TFullSearchSchema,
+    TAllParams,
+    TAllContext,
+    TLoaderData
+  >
   // The content to be rendered when the route encounters an error
   errorComponent?: ErrorRouteComponent<
     TFullSearchSchema,
@@ -244,18 +269,17 @@ export type RouteLoadFn<
   TFullSearchSchema extends Record<string, any> = {},
   TAllContext extends Record<string, any> = AnyContext,
   TRouteContext extends Record<string, any> = AnyContext,
+  TLoaderData extends any = unknown,
 > = (
-  match: LoadFnContext<
+  match: LoaderFnContext<
     TAllParams,
     TFullSearchSchema,
     TAllContext,
     TRouteContext
-  > & {
-    parentMatchPromise?: Promise<void>
-  },
-) => any
+  >,
+) => Promise<TLoaderData> | TLoaderData
 
-export interface LoadFnContext<
+export interface LoaderFnContext<
   TAllParams = {},
   TFullSearchSchema extends Record<string, any> = {},
   TAllContext extends Record<string, any> = AnyContext,
@@ -268,6 +292,8 @@ export interface LoadFnContext<
   context: Expand<Assign<TAllContext, TRouteContext>>
   location: ParsedLocation<TFullSearchSchema>
   navigate: (opts: NavigateOptions<AnyRoute>) => Promise<void>
+  parentMatchPromise?: Promise<void>
+  cause: 'enter' | 'stay'
 }
 
 export type SearchFilter<T, U = T> = (prev: T) => U
@@ -378,6 +404,7 @@ export class Route<
     Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
   >,
   TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
+  TLoaderData extends any = unknown,
   TChildren extends RouteConstraints['TChildren'] = unknown,
   TRouteTree extends RouteConstraints['TRouteTree'] = AnyRoute,
 > {
@@ -391,7 +418,8 @@ export class Route<
     TParams,
     TAllParams,
     TRouteContext,
-    TAllContext
+    TAllContext,
+    TLoaderData
   >
 
   test!: Expand<
@@ -422,7 +450,8 @@ export class Route<
       TParams,
       TAllParams,
       TRouteContext,
-      TAllContext
+      TAllContext,
+      TLoaderData
     >,
   ) {
     this.options = (options as any) || {}
@@ -446,6 +475,7 @@ export class Route<
     children: TChildren
     routeTree: TRouteTree
     routerContext: TRouterContext
+    loaderData: TLoaderData
   }
 
   init = (opts: { originalIndex: number }) => {
@@ -460,7 +490,8 @@ export class Route<
       TParams,
       TAllParams,
       TRouteContext,
-      TAllContext
+      TAllContext,
+      TLoaderData
     > &
       RoutePathOptionsIntersection<TCustomId, TPath>
 
@@ -542,7 +573,8 @@ export class Route<
       TAllParams,
       Expand<
         Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
-      >
+      >,
+      TLoaderData
     >,
   ) => {
     Object.assign(this.options, options)
@@ -578,6 +610,11 @@ export class Route<
   }): TSelected => {
     return useParams({ ...opts, from: this.id } as any)
   }
+  useLoaderData = <TSelected = TLoaderData>(opts?: {
+    select?: (search: TLoaderData) => TSelected
+  }): TSelected => {
+    return useLoaderData({ ...opts, from: this.id } as any) as any
+  }
 }
 
 export type AnyRootRoute = RootRoute<any, any, any>
@@ -586,6 +623,7 @@ export function rootRouteWithContext<TRouterContext extends {}>() {
   return <
     TSearchSchema extends Record<string, any> = {},
     TRouteContext extends RouteContext = RouteContext,
+    TLoaderData extends any = unknown,
   >(
     options?: Omit<
       RouteOptions<
@@ -597,7 +635,8 @@ export function rootRouteWithContext<TRouterContext extends {}>() {
         {}, // TParams
         {}, // TAllParams
         TRouteContext, // TRouteContext
-        Assign<TRouterContext, TRouteContext> // TAllContext
+        Assign<TRouterContext, TRouteContext>, // TAllContext
+        TLoaderData // TLoaderData
       >,
       | 'path'
       | 'id'
@@ -615,6 +654,7 @@ export class RootRoute<
   TSearchSchema extends Record<string, any> = {},
   TRouteContext extends RouteContext = RouteContext,
   TRouterContext extends {} = {},
+  TLoaderData extends any = unknown,
 > extends Route<
   any, // TParentRoute
   '/', // TPath
@@ -628,6 +668,7 @@ export class RootRoute<
   TRouteContext, // TRouteContext
   Expand<Assign<TRouterContext, TRouteContext>>, // TAllContext
   TRouterContext, // TRouterContext
+  TLoaderData,
   any, // TChildren
   any // TRouteTree
 > {
@@ -642,7 +683,8 @@ export class RootRoute<
         {}, // TParams
         {}, // TAllParams
         TRouteContext, // TRouteContext
-        Assign<TRouterContext, TRouteContext> // TAllContext
+        Assign<TRouterContext, TRouteContext>, // TAllContext
+        TLoaderData
       >,
       | 'path'
       | 'id'
@@ -720,6 +762,7 @@ export type RouteProps<
   TFullSearchSchema extends Record<string, any> = AnySearchSchema,
   TAllParams extends AnyPathParams = AnyPathParams,
   TAllContext extends Record<string, any> = AnyContext,
+  TLoaderData extends any = unknown,
 > = {
   useMatch: <TSelected = TAllContext>(opts?: {
     select?: (search: TAllContext) => TSelected
@@ -733,6 +776,9 @@ export type RouteProps<
   useParams: <TSelected = TAllParams>(opts?: {
     select?: (search: TAllParams) => TSelected
   }) => TSelected
+  useLoaderData: <TSelected = TLoaderData>(opts?: {
+    select?: (search: TLoaderData) => TSelected
+  }) => TSelected
 }
 
 export type ErrorRouteProps<
@@ -765,7 +811,10 @@ export type RouteComponent<
   TFullSearchSchema extends Record<string, any>,
   TAllParams extends AnyPathParams,
   TAllContext extends Record<string, any>,
-> = AsyncRouteComponent<RouteProps<TFullSearchSchema, TAllParams, TAllContext>>
+  TLoaderData extends any = unknown,
+> = AsyncRouteComponent<
+  RouteProps<TFullSearchSchema, TAllParams, TAllContext, TLoaderData>
+>
 
 export type ErrorRouteComponent<
   TFullSearchSchema extends Record<string, any>,
@@ -783,4 +832,4 @@ export type PendingRouteComponent<
   PendingRouteProps<TFullSearchSchema, TAllParams, TAllContext>
 >
 
-export type AnyRouteComponent = RouteComponent<any, any, any>
+export type AnyRouteComponent = RouteComponent<any, any, any, any>

package/src/router.ts

@@ -36,7 +36,7 @@ export interface Register {
   // router: Router
 }
 
-export type AnyRouter = Router<any, any>
+export type AnyRouter = Router<AnyRoute, any>
 
 export type RegisteredRouter = Register extends {
   router: infer TRouter extends AnyRouter