@tanstack/react-router 1.49.8 → 1.50.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-router",
-  "version": "1.49.8",
+  "version": "1.50.0",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/Matches.tsx

@@ -25,10 +25,109 @@ import type {
   RouteIds,
   RoutePaths,
 } from './routeInfo'
-import type { ControlledPromise, DeepPartial, NoInfer } from './utils'
+import type {
+  Constrain,
+  ControlledPromise,
+  DeepPartial,
+  NoInfer,
+} from './utils'
+
+export type AnyMatchAndValue = { match: any; value: any }
+
+export type FindValueByIndex<
+  TKey,
+  TValue extends ReadonlyArray<any>,
+> = TKey extends `${infer TIndex extends number}` ? TValue[TIndex] : never
+
+export type FindValueByKey<TKey, TValue> =
+  TValue extends ReadonlyArray<any>
+    ? FindValueByIndex<TKey, TValue>
+    : TValue[TKey & keyof TValue]
+
+export type CreateMatchAndValue<TMatch, TValue> = TValue extends any
+  ? {
+      match: TMatch
+      value: TValue
+    }
+  : never
+
+export type NextMatchAndValue<
+  TKey,
+  TMatchAndValue extends AnyMatchAndValue,
+> = TMatchAndValue extends any
+  ? CreateMatchAndValue<
+      TMatchAndValue['match'],
+      FindValueByKey<TKey, TMatchAndValue['value']>
+    >
+  : never
+
+export type IsMatchKeyOf<TValue> =
+  TValue extends ReadonlyArray<any>
+    ? number extends TValue['length']
+      ? `${number}`
+      : keyof TValue & `${number}`
+    : TValue extends object
+      ? keyof TValue & string
+      : never
+
+export type IsMatchPath<
+  TParentPath extends string,
+  TMatchAndValue extends AnyMatchAndValue,
+> = `${TParentPath}${IsMatchKeyOf<TMatchAndValue['value']>}`
+
+export type IsMatchResult<
+  TKey,
+  TMatchAndValue extends AnyMatchAndValue,
+> = TMatchAndValue extends any
+  ? TKey extends keyof TMatchAndValue['value']
+    ? TMatchAndValue['match']
+    : never
+  : never
+
+export type IsMatchParse<
+  TPath,
+  TMatchAndValue extends AnyMatchAndValue,
+  TParentPath extends string = '',
+> = TPath extends `${string}.${string}`
+  ? TPath extends `${infer TFirst}.${infer TRest}`
+    ? IsMatchParse<
+        TRest,
+        NextMatchAndValue<TFirst, TMatchAndValue>,
+        `${TParentPath}${TFirst}.`
+      >
+    : never
+  : {
+      path: IsMatchPath<TParentPath, TMatchAndValue>
+      result: IsMatchResult<TPath, TMatchAndValue>
+    }
+
+export type IsMatch<TMatch, TPath> = IsMatchParse<
+  TPath,
+  TMatch extends any ? { match: TMatch; value: TMatch } : never
+>
+
+/**
+ * Narrows matches based on a path
+ * @experimental
+ */
+export const isMatch = <TMatch, TPath extends string>(
+  match: TMatch,
+  path: Constrain<TPath, IsMatch<TMatch, TPath>['path']>,
+): match is IsMatch<TMatch, TPath>['result'] => {
+  const parts = (path as string).split('.')
+  let part
+  let value: any = match
+
+  while ((part = parts.shift()) != null && value != null) {
+    value = value[part]
+  }
+
+  return value != null
+}
 
 export interface RouteMatch<
   TRouteId,
+  TFullPath,
   TAllParams,
   TFullSearchSchema,
   TLoaderData,
