refactor(router-core): Process routeTree into segment tree instead of flatRoutes [WIP] (#5722)

Author: Sheraff

docs/router/framework/react/api/router/MatchRouteOptionsType.md

@@ -8,7 +8,7 @@ The `MatchRouteOptions` type is used to describe the options that can be used wh
 ```tsx
 interface MatchRouteOptions {
   pending?: boolean
-  caseSensitive?: boolean
+  caseSensitive?: boolean /* @deprecated */
   includeSearch?: boolean
   fuzzy?: boolean
 }
@@ -24,11 +24,12 @@ The `MatchRouteOptions` type has the following properties:
 - Optional
 - If `true`, will match against pending location instead of the current location
 
-### `caseSensitive` property
+### ~~`caseSensitive`~~ property (deprecated)
 
 - Type: `boolean`
 - Optional
 - If `true`, will match against the current location with case sensitivity
+- Declare case sensitivity in the route definition instead, or globally for all routes using the `caseSensitive` option on the router
 
 ### `includeSearch` property
 

docs/router/framework/react/how-to/debug-router-issues.md

@@ -109,7 +109,7 @@ const route = createRoute({
 ```tsx
 // Debug route tree in console
 console.log('Route tree:', router.routeTree)
-console.log('All routes:', router.flatRoutes)
+console.log('All routes:', router.routesById)
 ```
 
 3. **Check Parent Route Configuration**

packages/react-router/src/index.tsx

@@ -8,10 +8,7 @@ export {
   trimPathRight,
   trimPath,
   resolvePath,
-  parsePathname,
   interpolatePath,
-  matchPathname,
-  matchByPath,
   rootRouteId,
   defaultSerializeError,
   defaultParseSearch,
@@ -37,7 +34,6 @@ export type {
   RemoveTrailingSlashes,
   RemoveLeadingSlashes,
   ActiveOptions,
-  Segment,
   ResolveRelativePath,
   RootRouteId,
   AnyPathParams,

packages/react-router/src/useBlocker.tsx

@@ -177,10 +177,7 @@ export function useBlocker(
         location: HistoryLocation,
       ): AnyShouldBlockFnLocation {
         const parsedLocation = router.parseLocation(location)
-        const matchedRoutes = router.getMatchedRoutes(
-          parsedLocation.pathname,
-          undefined,
-        )
+        const matchedRoutes = router.getMatchedRoutes(parsedLocation.pathname)
         if (matchedRoutes.foundRoute === undefined) {
           throw new Error(`No route found for location ${location.href}`)
         }

packages/react-router/tests/Matches.test.tsx

@@ -271,7 +271,7 @@ describe('matching on different param types', () => {
       path: '/optional-{-$id}',
       nav: '/optional-',
       params: {},
-      matchParams: { id: '' },
+      matchParams: {},
     },
     {
       name: 'optional param with suffix and value',
@@ -285,14 +285,14 @@ describe('matching on different param types', () => {
       path: '/{-$id}-optional',
       nav: '/-optional',
       params: {},
-      matchParams: { id: '' },
+      matchParams: {},
     },
     {
       name: 'optional param with required param, prefix, suffix, wildcard and no value',
       path: `/$foo/a{-$id}-optional/$`,
       nav: '/bar/a-optional/qux',
-      params: { foo: 'bar', id: '', _splat: 'qux', '*': 'qux' },
-      matchParams: { foo: 'bar', id: '', _splat: 'qux', '*': 'qux' },
+      params: { foo: 'bar', _splat: 'qux', '*': 'qux' },
+      matchParams: { foo: 'bar', _splat: 'qux', '*': 'qux' },
     },
     {
       name: 'optional param with required param, prefix, suffix, wildcard and value',

packages/react-router/tests/router.test.tsx

@@ -1697,18 +1697,6 @@ describe('route ids should be consistent after rebuilding the route tree', () =>
 })
 
 describe('route id uniqueness', () => {
-  it('flatRoute should not have routes with duplicated route ids', () => {
-    const { router } = createTestRouter({
-      history: createMemoryHistory({ initialEntries: ['/'] }),
-    })
-    const routeIdSet = new Set<string>()
-
-    router.flatRoutes.forEach((route) => {
-      expect(routeIdSet.has(route.id)).toBe(false)
-      routeIdSet.add(route.id)
-    })
-  })
-
   it('routesById should not have routes duplicated route ids', () => {
     const { router } = createTestRouter({
       history: createMemoryHistory({ initialEntries: ['/'] }),

packages/router-core/src/Matches.ts

@@ -272,6 +272,8 @@ export interface MatchRouteOptions {
    * If `true`, will match against the current location with case sensitivity.
    *
    * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/MatchRouteOptionsType#casesensitive-property)
+   *
+   * @deprecated Declare case sensitivity in the route definition instead, or globally for all routes using the `caseSensitive` option on the router.
    */
   caseSensitive?: boolean
   /**

packages/router-core/src/index.ts

@@ -100,12 +100,8 @@ export {
   removeTrailingSlash,
   exactPathTest,
   resolvePath,
-  parsePathname,
   interpolatePath,
-  matchPathname,
-  matchByPath,
 } from './path'
-export type { Segment } from './path'
 export { encode, decode } from './qss'
 export { rootRouteId } from './root'
 export type { RootRouteId } from './root'
@@ -193,8 +189,6 @@ export type {
   RootRoute,
   FilebaseRouteOptionsInterface,
 } from './route'
-export { processRouteTree } from './process-route-tree'
-export type { ProcessRouteTreeResult } from './process-route-tree'
 export {
   defaultSerializeError,
   getLocationChangeInfo,

packages/router-core/src/lru-cache.ts

@@ -1,6 +1,7 @@
 export type LRUCache<TKey, TValue> = {
   get: (key: TKey) => TValue | undefined
   set: (key: TKey, value: TValue) => void
+  clear: () => void
 }
 
 export function createLRUCache<TKey, TValue>(
@@ -64,5 +65,10 @@ export function createLRUCache<TKey, TValue>(
         cache.set(key, entry)
       }
     },
+    clear() {
+      cache.clear()
+      oldest = undefined
+      newest = undefined
+    },
   }
 }