@tanstack/react-router 1.8.3 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-router",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/Matches.tsx

@@ -7,6 +7,8 @@ import { useRouter } from './useRouter'
 import { ResolveRelativePath, ToOptions } from './link'
 import { AnyRoute, ReactNode, RootSearchSchema } from './route'
 import {
+  AllParams,
+  FullSearchSchema,
   ParseRoute,
   RouteById,
   RouteByPath,
@@ -14,18 +16,21 @@ import {
   RoutePaths,
 } from './routeInfo'
 import { RegisteredRouter, RouterState } from './router'
-import { DeepOptional, NoInfer, StrictOrFrom, pick } from './utils'
+import { DeepOptional, Expand, NoInfer, StrictOrFrom, pick } from './utils'
 
 export const matchContext = React.createContext<string | undefined>(undefined)
 
 export interface RouteMatch<
-  TRouteTree extends AnyRoute = AnyRoute,
+  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id'],
+  TReturnIntersection extends boolean = false,
 > {
   id: string
   routeId: TRouteId
   pathname: string
-  params: RouteById<TRouteTree, TRouteId>['types']['allParams']
+  params: TReturnIntersection extends false
+    ? RouteById<TRouteTree, TRouteId>['types']['allParams']
+    : Expand<Partial<AllParams<TRouteTree>>>
   status: 'pending' | 'success' | 'error'
   isFetching: boolean
   showPending: boolean
@@ -37,10 +42,14 @@ export interface RouteMatch<
   loaderData?: RouteById<TRouteTree, TRouteId>['types']['loaderData']
   routeContext: RouteById<TRouteTree, TRouteId>['types']['routeContext']
   context: RouteById<TRouteTree, TRouteId>['types']['allContext']
-  search: Exclude<
-    RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'],
-    RootSearchSchema
-  >
+  search: TReturnIntersection extends false
+    ? Exclude<
+        RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'],
+        RootSearchSchema
+      >
+    : Expand<
+        Partial<Omit<FullSearchSchema<TRouteTree>, keyof RootSearchSchema>>
+      >
   fetchCount: number
   abortController: AbortController
   cause: 'preload' | 'enter' | 'stay'
@@ -298,7 +307,9 @@ export function MatchRoute<
   return !!params ? props.children : null
 }
 
-export function getRenderedMatches(state: RouterState) {
+export function getRenderedMatches<
+  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+>(state: RouterState<TRouteTree>) {
   return state.pendingMatches?.some((d) => d.showPending)
     ? state.pendingMatches
     : state.matches
@@ -307,10 +318,11 @@ export function getRenderedMatches(state: RouterState) {
 export function useMatch<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>,
-  TRouteMatchState = RouteMatch<TRouteTree, TFrom>,
+  TReturnIntersection extends boolean = false,
+  TRouteMatchState = RouteMatch<TRouteTree, TFrom, TReturnIntersection>,
   TSelected = TRouteMatchState,
 >(
-  opts: StrictOrFrom<TFrom> & {
+  opts: StrictOrFrom<TFrom, TReturnIntersection> & {
     select?: (match: TRouteMatchState) => TSelected
   },
 ): TSelected {
@@ -364,26 +376,44 @@ export function useMatch<
   return matchSelection as any
 }
 
-export function useMatches<T = RouteMatch[]>(opts?: {
-  select?: (matches: RouteMatch[]) => T
+export function useMatches<
+  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+  TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id'],
+  TReturnIntersection extends boolean = false,
+  TRouteMatch = RouteMatch<TRouteTree, TRouteId, TReturnIntersection>,
+  T = TRouteMatch[],
+>(opts?: {
+  select?: (matches: TRouteMatch[]) => T
+  experimental_returnIntersection?: TReturnIntersection
 }): T {
   return useRouterState({
     select: (state) => {
-      let matches = getRenderedMatches(state)
-      return opts?.select ? opts.select(matches) : (matches as T)
+      const matches = getRenderedMatches(state)
+      return opts?.select
+        ? opts.select(matches as TRouteMatch[])
+        : (matches as T)
     },
   })
 }
 
-export function useParentMatches<T = RouteMatch[]>(opts?: {
-  select?: (matches: RouteMatch[]) => T
+export function useParentMatches<
+  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
+  TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id'],
+  TReturnIntersection extends boolean = false,
+  TRouteMatch = RouteMatch<TRouteTree, TRouteId, TReturnIntersection>,
+  T = TRouteMatch[],
+>(opts?: {
+  select?: (matches: TRouteMatch[]) => T
+  experimental_returnIntersection?: TReturnIntersection
 }): T {
   const contextMatchId = React.useContext(matchContext)
 
   return useMatches({
     select: (matches) => {
       matches = matches.slice(matches.findIndex((d) => d.id === contextMatchId))
-      return opts?.select ? opts.select(matches) : (matches as T)
+      return opts?.select
+        ? opts.select(matches as TRouteMatch[])
+        : (matches as T)
     },
   })
 }

package/src/RouterProvider.tsx

@@ -88,8 +88,8 @@ export function RouterProvider<
 }
 
 function Transitioner() {
-  const mountLoadCount = React.useRef(0)
   const router = useRouter()
+  const mountLoadForRouter = React.useRef({ router, mounted: false })
   const routerState = useRouterState({
     select: (s) =>
       pick(s, ['isLoading', 'location', 'resolvedLocation', 'isTransitioning']),
@@ -192,11 +192,16 @@ function Transitioner() {
   ])
 
   useLayoutEffect(() => {
-    if (!window.__TSR_DEHYDRATED__ && !mountLoadCount.current) {
-      mountLoadCount.current++
-      tryLoad()
+    if (window.__TSR_DEHYDRATED__) return
+    if (
+      mountLoadForRouter.current.router === router &&
+      mountLoadForRouter.current.mounted
+    ) {
+      return
     }
-  }, [])
+    mountLoadForRouter.current = { router, mounted: true }
+    tryLoad()
+  }, [router])
 
   return null
 }

package/src/route.ts

@@ -236,15 +236,6 @@ export type SearchSchemaValidatorFn<TInput, TReturn> = (
   searchObj: TInput,
 ) => TReturn
 
-export type DefinedPathParamWarning =
-  'Path params cannot be redefined by child routes!'
-
-export type ParentParams<TParentParams> = AnyPathParams extends TParentParams
-  ? {}
-  : {
-      [Key in keyof TParentParams]?: DefinedPathParamWarning
-    }
-
 export type RouteLoaderFn<
   TAllParams = {},
   TLoaderDeps extends Record<string, any> = {},

package/src/useParams.tsx

@@ -1,7 +1,7 @@
 import { AnyRoute } from './route'
-import { RouteIds, RouteById } from './routeInfo'
+import { RouteIds, RouteById, AllParams } from './routeInfo'
 import { RegisteredRouter } from './router'
-import { last } from './utils'
+import { Expand, last } from './utils'
 import { useRouterState } from './useRouterState'
 import { StrictOrFrom } from './utils'
 import { getRenderedMatches } from './Matches'
@@ -9,10 +9,13 @@ import { getRenderedMatches } from './Matches'
 export function useParams<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>,
-  TParams = RouteById<TRouteTree, TFrom>['types']['allParams'],
+  TReturnIntersection extends boolean = false,
+  TParams = TReturnIntersection extends false
+    ? RouteById<TRouteTree, TFrom>['types']['allParams']
+    : Expand<Partial<AllParams<TRouteTree>>>,
   TSelected = TParams,
 >(
-  opts: StrictOrFrom<TFrom> & {
+  opts: StrictOrFrom<TFrom, TReturnIntersection> & {
     select?: (params: TParams) => TSelected
   },
 ): TSelected {

package/src/useSearch.tsx

@@ -1,20 +1,25 @@
 import { AnyRoute, RootSearchSchema } from './route'
-import { RouteIds, RouteById } from './routeInfo'
+import { RouteIds, RouteById, FullSearchSchema } from './routeInfo'
 import { RegisteredRouter } from './router'
 import { RouteMatch } from './Matches'
 import { useMatch } from './Matches'
-import { StrictOrFrom } from './utils'
+import { Expand, StrictOrFrom } from './utils'
 
 export function useSearch<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>,
-  TSearch = Exclude<
-    RouteById<TRouteTree, TFrom>['types']['fullSearchSchema'],
-    RootSearchSchema
-  >,
+  TReturnIntersection extends boolean = false,
+  TSearch = TReturnIntersection extends false
+    ? Exclude<
+        RouteById<TRouteTree, TFrom>['types']['fullSearchSchema'],
+        RootSearchSchema
+      >
+    : Expand<
+        Partial<Omit<FullSearchSchema<TRouteTree>, keyof RootSearchSchema>>
+      >,
   TSelected = TSearch,
 >(
-  opts: StrictOrFrom<TFrom> & {
+  opts: StrictOrFrom<TFrom, TReturnIntersection> & {
     select?: (search: TSearch) => TSelected
   },
 ): TSelected {

package/src/utils.ts

@@ -300,7 +300,7 @@ export type StringLiteral<T> = T extends string
     : T
   : never
 
-export type StrictOrFrom<TFrom> =
+export type StrictOrFrom<TFrom, TReturnIntersection extends boolean = false> =
   | {
       from: StringLiteral<TFrom> | TFrom
       strict?: true
@@ -308,6 +308,7 @@ export type StrictOrFrom<TFrom> =
   | {
       from?: never
       strict: false
+      experimental_returnIntersection?: TReturnIntersection
     }
 
 export const useLayoutEffect =