@tanstack/react-router 1.1.9 → 1.1.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/react-router",
   "author": "Tanner Linsley",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -44,7 +44,7 @@
     "@tanstack/store": "^0.1.3",
     "tiny-invariant": "^1.3.1",
     "tiny-warning": "^1.0.3",
-    "@tanstack/history": "1.1.9"
+    "@tanstack/history": "1.1.11"
   },
   "scripts": {
     "build": "rollup --config rollup.config.js"

package/src/fileRoute.ts

@@ -56,12 +56,20 @@ export type RemoveUnderScores<T extends string> = Replace<
   '/'
 >
 
+type ReplaceFirstOccurrence<
+  T extends string,
+  Search extends string,
+  Replacement extends string,
+> = T extends `${infer Prefix}${Search}${infer Suffix}`
+  ? `${Prefix}${Replacement}${Suffix}`
+  : T
+
 export type ResolveFilePath<
   TParentRoute extends AnyRoute,
   TFilePath extends string,
 > = TParentRoute['id'] extends RootRouteId
   ? TrimPathLeft<TFilePath>
-  : Replace<
+  : ReplaceFirstOccurrence<
       TrimPathLeft<TFilePath>,
       TrimPathLeft<TParentRoute['types']['customId']>,
       ''
@@ -72,7 +80,9 @@ export type FileRoutePath<
   TFilePath extends string,
 > = ResolveFilePath<TParentRoute, TFilePath> extends `_${infer _}`
   ? string
-  : ResolveFilePath<TParentRoute, TFilePath>
+  : ResolveFilePath<TParentRoute, TFilePath> extends `/_${infer _}`
+    ? string
+    : ResolveFilePath<TParentRoute, TFilePath>
 
 export class FileRoute<
   TFilePath extends keyof FileRoutesByPath,
@@ -115,7 +125,13 @@ export class FileRoute<
       TParentRoute['types']['allParams'],
       TParams
     >,
-    TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
+    TRouteContextReturn extends
+      RouteConstraints['TRouteContext'] = RouteContext,
+    TRouteContext extends RouteConstraints['TRouteContext'] = [
+      TRouteContextReturn,
+    ] extends [never]
+      ? RouteContext
+      : TRouteContextReturn,
     TContext extends Expand<
       Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
     > = Expand<
@@ -139,6 +155,7 @@ export class FileRoute<
         TFullSearchSchema,
         TParams,
         TAllParams,
+        TRouteContextReturn,
         TRouteContext,
         TContext,
         TLoaderDeps,
@@ -160,6 +177,7 @@ export class FileRoute<
     TFullSearchSchema,
     TParams,
     TAllParams,
+    TRouteContextReturn,
     TRouteContext,
     TContext,
     TRouterContext,

package/src/link.tsx

@@ -2,7 +2,7 @@ import * as React from 'react'
 import { useMatch } from './Matches'
 import { useRouter, useRouterState } from './RouterProvider'
 import { Trim } from './fileRoute'
-import { AnyRoute, ReactNode } from './route'
+import { AnyRoute, ReactNode, RootSearchSchema } from './route'
 import {
   AllParams,
   FullSearchSchema,
@@ -171,7 +171,7 @@ type ParamVariant = 'PATH' | 'SEARCH'
 export type ParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
-  TTo,
+  TTo extends string,
   TResolved,
   TParamVariant extends ParamVariant,
   TFromRouteType extends
@@ -184,12 +184,13 @@ export type ParamOptions<
     | 'fullSearchSchemaInput' = TParamVariant extends 'PATH'
     ? 'allParams'
     : 'fullSearchSchemaInput',
-  TFromParams = Expand<RouteByPath<TRouteTree, TFrom>['types'][TFromRouteType]>,
-  TToParams = TTo extends ''
+  TFromParams = Expand<Exclude<RouteByPath<TRouteTree, TFrom>['types'][TFromRouteType], RootSearchSchema>>,
+  TToIndex = RouteByPath<TRouteTree, `${TTo}/`> extends never ? TTo : `${TTo}/`, 
+  TToParams = TToIndex extends ''
     ? TFromParams
     : never extends TResolved
-      ? Expand<RouteByPath<TRouteTree, TTo>['types'][TToRouteType]>
-      : Expand<RouteByPath<TRouteTree, TResolved>['types'][TToRouteType]>,
+      ? Expand<Exclude<RouteByPath<TRouteTree, TToIndex>['types'][TToRouteType], RootSearchSchema>>
+      : Expand<Exclude<RouteByPath<TRouteTree, TResolved>['types'][TToRouteType], RootSearchSchema>>,
   TReducer = ParamsReducer<TFromParams, TToParams>,
 > = Expand<WithoutEmpty<PickRequired<TToParams>>> extends never
   ? Partial<MakeParamOption<TParamVariant, true | TReducer>>
@@ -209,14 +210,14 @@ type MakePathParamOptions<T> = { params: T }
 export type SearchParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
-  TTo,
+  TTo extends string,
   TResolved,
 > = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'SEARCH'>
 
 export type PathParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
-  TTo,
+  TTo extends string,
   TResolved,
 > = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'PATH'>
 

package/src/route.ts

@@ -67,6 +67,7 @@ export type RouteOptions<
   TFullSearchSchema extends Record<string, any> = TSearchSchema,
   TParams extends AnyPathParams = AnyPathParams,
   TAllParams extends AnyPathParams = TParams,
+  TRouteContextReturn extends RouteContext = RouteContext,
   TRouteContext extends RouteContext = RouteContext,
   TAllContext extends Record<string, any> = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
@@ -82,6 +83,7 @@ export type RouteOptions<
   TFullSearchSchema,
   TParams,
   TAllParams,
+  TRouteContextReturn,
   TRouteContext,
   TAllContext,
   TLoaderDeps,
@@ -105,6 +107,7 @@ export type BaseRouteOptions<
   TFullSearchSchema extends Record<string, any> = TSearchSchema,
   TParams extends AnyPathParams = {},
   TAllParams = ParamsFallback<TPath, TParams>,
+  TRouteContextReturn extends RouteContext = RouteContext,
   TRouteContext extends RouteContext = RouteContext,
   TAllContext extends Record<string, any> = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
@@ -122,36 +125,27 @@ export type BaseRouteOptions<
           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.
-      // If thrown during a navigation, the navigation will be cancelled and the error will be passed to the `onError` function.
-      // If thrown during a preload event, the error will be logged to the console.
-      {
-        beforeLoad?: BeforeLoadFn<
-          TFullSearchSchema,
-          TParentRoute,
-          TAllParams,
-          TRouteContext
-        >
-      }
-    : {
-        beforeLoad: BeforeLoadFn<
-          TFullSearchSchema,
-          TParentRoute,
-          TAllParams,
-          TRouteContext
-        >
-      }) & {
-    loaderDeps?: (opts: { search: TFullSearchSchema }) => TLoaderDeps
-    loader?: RouteLoaderFn<
-      TAllParams,
-      NoInfer<TLoaderDeps>,
-      NoInfer<TAllContext>,
-      NoInfer<TRouteContext>,
-      TLoaderData
-    >
-  } & (
+} & {
+  // This async function is called before a route is loaded.
+  // If an error is thrown here, the route's loader will not be called.
+  // If thrown during a navigation, the navigation will be cancelled and the error will be passed to the `onError` function.
+  // If thrown during a preload event, the error will be logged to the console.
+  beforeLoad?: BeforeLoadFn<
+    TFullSearchSchema,
+    TParentRoute,
+    TAllParams,
+    TRouteContextReturn
+  >
+} & {
+  loaderDeps?: (opts: { search: TFullSearchSchema }) => TLoaderDeps
+  loader?: RouteLoaderFn<
+    TAllParams,
+    NoInfer<TLoaderDeps>,
+    NoInfer<TAllContext>,
+    NoInfer<TRouteContext>,
+    TLoaderData
+  >
+} & (
     | {
         // Both or none
         parseParams?: (
@@ -173,7 +167,7 @@ type BeforeLoadFn<
   TFullSearchSchema extends Record<string, any>,
   TParentRoute extends AnyRoute,
   TAllParams,
-  TRouteContext,
+  TRouteContextReturn extends RouteContext,
 > = (opts: {
   search: TFullSearchSchema
   abortController: AbortController
@@ -184,7 +178,7 @@ type BeforeLoadFn<
   navigate: NavigateFn<AnyRoute>
   buildLocation: BuildLocationFn<TParentRoute>
   cause: 'preload' | 'enter' | 'stay'
-}) => Promise<TRouteContext> | TRouteContext | void
+}) => Promise<TRouteContextReturn> | TRouteContextReturn | void
 
 export type UpdatableRouteOptions<
   TFullSearchSchema extends Record<string, any>,
@@ -309,11 +303,19 @@ export type InferFullSearchSchemaInput<TRoute> = TRoute extends {
   : {}
 
 export type ResolveFullSearchSchema<TParentRoute, TSearchSchema> = Expand<
-  Assign<InferFullSearchSchema<TParentRoute>, TSearchSchema>
+  Assign<
+    Omit<InferFullSearchSchema<TParentRoute>, keyof RootSearchSchema>,
+    TSearchSchema
+  >
 >
 
 export type ResolveFullSearchSchemaInput<TParentRoute, TSearchSchemaUsed> =
-  Expand<Assign<InferFullSearchSchemaInput<TParentRoute>, TSearchSchemaUsed>>
+  Expand<
+    Assign<
+      Omit<InferFullSearchSchemaInput<TParentRoute>, keyof RootSearchSchema>,
+      TSearchSchemaUsed
+    >
+  >
 
 export interface AnyRoute
   extends Route<
@@ -335,6 +337,7 @@ export interface AnyRoute
     any,
     any,
     any,
+    any,
     any
   > {}
 
@@ -463,7 +466,12 @@ export class Route<
     TParentRoute,
     TParams
   >,
-  TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
+  TRouteContextReturn extends RouteConstraints['TRouteContext'] = RouteContext,
+  TRouteContext extends RouteConstraints['TRouteContext'] = [
+    TRouteContextReturn,
+  ] extends [never]
+    ? RouteContext
+    : TRouteContextReturn,
   TAllContext extends Expand<
     Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
   > = Expand<
@@ -487,6 +495,7 @@ export class Route<
     TFullSearchSchema,
     TParams,
     TAllParams,
+    TRouteContextReturn,
     TRouteContext,
     TAllContext,
     TLoaderDeps,
@@ -523,6 +532,7 @@ export class Route<
       TFullSearchSchema,
       TParams,
       TAllParams,
+      TRouteContextReturn,
       TRouteContext,
       TAllContext,
       TLoaderDeps,
@@ -575,6 +585,7 @@ export class Route<
       TFullSearchSchema,
       TParams,
       TAllParams,
+      TRouteContextReturn,
       TRouteContext,
       TAllContext,
       TLoaderDeps,
@@ -647,6 +658,7 @@ export class Route<
     TFullSearchSchema,
     TParams,
     TAllParams,
+    TRouteContextReturn,
     TRouteContext,
     TAllContext,
     TRouterContext,
@@ -682,6 +694,7 @@ export class Route<
       TFullSearchSchema,
       TParams,
       TAllParams,
+      TRouteContextReturn,
       TRouteContext,
       TAllContext,
       TRouterContext,
@@ -738,13 +751,14 @@ export class Route<
   }
 }
 
-export type AnyRootRoute = RootRoute<any, any, any, any, any, any, any>
+export type AnyRootRoute = RootRoute<any, any, any, any, any, any, any, any>
 
 export function rootRouteWithContext<TRouterContext extends {}>() {
   return <
-    TSearchSchemaInput extends Record<string, any> = {},
-    TSearchSchema extends Record<string, any> = {},
-    TSearchSchemaUsed extends Record<string, any> = {},
+    TSearchSchemaInput extends Record<string, any> = RootSearchSchema,
+    TSearchSchema extends Record<string, any> = RootSearchSchema,
+    TSearchSchemaUsed extends Record<string, any> = RootSearchSchema,
+    TRouteContextReturn extends RouteContext = RouteContext,
     TRouteContext extends RouteContext = RouteContext,
     TLoaderDeps extends Record<string, any> = {},
     TLoaderData extends any = unknown,
@@ -761,6 +775,7 @@ export function rootRouteWithContext<TRouterContext extends {}>() {
         TSearchSchema, // TFullSearchSchema
         {}, // TParams
         {}, // TAllParams
+        TRouteContextReturn, // TRouteContextReturn
         TRouteContext, // TRouteContext
         Assign<TRouterContext, TRouteContext>, // TAllContext
         TLoaderDeps,
@@ -777,6 +792,7 @@ export function rootRouteWithContext<TRouterContext extends {}>() {
     TSearchSchemaInput,
     TSearchSchema,
     TSearchSchemaUsed,
+    TRouteContextReturn,
     TRouteContext,
     TRouterContext
   > => {
@@ -784,10 +800,15 @@ export function rootRouteWithContext<TRouterContext extends {}>() {
   }
 }
 
+export type RootSearchSchema = {
+  __TRootSearchSchema__: '__TRootSearchSchema__'
+}
+
 export class RootRoute<
-  TSearchSchemaInput extends Record<string, any> = {},
-  TSearchSchema extends Record<string, any> = {},
-  TSearchSchemaUsed extends Record<string, any> = {},
+  TSearchSchemaInput extends Record<string, any> = RootSearchSchema,
+  TSearchSchema extends Record<string, any> = RootSearchSchema,
+  TSearchSchemaUsed extends Record<string, any> = RootSearchSchema,
+  TRouteContextReturn extends RouteContext = RouteContext,
   TRouteContext extends RouteContext = RouteContext,
   TRouterContext extends {} = {},
   TLoaderDeps extends Record<string, any> = {},
@@ -805,6 +826,7 @@ export class RootRoute<
   TSearchSchema, // TFullSearchSchema
   {}, // TParams
   {}, // TAllParams
+  TRouteContextReturn, // TRouteContextReturn
   TRouteContext, // TRouteContext
   Expand<Assign<TRouterContext, TRouteContext>>, // TAllContext
   TRouterContext, // TRouterContext
@@ -826,6 +848,7 @@ export class RootRoute<
         TSearchSchema, // TFullSearchSchema
         {}, // TParams
         {}, // TAllParams
+        TRouteContextReturn, // TRouteContextReturn
         TRouteContext, // TRouteContext
         Assign<TRouterContext, TRouteContext>, // TAllContext
         TLoaderDeps,
@@ -945,6 +968,7 @@ export class NotFoundRoute<
   > = Expand<
     Assign<IsAny<TParentRoute['types']['allContext'], {}>, TRouteContext>
   >,
+  TRouteContextReturn extends RouteConstraints['TRouterContext'] = AnyContext,
   TRouterContext extends RouteConstraints['TRouterContext'] = AnyContext,
   TLoaderDeps extends Record<string, any> = {},
   TLoaderData extends any = unknown,
@@ -963,6 +987,7 @@ export class NotFoundRoute<
   TFullSearchSchema,
   {},
   {},
+  TRouteContextReturn,
   TRouteContext,
   TAllContext,
   TRouterContext,
@@ -984,6 +1009,7 @@ export class NotFoundRoute<
         TFullSearchSchema,
         {},
         {},
+        TRouteContextReturn,
         TRouteContext,
         TAllContext,
         TLoaderDeps,

package/src/routeInfo.ts

@@ -24,6 +24,7 @@ export type ParseRouteChildren<TRouteTree extends AnyRoute> =
     any,
     any,
     any,
+    any,
     infer TChildren,
     any
   >