@tanstack/router-core 0.0.1-beta.30 → 0.0.1-beta.31

package/package.json

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

package/src/link.ts

@@ -5,7 +5,13 @@ import {
   RouteInfoByPath,
 } from './routeInfo'
 import { Location, LocationState } from './router'
-import { Expand, NoInfer, PickRequired, Updater } from './utils'
+import {
+  Expand,
+  NoInfer,
+  PickRequired,
+  UnionToIntersection,
+  Updater,
+} from './utils'
 
 export type LinkInfo =
   | {
@@ -140,21 +146,37 @@ type SearchParamOptions<
   TAllRouteInfo extends AnyAllRouteInfo,
   TFrom,
   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
-    {
-      search?: SearchReducer<TFromSchema, TToSchema>
-    }
-  : // Optional search params? Allow it
-  keyof PickRequired<TToSchema> extends never
+  TFromSchema = Expand<
+    UnionToIntersection<
+      TAllRouteInfo['fullSearchSchema'] &
+        RouteInfoByPath<TAllRouteInfo, TFrom> extends never
+        ? {}
+        : RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+    >
+  >,
+  // Find the schema for the new path, and make optional any keys
+  // that are already defined in the current schema
+  TToSchema = Partial<
+    RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+  > &
+    Omit<
+      RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema'],
+      keyof PickRequired<
+        RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+      >
+    >,
+  TFromFullSchema = Expand<
+    UnionToIntersection<TAllRouteInfo['fullSearchSchema'] & TFromSchema>
+  >,
+  TToFullSchema = Expand<
+    UnionToIntersection<TAllRouteInfo['fullSearchSchema'] & TToSchema>
+  >,
+> = keyof PickRequired<TToSchema> extends never
   ? {
-      search?: SearchReducer<TFromSchema, TToSchema>
+      search?: true | SearchReducer<TFromFullSchema, TToFullSchema>
     }
   : {
-      // Must have required search params, enforce it
-      search: SearchReducer<TFromSchema, TToSchema>
+      search: SearchReducer<TFromFullSchema, TToFullSchema>
     }
 
 type SearchReducer<TFrom, TTo> =
@@ -165,23 +187,33 @@ type PathParamOptions<
   TAllRouteInfo extends AnyAllRouteInfo,
   TFrom,
   TTo,
-  TFromParams = RouteInfoByPath<TAllRouteInfo, TFrom>['allParams'],
-  TToParams = RouteInfoByPath<TAllRouteInfo, TTo>['allParams'],
-> =
-  // If the next routes params extend or cover the from route, params will be optional
-  StartsWith<TFrom, TTo> extends true
-    ? {
-        params?: ParamsReducer<TFromParams, TToParams>
-      }
-    : // If the next route doesn't have params, warn if any have been passed
-    AnyPathParams extends TToParams
-    ? {
-        params?: ParamsReducer<TFromParams, Record<string, never>>
-      }
-    : // If the next route has params, enforce them
-      {
-        params: ParamsReducer<TFromParams, TToParams>
-      }
+  TFromSchema = Expand<
+    UnionToIntersection<
+      RouteInfoByPath<TAllRouteInfo, TFrom> extends never
+        ? {}
+        : RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']
+    >
+  >,
+  // Find the schema for the new path, and make optional any keys
+  // that are already defined in the current schema
+  TToSchema = Partial<RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']> &
+    Omit<
+      RouteInfoByPath<TAllRouteInfo, TTo>['allParams'],
+      keyof PickRequired<RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']>
+    >,
+  TFromFullParams = Expand<
+    UnionToIntersection<TAllRouteInfo['allParams'] & TFromSchema>
+  >,
+  TToFullParams = Expand<
+    UnionToIntersection<TAllRouteInfo['allParams'] & TToSchema>
+  >,
+> = keyof PickRequired<TToSchema> extends never
+  ? {
+      params?: ParamsReducer<TFromFullParams, TToFullParams>
+    }
+  : {
+      params: ParamsReducer<TFromFullParams, TToFullParams>
+    }
 
 type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
 

package/src/route.ts

@@ -225,7 +225,7 @@ export function createRoute<
           from: fullPath,
         } as any,
         opts,
-      )
+      ) as any
     },
   }
 

package/src/routeInfo.ts

