@tanstack/react-router 1.2.6 → 1.3.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/react-router",
   "author": "Tanner Linsley",
-  "version": "1.2.6",
+  "version": "1.3.1",
   "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.2.6"
+    "@tanstack/history": "1.3.1"
   },
   "scripts": {
     "build": "rollup --config rollup.config.js"

package/src/fileRoute.ts

@@ -10,7 +10,6 @@ import {
   RouteOptions,
   UpdatableRouteOptions,
   Route,
-  AnyPathParams,
   RootRouteId,
   TrimPathLeft,
   RouteConstraints,

package/src/link.tsx

@@ -4,8 +4,6 @@ import { useRouter, useRouterState } from './RouterProvider'
 import { Trim } from './fileRoute'
 import { AnyRoute, ReactNode, RootSearchSchema } from './route'
 import {
-  AllParams,
-  FullSearchSchema,
   RouteByPath,
   RouteIds,
   RoutePaths,
@@ -17,7 +15,6 @@ import {
   NoInfer,
   NonNullableUpdater,
   PickRequired,
-  UnionToIntersection,
   Updater,
   WithoutEmpty,
   deepEqual,
@@ -190,7 +187,7 @@ export type ParamOptions<
       RootSearchSchema
     >
   >,
-  TToIndex = RouteByPath<TRouteTree, `${TTo}/`> extends never ? TTo : `${TTo}/`,
+  TToIndex = TTo extends '' ? '' : RouteByPath<TRouteTree, `${TTo}/`> extends never ? TTo : `${TTo}/`,
   TToParams = TToIndex extends ''
     ? TFromParams
     : never extends TResolved
@@ -248,18 +245,6 @@ export type ToPathOption<
       NoInfer<TTo> & string
     >
 
-export type ToIdOption<
-  TRouteTree extends AnyRoute = AnyRoute,
-  TFrom extends RoutePaths<TRouteTree> | undefined = undefined,
-  TTo extends string = '',
-> =
-  | TTo
-  | RelativeToPathAutoComplete<
-      RouteIds<TRouteTree>,
-      NoInfer<TFrom> extends string ? NoInfer<TFrom> : '',
-      NoInfer<TTo> & string
-    >
-
 export interface ActiveOptions {
   exact?: boolean
   includeHash?: boolean
@@ -285,24 +270,6 @@ export type LinkOptions<
   disabled?: boolean
 }
 
-export type CheckRelativePath<
-  TRouteTree extends AnyRoute,
-  TFrom,
-  TTo,
-> = TTo extends string
-  ? TFrom extends string
-    ? ResolveRelativePath<TFrom, TTo> extends RoutePaths<TRouteTree>
-      ? {}
-      : {
-          Error: `${TFrom} + ${TTo} resolves to ${ResolveRelativePath<
-            TFrom,
-            TTo
-          >}, which is not a valid route path.`
-          'Valid Route Paths': RoutePaths<TRouteTree>
-        }
-    : {}
-  : {}
-
 export type CheckPath<TRouteTree extends AnyRoute, TPath, TPass> = Exclude<
   TPath,
   RoutePaths<TRouteTree>
@@ -314,20 +281,6 @@ export type CheckPathError<TRouteTree extends AnyRoute, TInvalids> = {
   to: RoutePaths<TRouteTree>
 }
 
-export type CheckId<TRouteTree extends AnyRoute, TPath, TPass> = Exclude<
-  TPath,
-  RouteIds<TRouteTree>
-> extends never
-  ? TPass
-  : CheckIdError<TRouteTree, Exclude<TPath, RouteIds<TRouteTree>>>
-
-export type CheckIdError<TRouteTree extends AnyRoute, TInvalids> = {
-  Error: `${TInvalids extends string
-    ? TInvalids
-    : never} is not a valid route ID.`
-  'Valid Route IDs': RouteIds<TRouteTree>
-}
-
 export type ResolveRelativePath<TFrom, TTo = '.'> = TFrom extends string
   ? TTo extends string
     ? TTo extends '.'

package/src/route.ts

@@ -366,6 +366,104 @@ export type RouteConstraints = {
   TRouteTree: AnyRoute
 }
 
+// TODO: This is part of a future APi to move away from classes and
+// towards a more functional API. It's not ready yet.
+
+// type RouteApiInstance<
+//   TId extends RouteIds<RegisteredRouter['routeTree']>,
+//   TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>,
+//   TFullSearchSchema extends Record<
+//     string,
+//     any
+//   > = TRoute['types']['fullSearchSchema'],
+//   TAllParams extends AnyPathParams = TRoute['types']['allParams'],
+//   TAllContext extends Record<string, any> = TRoute['types']['allContext'],
+//   TLoaderDeps extends Record<string, any> = TRoute['types']['loaderDeps'],
+//   TLoaderData extends any = TRoute['types']['loaderData'],
+// > = {
+//   id: TId
+//   useMatch: <TSelected = TAllContext>(opts?: {
+//     select?: (s: TAllContext) => TSelected
+//   }) => TSelected
+
+//   useRouteContext: <TSelected = TAllContext>(opts?: {
+//     select?: (s: TAllContext) => TSelected
+//   }) => TSelected
+
+//   useSearch: <TSelected = TFullSearchSchema>(opts?: {
+//     select?: (s: TFullSearchSchema) => TSelected
+//   }) => TSelected
+
+//   useParams: <TSelected = TAllParams>(opts?: {
+//     select?: (s: TAllParams) => TSelected
+//   }) => TSelected
+
+//   useLoaderDeps: <TSelected = TLoaderDeps>(opts?: {
+//     select?: (s: TLoaderDeps) => TSelected
+//   }) => TSelected
+
+//   useLoaderData: <TSelected = TLoaderData>(opts?: {
+//     select?: (s: TLoaderData) => TSelected
+//   }) => TSelected
+// }
+
+// export function RouteApi_v2<
+//   TId extends RouteIds<RegisteredRouter['routeTree']>,
+//   TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>,
+//   TFullSearchSchema extends Record<
+//     string,
+//     any
+//   > = TRoute['types']['fullSearchSchema'],
+//   TAllParams extends AnyPathParams = TRoute['types']['allParams'],
+//   TAllContext extends Record<string, any> = TRoute['types']['allContext'],
+//   TLoaderDeps extends Record<string, any> = TRoute['types']['loaderDeps'],
+//   TLoaderData extends any = TRoute['types']['loaderData'],
+// >({
+//   id,
+// }: {
+//   id: TId
+// }): RouteApiInstance<
+//   TId,
+//   TRoute,
+//   TFullSearchSchema,
+//   TAllParams,
+//   TAllContext,
+//   TLoaderDeps,
+//   TLoaderData
+// > {
+//   return {
+//     id,
+
+//     useMatch: (opts) => {
+//       return useMatch({ ...opts, from: id })
+//     },
+
+//     useRouteContext: (opts) => {
+//       return useMatch({
+//         ...opts,
+//         from: id,
+//         select: (d: any) => (opts?.select ? opts.select(d.context) : d.context),
+//       } as any)
+//     },
+
+//     useSearch: (opts) => {
+//       return useSearch({ ...opts, from: id } as any)
+//     },
+
+//     useParams: (opts) => {
+//       return useParams({ ...opts, from: id } as any)
+//     },
+
+//     useLoaderDeps: (opts) => {
+//       return useLoaderDeps({ ...opts, from: id } as any) as any
+//     },
+
+//     useLoaderData: (opts) => {
+//       return useLoaderData({ ...opts, from: id } as any) as any
+//     },
+//   }
+// }
+
 export class RouteApi<
   TId extends RouteIds<RegisteredRouter['routeTree']>,
   TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>,

package/src/router.ts

@@ -51,7 +51,6 @@ import {
   joinPaths,
   matchPathname,
   parsePathname,
-  removeBasepath,
   resolvePath,
   trimPath,
   trimPathLeft,

package/src/utils.ts

@@ -2,25 +2,13 @@ import * as React from 'react'
 import { useMatch } from './Matches'
 import { RouteMatch } from './Matches'
 import { AnyRoute } from './route'
-import { ParseRoute, RouteIds, RoutesById, RouteById } from './routeInfo'
+import { RouteIds, RouteById } from './routeInfo'
 import { RegisteredRouter } from './router'
 
 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 IsAnyBoolean<T> = 1 extends 0 & T ? true : false
-export type IsKnown<T, Y, N> = unknown extends T ? N : Y
 export type PickAsRequired<T, K extends keyof T> = Omit<T, K> &
   Required<Pick<T, K>>
-export type PickAsPartial<T, K extends keyof T> = Omit<T, K> &
-  Partial<Pick<T, K>>
-export type PickUnsafe<T, K> = K extends keyof T ? Pick<T, K> : never
-export type PickExtra<T, K> = {
-  [TKey in keyof K as string extends TKey
-    ? never
-    : TKey extends keyof T
-      ? never
-      : TKey]: K[TKey]
-}
 
 export type PickRequired<T> = {
   [K in keyof T as undefined extends T[K] ? never : K]: T[K]
@@ -102,22 +90,6 @@ export type AssignAll<T extends any[]> = T extends [infer Left, ...infer Right]
 // // Using DeepMerge to merge TypeA and TypeB
 // type MergedType = Expand<AssignAll<[TypeA, TypeB, TypeC]>>
 
-export type Values<O> = O[ValueKeys<O>]
-export type ValueKeys<O> = Extract<keyof O, PropertyKey>
-
-export type DeepAwaited<T> = T extends Promise<infer A>
-  ? DeepAwaited<A>
-  : T extends Record<infer A, Promise<infer B>>
-    ? { [K in A]: DeepAwaited<B> }
-    : T
-
-export type PathParamMask<TRoutePath extends string> =
-  TRoutePath extends `${infer L}/$${infer C}/${infer R}`
-    ? PathParamMask<`${L}/${string}/${R}`>
-    : TRoutePath extends `${infer L}/$${infer C}`
-      ? PathParamMask<`${L}/${string}`>
-      : TRoutePath
-
 export type Timeout = ReturnType<typeof setTimeout>
 
 export type Updater<TPrevious, TResult = TPrevious> =
@@ -128,14 +100,6 @@ export type NonNullableUpdater<TPrevious, TResult = TPrevious> =
   | TResult
   | ((prev: TPrevious) => TResult)
 
-export type PickExtract<T, U> = {
-  [K in keyof T as T[K] extends U ? K : never]: T[K]
-}
-
-export type PickExclude<T, U> = {
-  [K in keyof T as T[K] extends U ? never : K]: T[K]
-}
-
 // from https://github.com/type-challenges/type-challenges/issues/737
 type LastInUnion<U> = UnionToIntersection<
   U extends unknown ? (x: U) => 0 : never
@@ -321,17 +285,6 @@ export type StrictOrFrom<TFrom> =
       strict: false
     }
 
-export type RouteFromIdOrRoute<
-  T,
-  TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
-> = T extends ParseRoute<TRouteTree>
-  ? T
-  : T extends RouteIds<TRouteTree>
-    ? RoutesById<TRouteTree>[T]
-    : T extends string
-      ? RouteIds<TRouteTree>
-      : never
-
 export function useRouteContext<
   TRouteTree extends AnyRoute = RegisteredRouter['routeTree'],
   TFrom extends RouteIds<TRouteTree> = RouteIds<TRouteTree>,