@tanstack/react-router 1.0.7 → 1.0.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/react-router",
   "author": "Tanner Linsley",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -44,7 +44,7 @@
     "@tanstack/store": "^0.1.3",
     "tiny-invariant": "^1.3.1",
     "tiny-warning": "^1.0.3",
-    "@tanstack/history": "1.0.7"
+    "@tanstack/history": "1.0.8"
   },
   "scripts": {
     "build": "rollup --config rollup.config.js"

package/src/RouterProvider.tsx

@@ -40,10 +40,10 @@ export interface MatchLocation {
 }
 
 export type NavigateFn<TRouteTree extends AnyRoute> = <
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = TFrom,
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 >(
   opts: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>,
 ) => Promise<void>

package/src/link.tsx

@@ -19,6 +19,7 @@ import {
   PickRequired,
   UnionToIntersection,
   Updater,
+  WithoutEmpty,
   deepEqual,
   functionalUpdate,
 } from './utils'
@@ -116,10 +117,10 @@ export type RelativeToPathAutoComplete<
 
 export type NavigateOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = TFrom,
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = 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
@@ -130,26 +131,26 @@ export type NavigateOptions<
 
 export type ToOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = ToSubOptions<TRouteTree, TFrom, TTo> & {
   mask?: ToMaskOptions<TRouteTree, TMaskFrom, TMaskTo>
 }
 
 export type ToMaskOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TMaskFrom extends RoutePaths<TRouteTree> | string = string,
+  TMaskTo extends string | undefined = undefined,
 > = ToSubOptions<TRouteTree, TMaskFrom, TMaskTo> & {
   unmaskOnReload?: boolean
 }
 
 export type ToSubOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
   TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>,
 > = {
   to?: ToPathOption<TRouteTree, TFrom, TTo>
@@ -162,72 +163,56 @@ export type ToSubOptions<
   // // When using relative route paths, this option forces resolution from the current path, instead of the route API's path or `from` path
 } & CheckPath<TRouteTree, NoInfer<TResolved>, {}> &
   SearchParamOptions<TRouteTree, TFrom, TTo, TResolved> &
-  PathParamOptions<TRouteTree, TFrom, TResolved>
+  PathParamOptions<TRouteTree, TFrom, TTo, TResolved>
 
-export type SearchParamOptions<
+type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
+
+export type ParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo,
-  TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>,
-  TFromSearchEnsured = '/' extends TFrom
-    ? FullSearchSchema<TRouteTree>
-    : Expand<
-        PickRequired<
-          RouteByPath<TRouteTree, TFrom>['types']['fullSearchSchema']
-        >
-      >,
-  TFromSearchOptional = Omit<
-    FullSearchSchema<TRouteTree>,
-    keyof TFromSearchEnsured
-  >,
-  TFromSearch = Expand<TFromSearchEnsured & TFromSearchOptional>,
-  TToSearch = '' extends TTo
-    ? FullSearchSchema<TRouteTree>
-    : Expand<RouteByPath<TRouteTree, TResolved>['types']['fullSearchSchema']>,
-> = keyof PickRequired<TToSearch> extends never
-  ? {
-      search?: true | SearchReducer<TFromSearch, TToSearch>
-    }
-  : {
-      search: TFromSearchEnsured extends PickRequired<TToSearch>
-        ? true | SearchReducer<TFromSearch, TToSearch>
-        : SearchReducer<TFromSearch, TToSearch>
-    }
+  TResolved,
+  TParamVariant extends 'allParams' | 'fullSearchSchema',
+  TFromParams = Expand<RouteByPath<TRouteTree, TFrom>['types'][TParamVariant]>,
+  TToParams = TTo extends undefined
+    ? TFromParams
+    : never extends TResolved
+      ? Expand<RouteByPath<TRouteTree, TTo>['types'][TParamVariant]>
+      : Expand<RouteByPath<TRouteTree, TResolved>['types'][TParamVariant]>,
+  TReducer = ParamsReducer<TFromParams, TToParams>,
+> = Expand<WithoutEmpty<PickRequired<TToParams>>> extends never
+  ? Partial<MakeParamOption<TParamVariant, true | TReducer>>
+  : TFromParams extends Expand<WithoutEmpty<PickRequired<TToParams>>>
+    ? MakeParamOption<TParamVariant, true | TReducer>
+    : MakeParamOption<TParamVariant, TReducer>
+
+type MakeParamOption<
+  TParamVariant extends 'allParams' | 'fullSearchSchema',
+  T,
+> = TParamVariant extends 'allParams'
+  ? MakePathParamOptions<T>
+  : MakeSearchParamOptions<T>
+type MakeSearchParamOptions<T> = { search: T }
+type MakePathParamOptions<T> = { params: T }
 
-type SearchReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
+export type SearchParamOptions<
+  TRouteTree extends AnyRoute,
+  TFrom,
+  TTo,
+  TResolved,
+> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'fullSearchSchema'>
 
 export type PathParamOptions<
   TRouteTree extends AnyRoute,
   TFrom,
   TTo,
-  TFromParamsEnsured = Expand<
-    UnionToIntersection<
-      PickRequired<RouteByPath<TRouteTree, TFrom>['types']['allParams']>
-    >
-  >,
-  TFromParamsOptional = Omit<AllParams<TRouteTree>, keyof TFromParamsEnsured>,
-  TFromParams = Expand<TFromParamsOptional & TFromParamsEnsured>,
-  TToParams = Expand<RouteByPath<TRouteTree, TTo>['types']['allParams']>,
-> = never extends TToParams
-  ? {
-      params?: true | ParamsReducer<Partial<TFromParams>, Partial<TFromParams>>
-    }
-  : keyof PickRequired<TToParams> extends never
-    ? {
-        params?: true | ParamsReducer<TFromParams, TToParams>
-      }
-    : {
-        params: TFromParamsEnsured extends PickRequired<TToParams>
-          ? true | ParamsReducer<TFromParams, TToParams>
-          : ParamsReducer<TFromParams, TToParams>
-      }
-
-type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
+  TResolved,
+> = ParamOptions<TRouteTree, TFrom, TTo, TResolved, 'allParams'>
 
 export type ToPathOption<
   TRouteTree extends AnyRoute = AnyRoute,
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
 > =
   | TTo
   | RelativeToPathAutoComplete<
@@ -238,8 +223,8 @@ export type ToPathOption<
 
 export type ToIdOption<
   TRouteTree extends AnyRoute = AnyRoute,
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | undefined = undefined,
+  TTo extends string | undefined = undefined,
 > =
   | TTo
   | RelativeToPathAutoComplete<
@@ -256,10 +241,10 @@ export interface ActiveOptions {
 
 export type LinkOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = TFrom,
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> & {
   // The standard anchor tag target attribute
   target?: HTMLAnchorElement['target']
@@ -348,20 +333,13 @@ const preloadWarning = 'Error preloading route! ☝️'
 
 export function useLinkProps<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
->({
-  from,
-  ...options
-}: UseLinkPropsOptions<
-  TRouteTree,
-  TFrom,
-  TTo,
-  TMaskFrom,
-  TMaskTo
->): React.AnchorHTMLAttributes<HTMLAnchorElement> {
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
+>(
+  options: UseLinkPropsOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>,
+): React.AnchorHTMLAttributes<HTMLAnchorElement> {
   const router = useRouter()
   const matchPathname = useMatch({
     strict: false,
@@ -574,10 +552,10 @@ export function useLinkProps<
 export interface LinkComponent<TProps extends Record<string, any> = {}> {
   <
     TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-    TFrom extends RoutePaths<TRouteTree> = '/',
-    TTo extends string = '',
-    TMaskFrom extends RoutePaths<TRouteTree> = '/',
-    TMaskTo extends string = '',
+    TFrom extends RoutePaths<TRouteTree> | string = string,
+    TTo extends string | undefined = undefined,
+    TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+    TMaskTo extends string | undefined = undefined,
   >(
     props: LinkProps<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> &
       TProps &

package/src/useNavigate.tsx

@@ -5,11 +5,10 @@ import { LinkOptions, NavigateOptions } from './link'
 import { AnyRoute } from './route'
 import { RoutePaths } from './routeInfo'
 import { RegisteredRouter } from './router'
-import { useLayoutEffect } from './utils'
 
 export function useNavigate<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TDefaultFrom extends RoutePaths<TRouteTree> = '/',
+  TDefaultFrom extends RoutePaths<TRouteTree> | string = string,
 >(_defaultOpts?: { from?: TDefaultFrom }) {
   const { navigate, buildLocation } = useRouter()
 
@@ -20,10 +19,10 @@ export function useNavigate<
 
   return React.useCallback(
     <
-      TFrom extends RoutePaths<TRouteTree> = TDefaultFrom,
-      TTo extends string = '',
-      TMaskFrom extends RoutePaths<TRouteTree> = '/',
-      TMaskTo extends string = '',
+      TFrom extends RoutePaths<TRouteTree> | string = TDefaultFrom,
+      TTo extends string | undefined = undefined,
+      TMaskFrom extends RoutePaths<TRouteTree>| string = TFrom,
+      TMaskTo extends string | undefined = undefined,
     >({
       from,
       ...rest
@@ -54,10 +53,10 @@ export function useNavigate<
 
 export function Navigate<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 >(props: NavigateOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo>): null {
   const { navigate } = useRouter()
   const match = useMatch({ strict: false })
@@ -74,19 +73,19 @@ export function Navigate<
 
 export type UseLinkPropsOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined= undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = ActiveLinkOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> &
   React.AnchorHTMLAttributes<HTMLAnchorElement>
 
 export type LinkProps<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string| undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = ActiveLinkOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> &
   Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'children'> & {
     // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns
@@ -97,10 +96,10 @@ export type LinkProps<
 
 export type ActiveLinkOptions<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-  TFrom extends RoutePaths<TRouteTree> = '/',
-  TTo extends string = '',
-  TMaskFrom extends RoutePaths<TRouteTree> = '/',
-  TMaskTo extends string = '',
+  TFrom extends RoutePaths<TRouteTree> | string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom,
+  TMaskTo extends string | undefined = undefined,
 > = LinkOptions<TRouteTree, TFrom, TTo, TMaskFrom, TMaskTo> & {
   // A function that returns additional props for the `active` state of this link. These props override other props passed to the link (`style`'s are merged, `className`'s are concatenated)
   activeProps?:

package/src/utils.ts

@@ -26,6 +26,9 @@ export type PickRequired<T> = {
   [K in keyof T as undefined extends T[K] ? never : K]: T[K]
 }
 
+// from https://stackoverflow.com/a/76458160
+export type WithoutEmpty<T> = T extends T ? ({} extends T ? never : T) : never
+
 // export type Expand<T> = T
 export type Expand<T> = T extends object
   ? T extends infer O