@tanstack/router-core 0.0.1-beta.184 → 0.0.1-beta.186

package/package.json

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

package/src/fileRoute.ts

@@ -3,7 +3,7 @@ import {
   AnyRoute,
   ResolveFullPath,
   ResolveFullSearchSchema,
-  MergeParamsFromParent,
+  MergeFromFromParent,
   RouteContext,
   AnyContext,
   RouteOptions,
@@ -94,14 +94,14 @@ export class FileRoute<
     TParams extends RouteConstraints['TParams'] = ParsePathParams<TPath> extends never
       ? AnyPathParams
       : Record<ParsePathParams<TPath>, RouteConstraints['TPath']>,
-    TAllParams extends RouteConstraints['TAllParams'] = MergeParamsFromParent<
+    TAllParams extends RouteConstraints['TAllParams'] = MergeFromFromParent<
       TParentRoute['types']['allParams'],
       TParams
     >,
     TParentContext extends RouteConstraints['TParentContext'] = TParentRoute['types']['routeContext'],
     TAllParentContext extends RouteConstraints['TId'] = TParentRoute['types']['context'],
     TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
-    TContext extends RouteConstraints['TAllContext'] = MergeParamsFromParent<
+    TContext extends RouteConstraints['TAllContext'] = MergeFromFromParent<
       TParentRoute['types']['context'],
       TRouteContext
     >,

package/src/history.ts

@@ -3,7 +3,7 @@
 // making assumptions about the way TanStack Router works
 
 export interface RouterHistory {
-  location: RouterLocation
+  location: HistoryLocation
   subscribe: (cb: () => void) => () => void
   push: (path: string, state?: any) => void
   replace: (path: string, state?: any) => void
@@ -14,6 +14,10 @@ export interface RouterHistory {
   block: (blockerFn: BlockerFn) => () => void
 }
 
+export interface HistoryLocation extends ParsedPath {
+  state: LocationState
+}
+
 export interface ParsedPath {
   href: string
   pathname: string
@@ -21,8 +25,10 @@ export interface ParsedPath {
   hash: string
 }
 
-export interface RouterLocation extends ParsedPath {
-  state: any
+export interface LocationState {
+  key: string
+  __tempLocation?: HistoryLocation
+  __tempKey?: string
 }
 
 type BlockerFn = (retry: () => void, cancel: () => void) => void
@@ -44,7 +50,7 @@ const stopBlocking = () => {
 }
 
 function createHistory(opts: {
-  getLocation: () => RouterLocation
+  getLocation: () => HistoryLocation
   subscriber: false | ((onUpdate: () => void) => () => void)
   pushState: (path: string, state: any) => void
   replaceState: (path: string, state: any) => void
@@ -108,11 +114,13 @@ function createHistory(opts: {
       }
     },
     push: (path: string, state: any) => {
+      assignKey(state)
       queueTask(() => {
         opts.pushState(path, state)
       })
     },
     replace: (path: string, state: any) => {
+      assignKey(state)
       queueTask(() => {
         opts.replaceState(path, state)
       })
@@ -153,6 +161,16 @@ function createHistory(opts: {
   }
 }
 
+function assignKey(state: LocationState) {
+  state.key = createRandomKey()
+  // if (state.__actualLocation) {
+  //   state.__actualLocation.state = {
+  //     ...state.__actualLocation.state,
+  //     key,
+  //   }
+  // }
+}
+
 export function createBrowserHistory(opts?: {
   getHref?: () => string
   createHref?: (path: string) => string
@@ -161,8 +179,10 @@ export function createBrowserHistory(opts?: {
     opts?.getHref ??
     (() =>
       `${window.location.pathname}${window.location.search}${window.location.hash}`)
+
   const createHref = opts?.createHref ?? ((path) => path)
-  const getLocation = () => parseLocation(getHref(), history.state)
+
+  const getLocation = () => parseLocation(getHref(), window.history.state)
 
   return createHistory({
     getLocation,
@@ -191,18 +211,10 @@ export function createBrowserHistory(opts?: {
       }
     },
     pushState: (path, state) => {
-      window.history.pushState(
-        { ...state, key: createRandomKey() },
-        '',
-        createHref(path),
-      )
+      window.history.pushState(state, '', createHref(path))
     },
     replaceState: (path, state) => {
-      window.history.replaceState(
-        { ...state, key: createRandomKey() },
-        '',
-        createHref(path),
-      )
+      window.history.replaceState(state, '', createHref(path))
     },
     back: () => window.history.back(),
     forward: () => window.history.forward(),
@@ -228,7 +240,9 @@ export function createMemoryHistory(
 ): RouterHistory {
   const entries = opts.initialEntries
   let index = opts.initialIndex ?? entries.length - 1
-  let currentState = {}
+  let currentState = {
+    key: createRandomKey(),
+  } as LocationState
 
   const getLocation = () => parseLocation(entries[index]!, currentState)
 
@@ -236,18 +250,12 @@ export function createMemoryHistory(
     getLocation,
     subscriber: false,
     pushState: (path, state) => {
-      currentState = {
-        ...state,
-        key: createRandomKey(),
-      }
+      currentState = state
       entries.push(path)
       index++
     },
     replaceState: (path, state) => {
-      currentState = {
-        ...state,
-        key: createRandomKey(),
-      }
+      currentState = state
       entries[index] = path
     },
     back: () => {
@@ -261,7 +269,7 @@ export function createMemoryHistory(
   })
 }
 
-function parseLocation(href: string, state: any): RouterLocation {
+function parseLocation(href: string, state: LocationState): HistoryLocation {
   let hashIndex = href.indexOf('#')
   let searchIndex = href.indexOf('?')
 
@@ -282,7 +290,7 @@ function parseLocation(href: string, state: any): RouterLocation {
       searchIndex > -1
         ? href.slice(searchIndex, hashIndex === -1 ? undefined : hashIndex)
         : '',
-    state,
+    state: state || {},
   }
 }
 

package/src/link.ts

@@ -1,4 +1,5 @@
 import { Trim } from './fileRoute'
+import { LocationState } from './history'
 import { AnyRoute } from './route'
 import {
   AllParams,
@@ -7,8 +8,16 @@ import {
   RouteIds,
   RoutePaths,
 } from './routeInfo'
-import { ParsedLocation, LocationState } from './router'
-import { NoInfer, PickRequired, UnionToIntersection, Updater } from './utils'
+import { ParsedLocation } from './router'
+import {
+  Expand,
+  NoInfer,
+  NonNullableUpdater,
+  PickAsRequired,
+  PickRequired,
+  UnionToIntersection,
+  Updater,
+} from './utils'
 
 export type LinkInfo =
   | {
@@ -121,7 +130,9 @@ export type NavigateOptions<
   TRouteTree extends AnyRoute = AnyRoute,
   TFrom extends RoutePaths<TRouteTree> = '/',
   TTo extends string = '',
-> = ToOptions<TRouteTree, TFrom, TTo> & {
+  TMaskFrom extends RoutePaths<TRouteTree> = TFrom,
+  TMaskTo extends string = '',
+> = ToOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> & {
   // `replace` is a boolean that determines whether the navigation should replace the current history entry or push a new one.
   replace?: boolean
   resetScroll?: boolean
@@ -131,81 +142,83 @@ export type ToOptions<
   TRouteTree extends AnyRoute = AnyRoute,
   TFrom extends RoutePaths<TRouteTree> = '/',
   TTo extends string = '',
-  TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>,
+  TMaskFrom extends RoutePaths<TRouteTree> = '/',
+  TMaskTo extends string = '',
+> = ToSubOptions<TRouteTree, TFrom, TTo> & {
+  mask?: ToMaskOptions<TRouteTree, TMaskFrom, TMaskTo>
+}
+
+export type ToMaskOptions<
+  TRouteTree extends AnyRoute = AnyRoute,
+  TMaskFrom extends RoutePaths<TRouteTree> = '/',
+  TMaskTo extends string = '',
+> = ToSubOptions<TRouteTree, TMaskFrom, TMaskTo> & {
+  unmaskOnReload?: boolean
+}
+
+export type ToSubOptions<
+  TRouteTree extends AnyRoute = AnyRoute,
+  TFrom extends RoutePaths<TRouteTree> = '/',
+  TTo extends string = '',
+  TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>,
 > = {
   to?: ToPathOption<TRouteTree, TFrom, TTo>
   // The new has string or a function to update it
-  hash?: Updater<string>
+  hash?: true | Updater<string>
   // State to pass to the history stack
-  state?: LocationState
+  state?: true | NonNullableUpdater<LocationState>
   // The source route path. This is automatically set when using route-level APIs, but for type-safe relative routing on the router itself, this is required
   from?: TFrom
   // // When using relative route paths, this option forces resolution from the current path, instead of the route API's path or `from` path
   // fromCurrent?: boolean
-} & CheckPath<TRouteTree, NoInfer<TResolvedTo>, {}> &
-  SearchParamOptions<TRouteTree, TFrom, TResolvedTo> &
-  PathParamOptions<TRouteTree, TFrom, TResolvedTo>
+} & CheckPath<TRouteTree, NoInfer<TResolved>, {}> &
+  SearchParamOptions<TRouteTree, TFrom, TResolved> &
+  PathParamOptions<TRouteTree, TFrom, TResolved>
 
 export type SearchParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo,
-  TFromSchema = UnionToIntersection<
-    FullSearchSchema<TRouteTree> & RouteByPath<TRouteTree, TFrom> extends never
-      ? {}
-      : RouteByPath<TRouteTree, TFrom>['types']['fullSearchSchema']
-  >,
-  // Find the schema for the new path, and make optional any keys
-  // that are already defined in the current schema
-  TToSchema = Partial<
-    RouteByPath<TRouteTree, TFrom>['types']['fullSearchSchema']
-  > &
-    Omit<
-      RouteByPath<TRouteTree, TTo>['types']['fullSearchSchema'],
-      keyof PickRequired<
-        RouteByPath<TRouteTree, TFrom>['types']['fullSearchSchema']
-      >
-    >,
-  TFromFullSchema = UnionToIntersection<
-    FullSearchSchema<TRouteTree> & TFromSchema
+  TFromSearchEnsured = Expand<
+    UnionToIntersection<
+      PickRequired<RouteByPath<TRouteTree, TFrom>['types']['fullSearchSchema']>
+    >
   >,
-  TToFullSchema = UnionToIntersection<FullSearchSchema<TRouteTree> & TToSchema>,
-> = keyof PickRequired<TToSchema> extends never
+  TFromSearchOptional = Omit<AllParams<TRouteTree>, keyof TFromSearchEnsured>,
+  TFromSearch = Expand<TFromSearchEnsured & TFromSearchOptional>,
+  TToSearch = Expand<RouteByPath<TRouteTree, TTo>['types']['fullSearchSchema']>,
+> = keyof PickRequired<TToSearch> extends never
   ? {
-      search?: true | SearchReducer<TFromFullSchema, TToFullSchema>
+      search?: true | SearchReducer<TFromSearch, TToSearch>
     }
   : {
-      search: SearchReducer<TFromFullSchema, TToFullSchema>
+      search: TFromSearchEnsured extends PickRequired<TToSearch>
+        ? true | SearchReducer<TFromSearch, TToSearch>
+        : SearchReducer<TFromSearch, TToSearch>
     }
 
-type SearchReducer<TFrom, TTo> =
-  | { [TKey in keyof TTo]: TTo[TKey] }
-  | ((current: TFrom) => TTo)
+type SearchReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
 
 export type PathParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo,
-  TFromSchema = UnionToIntersection<
-    RouteByPath<TRouteTree, TFrom> extends never
-      ? {}
-      : RouteByPath<TRouteTree, TFrom>['types']['allParams']
+  TFromParamsEnsured = Expand<
+    UnionToIntersection<
+      PickRequired<RouteByPath<TRouteTree, TFrom>['types']['allParams']>
+    >
   >,
-  // Find the schema for the new path, and make optional any keys
-  // that are already defined in the current schema
-  TToSchema = Partial<RouteByPath<TRouteTree, TFrom>['types']['allParams']> &
-    Omit<
-      RouteByPath<TRouteTree, TTo>['types']['allParams'],
-      keyof PickRequired<RouteByPath<TRouteTree, TFrom>['types']['allParams']>
-    >,
-  TFromFullParams = UnionToIntersection<AllParams<TRouteTree> & TFromSchema>,
-  TToFullParams = UnionToIntersection<AllParams<TRouteTree> & TToSchema>,
-> = keyof PickRequired<TToSchema> extends never
+  TFromParamsOptional = Omit<AllParams<TRouteTree>, keyof TFromParamsEnsured>,
+  TFromParams = Expand<TFromParamsOptional & TFromParamsEnsured>,
+  TToParams = Expand<RouteByPath<TRouteTree, TTo>['types']['allParams']>,
+> = keyof PickRequired<TToParams> extends never
   ? {
-      params?: ParamsReducer<TFromFullParams, TToFullParams>
+      params?: true | ParamsReducer<TFromParams, TToParams>
     }
   : {
-      params: ParamsReducer<TFromFullParams, TToFullParams>
+      params: TFromParamsEnsured extends PickRequired<TToParams>
+        ? true | ParamsReducer<TFromParams, TToParams>
+        : ParamsReducer<TFromParams, TToParams>
     }
 
 type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
@@ -244,7 +257,9 @@ export type LinkOptions<
   TRouteTree extends AnyRoute = AnyRoute,
   TFrom extends RoutePaths<TRouteTree> = '/',
   TTo extends string = '',
-> = NavigateOptions<TRouteTree, TFrom, TTo> & {
+  TMaskFrom extends RoutePaths<TRouteTree> = TFrom,
+  TMaskTo extends string = '',
+> = NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> & {
   // The standard anchor tag target attribute
   target?: HTMLAnchorElement['target']
   // Defaults to `{ exact: false, includeHash: false }`

package/src/route.ts

@@ -1,14 +1,25 @@
-import { ParsePathParams } from './link'
+import invariant from 'tiny-invariant'
+import { RouteById, RoutePaths } from './routeInfo'
+import { joinPaths, trimPath } from './path'
 import {
   AnyRouter,
-  Router,
   RouteMatch,
-  RegisteredRouter,
   AnyRouteMatch,
+  RegisteredRouter,
 } from './router'
-import { IsAny, NoInfer, PickRequired, UnionToIntersection } from './utils'
-import invariant from 'tiny-invariant'
-import { joinPaths, trimPath } from './path'
+import {
+  Expand,
+  IsAny,
+  NoInfer,
+  PickRequired,
+  UnionToIntersection,
+} from './utils'
+import {
+  ParsePathParams,
+  ResolveRelativePath,
+  ToMaskOptions,
+  ToSubOptions,
+} from './link'
 
 export const rootRouteId = '__root__' as const
 export type RootRouteId = typeof rootRouteId
@@ -393,6 +404,9 @@ export type UpdatableRouteOptions<
   onEnter?: (match: AnyRouteMatch) => void
   onTransition?: (match: AnyRouteMatch) => void
   onLeave?: (match: AnyRouteMatch) => void
+  // Set this to true or false to specifically set whether or not this route should be preloaded. If unset, will
+  // default to router.options.reloadOnWindowFocus
+  reloadOnWindowFocus?: boolean
 }
 
 export type ParseParamsOption<TPath extends string, TParams> = ParseParamsFn<
@@ -525,7 +539,7 @@ export interface AnyRoute
     any
   > {}
 
-export type MergeParamsFromParent<T, U> = IsAny<T, U, T & U>
+export type MergeFromFromParent<T, U> = IsAny<T, U, T & U>
 
 export type UseLoaderResult<T> = T
 // T extends Record<PropertyKey, infer U>
@@ -545,6 +559,15 @@ export type StreamedPromise<T> = {
   resolve: (value: T) => void
 }
 
+export type ResolveAllParams<
+  TParentRoute extends AnyRoute,
+  TParams extends AnyPathParams,
+> = Record<never, string> extends TParentRoute['types']['allParams']
+  ? TParams
+  : Expand<
+      UnionToIntersection<TParentRoute['types']['allParams'] & TParams> & {}
+    >
+
 export type RouteConstraints = {
   TParentRoute: AnyRoute
   TPath: string
@@ -583,18 +606,17 @@ export class Route<
     TParentRoute,
     TSearchSchema
   >,
-  TParams extends RouteConstraints['TParams'] = Record<
-    ParsePathParams<TPath>,
-    string
+  TParams extends RouteConstraints['TParams'] = Expand<
+    Record<ParsePathParams<TPath>, string>
   >,
-  TAllParams extends RouteConstraints['TAllParams'] = MergeParamsFromParent<
-    TParentRoute['types']['allParams'],
+  TAllParams extends RouteConstraints['TAllParams'] = ResolveAllParams<
+    TParentRoute,
     TParams
   >,
   TParentContext extends RouteConstraints['TParentContext'] = TParentRoute['types']['routeContext'],
   TAllParentContext extends RouteConstraints['TAllParentContext'] = TParentRoute['types']['context'],
   TRouteContext extends RouteConstraints['TRouteContext'] = RouteContext,
-  TAllContext extends RouteConstraints['TAllContext'] = MergeParamsFromParent<
+  TAllContext extends RouteConstraints['TAllContext'] = MergeFromFromParent<
     TParentRoute['types']['context'],
     TRouteContext
   >,
@@ -816,7 +838,7 @@ export class RouterContext<TRouterContext extends {}> {
         TRouterContext,
         TRouterContext,
         TRouteContext,
-        MergeParamsFromParent<TRouterContext, TRouteContext>
+        MergeFromFromParent<TRouterContext, TRouteContext>
       >,
       | 'path'
       | 'id'
@@ -849,7 +871,7 @@ export class RootRoute<
   TRouterContext,
   TRouterContext,
   TRouteContext,
-  MergeParamsFromParent<TRouterContext, TRouteContext>,
+  MergeFromFromParent<TRouterContext, TRouteContext>,
   TRouterContext,
   any,
   any
@@ -869,7 +891,7 @@ export class RootRoute<
         TRouterContext,
         TRouterContext,
         TRouteContext,
-        MergeParamsFromParent<TRouterContext, TRouteContext>
+        MergeFromFromParent<TRouterContext, TRouteContext>
       >,
       | 'path'
       | 'id'
@@ -919,3 +941,26 @@ export type TrimPathRight<T extends string> = T extends '/'
   : T extends `${infer U}/`
   ? TrimPathRight<U>
   : T
+
+export type RouteMask<TRouteTree extends AnyRoute> = {
+  routeTree: TRouteTree
+  from: RoutePaths<TRouteTree>
+  to?: any
+  params?: any
+  search?: any
+  hash?: any
+  state?: any
+  unmaskOnReload?: boolean
+}
+
+export function createRouteMask<
+  TRouteTree extends AnyRoute,
+  TFrom extends RoutePaths<TRouteTree>,
+  TTo extends string,
+>(
+  opts: {
+    routeTree: TRouteTree
+  } & ToSubOptions<TRouteTree, TFrom, TTo>,
+): RouteMask<TRouteTree> {
+  return opts as any
+}

package/src/routeInfo.ts

@@ -1,5 +1,5 @@
 import { AnyRoute, Route } from './route'
-import { MergeUnion } from './utils'
+import { UnionToIntersection } from './utils'
 
 export type ParseRoute<TRouteTree extends AnyRoute> =
   | TRouteTree
@@ -60,10 +60,10 @@ export type RoutePaths<TRouteTree extends AnyRoute> =
   | ParseRoute<TRouteTree>['fullPath']
   | '/'
 
-export type FullSearchSchema<TRouteTree extends AnyRoute> = MergeUnion<
+export type FullSearchSchema<TRouteTree extends AnyRoute> = UnionToIntersection<
   ParseRoute<TRouteTree>['types']['fullSearchSchema']
 > & {}
 
-export type AllParams<TRouteTree extends AnyRoute> = MergeUnion<
+export type AllParams<TRouteTree extends AnyRoute> = UnionToIntersection<
   ParseRoute<TRouteTree>['types']['allParams']
 >