@tanstack/react-router 1.39.6 → 1.39.8

package/src/fileRoute.ts

@@ -13,6 +13,7 @@ import type {
   AnyRoute,
   AnySearchSchema,
   FileBaseRouteOptions,
+  InferAllContext,
   ResolveAllContext,
   ResolveAllParamsFromParent,
   ResolveFullSearchSchema,
@@ -92,14 +93,12 @@ export class FileRoute<
     TRouteContextReturn = RouteContext,
     TRouteContext = ResolveRouteContext<TRouteContextReturn>,
     TAllContext = ResolveAllContext<TParentRoute, TRouteContext>,
-    TRouterContext = AnyContext,
     TLoaderDeps extends Record<string, any> = {},
     TLoaderDataReturn = {},
     TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
     TChildren = unknown,
   >(
     options?: FileBaseRouteOptions<
-      TParentRoute,
       TPath,
       TSearchSchemaInput,
       TSearchSchema,
@@ -107,8 +106,7 @@ export class FileRoute<
       TParams,
       TAllParams,
       TRouteContextReturn,
-      TRouteContext,
-      TRouterContext,
+      InferAllContext<TParentRoute>,
       TAllContext,
       TLoaderDeps,
       TLoaderDataReturn
@@ -138,7 +136,6 @@ export class FileRoute<
     TRouteContextReturn,
     TRouteContext,
     TAllContext,
-    TRouterContext,
     TLoaderDeps,
     TLoaderDataReturn,
     TLoaderData,
@@ -169,14 +166,12 @@ export function FileRouteLoader<
     TRoute['types']['allParams'],
     TRoute['types']['loaderDeps'],
     TRoute['types']['allContext'],
-    TRoute['types']['routeContext'],
     TLoaderData
   >,
 ) => RouteLoaderFn<
   TRoute['types']['allParams'],
   TRoute['types']['loaderDeps'],
   TRoute['types']['allContext'],
-  TRoute['types']['routeContext'],
   NoInfer<TLoaderData>
 > {
   warning(

package/src/path.ts

@@ -205,21 +205,33 @@ export function interpolatePath({
   leaveParams,
 }: InterpolatePathOptions) {
   const interpolatedPathSegments = parsePathname(path)
+  const encodedParams: any = {}
+
+  for (const [key, value] of Object.entries(params)) {
+    const isValueString = typeof value === 'string'
+
+    if (['*', '_splat'].includes(key)) {
+      // the splat/catch-all routes shouldn't have the '/' encoded out
+      encodedParams[key] = isValueString ? encodeURI(value) : value
+    } else {
+      encodedParams[key] = isValueString ? encodeURIComponent(value) : value
+    }
+  }
 
   return joinPaths(
     interpolatedPathSegments.map((segment) => {
       if (segment.type === 'wildcard') {
-        const value = params._splat
+        const value = encodedParams._splat
         if (leaveWildcards) return `${segment.value}${value ?? ''}`
         return value
       }
 
       if (segment.type === 'param') {
         if (leaveParams) {
-          const value = params[segment.value]
+          const value = encodedParams[segment.value]
           return `${segment.value}${value ?? ''}`
         }
-        return params![segment.value.substring(1)] ?? 'undefined'
+        return encodedParams![segment.value.substring(1)] ?? 'undefined'
       }
 
       return segment.value

package/src/route.ts

@@ -61,7 +61,7 @@ export type RouteOptions<
   TAllParams = TParams,
   TRouteContextReturn = RouteContext,
   TRouteContext = RouteContext,
-  TRouterContext = AnyContext,
+  TParentAllContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
@@ -76,8 +76,7 @@ export type RouteOptions<
   TParams,
   TAllParams,
   TRouteContextReturn,
-  TRouteContext,
-  TRouterContext,
+  TParentAllContext,
   TAllContext,
   TLoaderDeps,
   TLoaderDataReturn
@@ -98,7 +97,6 @@ export type ParamsFallback<
 > = unknown extends TParams ? Record<ParsePathParams<TPath>, string> : TParams
 
 export type FileBaseRouteOptions<
-  TParentRoute extends AnyRoute = AnyRoute,
   TPath extends string = string,
   TSearchSchemaInput = Record<string, unknown>,
   TSearchSchema = {},
@@ -106,8 +104,7 @@ export type FileBaseRouteOptions<
   TParams = {},
   TAllParams = ParamsFallback<TPath, TParams>,
   TRouteContextReturn = RouteContext,
-  TRouteContext = RouteContext,
-  TRouterContext = AnyContext,
+  TParentAllContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
@@ -116,12 +113,7 @@ export type FileBaseRouteOptions<
   shouldReload?:
     | boolean
     | ((
-        match: LoaderFnContext<
-          TAllParams,
-          TFullSearchSchema,
-          TAllContext,
-          TRouteContext
-        >,
+        match: LoaderFnContext<TAllParams, TFullSearchSchema, TAllContext>,
       ) => any)
   // This async function is called before a route is loaded.
   // If an error is thrown here, the route's loader will not be called.
@@ -129,17 +121,15 @@ export type FileBaseRouteOptions<
   // If thrown during a preload event, the error will be logged to the console.
   beforeLoad?: BeforeLoadFn<
     TFullSearchSchema,
-    TParentRoute,
     TAllParams,
     TRouteContextReturn,
-    TRouterContext
+    TParentAllContext
   >
   loaderDeps?: (opts: { search: TFullSearchSchema }) => TLoaderDeps
   loader?: RouteLoaderFn<
     TAllParams,
     NoInfer<TLoaderDeps>,
     NoInfer<TAllContext>,
-    NoInfer<TRouteContext>,
     TLoaderDataReturn
   >
 } & (
@@ -170,14 +160,12 @@ export type BaseRouteOptions<
   TParams = {},
   TAllParams = ParamsFallback<TPath, TParams>,
   TRouteContextReturn = RouteContext,
-  TRouteContext = RouteContext,
-  TRouterContext = AnyContext,
+  TParentAllContext = AnyContext,
   TAllContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
 > = RoutePathOptions<TCustomId, TPath> &
   FileBaseRouteOptions<
-    TParentRoute,
     TPath,
     TSearchSchemaInput,
     TSearchSchema,
@@ -185,8 +173,7 @@ export type BaseRouteOptions<
     TParams,
     TAllParams,
     TRouteContextReturn,
-    TRouteContext,
-    TRouterContext,
+    TParentAllContext,
     TAllContext,
     TLoaderDeps,
     TLoaderDataReturn
@@ -196,23 +183,21 @@ export type BaseRouteOptions<
 
 type BeforeLoadFn<
   in out TFullSearchSchema,
-  in out TParentRoute extends AnyRoute,
   in out TAllParams,
   TRouteContextReturn,
-  in out TRouterContext = AnyContext,
-  in out TContext = IsAny<TParentRoute['types']['allContext'], TRouterContext>,
+  in out TParentAllContext,
 > = (opts: {
   search: TFullSearchSchema
   abortController: AbortController
   preload: boolean
   params: TAllParams
-  context: TContext
+  context: TParentAllContext
   location: ParsedLocation
   /**
    * @deprecated Use `throw redirect({ to: '/somewhere' })` instead
    **/
   navigate: NavigateFn
-  buildLocation: BuildLocationFn<TParentRoute>
+  buildLocation: BuildLocationFn
   cause: 'preload' | 'enter' | 'stay'
 }) => Promise<TRouteContextReturn> | TRouteContextReturn | void
 
@@ -333,23 +318,21 @@ export type RouteLoaderFn<
   in out TAllParams = {},
   in out TLoaderDeps extends Record<string, any> = {},
   in out TAllContext = AnyContext,
-  in out TRouteContext = AnyContext,
   TLoaderData = undefined,
 > = (
-  match: LoaderFnContext<TAllParams, TLoaderDeps, TAllContext, TRouteContext>,
+  match: LoaderFnContext<TAllParams, TLoaderDeps, TAllContext>,
 ) => Promise<TLoaderData> | TLoaderData
 
 export interface LoaderFnContext<
   in out TAllParams = {},
   in out TLoaderDeps = {},
   in out TAllContext = AnyContext,
-  in out TRouteContext = AnyContext,
 > {
   abortController: AbortController
   preload: boolean
   params: TAllParams
   deps: TLoaderDeps
-  context: Assign<TAllContext, TRouteContext>
+  context: TAllContext
   location: ParsedLocation // Do not supply search schema here so as to demotivate people from trying to shortcut loaderDeps
   /**
    * @deprecated Use `throw redirect({ to: '/somewhere' })` instead
@@ -386,6 +369,22 @@ export type InferFullSearchSchemaInput<TRoute> = TRoute extends {
   ? TFullSearchSchemaInput
   : {}
 
+export type InferAllParams<TRoute> = TRoute extends {
+  types: {
+    allParams: infer TAllParams
+  }
+}
+  ? TAllParams
+  : {}
+
+export type InferAllContext<TRoute> = TRoute extends {
+  types: {
+    allContext: infer TAllContext
+  }
+}
+  ? TAllContext
+  : {}
+
 export type ResolveSearchSchemaUsed<TSearchSchemaInput, TSearchSchema> =
   TSearchSchemaInput extends SearchSchemaInput
     ? Omit<TSearchSchemaInput, keyof SearchSchemaInput>
@@ -394,16 +393,12 @@ export type ResolveSearchSchemaUsed<TSearchSchemaInput, TSearchSchema> =
 export type ResolveFullSearchSchema<
   TParentRoute extends AnyRoute,
   TSearchSchema,
-> = unknown extends TParentRoute
-  ? TSearchSchema
-  : Assign<TParentRoute['types']['fullSearchSchema'], TSearchSchema>
+> = Assign<InferFullSearchSchema<TParentRoute>, TSearchSchema>
 
 export type ResolveFullSearchSchemaInput<
   TParentRoute extends AnyRoute,
   TSearchSchemaUsed,
-> = unknown extends TParentRoute
-  ? TSearchSchemaUsed
-  : Assign<TParentRoute['types']['fullSearchSchemaInput'], TSearchSchemaUsed>
+> = Assign<InferFullSearchSchemaInput<TParentRoute>, TSearchSchemaUsed>
 
 export type ResolveRouteContext<TRouteContextReturn> = [
   TRouteContextReturn,
@@ -414,7 +409,7 @@ export type ResolveRouteContext<TRouteContextReturn> = [
 export type ResolveAllContext<
   TParentRoute extends AnyRoute,
   TRouteContext,
-> = Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
+> = Assign<InferAllContext<TParentRoute>, TRouteContext>
 
 export type ResolveLoaderData<TLoaderDataReturn> = [TLoaderDataReturn] extends [
   never,
@@ -442,16 +437,13 @@ export interface AnyRoute
     any,
     any,
     any,
-    any,
     any
   > {}
 
 export type ResolveAllParamsFromParent<
   TParentRoute extends AnyRoute,
   TParams,
-> = unknown extends TParentRoute
-  ? TParams
-  : Assign<TParentRoute['types']['allParams'], TParams>
+> = Assign<InferAllParams<TParentRoute>, TParams>
 
 export type RouteConstraints = {
   TParentRoute: AnyRoute
@@ -595,11 +587,7 @@ export class Route<
   in out TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>,
   TRouteContextReturn = RouteContext,
   in out TRouteContext = ResolveRouteContext<TRouteContextReturn>,
-  in out TAllContext = Assign<
-    IsAny<TParentRoute['types']['allContext'], {}>,
-    TRouteContext
-  >,
-  in out TRouterContext = AnyContext,
+  in out TAllContext = ResolveAllContext<TParentRoute, TRouteContext>,
   in out TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
   in out TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
@@ -617,7 +605,7 @@ export class Route<
     TAllParams,
     TRouteContextReturn,
     TRouteContext,
-    TRouterContext,
+    InferAllContext<TParentRoute>,
     TAllContext,
     TLoaderDeps,
     TLoaderDataReturn,
@@ -654,7 +642,7 @@ export class Route<
       TAllParams,
       TRouteContextReturn,
       TRouteContext,
-      TRouterContext,
+      InferAllContext<TParentRoute>,
       TAllContext,
       TLoaderDeps,
       TLoaderDataReturn,
@@ -688,7 +676,6 @@ export class Route<
     routeContext: TRouteContext
     allContext: TAllContext
     children: TChildren
-    routerContext: TRouterContext
     loaderData: TLoaderData
     loaderDeps: TLoaderDeps
   }
@@ -708,7 +695,7 @@ export class Route<
           TAllParams,
           TRouteContextReturn,
           TRouteContext,
-          TRouterContext,
+          InferAllContext<TParentRoute>,
           TAllContext,
           TLoaderDeps,
           TLoaderDataReturn,
@@ -788,7 +775,6 @@ export class Route<
     TRouteContextReturn,
     TRouteContext,
     TAllContext,
-    TRouterContext,
     TLoaderDeps,
     TLoaderDataReturn,
     TLoaderData,
@@ -801,13 +787,7 @@ export class Route<
   }
 
   updateLoader = <TNewLoaderData = unknown>(options: {
-    loader: RouteLoaderFn<
-      TAllParams,
-      TLoaderDeps,
-      TAllContext,
-      TRouteContext,
-      TNewLoaderData
-    >
+    loader: RouteLoaderFn<TAllParams, TLoaderDeps, TAllContext, TNewLoaderData>
   }) => {
     Object.assign(this.options, options)
     return this as unknown as Route<
@@ -826,7 +806,6 @@ export class Route<
       TRouteContextReturn,
       TRouteContext,
       TAllContext,
-      TRouterContext,
       TLoaderDeps,
       TNewLoaderData,
       TChildren
@@ -931,11 +910,7 @@ export function createRoute<
   TAllParams = ResolveAllParamsFromParent<TParentRoute, TParams>,
   TRouteContextReturn = RouteContext,
   TRouteContext = ResolveRouteContext<TRouteContextReturn>,
-  TAllContext = Assign<
-    IsAny<TParentRoute['types']['allContext'], {}>,
-    TRouteContext
-  >,
-  TRouterContext = AnyContext,
+  TAllContext = ResolveAllContext<TParentRoute, TRouteContext>,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
   TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
@@ -952,7 +927,7 @@ export function createRoute<
     TAllParams,
     TRouteContextReturn,
     TRouteContext,
-    TRouterContext,
+    InferAllContext<TParentRoute>,
     TAllContext,
     TLoaderDeps,
     TLoaderDataReturn,
@@ -975,7 +950,6 @@ export function createRoute<
     TRouteContextReturn,
     TRouteContext,
     TAllContext,
-    TRouterContext,
     TLoaderDeps,
     TLoaderDataReturn,
     TLoaderData,
@@ -1006,7 +980,7 @@ export type RootRouteOptions<
     {}, // TAllParams
     TRouteContextReturn, // TRouteContextReturn
     TRouteContext, // TRouteContext
-    TRouterContext,
+    TRouterContext, // TParentAllContext
     Assign<TRouterContext, TRouteContext>, // TAllContext
     TLoaderDeps,
     TLoaderDataReturn, // TLoaderDataReturn,
@@ -1090,7 +1064,6 @@ export class RootRoute<
   TRouteContextReturn, // TRouteContextReturn
   TRouteContext, // TRouteContext
   Assign<TRouterContext, TRouteContext>, // TAllContext
-  TRouterContext, // TRouterContext
   TLoaderDeps,
   TLoaderDataReturn,
   TLoaderData,
@@ -1277,7 +1250,6 @@ export class NotFoundRoute<
   TRouteContextReturn = AnyContext,
   TRouteContext = RouteContext,
   TAllContext = ResolveAllContext<TParentRoute, TRouteContext>,
-  TRouterContext = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderDataReturn = {},
   TLoaderData = ResolveLoaderData<TLoaderDataReturn>,
@@ -1298,7 +1270,6 @@ export class NotFoundRoute<
   TRouteContextReturn,
   TRouteContext,
   TAllContext,
-  TRouterContext,
   TLoaderDeps,
   TLoaderDataReturn,
   TLoaderData,
@@ -1317,7 +1288,7 @@ export class NotFoundRoute<
         {},
         TRouteContextReturn,
         TRouteContext,
-        TRouterContext,
+        InferAllContext<TParentRoute>,
         TAllContext,
         TLoaderDeps,
         TLoaderDataReturn,

package/src/router.ts

@@ -43,6 +43,7 @@ import type {
   ErrorRouteComponent,
   LoaderFnContext,
   NotFoundRouteComponent,
+  RootRoute,
   RouteMask,
 } from './route'
 import type {
@@ -109,13 +110,28 @@ export type HydrationCtx = {
   payload: Record<string, any>
 }
 
+export type InferRouterContext<TRouteTree extends AnyRoute> =
+  TRouteTree extends RootRoute<
+    any,
+    any,
+    any,
+    any,
+    any,
+    infer TRouterContext extends AnyContext,
+    any,
+    any,
+    any
+  >
+    ? TRouterContext
+    : AnyContext
+
 export type RouterContextOptions<TRouteTree extends AnyRoute> =
-  AnyContext extends TRouteTree['types']['routerContext']
+  AnyContext extends InferRouterContext<TRouteTree>
     ? {
-        context?: TRouteTree['types']['routerContext']
+        context?: InferRouterContext<TRouteTree>
       }
     : {
-        context: TRouteTree['types']['routerContext']
+        context: InferRouterContext<TRouteTree>
       }
 
 export type TrailingSlashOption = 'always' | 'never' | 'preserve'
@@ -261,7 +277,7 @@ export interface RouterOptions<
    * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#context-property)
    * @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/router-context)
    */
-  context?: TRouteTree['types']['routerContext']
+  context?: InferRouterContext<TRouteTree>
   /**
    * A function that will be called when the router is dehydrated.
    * The return value of this function will be serialized and stored in the router's dehydrated state.
@@ -1094,7 +1110,7 @@ export class Router<
     })
   }
 
-  buildLocation: BuildLocationFn<TRouteTree> = (opts) => {
+  buildLocation: BuildLocationFn = (opts) => {
     const build = (
       dest: BuildNextOptions & {
         unmaskOnReload?: boolean
@@ -1170,16 +1186,6 @@ export class Router<
           })
       }
 
-      // encode all path params so the generated href is valid and stable
-      Object.keys(nextParams).forEach((key) => {
-        if (['*', '_splat'].includes(key)) {
-          // the splat/catch-all routes shouldn't have the '/' encoded out
-          nextParams[key] = encodeURI(nextParams[key])
-        } else {
-          nextParams[key] = encodeURIComponent(nextParams[key])
-        }
-      })
-
       pathname = interpolatePath({
         path: pathname,
         params: nextParams ?? {},