@@ -20,6 +20,7 @@ export interface AnyAllRouteInfo {
   routeIds: any
   routePaths: any
   fullSearchSchema: Record<string, any>
+  allParams: Record<string, any>
 }
 
 export interface DefaultAllRouteInfo {
@@ -30,6 +31,7 @@ export interface DefaultAllRouteInfo {
   routeIds: string
   routePaths: string
   fullSearchSchema: AnySearchSchema
+  allParams: AnyPathParams
 }
 
 export interface AllRouteInfo<TRouteConfig extends AnyRouteConfig = RouteConfig>
@@ -140,6 +142,7 @@ export interface RoutesInfoInner<
   routeIds: keyof TRouteInfoById
   routePaths: keyof TRouteInfoByFullPath
   fullSearchSchema: Partial<UnionToIntersection<TRouteInfo['fullSearchSchema']>>
+  allParams: Partial<UnionToIntersection<TRouteInfo['allParams']>>
 }
 
 export interface AnyRouteInfo
@@ -166,7 +169,7 @@ export interface RouteInfo<
   TId extends string = string,
   TRouteId extends string = string,
   TPath extends string = string,
-  TFullPath extends string = string,
+  TFullPath extends string = '/',
   TParentRouteLoaderData extends AnyLoaderData = {},
   TRouteLoaderData extends AnyLoaderData = {},
   TParentLoaderData extends AnyLoaderData = {},

package/src/routeMatch.ts

@@ -7,7 +7,7 @@ import {
   RouteInfo,
 } from './routeInfo'
 import { Router } from './router'
-import { replaceEqualDeep } from './utils'
+import { Expand, replaceEqualDeep } from './utils'
 
 export interface RouteMatch<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
@@ -19,7 +19,9 @@ export interface RouteMatch<
   parentMatch?: RouteMatch
   childMatches: RouteMatch[]
   routeSearch: TRouteInfo['searchSchema']
-  search: TRouteInfo['fullSearchSchema']
+  search: Expand<
+    TAllRouteInfo['fullSearchSchema'] & TRouteInfo['fullSearchSchema']
+  >
   status: 'idle' | 'loading' | 'success' | 'error'
   updatedAt?: number
   error?: unknown
@@ -85,7 +87,7 @@ export function createRouteMatch<
     ...opts,
     router,
     routeSearch: {},
-    search: {},
+    search: {} as any,
     childMatches: [],
     status: 'idle',
     routeLoaderData: {} as TRouteInfo['routeLoaderData'],
