@tanstack/react-router 1.22.4 → 1.22.6

package/src/routerContext.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react'
-import { Router } from './router'
+import type { Router } from './router'
 
-let routerContext = React.createContext<Router<any>>(null!)
+const routerContext = React.createContext<Router<any>>(null!)
 
 export function getRouterContext() {
   if (typeof document === 'undefined') {

package/src/scroll-restoration.tsx

@@ -3,9 +3,10 @@ import * as React from 'react'
 const useLayoutEffect =
   typeof window !== 'undefined' ? React.useLayoutEffect : React.useEffect
 
-import { ParsedLocation } from './location'
 import { useRouter } from './useRouter'
-import { NonNullableUpdater, functionalUpdate } from './utils'
+import { functionalUpdate } from './utils'
+import type { ParsedLocation } from './location'
+import type { NonNullableUpdater } from './utils'
 
 const windowKey = 'window'
 const delimiter = '___'
@@ -25,7 +26,7 @@ type Cache = {
 
 const sessionsStorage = typeof window !== 'undefined' && window.sessionStorage
 
-let cache: Cache = sessionsStorage
+const cache: Cache = sessionsStorage
   ? (() => {
       const storageKey = 'tsr-scroll-restoration-v2'
 
@@ -56,9 +57,7 @@ export function useScrollRestoration(options?: ScrollRestorationOptions) {
     const getKey = options?.getKey || defaultGetKey
 
     const { history } = window
-    if (history.scrollRestoration) {
-      history.scrollRestoration = 'manual'
-    }
+    history.scrollRestoration = 'manual'
 
     const onScroll = (event: Event) => {
       if (weakScrolledElements.has(event.target)) return
@@ -137,8 +136,6 @@ export function useScrollRestoration(options?: ScrollRestorationOptions) {
 
         router.resetNextScroll = true
 
-        const getKey = options?.getKey || defaultGetKey
-
         const restoreKey = getKey(event.toLocation)
         let windowRestored = false
 
@@ -173,7 +170,7 @@ export function useScrollRestoration(options?: ScrollRestorationOptions) {
       unsubOnBeforeLoad()
       unsubOnResolved()
     }
-  }, [])
+  }, [options?.getKey, router])
 }
 
 export function ScrollRestoration(props: ScrollRestorationOptions) {
@@ -196,7 +193,7 @@ export function useElementScrollRestoration(
   },
 ) {
   const router = useRouter()
-  const getKey = options?.getKey || defaultGetKey
+  const getKey = options.getKey || defaultGetKey
 
   let elementSelector = ''
 
@@ -216,8 +213,8 @@ export function useElementScrollRestoration(
 }
 
 function getCssSelector(el: any): string {
-  let path = [],
-    parent
+  const path = []
+  let parent
   while ((parent = el.parentNode)) {
     path.unshift(
       `${el.tagName}:nth-child(${

package/src/searchParams.ts

@@ -1,5 +1,5 @@
 import { decode, encode } from './qss'
-import { AnySearchSchema } from './route'
+import type { AnySearchSchema } from './route'
 
 export const defaultParseSearch = parseSearchWith(JSON.parse)
 export const defaultStringifySearch = stringifySearchWith(
@@ -13,10 +13,10 @@ export function parseSearchWith(parser: (str: string) => any) {
       searchStr = searchStr.substring(1)
     }
 
-    let query: Record<string, unknown> = decode(searchStr)
+    const query: Record<string, unknown> = decode(searchStr)
 
     // Try to parse any query params that might be json
-    for (let key in query) {
+    for (const key in query) {
       const value = query[key]
       if (typeof value === 'string') {
         try {
@@ -58,16 +58,14 @@ export function stringifySearchWith(
   return (search: Record<string, any>) => {
     search = { ...search }
 
-    if (search) {
-      Object.keys(search).forEach((key) => {
-        const val = search[key]
-        if (typeof val === 'undefined' || val === undefined) {
-          delete search[key]
-        } else {
-          search[key] = stringifyValue(val)
-        }
-      })
-    }
+    Object.keys(search).forEach((key) => {
+      const val = search[key]
+      if (typeof val === 'undefined' || val === undefined) {
+        delete search[key]
+      } else {
+        search[key] = stringifyValue(val)
+      }
+    })
 
     const searchStr = encode(search as Record<string, string>).toString()
 

package/src/useBlocker.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react'
-import { ReactNode } from './route'
 import { useRouter } from './useRouter'
-import { BlockerFn } from '@tanstack/history'
+import type { BlockerFn } from '@tanstack/history'
+import type { ReactNode } from './route'
 
 export function useBlocker(
   blockerFn: BlockerFn,
@@ -17,7 +17,7 @@ export function useBlocker(
 
 export function Block({ blocker, condition, children }: PromptProps) {
   useBlocker(blocker, condition)
-  return (children ?? null) as ReactNode
+  return children ?? null
 }
 
 export type PromptProps = {

package/src/useNavigate.tsx

@@ -1,10 +1,11 @@
 import * as React from 'react'
 import { useMatch } from './Matches'
 import { useRouter } from './useRouter'
-import { NavigateOptions } from './link'
-import { AnyRoute } from './route'
-import { RoutePaths, RoutePathsAutoComplete } from './routeInfo'
-import { RegisteredRouter } from './router'
+
+import type { NavigateOptions } from './link'
+import type { AnyRoute } from './route'
+import type { RoutePaths, RoutePathsAutoComplete } from './routeInfo'
+import type { RegisteredRouter } from './router'
 
 export type UseNavigateResult<TDefaultFrom extends string> = <
   TTo extends string,
@@ -28,7 +29,7 @@ export function useNavigate<
     (options: NavigateOptions) => {
       return router.navigate({
         ...options,
-        from: options?.to ? router.state.resolvedLocation.pathname : undefined,
+        from: options.to ? router.state.resolvedLocation.pathname : undefined,
       })
     },
     [router],
@@ -65,6 +66,7 @@ export function Navigate<
       from: props.to ? match.pathname : undefined,
       ...props,
     } as any)
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
   return null

package/src/useParams.tsx

@@ -1,9 +1,9 @@
-import { AnyRoute } from './route'
-import { RouteIds, RouteById, AllParams } from './routeInfo'
-import { RegisteredRouter } from './router'
-import { Expand } from './utils'
-import { StrictOrFrom } from './utils'
 import { useMatch } from './Matches'
+import type { AnyRoute } from './route'
+import type { AllParams, RouteById, RouteIds } from './routeInfo'
+import type { RegisteredRouter } from './router'
+import type { Expand } from './utils'
+import type { StrictOrFrom } from './utils'
 
 export function useParams<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
@@ -21,7 +21,7 @@ export function useParams<
   return useMatch({
     ...opts,
     select: (match) => {
-      return opts?.select ? opts.select(match.params) : match.params
+      return opts.select ? opts.select(match.params) : match.params
     },
   })
 }

package/src/useRouteContext.ts

@@ -1,8 +1,9 @@
-import { useMatch, RouteMatch } from './Matches'
-import { AnyRoute } from './route'
-import { RouteIds, RouteById } from './routeInfo'
-import { RegisteredRouter } from './router'
-import { StrictOrFrom } from './utils'
+import { useMatch } from './Matches'
+import type { RouteMatch } from './Matches'
+import type { AnyRoute } from './route'
+import type { RouteById, RouteIds } from './routeInfo'
+import type { RegisteredRouter } from './router'
+import type { StrictOrFrom } from './utils'
 
 export function useRouteContext<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
@@ -17,8 +18,6 @@ export function useRouteContext<
   return useMatch({
     ...(opts as any),
     select: (match: RouteMatch) =>
-      opts?.select
-        ? opts.select(match.context as TRouteContext)
-        : match.context,
+      opts.select ? opts.select(match.context as TRouteContext) : match.context,
   })
 }

package/src/useRouter.tsx

@@ -1,8 +1,8 @@
 import * as React from 'react'
 import warning from 'tiny-warning'
-import { AnyRoute } from './route'
-import { RegisteredRouter, Router } from './router'
 import { getRouterContext } from './routerContext'
+import type { AnyRoute } from './route'
+import type { RegisteredRouter, Router } from './router'
 
 export function useRouter<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],

package/src/useRouterState.tsx

@@ -1,7 +1,7 @@
 import { useStore } from '@tanstack/react-store'
-import { AnyRoute } from './route'
-import { RegisteredRouter, Router, RouterState } from './router'
 import { useRouter } from './useRouter'
+import type { AnyRoute } from './route'
+import type { RegisteredRouter, Router, RouterState } from './router'
 
 export function useRouterState<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],

package/src/useSearch.tsx

@@ -1,9 +1,10 @@
-import { AnyRoute, RootSearchSchema } from './route'
-import { RouteIds, RouteById, FullSearchSchema } from './routeInfo'
-import { RegisteredRouter } from './router'
-import { RouteMatch } from './Matches'
 import { useMatch } from './Matches'
-import { Expand, StrictOrFrom } from './utils'
+import { Expand } from './utils'
+import type { AnyRoute, RootSearchSchema } from './route'
+import type { FullSearchSchema, RouteById, RouteIds } from './routeInfo'
+import type { RegisteredRouter } from './router'
+import type { RouteMatch } from './Matches'
+import type { StrictOrFrom } from './utils'
 
 export function useSearch<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
@@ -24,7 +25,7 @@ export function useSearch<
   return useMatch({
     ...opts,
     select: (match: RouteMatch) => {
-      return opts?.select ? opts.select(match.search as TSearch) : match.search
+      return opts.select ? opts.select(match.search as TSearch) : match.search
     },
   })
 }

package/src/utils.ts

@@ -1,9 +1,14 @@
 import * as React from 'react'
 
 export type NoInfer<T> = [T][T extends any ? 0 : never]
-export type IsAny<T, Y, N = T> = 1 extends 0 & T ? Y : N
-export type PickAsRequired<T, K extends keyof T> = Omit<T, K> &
-  Required<Pick<T, K>>
+export type IsAny<TValue, TYesResult, TNoResult = TValue> = 1 extends 0 & TValue
+  ? TYesResult
+  : TNoResult
+export type PickAsRequired<TValue, TKey extends keyof TValue> = Omit<
+  TValue,
+  TKey
+> &
+  Required<Pick<TValue, TKey>>
 
 export type PickRequired<T> = {
   [K in keyof T as undefined extends T[K] ? never : K]: T[K]
@@ -19,26 +24,25 @@ export type Expand<T> = T extends object
     : never
   : T
 
-export type UnionToIntersection<U> = (
-  U extends any ? (k: U) => void : never
+export type UnionToIntersection<T> = (
+  T extends any ? (k: T) => void : never
 ) extends (k: infer I) => any
   ? I
   : never
 
-export type DeepOptional<T, K extends keyof T> = Pick<DeepPartial<T>, K> &
-  Omit<T, K>
-
 export type DeepPartial<T> = T extends object
   ? {
       [P in keyof T]?: DeepPartial<T[P]>
     }
   : T
 
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export type MakeDifferenceOptional<T, U> = Omit<U, keyof T> &
   Partial<Pick<U, keyof T & keyof U>> &
   PickRequired<Omit<U, keyof PickRequired<T>>>
 
 // from https://stackoverflow.com/a/53955431
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export type IsUnion<T, U extends T = T> = (
   T extends any ? (U extends T ? false : true) : never
 ) extends false
@@ -61,10 +65,13 @@ export type IsUnion<T, U extends T = T> = (
 //   }
 // >
 
-export type Assign<Left, Right> = Omit<Left, keyof Right> & Right
+export type Assign<TLeft, TRight> = Omit<TLeft, keyof TRight> & TRight
 
-export type AssignAll<T extends any[]> = T extends [infer Left, ...infer Right]
-  ? Right extends any[]
+export type AssignAll<T extends Array<any>> = T extends [
+  infer Left,
+  ...infer Right,
+]
+  ? Right extends Array<any>
     ? Assign<Left, AssignAll<Right>>
     : Left
   : {}
@@ -116,21 +123,21 @@ export type NonNullableUpdater<TPrevious, TResult = TPrevious> =
   | ((prev: TPrevious) => TResult)
 
 // from https://github.com/type-challenges/type-challenges/issues/737
-type LastInUnion<U> =
-  UnionToIntersection<U extends unknown ? (x: U) => 0 : never> extends (
+type LastInUnion<T> =
+  UnionToIntersection<T extends unknown ? (x: T) => 0 : never> extends (
     x: infer L,
   ) => 0
     ? L
     : never
-export type UnionToTuple<U, Last = LastInUnion<U>> = [U] extends [never]
+export type UnionToTuple<T, TLast = LastInUnion<T>> = [T] extends [never]
   ? []
-  : [...UnionToTuple<Exclude<U, Last>>, Last]
+  : [...UnionToTuple<Exclude<T, TLast>>, TLast]
 
 //
 
 export const isServer = typeof document === 'undefined'
 
-export function last<T>(arr: T[]) {
+export function last<T>(arr: Array<T>) {
   return arr[arr.length - 1]
 }
 
@@ -143,14 +150,17 @@ export function functionalUpdate<TResult>(
   previous: TResult,
 ): TResult {
   if (isFunction(updater)) {
-    return updater(previous as TResult)
+    return updater(previous)
   }
 
   return updater
 }
 
-export function pick<T, K extends keyof T>(parent: T, keys: K[]): Pick<T, K> {
-  return keys.reduce((obj: any, key: K) => {
+export function pick<TValue, TKey extends keyof TValue>(
+  parent: TValue,
+  keys: Array<TKey>,
+): Pick<TValue, TKey> {
+  return keys.reduce((obj: any, key: TKey) => {
     obj[key] = parent[key]
     return obj
   }, {} as any)
@@ -268,11 +278,13 @@ export function deepEqual(a: any, b: any, partial: boolean = false): boolean {
   return false
 }
 
-export function useStableCallback<T extends (...args: any[]) => any>(fn: T): T {
+export function useStableCallback<T extends (...args: Array<any>) => any>(
+  fn: T,
+): T {
   const fnRef = React.useRef(fn)
   fnRef.current = fn
 
-  const ref = React.useRef((...args: any[]) => fnRef.current(...args))
+  const ref = React.useRef((...args: Array<any>) => fnRef.current(...args))
   return ref.current as T
 }
 
@@ -295,10 +307,10 @@ export function shallow<T>(objA: T, objB: T) {
     return false
   }
 
-  for (let i = 0; i < keysA.length; i++) {
+  for (const item of keysA) {
     if (
-      !Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
-      !Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
+      !Object.prototype.hasOwnProperty.call(objB, item) ||
+      !Object.is(objA[item as keyof T], objB[item as keyof T])
     ) {
       return false
     }