@@ -37,6 +136,7 @@ export interface RouteMatch<
 > {
   id: string
   routeId: TRouteId
+  fullPath: TFullPath
   index: number
   pathname: string
   params: TAllParams
@@ -76,6 +176,7 @@ export type MakeRouteMatch<
   TRouteId = ParseRoute<TRouteTree>['id'],
   TStrict extends boolean = true,
   TTypes extends AnyRoute['types'] = RouteById<TRouteTree, TRouteId>['types'],
+  TFullPath = TTypes['fullPath'],
   TAllParams = TStrict extends false
     ? AllParams<TRouteTree>
     : TTypes['allParams'],
@@ -91,6 +192,7 @@ export type MakeRouteMatch<
   TLoaderDeps = TTypes['loaderDeps'],
 > = RouteMatch<
   TRouteId,
+  TFullPath,
   TAllParams,
   TFullSearchSchema,
   TLoaderData,
@@ -98,7 +200,7 @@ export type MakeRouteMatch<
   TLoaderDeps
 >
 
-export type AnyRouteMatch = RouteMatch<any, any, any, any, any, any>
+export type AnyRouteMatch = RouteMatch<any, any, any, any, any, any, any>
 
 export function Matches() {
   const router = useRouter()
@@ -254,10 +356,24 @@ export function MatchRoute<
   return params ? props.children : null
 }
 
+export type MakeRouteMatches<
+  TRouter extends AnyRouter = AnyRouter,
+  TRoute extends AnyRoute = ParseRoute<TRouter['routeTree']>,
+> = TRoute extends any
+  ? RouteMatch<
+      TRoute['id'],
+      TRoute['fullPath'],
+      TRoute['types']['allParams'],
+      TRoute['types']['fullSearchSchema'],
+      TRoute['types']['loaderData'],
+      TRoute['types']['allContext'],
+      TRoute['types']['loaderDeps']
+    >
+  : never
+
 export function useMatches<
-  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TRouteId extends RouteIds<TRouteTree> = ParseRoute<TRouteTree>['id'],
-  TRouteMatch = MakeRouteMatch<TRouteTree, TRouteId>,
+  TRouter extends AnyRouter = RegisteredRouter,
+  TRouteMatch = MakeRouteMatches<TRouter>,
   T = Array<TRouteMatch>,
 >(opts?: { select?: (matches: Array<TRouteMatch>) => T }): T {
   return useRouterState({

package/src/fileRoute.ts

@@ -88,6 +88,7 @@ export class FileRoute<
       UpdatableRouteOptions<
         TParentRoute,
         TId,
+        TFullPath,
         TParams,
         TSearchValidator,
         TLoaderFn,
@@ -155,6 +156,7 @@ export type LazyRouteOptions = Pick<
   UpdatableRouteOptions<
     AnyRoute,
     string,
+    string,
     AnyPathParams,
     AnySearchValidator,
     {},

package/src/index.tsx

@@ -80,6 +80,7 @@ export {
   useMatches,
   useParentMatches,
   useChildMatches,
+  isMatch,
 } from './Matches'
 export type {
   RouteMatch,

package/src/route.ts

@@ -53,6 +53,7 @@ export type RoutePathOptionsIntersection<TCustomId, TPath> = {
 export type RouteOptions<
   TParentRoute extends AnyRoute = AnyRoute,
   TCustomId extends string = string,
+  TFullPath extends string = string,
   TPath extends string = string,
   TSearchValidator = undefined,
   TParams = AnyPathParams,
@@ -76,6 +77,7 @@ export type RouteOptions<
   UpdatableRouteOptions<
     NoInfer<TParentRoute>,
     NoInfer<TCustomId>,
+    NoInfer<TFullPath>,
     NoInfer<TParams>,
     NoInfer<TSearchValidator>,
     NoInfer<TLoaderFn>,
@@ -309,6 +311,7 @@ export interface BeforeLoadContextOptions<
 export interface UpdatableRouteOptions<
   in out TParentRoute extends AnyRoute,
   in out TRouteId,
+  in out TFullPath,
   in out TParams,
   in out TSearchValidator,
   in out TLoaderFn,
@@ -351,6 +354,7 @@ export interface UpdatableRouteOptions<
   onEnter?: (
     match: RouteMatch<
       TRouteId,
+      TFullPath,
       ResolveAllParamsFromParent<TParentRoute, TParams>,
       ResolveFullSearchSchema<TParentRoute, TSearchValidator>,
       ResolveLoaderData<TLoaderFn>,
@@ -366,6 +370,7 @@ export interface UpdatableRouteOptions<
   onStay?: (
     match: RouteMatch<
       TRouteId,
+      TFullPath,
       ResolveAllParamsFromParent<TParentRoute, TParams>,
       ResolveFullSearchSchema<TParentRoute, TSearchValidator>,
       ResolveLoaderData<TLoaderFn>,
@@ -381,6 +386,7 @@ export interface UpdatableRouteOptions<
   onLeave?: (
     match: RouteMatch<
       TRouteId,
+      TFullPath,
       ResolveAllParamsFromParent<TParentRoute, TParams>,
       ResolveFullSearchSchema<TParentRoute, TSearchValidator>,
       ResolveLoaderData<TLoaderFn>,
@@ -397,6 +403,7 @@ export interface UpdatableRouteOptions<
     matches: Array<
       RouteMatch<
         TRouteId,
+        TFullPath,
         ResolveAllParamsFromParent<TParentRoute, TParams>,
         ResolveFullSearchSchema<TParentRoute, TSearchValidator>,
         ResolveLoaderData<TLoaderFn>,
@@ -411,6 +418,7 @@ export interface UpdatableRouteOptions<
     >
     match: RouteMatch<
       TRouteId,
+      TFullPath,
       ResolveAllParamsFromParent<TParentRoute, TParams>,
       ResolveFullSearchSchema<TParentRoute, TSearchValidator>,
       ResolveLoaderData<TLoaderFn>,
@@ -860,6 +868,7 @@ export class Route<
   options: RouteOptions<
     TParentRoute,
     TCustomId,
+    TFullPath,
     TPath,
     TSearchValidator,
     TParams,
@@ -893,6 +902,7 @@ export class Route<
     options?: RouteOptions<
       TParentRoute,
       TCustomId,
+      TFullPath,
       TPath,
       TSearchValidator,
       TParams,
@@ -952,6 +962,7 @@ export class Route<
       | (RouteOptions<
           TParentRoute,
           TCustomId,
+          TFullPath,
           TPath,
           TSearchValidator,
           TParams,
@@ -1075,6 +1086,7 @@ export class Route<
     options: UpdatableRouteOptions<
       TParentRoute,
       TCustomId,
+      TFullPath,
       TParams,
       TSearchValidator,
       TLoaderFn,
@@ -1193,6 +1205,7 @@ export function createRoute<
   options: RouteOptions<
     TParentRoute,
     TCustomId,
+    TFullPath,
     TPath,
     TSearchValidator,
     TParams,
@@ -1232,7 +1245,8 @@ export type RootRouteOptions<
 > = Omit<
   RouteOptions<
     any, // TParentRoute
-    RootRouteId, // TCustomId
+    RootRouteId,
+    '', // TCustomId
     '', // TPath
     TSearchValidator,
     {}, // TParams
@@ -1495,6 +1509,7 @@ export class NotFoundRoute<
         TParentRoute,
         string,
         string,
+        string,
         TSearchValidator,
         {},
         TLoaderDeps,

package/src/router.ts

@@ -1210,6 +1210,7 @@ export class Router<
           scripts: route.options.scripts?.(),
           staticData: route.options.staticData || {},
           loadPromise: createControlledPromise(),
+          fullPath: route.fullPath,
         }
       }