@@ -109,7 +111,7 @@ export function createRouteMatch<
       validate: () => {
         // Validate the search params and stabilize them
         const parentSearch =
-          routeMatch.parentMatch?.search ?? router.location.search
+          routeMatch.parentMatch?.search ?? router.__location.search
 
         try {
           const prevSearch = routeMatch.routeSearch

package/src/router.ts

@@ -221,7 +221,7 @@ export type ListenerFn = () => void
 
 export interface BuildNextOptions {
   to?: string | number | null
-  params?: true | Updater<Record<string, any>>
+  params?: true | Updater<unknown>
   search?: true | Updater<unknown>
   hash?: true | Updater<string>
   state?: LocationState
@@ -263,7 +263,7 @@ export interface DehydratedRouterState
 }
 
 export interface DehydratedRouter<TRouterContext = unknown> {
-  location: Router['location']
+  location: Router['__location']
   state: DehydratedRouterState
   context: TRouterContext
 }
@@ -302,7 +302,7 @@ export interface Router<
   basepath: string
   // Internal:
   listeners: Listener[]
-  location: Location<TAllRouteInfo['fullSearchSchema']>
+  __location: Location<TAllRouteInfo['fullSearchSchema']>
   navigateTimeout?: Timeout
   nextAction?: 'push' | 'replace'
   state: RouterState<TAllRouteInfo['fullSearchSchema']>
@@ -442,7 +442,7 @@ export function createRouter<
     basepath: '',
     routeTree: undefined!,
     routesById: {} as any,
-    location: undefined!,
+    __location: undefined!,
     //
     resolveNavigation: () => {},
     matchCache: {},
@@ -489,7 +489,7 @@ export function createRouter<
 
     dehydrate: () => {
       return {
-        location: router.location,
+        location: router.__location,
         state: {
           ...pick(router.state, [
             'status',
@@ -514,13 +514,13 @@ export function createRouter<
 
     hydrate: (dehydratedState) => {
       // Update the location
-      router.location = dehydratedState.location
+      router.__location = dehydratedState.location
 
       // Update the context
       router.options.context = dehydratedState.context
 
       // Match the routes
-      const matches = router.matchRoutes(router.location.pathname, {
+      const matches = router.matchRoutes(router.__location.pathname, {
         strictParseParams: true,
       })
 
@@ -551,7 +551,7 @@ export function createRouter<
 
       // If the current location isn't updated, trigger a navigation
       // to the current location. Otherwise, load the current location.
-      if (next.href !== router.location.href) {
+      if (next.href !== router.__location.href) {
         router.__.commitLocation(next, true)
       }
 
@@ -560,7 +560,7 @@ export function createRouter<
       }
 
       const unsub = router.history.listen((event) => {
-        router.load(router.__.parseLocation(event.location, router.location))
+        router.load(router.__.parseLocation(event.location, router.__location))
       })
 
       // addEventListener does not exist in React Native, but window does
@@ -587,12 +587,12 @@ export function createRouter<
 
     update: (opts) => {
       const newHistory = opts?.history !== router.history
-      if (!router.location || newHistory) {
+      if (!router.__location || newHistory) {
         if (opts?.history) {
           router.history = opts.history
         }
-        router.location = router.__.parseLocation(router.history.location)
-        router.state.location = router.location
+        router.__location = router.__.parseLocation(router.history.location)
+        router.state.location = router.__location
       }
 
       Object.assign(router.options, opts)
@@ -624,14 +624,14 @@ export function createRouter<
 
       if (next) {
         // Ingest the new location
-        router.location = next
+        router.__location = next
       }
 
       // Cancel any pending matches
       router.cancelMatches()
 
       // Match the routes
-      const matches = router.matchRoutes(router.location.pathname, {
+      const matches = router.matchRoutes(router.__location.pathname, {
         strictParseParams: true,
       })
 
@@ -640,7 +640,7 @@ export function createRouter<
           ...router.state,
           pending: {
             matches: matches,
-            location: router.location,
+            location: router.__location,
           },
           status: 'loading',
         }
@@ -648,7 +648,7 @@ export function createRouter<
         router.state = {
           ...router.state,
           matches: matches,
-          location: router.location,
+          location: router.__location,
           status: 'loading',
         }
       }
@@ -752,7 +752,7 @@ export function createRouter<
 
       router.state = {
         ...router.state,
-        location: router.location,
+        location: router.__location,
         matches,
         pending: undefined,
         status: 'idle',
@@ -783,7 +783,7 @@ export function createRouter<
       })
     },
 
-    loadRoute: async (navigateOpts = router.location) => {
+    loadRoute: async (navigateOpts = router.__location) => {
       const next = router.buildNext(navigateOpts)
       const matches = router.matchRoutes(next.pathname, {
         strictParseParams: true,
@@ -792,7 +792,7 @@ export function createRouter<
       return matches
     },
 
-    preloadRoute: async (navigateOpts = router.location, loaderOpts) => {
+    preloadRoute: async (navigateOpts = router.__location, loaderOpts) => {
       const next = router.buildNext(navigateOpts)
       const matches = router.matchRoutes(next.pathname, {
         strictParseParams: true,
@@ -1282,11 +1282,9 @@ export function createRouter<
       },
 
       buildLocation: (dest: BuildNextOptions = {}): Location => {
-        // const resolvedFrom: Location = {
-        //   ...router.location,
         const fromPathname = dest.fromCurrent
-          ? router.location.pathname
-          : dest.from ?? router.location.pathname
+          ? router.__location.pathname
+          : dest.from ?? router.__location.pathname
 
         let pathname = resolvePath(
           router.basepath ?? '/',
@@ -1294,7 +1292,7 @@ export function createRouter<
           `${dest.to ?? '.'}`,
         )
 
-        const fromMatches = router.matchRoutes(router.location.pathname, {
+        const fromMatches = router.matchRoutes(router.__location.pathname, {
           strictParseParams: true,
         })
 
@@ -1322,9 +1320,9 @@ export function createRouter<
         const preFilteredSearch = dest.__preSearchFilters?.length
           ? dest.__preSearchFilters.reduce(
               (prev, next) => next(prev),
-              router.location.search,
+              router.__location.search,
             )
-          : router.location.search
+          : router.__location.search
 
         // Then the link/navigate function
         const destSearch =
@@ -1345,22 +1343,22 @@ export function createRouter<
           : destSearch
 
         const search = replaceEqualDeep(
-          router.location.search,
+          router.__location.search,
           postFilteredSearch,
         )
 
         const searchStr = router.options.stringifySearch(search)
         let hash =
           dest.hash === true
-            ? router.location.hash
-            : functionalUpdate(dest.hash!, router.location.hash)
+            ? router.__location.hash
+            : functionalUpdate(dest.hash!, router.__location.hash)
         hash = hash ? `#${hash}` : ''
 
         return {
           pathname,
           search,
           searchStr,
-          state: router.location.state,
+          state: router.__location.state,
           hash,
           href: `${pathname}${searchStr}${hash}`,
           key: dest.key,