@tanstack/router-core 1.111.3 → 1.111.7

package/src/useNavigate.ts

@@ -0,0 +1,13 @@
+import type { NavigateOptions } from './link'
+import type { RegisteredRouter } from './router'
+
+export type UseNavigateResult<TDefaultFrom extends string> = <
+  TRouter extends RegisteredRouter,
+  TTo extends string | undefined,
+  TFrom extends string = TDefaultFrom,
+  TMaskFrom extends string = TFrom,
+  TMaskTo extends string = '',
+>({
+  from,
+  ...rest
+}: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<void>

package/src/useParams.ts

@@ -0,0 +1,20 @@
+import type { AllParams, RouteById } from './routeInfo'
+import type { AnyRouter } from './router'
+import type { Expand } from './utils'
+
+export type ResolveUseParams<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+> = TStrict extends false
+  ? AllParams<TRouter['routeTree']>
+  : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['allParams']>
+
+export type UseParamsResult<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+  TSelected,
+> = unknown extends TSelected
+  ? ResolveUseParams<TRouter, TFrom, TStrict>
+  : TSelected

package/src/useRouteContext.ts

@@ -0,0 +1,39 @@
+import type { AllContext, RouteById } from './routeInfo'
+import type { AnyRouter } from './router'
+import type { Expand, StrictOrFrom } from './utils'
+
+export interface UseRouteContextBaseOptions<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+  TSelected,
+> {
+  select?: (
+    search: ResolveUseRouteContext<TRouter, TFrom, TStrict>,
+  ) => TSelected
+}
+
+export type UseRouteContextOptions<
+  TRouter extends AnyRouter,
+  TFrom extends string | undefined,
+  TStrict extends boolean,
+  TSelected,
+> = StrictOrFrom<TRouter, TFrom, TStrict> &
+  UseRouteContextBaseOptions<TRouter, TFrom, TStrict, TSelected>
+
+export type ResolveUseRouteContext<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+> = TStrict extends false
+  ? AllContext<TRouter['routeTree']>
+  : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['allContext']>
+
+export type UseRouteContextResult<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+  TSelected,
+> = unknown extends TSelected
+  ? ResolveUseRouteContext<TRouter, TFrom, TStrict>
+  : TSelected

package/src/useSearch.ts

@@ -0,0 +1,20 @@
+import type { FullSearchSchema, RouteById } from './routeInfo'
+import type { AnyRouter } from './router'
+import type { Expand } from './utils'
+
+export type UseSearchResult<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+  TSelected,
+> = unknown extends TSelected
+  ? ResolveUseSearch<TRouter, TFrom, TStrict>
+  : TSelected
+
+export type ResolveUseSearch<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean,
+> = TStrict extends false
+  ? FullSearchSchema<TRouter['routeTree']>
+  : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['fullSearchSchema']>

package/src/utils.ts

@@ -1,3 +1,6 @@
+import type { RouteIds } from './routeInfo'
+import type { AnyRouter } from './router'
+
 export type NoInfer<T> = [T][T extends any ? 0 : never]
 export type IsAny<TValue, TYesResult, TNoResult = TValue> = 1 extends 0 & TValue
   ? TYesResult
@@ -330,6 +333,20 @@ export type ThrowOrOptional<T, TThrow extends boolean> = TThrow extends true
   ? T
   : T | undefined
 
+export type StrictOrFrom<
+  TRouter extends AnyRouter,
+  TFrom,
+  TStrict extends boolean = true,
+> = TStrict extends false
+  ? {
+      from?: never
+      strict: TStrict
+    }
+  : {
+      from: ConstrainLiteral<TFrom, RouteIds<TRouter['routeTree']>>
+      strict?: TStrict
+    }
+
 export type ControlledPromise<T> = Promise<T> & {
   resolve: (value: T) => void
   reject: (value: any) => void