@tanstack/router-core 0.0.1-beta.21 → 0.0.1-beta.24

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/router-core",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.21",
+  "version": "0.0.1-beta.24",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",

package/src/link.ts

@@ -142,8 +142,9 @@ type SearchParamOptions<
   TTo,
   TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'],
   TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema'],
-> = StartsWith<TFrom, TTo> extends true // If the next route search extend or cover the from route, params will be optional
-  ? {
+> = StartsWith<TFrom, TTo> extends true
+  ? // If the next route search extend or cover the from route, params will be optional
+    {
       search?: SearchReducer<TFromSchema, TToSchema>
     }
   : // Optional search params? Allow it

package/src/path.ts

@@ -155,10 +155,6 @@ export function matchPathname(
     return
   }
 
-  // if (matchLocation.search && !searchMatched) {
-  //   return
-  // }
-
   return pathParams ?? {}
 }
 

package/src/route.ts

@@ -29,6 +29,7 @@ export interface Route<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
   TRouteInfo extends AnyRouteInfo = RouteInfo,
 > {
+  routeInfo: TRouteInfo
   routeId: TRouteInfo['id']
   routeRouteId: TRouteInfo['routeId']
   routePath: TRouteInfo['path']
@@ -56,7 +57,10 @@ export interface Route<
     opts?: MatchRouteOptions,
   ) => RouteInfoByPath<TAllRouteInfo, TResolved>['allParams']
   navigate: <TTo extends string = '.'>(
-    options: Omit<LinkOptions<TAllRouteInfo, TRouteInfo['id'], TTo>, 'from'>,
+    options: Omit<
+      LinkOptions<TAllRouteInfo, TRouteInfo['fullPath'], TTo>,
+      'from'
+    >,
   ) => Promise<void>
   action: unknown extends TRouteInfo['actionResponse']
     ?
@@ -185,6 +189,7 @@ export function createRoute<
     })()
 
   let route: Route<TAllRouteInfo, TRouteInfo> = {
+    routeInfo: undefined!,
     routeId: id,
     routeRouteId: routeId,
     routePath,

package/src/routeConfig.ts

@@ -3,6 +3,7 @@ import { ParsePathParams } from './link'
 import { joinPaths, trimPath, trimPathRight } from './path'
 import { RouteInfo } from './routeInfo'
 import { RouteMatch } from './routeMatch'
+import { RouterContext } from './router'
 import {
   DeepAwaited,
   Expand,
@@ -127,10 +128,13 @@ export type RouteOptions<
   // An asynchronous function made available to the route for performing asynchronous or mutative actions that
   // might invalidate the route's data.
   action?: ActionFn<TActionPayload, TActionResponse>
+  // This async function is called before a route is loaded. If an error is thrown, the navigation is cancelled.
+  // If you want to redirect instead, throw a call to the `router.navigate()` function
+  beforeLoad?: (opts: { context: RouterContext }) => Promise<void> | void
   // This function is called
   // when moving from an inactive state to an active one. Likewise, when moving from
   // an active to an inactive state, the return function (if provided) is called.
-  onMatch?: (matchContext: {
+  onLoaded?: (matchContext: {
     params: TAllParams
     search: TFullSearchSchema
   }) =>

package/src/routeInfo.ts

@@ -10,7 +10,7 @@ import {
   RouteConfig,
   RouteOptions,
 } from './routeConfig'
-import { IsAny, Values } from './utils'
+import { IsAny, UnionToIntersection, Values } from './utils'
 
 export interface AnyAllRouteInfo {
   routeConfig: AnyRouteConfig
@@ -19,6 +19,7 @@ export interface AnyAllRouteInfo {
   routeInfoByFullPath: Record<string, AnyRouteInfo>
   routeIds: any
   routePaths: any
+  fullSearchSchema: Record<string, any>
 }
 
 export interface DefaultAllRouteInfo {
@@ -28,6 +29,7 @@ export interface DefaultAllRouteInfo {
   routeInfoByFullPath: Record<string, RouteInfo>
   routeIds: string
   routePaths: string
+  fullSearchSchema: AnySearchSchema
 }
 
 export interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig>
@@ -133,6 +135,7 @@ export interface RoutesInfoInner<
   routeInfoByFullPath: TRouteInfoByFullPath
   routeIds: keyof TRouteInfoById
   routePaths: keyof TRouteInfoByFullPath
+  fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>
 }
 
 export interface AnyRouteInfo

package/src/router.ts

@@ -172,9 +172,12 @@ export interface LoaderState<
   loaderContext: LoaderContext<TFullSearchSchema, TAllParams>
 }
 
-export interface RouterState {
+export interface RouterState<
+  TSearchObj extends AnySearchSchema = {},
+  TState extends LocationState = LocationState,
+> {
   status: 'idle' | 'loading'
-  location: Location
+  location: Location<TSearchObj, TState>
   matches: RouteMatch[]
   lastUpdated: number
   actions: Record<string, Action>
@@ -244,6 +247,8 @@ interface DehydratedRouteMatch
     | 'invalidAt'
   > {}
 
+export interface RouterContext {}
+
 export interface Router<
   TRouteConfig extends AnyRouteConfig = RouteConfig,
   TAllRouteInfo extends AnyAllRouteInfo = AllRouteInfo<TRouteConfig>,
@@ -263,11 +268,12 @@ export interface Router<
   // Computed in this.update()
   basepath: string
   // Internal:
+  context: RouterContext
   listeners: Listener[]
-  location: Location
+  location: Location<TAllRouteInfo['fullSearchSchema']>
   navigateTimeout?: Timeout
   nextAction?: 'push' | 'replace'
-  state: RouterState
+  state: RouterState<TAllRouteInfo['fullSearchSchema']>
   routeTree: Route<TAllRouteInfo, RouteInfo>
   routesById: RoutesById<TAllRouteInfo>
   navigationPromise: Promise<void>
@@ -395,6 +401,7 @@ export function createRouter<
     options: originalOptions,
     listeners: [],
     // Resolved after construction
+    context: {},
     basepath: '',
     routeTree: undefined!,
     routesById: {} as any,
@@ -577,6 +584,22 @@ export function createRouter<
         strictParseParams: true,
       })
 
+      // Check if each match middleware to see if the route can be accessed
+      try {
+        await Promise.all(
+          matches.map((match) =>
+            match.options.beforeLoad?.({
+              context: router.context,
+            }),
+          ),
+        )
+      } catch (err: any) {
+        if (err?.then) {
+          await new Promise(() => {})
+        }
+        throw err
+      }
+
       if (typeof document !== 'undefined') {
         router.state = {
           ...router.state,
@@ -655,7 +678,7 @@ export function createRouter<
       })
 
       entering.forEach((d) => {
-        d.__.onExit = d.options.onMatch?.({
+        d.__.onExit = d.options.onLoaded?.({
           params: d.params,
           search: d.search,
         })

package/src/utils.ts

@@ -24,11 +24,11 @@ export type Expand<T> = T extends object
     : never
   : T
 
-// type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
-//   k: infer I,
-// ) => any
-//   ? I
-//   : never
+export type UnionToIntersection<U> = (
+  U extends any ? (k: U) => void : never
+) extends (k: infer I) => any
+  ? I
+  : never
 
 export type Values<O> = O[ValueKeys<O>]
 export type ValueKeys<O> = Extract<keyof O, PropertyKey>