@tanstack/router-core 1.171.2 → 1.171.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/router-core",
-  "version": "1.171.2",
+  "version": "1.171.4",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/index.ts

@@ -185,6 +185,7 @@ export type {
   RouteContextFn,
   ContextOptions,
   RouteContextOptions,
+  SsrContextOptions,
   BeforeLoadContextOptions,
   RootRouteOptions,
   RootRouteOptionsExtensions,
@@ -406,12 +407,9 @@ export {
   defaultGetScrollRestorationKey,
   getElementScrollRestorationEntry,
   storageKey,
-  scrollRestorationCache,
   setupScrollRestoration,
 } from './scroll-restoration'
 
-export { handleHashScroll } from './hash-scroll'
-
 export type {
   ScrollRestorationOptions,
   ScrollRestorationEntry,

package/src/rewrite.ts

@@ -1,7 +1,6 @@
 import { joinPaths, trimPath } from './path'
 import type { LocationRewrite } from './router'
 
-/** Compose multiple rewrite pairs into a single in/out rewrite. */
 /** Compose multiple rewrite pairs into a single in/out rewrite. */
 export function composeRewrites(rewrites: Array<LocationRewrite>) {
   return {
@@ -20,7 +19,6 @@ export function composeRewrites(rewrites: Array<LocationRewrite>) {
   } satisfies LocationRewrite
 }
 
-/** Create a rewrite pair that strips/adds a basepath on input/output. */
 /** Create a rewrite pair that strips/adds a basepath on input/output. */
 export function rewriteBasepath(opts: {
   basepath: string
@@ -28,13 +26,10 @@ export function rewriteBasepath(opts: {
 }) {
   const trimmedBasepath = trimPath(opts.basepath)
   const normalizedBasepath = `/${trimmedBasepath}`
-  const normalizedBasepathWithSlash = `${normalizedBasepath}/`
   const checkBasepath = opts.caseSensitive
     ? normalizedBasepath
     : normalizedBasepath.toLowerCase()
-  const checkBasepathWithSlash = opts.caseSensitive
-    ? normalizedBasepathWithSlash
-    : normalizedBasepathWithSlash.toLowerCase()
+  const checkBasepathWithSlash = `${checkBasepath}/`
 
   return {
     input: ({ url }) => {
@@ -58,7 +53,6 @@ export function rewriteBasepath(opts: {
   } satisfies LocationRewrite
 }
 
-/** Execute a location input rewrite if provided. */
 /** Execute a location input rewrite if provided. */
 export function executeRewriteInput(
   rewrite: LocationRewrite | undefined,
@@ -75,7 +69,6 @@ export function executeRewriteInput(
   return url
 }
 
-/** Execute a location output rewrite if provided. */
 /** Execute a location output rewrite if provided. */
 export function executeRewriteOutput(
   rewrite: LocationRewrite | undefined,

package/src/router.ts

@@ -52,6 +52,7 @@ import type {
 import type { SearchParser, SearchSerializer } from './searchParams'
 import type { AnyRedirect, ResolvedRedirect } from './redirect'
 import type {
+  HistoryAction,
   HistoryLocation,
   HistoryState,
   ParsedHistoryState,
@@ -740,7 +741,10 @@ export type GetMatchRoutesFn = (pathname: string) => {
 
 export type EmitFn = (routerEvent: RouterEvent) => void
 
-export type LoadFn = (opts?: { sync?: boolean }) => Promise<void>
+export type LoadFn = (opts?: {
+  sync?: boolean
+  action?: { type: HistoryAction }
+}) => Promise<void>
 
 export type CommitLocationFn = ({
   viewTransition,
@@ -883,6 +887,11 @@ export function getLocationChangeInfo(
   return { fromLocation, toLocation, pathChanged, hrefChanged, hashChanged }
 }
 
+export const locationHistoryActions = new WeakMap<
+  ParsedLocation,
+  HistoryAction
+>()
+
 export type CreateRouterFn = <
   TRouteTree extends AnyRoute,
   TTrailingSlashOption extends TrailingSlashOption = 'never',
@@ -2116,6 +2125,7 @@ export class RouterCore<
     ignoreBlocker,
     ...next
   }) => {
+    let historyAction: HistoryAction | undefined
     const isSameState = () => {
       // the following props are ignored but may still be provided when navigating,
       // temporarily add the previous values to the next state so they don't affect
@@ -2191,7 +2201,9 @@ export class RouterCore<
 
       this.shouldViewTransition = viewTransition
 
-      this.history[next.replace ? 'replace' : 'push'](
+      historyAction = next.replace ? 'REPLACE' : 'PUSH'
+
+      this.history[historyAction === 'REPLACE' ? 'replace' : 'push'](
         nextHistory.publicHref,
         nextHistory.state,
         { ignoreBlocker },
@@ -2201,7 +2213,13 @@ export class RouterCore<
     this.resetNextScroll = next.resetScroll ?? true
 
     if (!this.history.subscribers.size) {
-      this.load()
+      this.load(
+        historyAction
+          ? {
+              action: { type: historyAction },
+            }
+          : undefined,
+      )
     }
 
     return this.commitLocationPromise
@@ -2403,7 +2421,8 @@ export class RouterCore<
     })
   }
 
-  load: LoadFn = async (opts?: { sync?: boolean }): Promise<void> => {
+  load: LoadFn = async (opts): Promise<void> => {
+    const historyAction = opts?.action?.type
     let redirect: AnyRedirect | undefined
     let notFound: NotFoundError | undefined
     let loadPromise: Promise<void>
@@ -2415,6 +2434,11 @@ export class RouterCore<
       this.startTransition(async () => {
         try {
           this.beforeLoad()
+          if (historyAction) {
+            locationHistoryActions.set(this.latestLocation, historyAction)
+          } else {
+            locationHistoryActions.delete(this.latestLocation)
+          }
           const next = this.latestLocation
           const prevLocation = this.stores.resolvedLocation.get()
           const locationChangeInfo = getLocationChangeInfo(next, prevLocation)

package/src/scroll-restoration-inline.ts

@@ -1,9 +1,4 @@
-export default function (options: {
-  storageKey: string
-  key?: string
-  behavior?: ScrollToOptions['behavior']
-  shouldScrollRestoration?: boolean
-}) {
+export default function (options: { storageKey: string; key?: string }) {
   let byKey
 
   try {
@@ -15,13 +10,9 @@ export default function (options: {
 
   const resolvedKey = options.key || window.history.state?.__TSR_key
   const elementEntries = resolvedKey ? byKey[resolvedKey] : undefined
+  let windowRestored = false
 
-  if (
-    options.shouldScrollRestoration &&
-    elementEntries &&
-    typeof elementEntries === 'object' &&
-    Object.keys(elementEntries).length > 0
-  ) {
+  if (elementEntries && typeof elementEntries === 'object') {
     for (const elementSelector in elementEntries) {
       const entry = elementEntries[elementSelector]
 
@@ -40,8 +31,8 @@ export default function (options: {
         window.scrollTo({
           top: scrollY,
           left: scrollX,
-          behavior: options.behavior,
         })
+        windowRestored = true
       } else if (elementSelector) {
         let element
 
@@ -57,10 +48,10 @@ export default function (options: {
         }
       }
     }
-
-    return
   }
 
+  if (windowRestored) return
+
   const hash = window.location.hash.split('#', 2)[1]
 
   if (hash) {
@@ -77,5 +68,5 @@ export default function (options: {
     return
   }
 
-  window.scrollTo({ top: 0, left: 0, behavior: options.behavior })
+  window.scrollTo({ top: 0, left: 0 })
 }

package/src/scroll-restoration-script/server.ts

@@ -9,26 +9,18 @@ import type { AnyRouter } from '../router'
 type InlineScrollRestorationScriptOptions = {
   storageKey: string
   key?: string
-  behavior?: ScrollToOptions['behavior']
-  shouldScrollRestoration?: boolean
 }
 
 const defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(
   JSON.stringify({
     storageKey,
-    shouldScrollRestoration: true,
   } satisfies InlineScrollRestorationScriptOptions),
 )})`
 
 function getScrollRestorationScript(
   options: InlineScrollRestorationScriptOptions,
 ) {
-  if (
-    options.storageKey === storageKey &&
-    options.shouldScrollRestoration === true &&
-    options.key === undefined &&
-    options.behavior === undefined
-  ) {
+  if (options.storageKey === storageKey && options.key === undefined) {
     return defaultInlineScrollRestorationScript
   }
 
@@ -58,7 +50,6 @@ export function getScrollRestorationScriptForRouter(router: AnyRouter) {
 
   return getScrollRestorationScript({
     storageKey,
-    shouldScrollRestoration: true,
     key: userKey,
   })
 }