From 4d28d3dfcfa3cbafbd0776a4d644cd881de285e7 Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Sat, 20 Dec 2025 17:18:18 +0100 Subject: [PATCH 1/3] wip --- packages/react-router/src/Matches.tsx | 115 +++++--- packages/react-router/src/RouterProvider.tsx | 33 ++- packages/react-router/src/fileRoute.ts | 39 +-- packages/react-router/src/link.tsx | 59 +++-- packages/react-router/src/route.tsx | 101 +++---- .../react-router/src/ssr/RouterServer.tsx | 6 +- .../react-router/src/structuralSharing.ts | 26 +- packages/react-router/src/typePrimitives.ts | 19 +- packages/react-router/src/useBlocker.tsx | 43 +-- packages/react-router/src/useLoaderData.tsx | 49 ++-- packages/react-router/src/useLoaderDeps.tsx | 45 ++-- packages/react-router/src/useLocation.tsx | 30 ++- packages/react-router/src/useMatch.tsx | 55 ++-- packages/react-router/src/useNavigate.tsx | 27 +- packages/react-router/src/useParams.tsx | 51 ++-- packages/react-router/src/useRouteContext.ts | 39 ++- packages/react-router/src/useRouter.tsx | 6 +- packages/react-router/src/useRouterState.tsx | 43 ++- packages/react-router/src/useSearch.tsx | 42 +-- .../react-router/tests/Matches.test-d.tsx | 16 +- packages/router-core/src/link.ts | 249 ++++++++++-------- packages/router-core/src/redirect.ts | 24 +- packages/router-core/src/routeInfo.ts | 131 +++++---- packages/router-core/src/router.ts | 6 +- packages/router-core/src/typePrimitives.ts | 6 +- packages/router-core/src/useNavigate.ts | 11 +- packages/router-core/src/useParams.ts | 24 +- packages/router-core/src/utils.ts | 14 +- 28 files changed, 780 insertions(+), 529 deletions(-) diff --git a/packages/react-router/src/Matches.tsx b/packages/react-router/src/Matches.tsx index 0d64831d94..a4e83023bc 100644 --- a/packages/react-router/src/Matches.tsx +++ b/packages/react-router/src/Matches.tsx @@ -24,6 +24,7 @@ import type { MatchRouteOptions, NoInfer, RegisteredRouter, + Register, ResolveRelativePath, ResolveRoute, RouteByPath, @@ -112,15 +113,17 @@ function MatchesInner() { } export type UseMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = ToSubOptionsProps & - DeepPartial> & - DeepPartial> & - MaskOptions & +> = ToSubOptionsProps, TFrom, TTo> & + DeepPartial< + MakeOptionalSearchParams, TFrom, TTo> + > & + DeepPartial, TFrom, TTo>> & + MaskOptions, TMaskFrom, TMaskTo> & MatchRouteOptions /** @@ -135,8 +138,8 @@ export type UseMatchRouteOptions< * @returns A `matchRoute(options)` function that returns `false` or params. * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useMatchRouteHook */ -export function useMatchRoute() { - const router = useRouter() +export function useMatchRoute() { + const router = useRouter() useRouterState({ select: (s) => [s.location.href, s.resolvedLocation?.href, s.status], @@ -150,10 +153,16 @@ export function useMatchRoute() { const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - opts: UseMatchRouteOptions, + opts: UseMatchRouteOptions, ): | false - | Expand['types']['allParams']> => { + | Expand< + ResolveRoute< + RegisteredRouter, + TFrom, + TTo + >['types']['allParams'] + > => { const { pending, caseSensitive, fuzzy, includeSearch, ...rest } = opts return router.matchRoute(rest as any, { @@ -168,17 +177,17 @@ export function useMatchRoute() { } export type MakeMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = UseMatchRouteOptions & { +> = UseMatchRouteOptions & { // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns children?: | (( params?: RouteByPath< - TRouter['routeTree'], + RegisteredRouter['routeTree'], ResolveRelativePath> >['types']['allParams'], ) => React.ReactNode) @@ -193,13 +202,15 @@ export type MakeMatchRouteOptions< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/matchRouteComponent */ export function MatchRoute< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', ->(props: MakeMatchRouteOptions): any { - const matchRoute = useMatchRoute() +>( + props: MakeMatchRouteOptions, +): any { + const matchRoute = useMatchRoute() const params = matchRoute(props as any) as boolean if (typeof props.children === 'function') { @@ -210,37 +221,49 @@ export function MatchRoute< } export interface UseMatchesBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, TStructuralSharing, > { select?: ( - matches: Array>, - ) => ValidateSelected + matches: Array>>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > } export type UseMatchesResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? Array> : TSelected +> = unknown extends TSelected + ? Array>> + : TSelected export function useMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseMatchesBaseOptions & - StructuralSharingOption, -): UseMatchesResult { - return useRouterState({ - select: (state: RouterState) => { + opts?: UseMatchesBaseOptions & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +): UseMatchesResult { + return useRouterState({ + select: (state: RouterState['routeTree']>) => { const matches = state.matches return opts?.select - ? opts.select(matches as Array>) + ? opts.select( + matches as Array>>, + ) : matches }, structuralSharing: opts?.structuralSharing, - } as any) as UseMatchesResult + } as any) as UseMatchesResult } /** @@ -260,17 +283,23 @@ export function useMatches< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useMatchesHook */ export function useParentMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseMatchesBaseOptions & - StructuralSharingOption, -): UseMatchesResult { + opts?: UseMatchesBaseOptions & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +): UseMatchesResult { const contextMatchId = React.useContext(matchContext) - return useMatches({ - select: (matches: Array>) => { + return useMatches({ + select: ( + matches: Array>>, + ) => { matches = matches.slice( 0, matches.findIndex((d) => d.id === contextMatchId), @@ -286,17 +315,23 @@ export function useParentMatches< * match (or selected parent) in the match tree. */ export function useChildMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseMatchesBaseOptions & - StructuralSharingOption, -): UseMatchesResult { + opts?: UseMatchesBaseOptions & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +): UseMatchesResult { const contextMatchId = React.useContext(matchContext) - return useMatches({ - select: (matches: Array>) => { + return useMatches({ + select: ( + matches: Array>>, + ) => { matches = matches.slice( matches.findIndex((d) => d.id === contextMatchId) + 1, ) diff --git a/packages/react-router/src/RouterProvider.tsx b/packages/react-router/src/RouterProvider.tsx index fd2aeb1eef..a177ac9f12 100644 --- a/packages/react-router/src/RouterProvider.tsx +++ b/packages/react-router/src/RouterProvider.tsx @@ -3,6 +3,7 @@ import { Matches } from './Matches' import { getRouterContext } from './routerContext' import type { AnyRouter, + Register, RegisteredRouter, RouterOptions, } from '@tanstack/router-core' @@ -12,13 +13,13 @@ import type { * updates router options from props. Most apps should use `RouterProvider`. */ export function RouterContextProvider< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, >({ router, children, ...rest -}: RouterProps & { +}: RouterProps & { children: React.ReactNode }) { if (Object.keys(rest).length > 0) { @@ -58,9 +59,9 @@ export function RouterContextProvider< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRouterFunction */ export function RouterProvider< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, ->({ router, ...rest }: RouterProps) { +>({ router, ...rest }: RouterProps) { return ( @@ -69,25 +70,29 @@ export function RouterProvider< } export type RouterProps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, > = Omit< RouterOptions< - TRouter['routeTree'], - NonNullable, - NonNullable, - TRouter['history'], + RegisteredRouter['routeTree'], + NonNullable['options']['trailingSlash']>, + NonNullable< + RegisteredRouter['options']['defaultStructuralSharing'] + >, + RegisteredRouter['history'], TDehydrated >, 'context' > & { - router: TRouter + router: RegisteredRouter context?: Partial< RouterOptions< - TRouter['routeTree'], - NonNullable, - NonNullable, - TRouter['history'], + RegisteredRouter['routeTree'], + NonNullable['options']['trailingSlash']>, + NonNullable< + RegisteredRouter['options']['defaultStructuralSharing'] + >, + RegisteredRouter['history'], TDehydrated >['context'] > diff --git a/packages/react-router/src/fileRoute.ts b/packages/react-router/src/fileRoute.ts index 7af8877d1a..de94baf6f8 100644 --- a/packages/react-router/src/fileRoute.ts +++ b/packages/react-router/src/fileRoute.ts @@ -192,13 +192,13 @@ export function FileRouteLoader< declare module '@tanstack/router-core' { export interface LazyRoute { - useMatch: UseMatchRoute - useRouteContext: UseRouteContextRoute - useSearch: UseSearchRoute - useParams: UseParamsRoute - useLoaderDeps: UseLoaderDepsRoute - useLoaderData: UseLoaderDataRoute - useNavigate: () => UseNavigateResult + useMatch: UseMatchRoute + useRouteContext: UseRouteContextRoute + useSearch: UseSearchRoute + useParams: UseParamsRoute + useLoaderDeps: UseLoaderDepsRoute + useLoaderData: UseLoaderDataRoute + useNavigate: () => UseNavigateResult } } @@ -216,7 +216,7 @@ export class LazyRoute { ;(this as any).$$typeof = Symbol.for('react.memo') } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.options.id, @@ -224,14 +224,14 @@ export class LazyRoute { } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ from: this.options.id, select: (d: any) => (opts?.select ? opts.select(d.context) : d.context), }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useSearch({ select: opts?.select, @@ -240,7 +240,7 @@ export class LazyRoute { } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useParams({ select: opts?.select, @@ -249,15 +249,15 @@ export class LazyRoute { } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.options.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.options.id } as any) } - useNavigate = (): UseNavigateResult => { + useNavigate = (): UseNavigateResult => { const router = useRouter() return useNavigate({ from: router.routesById[this.options.id].fullPath }) } @@ -276,10 +276,15 @@ export class LazyRoute { * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createLazyRouteFunction */ export function createLazyRoute< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TId extends string = string, - TRoute extends AnyRoute = RouteById, ->(id: ConstrainLiteral>) { + TRoute extends AnyRoute = RouteById< + RegisteredRouter['routeTree'], + TId + >, +>( + id: ConstrainLiteral['routeTree']>>, +) { return (opts: LazyRouteOptions) => { return new LazyRoute({ id: id, diff --git a/packages/react-router/src/link.tsx b/packages/react-router/src/link.tsx index 365464bf01..2695f88531 100644 --- a/packages/react-router/src/link.tsx +++ b/packages/react-router/src/link.tsx @@ -18,6 +18,7 @@ import type { LinkOptions, RegisteredRouter, RoutePaths, + Register, } from '@tanstack/router-core' import type { ReactNode } from 'react' import type { @@ -38,16 +39,16 @@ import type { * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLinkPropsHook */ export function useLinkProps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - options: UseLinkPropsOptions, + options: UseLinkPropsOptions, forwardedRef?: React.ForwardedRef, ): React.ComponentPropsWithRef<'a'> { - const router = useRouter() + const router = useRouter() const [isTransitioning, setIsTransitioning] = React.useState(false) const hasRenderFetched = React.useRef(false) const innerRef = useForwardedRef(forwardedRef) @@ -278,7 +279,7 @@ export function useLinkProps< startTransition, viewTransition, ignoreBlocker, - }) + } as any) } } @@ -416,22 +417,22 @@ type UseLinkReactProps = TComp extends keyof React.JSX.IntrinsicElements : never export type UseLinkPropsOptions< - TRouter extends AnyRouter = RegisteredRouter, - TFrom extends RoutePaths | string = string, - TTo extends string | undefined = '.', - TMaskFrom extends RoutePaths | string = TFrom, - TMaskTo extends string = '.', -> = ActiveLinkOptions<'a', TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & - UseLinkReactProps<'a'> - -export type ActiveLinkOptions< - TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = LinkOptions & +> = ActiveLinkOptions<'a', TRegister, TFrom, TTo, TMaskFrom, TMaskTo> & + UseLinkReactProps<'a'> + +export type ActiveLinkOptions< + TComp = 'a', + TRegister extends Register = Register, + TFrom extends string = string, + TTo extends string | undefined = '.', + TMaskFrom extends string = TFrom, + TMaskTo extends string = '.', +> = LinkOptions & ActiveLinkOptionProps type ActiveLinkProps = Partial< @@ -455,12 +456,12 @@ export interface ActiveLinkOptionProps { export type LinkProps< TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = ActiveLinkOptions & +> = ActiveLinkOptions & LinkPropsChildren export interface LinkPropsChildren { @@ -480,13 +481,13 @@ type LinkComponentReactProps = Omit< export type LinkComponentProps< TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', > = LinkComponentReactProps & - LinkProps + LinkProps export type CreateLinkProps = LinkProps< any, @@ -501,13 +502,13 @@ export type LinkComponent< in out TComp, in out TDefaultFrom extends string = string, > = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = TDefaultFrom, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - props: LinkComponentProps, + props: LinkComponentProps, ) => React.ReactElement export interface LinkComponentRoute< @@ -515,13 +516,13 @@ export interface LinkComponentRoute< > { defaultFrom: TDefaultFrom < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TTo extends string | undefined = undefined, const TMaskTo extends string = '', >( props: LinkComponentProps< 'a', - TRouter, + TRegister, this['defaultFrom'], TTo, this['defaultFrom'], @@ -606,17 +607,17 @@ function isCtrlEvent(e: React.MouseEvent) { export type LinkOptionsFnOptions< TOptions, TComp, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = TOptions extends ReadonlyArray - ? ValidateLinkOptionsArray - : ValidateLinkOptions + ? ValidateLinkOptionsArray + : ValidateLinkOptions export type LinkOptionsFn = < const TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, >( - options: LinkOptionsFnOptions, + options: LinkOptionsFnOptions, ) => TOptions /** diff --git a/packages/react-router/src/route.tsx b/packages/react-router/src/route.tsx index 3fb7716e7a..7553516f4b 100644 --- a/packages/react-router/src/route.tsx +++ b/packages/react-router/src/route.tsx @@ -67,13 +67,13 @@ declare module '@tanstack/router-core' { in out TId extends string, in out TFullPath extends string, > { - useMatch: UseMatchRoute - useRouteContext: UseRouteContextRoute - useSearch: UseSearchRoute - useParams: UseParamsRoute - useLoaderDeps: UseLoaderDepsRoute - useLoaderData: UseLoaderDataRoute - useNavigate: () => UseNavigateResult + useMatch: UseMatchRoute + useRouteContext: UseRouteContextRoute + useSearch: UseSearchRoute + useParams: UseParamsRoute + useLoaderDeps: UseLoaderDepsRoute + useLoaderData: UseLoaderDataRoute + useNavigate: () => UseNavigateResult Link: LinkComponentRoute } } @@ -87,17 +87,16 @@ declare module '@tanstack/router-core' { * @returns A `RouteApi` instance bound to the given route ID. * @link https://tanstack.com/router/latest/docs/framework/react/api/router/getRouteApiFunction */ -export function getRouteApi< - const TId, - TRouter extends AnyRouter = RegisteredRouter, ->(id: ConstrainLiteral>) { - return new RouteApi({ id }) +export function getRouteApi( + id: ConstrainLiteral['routeTree']>>, +) { + return new RouteApi({ id }) } export class RouteApi< TId, - TRouter extends AnyRouter = RegisteredRouter, -> extends BaseRouteApi { + TRegister extends Register = Register, +> extends BaseRouteApi> { /** * @deprecated Use the `getRouteApi` function instead. */ @@ -105,7 +104,7 @@ export class RouteApi< super({ id }) } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, @@ -113,14 +112,14 @@ export class RouteApi< } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ from: this.id as any, select: (d) => (opts?.select ? opts.select(d.context) : d.context), }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useSearch({ select: opts?.select, @@ -129,7 +128,7 @@ export class RouteApi< } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useParams({ select: opts?.select, @@ -138,16 +137,17 @@ export class RouteApi< } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id, strict: false } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id, strict: false } as any) } useNavigate = (): UseNavigateResult< - RouteTypesById['fullPath'] + TRegister, + RouteTypesById, TId>['fullPath'] > => { const router = useRouter() return useNavigate({ from: router.routesById[this.id as string].fullPath }) @@ -157,18 +157,19 @@ export class RouteApi< return notFound({ routeId: this.id as string, ...opts }) } - Link: LinkComponentRoute['fullPath']> = - React.forwardRef((props, ref: React.ForwardedRef) => { - const router = useRouter() - const fullPath = router.routesById[this.id as string].fullPath - return - }) as unknown as LinkComponentRoute< - RouteTypesById['fullPath'] - > + Link: LinkComponentRoute< + RouteTypesById, TId>['fullPath'] + > = React.forwardRef((props, ref: React.ForwardedRef) => { + const router = useRouter() + const fullPath = router.routesById[this.id as string].fullPath + return + }) as unknown as LinkComponentRoute< + RouteTypesById, TId>['fullPath'] + > } export class Route< - in out TRegister = unknown, + in out TRegister extends Register = Register, in out TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, in out TPath extends RouteConstraints['TPath'] = '/', in out TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath< @@ -263,7 +264,7 @@ export class Route< ;(this as any).$$typeof = Symbol.for('react.memo') } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, @@ -271,7 +272,7 @@ export class Route< } as any) as any } - useRouteContext: UseRouteContextRoute = (opts?) => { + useRouteContext: UseRouteContextRoute = (opts?) => { return useMatch({ ...opts, from: this.id, @@ -279,7 +280,7 @@ export class Route< }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useSearch({ select: opts?.select, @@ -288,7 +289,7 @@ export class Route< } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useParams({ select: opts?.select, @@ -297,15 +298,15 @@ export class Route< } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id } as any) } - useNavigate = (): UseNavigateResult => { + useNavigate = (): UseNavigateResult => { return useNavigate({ from: this.fullPath }) } @@ -328,7 +329,7 @@ export class Route< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRouteFunction */ export function createRoute< - TRegister = unknown, + TRegister extends Register = Register, TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath< @@ -434,7 +435,7 @@ export type AnyRootRoute = RootRoute< */ export function createRootRouteWithContext() { return < - TRegister = Register, + TRegister extends Register = Register, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TSearchValidator = undefined, @@ -475,7 +476,7 @@ export function createRootRouteWithContext() { export const rootRouteWithContext = createRootRouteWithContext export class RootRoute< - in out TRegister = unknown, + in out TRegister extends Register = Register, in out TSearchValidator = undefined, in out TRouterContext = {}, in out TRouteContextFn = AnyContext, @@ -539,7 +540,7 @@ export class RootRoute< ;(this as any).$$typeof = Symbol.for('react.memo') } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, @@ -547,7 +548,7 @@ export class RootRoute< } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ ...opts, from: this.id, @@ -555,7 +556,7 @@ export class RootRoute< }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useSearch({ select: opts?.select, @@ -564,7 +565,7 @@ export class RootRoute< } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion return useParams({ select: opts?.select, @@ -573,15 +574,15 @@ export class RootRoute< } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id } as any) } - useNavigate = (): UseNavigateResult<'/'> => { + useNavigate = (): UseNavigateResult => { return useNavigate({ from: this.fullPath }) } @@ -603,7 +604,7 @@ export class RootRoute< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRootRouteFunction */ export function createRootRoute< - TRegister = Register, + TRegister extends Register = Register, TSearchValidator = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, @@ -663,7 +664,7 @@ export function createRouteMask< >( opts: { routeTree: TRouteTree - } & ToMaskOptions, TFrom, TTo>, + } & ToMaskOptions, ): RouteMask { return opts as any } @@ -686,7 +687,7 @@ export type ErrorRouteComponent = AsyncRouteComponent export type NotFoundRouteComponent = RouteTypes['component'] export class NotFoundRoute< - TRegister, + TRegister extends Register, TParentRoute extends AnyRootRoute, TRouterContext = AnyContext, TRouteContextFn = AnyContext, diff --git a/packages/react-router/src/ssr/RouterServer.tsx b/packages/react-router/src/ssr/RouterServer.tsx index c0199cb05c..c824d2a332 100644 --- a/packages/react-router/src/ssr/RouterServer.tsx +++ b/packages/react-router/src/ssr/RouterServer.tsx @@ -1,9 +1,9 @@ import * as React from 'react' import { RouterProvider } from '../RouterProvider' -import type { AnyRouter } from '@tanstack/router-core' +import type { Register, RegisteredRouter } from '@tanstack/router-core' -export function RouterServer(props: { - router: TRouter +export function RouterServer(props: { + router: RegisteredRouter }) { return } diff --git a/packages/react-router/src/structuralSharing.ts b/packages/react-router/src/structuralSharing.ts index 7810a1ec52..34356cab33 100644 --- a/packages/react-router/src/structuralSharing.ts +++ b/packages/react-router/src/structuralSharing.ts @@ -2,46 +2,52 @@ import type { AnyRouter, Constrain, OptionalStructuralSharing, + Register, + RegisteredRouter, ValidateJSON, } from '@tanstack/router-core' -export type DefaultStructuralSharingEnabled = - boolean extends TRouter['options']['defaultStructuralSharing'] +export type DefaultStructuralSharingEnabled< + TRegister extends Register = Register, +> = + boolean extends RegisteredRouter['options']['defaultStructuralSharing'] ? // for now, default to false. // TODO in V2: default to true false - : NonNullable + : NonNullable< + RegisteredRouter['options']['defaultStructuralSharing'] + > export interface RequiredStructuralSharing { readonly structuralSharing: Constrain } export type StructuralSharingOption< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, TStructuralSharing, > = unknown extends TSelected ? OptionalStructuralSharing - : unknown extends TRouter['routeTree'] + : unknown extends RegisteredRouter['routeTree'] ? OptionalStructuralSharing : TSelected extends ValidateJSON ? OptionalStructuralSharing - : DefaultStructuralSharingEnabled extends true + : DefaultStructuralSharingEnabled extends true ? RequiredStructuralSharing : OptionalStructuralSharing export type StructuralSharingEnabled< - TRouter extends AnyRouter, + TRegister extends Register, TStructuralSharing, > = boolean extends TStructuralSharing - ? DefaultStructuralSharingEnabled + ? DefaultStructuralSharingEnabled : TStructuralSharing export type ValidateSelected< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, TStructuralSharing, > = - StructuralSharingEnabled extends true + StructuralSharingEnabled extends true ? ValidateJSON : TSelected diff --git a/packages/react-router/src/typePrimitives.ts b/packages/react-router/src/typePrimitives.ts index 317ab260c8..8d87c8331c 100644 --- a/packages/react-router/src/typePrimitives.ts +++ b/packages/react-router/src/typePrimitives.ts @@ -9,13 +9,14 @@ import type { InferStrict, InferTo, RegisteredRouter, + Register, } from '@tanstack/router-core' import type { LinkComponentProps } from './link' import type { UseParamsOptions } from './useParams' import type { UseSearchOptions } from './useSearch' export type ValidateLinkOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions = unknown, TDefaultFrom extends string = string, TComp = 'a', @@ -23,7 +24,7 @@ export type ValidateLinkOptions< TOptions, LinkComponentProps< TComp, - TRouter, + TRegister, InferFrom, InferTo, InferMaskFrom, @@ -42,11 +43,11 @@ export type InferStructuralSharing = TOptions extends { export type ValidateUseSearchOptions< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = Constrain< TOptions, UseSearchOptions< - TRouter, + TRegister, InferFrom, InferStrict, InferShouldThrow, @@ -57,26 +58,26 @@ export type ValidateUseSearchOptions< export type ValidateUseParamsOptions< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = Constrain< TOptions, UseParamsOptions< - TRouter, + TRegister, InferFrom, InferStrict, InferShouldThrow, InferSelected, - InferSelected + InferStructuralSharing > > export type ValidateLinkOptionsArray< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions extends ReadonlyArray = ReadonlyArray, TDefaultFrom extends string = string, TComp = 'a', > = { [K in keyof TOptions]: ValidateLinkOptions< - TRouter, + TRegister, TOptions[K], TDefaultFrom, TComp diff --git a/packages/react-router/src/useBlocker.tsx b/packages/react-router/src/useBlocker.tsx index 209af19501..80da7edb34 100644 --- a/packages/react-router/src/useBlocker.tsx +++ b/packages/react-router/src/useBlocker.tsx @@ -9,6 +9,7 @@ import type { AnyRoute, AnyRouter, ParseRoute, + Register, RegisteredRouter, } from '@tanstack/router-core' @@ -27,8 +28,10 @@ interface ShouldBlockFnLocation< type AnyShouldBlockFnLocation = ShouldBlockFnLocation type MakeShouldBlockFnLocationUnion< - TRouter extends AnyRouter = RegisteredRouter, - TRoute extends AnyRoute = ParseRoute, + TRegister extends Register = Register, + TRoute extends AnyRoute = ParseRoute< + RegisteredRouter['routeTree'] + >, > = TRoute extends any ? ShouldBlockFnLocation< TRoute['id'], @@ -38,11 +41,11 @@ type MakeShouldBlockFnLocationUnion< > : never -type BlockerResolver = +type BlockerResolver = | { status: 'blocked' - current: MakeShouldBlockFnLocationUnion - next: MakeShouldBlockFnLocationUnion + current: MakeShouldBlockFnLocationUnion + next: MakeShouldBlockFnLocationUnion action: HistoryAction proceed: () => void reset: () => void @@ -56,20 +59,20 @@ type BlockerResolver = reset: undefined } -type ShouldBlockFnArgs = { - current: MakeShouldBlockFnLocationUnion - next: MakeShouldBlockFnLocationUnion +type ShouldBlockFnArgs = { + current: MakeShouldBlockFnLocationUnion + next: MakeShouldBlockFnLocationUnion action: HistoryAction } -export type ShouldBlockFn = ( - args: ShouldBlockFnArgs, +export type ShouldBlockFn = ( + args: ShouldBlockFnArgs, ) => boolean | Promise export type UseBlockerOpts< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, > = { - shouldBlockFn: ShouldBlockFn + shouldBlockFn: ShouldBlockFn enableBeforeUnload?: boolean | (() => boolean) disabled?: boolean withResolver?: TWithResolver @@ -129,11 +132,11 @@ function _resolveBlockerOpts( } export function useBlocker< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = false, >( - opts: UseBlockerOpts, -): TWithResolver extends true ? BlockerResolver : void + opts: UseBlockerOpts, +): TWithResolver extends true ? BlockerResolver : void /** * @deprecated Use the shouldBlockFn property instead @@ -284,9 +287,9 @@ const _resolvePromptBlockerArgs = ( } export function Block< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, ->(opts: PromptProps): React.ReactNode +>(opts: PromptProps): React.ReactNode /** * @deprecated Use the UseBlockerOpts property instead @@ -312,9 +315,9 @@ type LegacyPromptProps = { } type PromptProps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, - TParams = TWithResolver extends true ? BlockerResolver : void, -> = UseBlockerOpts & { + TParams = TWithResolver extends true ? BlockerResolver : void, +> = UseBlockerOpts & { children?: React.ReactNode | ((params: TParams) => React.ReactNode) } diff --git a/packages/react-router/src/useLoaderData.tsx b/packages/react-router/src/useLoaderData.tsx index eb82a40461..a55183e3fd 100644 --- a/packages/react-router/src/useLoaderData.tsx +++ b/packages/react-router/src/useLoaderData.tsx @@ -5,6 +5,7 @@ import type { } from './structuralSharing' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderData, StrictOrFrom, @@ -12,47 +13,58 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDataBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, TStructuralSharing, > { select?: ( - match: ResolveUseLoaderData, - ) => ValidateSelected + match: ResolveUseLoaderData, TFrom, TStrict>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > } export type UseLoaderDataOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom & +> = StrictOrFrom, TFrom, TStrict> & UseLoaderDataBaseOptions< - TRouter, + TRegister, TFrom, TStrict, TSelected, TStructuralSharing > & - StructuralSharingOption + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseLoaderDataRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseLoaderDataRoute = < TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts?: UseLoaderDataBaseOptions< - TRouter, + TRegister, TId, true, TSelected, TStructuralSharing > & - StructuralSharingOption, -) => UseLoaderDataResult + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => UseLoaderDataResult, TId, true, TSelected> /** * Read and select the current route's loader data with type‑safety. @@ -66,20 +78,20 @@ export type UseLoaderDataRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLoaderDataHook */ export function useLoaderData< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts: UseLoaderDataOptions< - TRouter, + TRegister, TFrom, TStrict, TSelected, TStructuralSharing >, -): UseLoaderDataResult { +): UseLoaderDataResult, TFrom, TStrict, TSelected> { return useMatch({ from: opts.from!, strict: opts.strict, @@ -87,5 +99,10 @@ export function useLoaderData< select: (s: any) => { return opts.select ? opts.select(s.loaderData) : s.loaderData }, - } as any) as UseLoaderDataResult + } as any) as UseLoaderDataResult< + RegisteredRouter, + TFrom, + TStrict, + TSelected + > } diff --git a/packages/react-router/src/useLoaderDeps.tsx b/packages/react-router/src/useLoaderDeps.tsx index bab8cbdf36..309256c9f6 100644 --- a/packages/react-router/src/useLoaderDeps.tsx +++ b/packages/react-router/src/useLoaderDeps.tsx @@ -5,6 +5,7 @@ import type { } from './structuralSharing' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderDeps, StrictOrFrom, @@ -12,33 +13,45 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDepsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TSelected, TStructuralSharing, > { select?: ( - deps: ResolveUseLoaderDeps, - ) => ValidateSelected + deps: ResolveUseLoaderDeps, TFrom>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > } export type UseLoaderDepsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TSelected, TStructuralSharing, -> = StrictOrFrom & - UseLoaderDepsBaseOptions & - StructuralSharingOption +> = StrictOrFrom, TFrom> & + UseLoaderDepsBaseOptions & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseLoaderDepsRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseLoaderDepsRoute = < TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseLoaderDepsBaseOptions & - StructuralSharingOption, -) => UseLoaderDepsResult + opts?: UseLoaderDepsBaseOptions< + TRegister, + TId, + TSelected, + TStructuralSharing + > & + StructuralSharingOption, TSelected, false>, +) => UseLoaderDepsResult, TId, TSelected> /** * Read and select the current route's loader dependencies object. @@ -52,18 +65,18 @@ export type UseLoaderDepsRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLoaderDepsHook */ export function useLoaderDeps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts: UseLoaderDepsOptions, -): UseLoaderDepsResult { + opts: UseLoaderDepsOptions, +): UseLoaderDepsResult, TFrom, TSelected> { const { select, ...rest } = opts return useMatch({ ...rest, select: (s) => { return select ? select(s.loaderDeps) : s.loaderDeps }, - }) as UseLoaderDepsResult + }) as UseLoaderDepsResult, TFrom, TSelected> } diff --git a/packages/react-router/src/useLocation.tsx b/packages/react-router/src/useLocation.tsx index f0bcc8fffc..683c7e8307 100644 --- a/packages/react-router/src/useLocation.tsx +++ b/packages/react-router/src/useLocation.tsx @@ -4,26 +4,30 @@ import type { ValidateSelected, } from './structuralSharing' import type { - AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' export interface UseLocationBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, TStructuralSharing extends boolean = boolean, > { select?: ( - state: RouterState['location'], - ) => ValidateSelected + state: RouterState['routeTree']>['location'], + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > } export type UseLocationResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, > = unknown extends TSelected - ? RouterState['location'] + ? RouterState['routeTree']>['location'] : TSelected /** @@ -38,15 +42,19 @@ export type UseLocationResult< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLocationHook */ export function useLocation< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseLocationBaseOptions & - StructuralSharingOption, -): UseLocationResult { + opts?: UseLocationBaseOptions & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +): UseLocationResult { return useRouterState({ select: (state: any) => opts?.select ? opts.select(state.location) : state.location, - } as any) as UseLocationResult + } as any) as UseLocationResult } diff --git a/packages/react-router/src/useMatch.tsx b/packages/react-router/src/useMatch.tsx index 0f362a2c5b..9931314aa2 100644 --- a/packages/react-router/src/useMatch.tsx +++ b/packages/react-router/src/useMatch.tsx @@ -10,6 +10,7 @@ import type { AnyRouter, MakeRouteMatch, MakeRouteMatchUnion, + Register, RegisteredRouter, StrictOrFrom, ThrowConstraint, @@ -17,7 +18,7 @@ import type { } from '@tanstack/router-core' export interface UseMatchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, @@ -25,54 +26,69 @@ export interface UseMatchBaseOptions< TStructuralSharing extends boolean, > { select?: ( - match: MakeRouteMatch, - ) => ValidateSelected + match: MakeRouteMatch< + RegisteredRouter['routeTree'], + TFrom, + TStrict + >, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > shouldThrow?: TThrow } -export type UseMatchRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseMatchRoute = < TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts?: UseMatchBaseOptions< - TRouter, + TRegister, TFrom, true, true, TSelected, TStructuralSharing > & - StructuralSharingOption, -) => UseMatchResult + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => UseMatchResult export type UseMatchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, TStructuralSharing extends boolean, -> = StrictOrFrom & +> = StrictOrFrom, TFrom, TStrict> & UseMatchBaseOptions< - TRouter, + TRegister, TFrom, TStrict, TThrow, TSelected, TStructuralSharing > & - StructuralSharingOption + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > export type UseMatchResult< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected ? TStrict extends true - ? MakeRouteMatch - : MakeRouteMatchUnion + ? MakeRouteMatch['routeTree'], TFrom, TStrict> + : MakeRouteMatchUnion> : TSelected /** @@ -80,7 +96,7 @@ export type UseMatchResult< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useMatchHook */ export function useMatch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, @@ -88,14 +104,17 @@ export function useMatch< TStructuralSharing extends boolean = boolean, >( opts: UseMatchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected, TStructuralSharing >, -): ThrowOrOptional, TThrow> { +): ThrowOrOptional< + UseMatchResult, + TThrow +> { const nearestMatchId = React.useContext( opts.from ? dummyMatchContext : matchContext, ) diff --git a/packages/react-router/src/useNavigate.tsx b/packages/react-router/src/useNavigate.tsx index f697d0fbdd..55ac87d90d 100644 --- a/packages/react-router/src/useNavigate.tsx +++ b/packages/react-router/src/useNavigate.tsx @@ -2,10 +2,9 @@ import * as React from 'react' import { useLayoutEffect } from './utils' import { useRouter } from './useRouter' import type { - AnyRouter, FromPathOption, NavigateOptions, - RegisteredRouter, + Register, UseNavigateResult, } from '@tanstack/router-core' @@ -24,22 +23,22 @@ import type { * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useNavigateHook */ export function useNavigate< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDefaultFrom extends string = string, >(_defaultOpts?: { - from?: FromPathOption -}): UseNavigateResult { - const router = useRouter() + from?: FromPathOption +}): UseNavigateResult { + const router = useRouter() return React.useCallback( (options: NavigateOptions) => { return router.navigate({ ...options, from: options.from ?? _defaultOpts?.from, - }) + } as any) }, [_defaultOpts?.from, router], - ) as UseNavigateResult + ) as UseNavigateResult } /** @@ -52,17 +51,17 @@ export function useNavigate< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/navigateComponent */ export function Navigate< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', ->(props: NavigateOptions): null { - const router = useRouter() - const navigate = useNavigate() +>(props: NavigateOptions): null { + const router = useRouter() + const navigate = useNavigate() const previousPropsRef = React.useRef | null>(null) useLayoutEffect(() => { if (previousPropsRef.current !== props) { - navigate(props) + navigate(props as any) previousPropsRef.current = props } }, [router, props, navigate]) diff --git a/packages/react-router/src/useParams.tsx b/packages/react-router/src/useParams.tsx index 444eee7a41..0d00d7b284 100644 --- a/packages/react-router/src/useParams.tsx +++ b/packages/react-router/src/useParams.tsx @@ -4,7 +4,7 @@ import type { ValidateSelected, } from './structuralSharing' import type { - AnyRouter, + Register, RegisteredRouter, ResolveUseParams, StrictOrFrom, @@ -14,7 +14,7 @@ import type { } from '@tanstack/router-core' export interface UseParamsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, @@ -22,44 +22,55 @@ export interface UseParamsBaseOptions< TStructuralSharing, > { select?: ( - params: ResolveUseParams, - ) => ValidateSelected + params: ResolveUseParams, TFrom, TStrict>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > shouldThrow?: TThrow } export type UseParamsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom & +> = StrictOrFrom, TFrom, TStrict> & UseParamsBaseOptions< - TRouter, + TRegister, TFrom, TStrict, TThrow, TSelected, TStructuralSharing > & - StructuralSharingOption + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseParamsRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseParamsRoute = < TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts?: UseParamsBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, TSelected, TStructuralSharing > & - StructuralSharingOption, -) => UseParamsResult + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => UseParamsResult, TFrom, true, TSelected> /** * Access the current route's path parameters with type-safety. @@ -74,7 +85,7 @@ export type UseParamsRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useParamsHook */ export function useParams< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, @@ -82,26 +93,26 @@ export function useParams< TStructuralSharing extends boolean = boolean, >( opts: UseParamsOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected, TStructuralSharing - >, + > = {} as any, ): ThrowOrOptional< - UseParamsResult, + UseParamsResult, TFrom, TStrict, TSelected>, TThrow > { - return useMatch({ + return useMatch({ from: opts.from!, shouldThrow: opts.shouldThrow, structuralSharing: opts.structuralSharing, strict: opts.strict, - select: (match) => { + select: (match: any) => { const params = opts.strict === false ? match.params : match._strictParams return opts.select ? opts.select(params) : params }, - }) as any + } as any) as any } diff --git a/packages/react-router/src/useRouteContext.ts b/packages/react-router/src/useRouteContext.ts index 0aed8720e6..42ca66fb3b 100644 --- a/packages/react-router/src/useRouteContext.ts +++ b/packages/react-router/src/useRouteContext.ts @@ -1,30 +1,49 @@ import { useMatch } from './useMatch' import type { - AnyRouter, + Register, RegisteredRouter, UseRouteContextBaseOptions, UseRouteContextOptions, UseRouteContextResult, } from '@tanstack/router-core' -export type UseRouteContextRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseRouteContextRoute = < TSelected = unknown, >( - opts?: UseRouteContextBaseOptions, -) => UseRouteContextResult + opts?: UseRouteContextBaseOptions< + RegisteredRouter, + TFrom, + true, + TSelected + >, +) => UseRouteContextResult, TFrom, true, TSelected> export function useRouteContext< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseRouteContextOptions, -): UseRouteContextResult { + opts: UseRouteContextOptions< + RegisteredRouter, + TFrom, + TStrict, + TSelected + >, +): UseRouteContextResult< + RegisteredRouter, + TFrom, + TStrict, + TSelected +> { return useMatch({ ...(opts as any), - select: (match) => + select: (match: any) => opts.select ? opts.select(match.context) : match.context, - }) as UseRouteContextResult + }) as UseRouteContextResult< + RegisteredRouter, + TFrom, + TStrict, + TSelected + > } diff --git a/packages/react-router/src/useRouter.tsx b/packages/react-router/src/useRouter.tsx index abfefecaa3..c282171867 100644 --- a/packages/react-router/src/useRouter.tsx +++ b/packages/react-router/src/useRouter.tsx @@ -1,7 +1,7 @@ import * as React from 'react' import warning from 'tiny-warning' import { getRouterContext } from './routerContext' -import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core' +import type { Register, RegisteredRouter } from '@tanstack/router-core' /** * Access the current TanStack Router instance from React context. @@ -13,9 +13,9 @@ import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core' * @returns The registered router instance. * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useRouterHook */ -export function useRouter(opts?: { +export function useRouter(opts?: { warn?: boolean -}): TRouter { +}): RegisteredRouter { const value = React.useContext(getRouterContext()) warning( !((opts?.warn ?? true) && !value), diff --git a/packages/react-router/src/useRouterState.tsx b/packages/react-router/src/useRouterState.tsx index 08a7c7b9b8..8c7a64888b 100644 --- a/packages/react-router/src/useRouterState.tsx +++ b/packages/react-router/src/useRouterState.tsx @@ -4,6 +4,7 @@ import { replaceEqualDeep } from '@tanstack/router-core' import { useRouter } from './useRouter' import type { AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' @@ -13,20 +14,30 @@ import type { } from './structuralSharing' export type UseRouterStateOptions< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, TStructuralSharing, > = { - router?: TRouter + router?: RegisteredRouter select?: ( - state: RouterState, - ) => ValidateSelected -} & StructuralSharingOption + state: RouterState['routeTree']>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > +} & StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing +> export type UseRouterStateResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? RouterState : TSelected +> = unknown extends TSelected + ? RouterState['routeTree']> + : TSelected /** * Subscribe to the router's state store with optional selection and @@ -41,18 +52,24 @@ export type UseRouterStateResult< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useRouterStateHook */ export function useRouterState< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts?: UseRouterStateOptions, -): UseRouterStateResult { - const contextRouter = useRouter({ + opts?: UseRouterStateOptions, +): UseRouterStateResult { + const contextRouter = useRouter({ warn: opts?.router === undefined, }) const router = opts?.router || contextRouter const previousResult = - useRef>(undefined) + useRef< + ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > + >(undefined) return useStore(router.__store, (state) => { if (opts?.select) { @@ -67,5 +84,5 @@ export function useRouterState< return opts.select(state) } return state - }) as UseRouterStateResult + }) as UseRouterStateResult } diff --git a/packages/react-router/src/useSearch.tsx b/packages/react-router/src/useSearch.tsx index 46b6e51642..38630f19d1 100644 --- a/packages/react-router/src/useSearch.tsx +++ b/packages/react-router/src/useSearch.tsx @@ -6,6 +6,7 @@ import type { import type { AnyRouter, RegisteredRouter, + Register, ResolveUseSearch, StrictOrFrom, ThrowConstraint, @@ -14,7 +15,7 @@ import type { } from '@tanstack/router-core' export interface UseSearchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, @@ -22,44 +23,55 @@ export interface UseSearchBaseOptions< TStructuralSharing, > { select?: ( - state: ResolveUseSearch, - ) => ValidateSelected + state: ResolveUseSearch, TFrom, TStrict>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > shouldThrow?: TThrow } export type UseSearchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom & +> = StrictOrFrom, TFrom, TStrict> & UseSearchBaseOptions< - TRouter, + TRegister, TFrom, TStrict, TThrow, TSelected, TStructuralSharing > & - StructuralSharingOption + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseSearchRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseSearchRoute = < TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts?: UseSearchBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, TSelected, TStructuralSharing > & - StructuralSharingOption, -) => UseSearchResult + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => UseSearchResult, TFrom, true, TSelected> /** * Read and select the current route's search parameters with type-safety. @@ -74,7 +86,7 @@ export type UseSearchRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useSearchHook */ export function useSearch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, @@ -82,7 +94,7 @@ export function useSearch< TStructuralSharing extends boolean = boolean, >( opts: UseSearchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, @@ -90,7 +102,7 @@ export function useSearch< TStructuralSharing >, ): ThrowOrOptional< - UseSearchResult, + UseSearchResult, TFrom, TStrict, TSelected>, TThrow > { return useMatch({ diff --git a/packages/react-router/tests/Matches.test-d.tsx b/packages/react-router/tests/Matches.test-d.tsx index 2116e78416..e3400e24e1 100644 --- a/packages/react-router/tests/Matches.test-d.tsx +++ b/packages/react-router/tests/Matches.test-d.tsx @@ -8,7 +8,7 @@ import { useMatchRoute, useMatches, } from '../src' -import type { AnyRouteMatch, RouteMatch } from '../src' +import type { AnyRouteMatch, Register, RouteMatch } from '../src' const rootRoute = createRootRoute() @@ -146,7 +146,13 @@ const defaultRouter = createRouter({ type DefaultRouter = typeof defaultRouter -const useDefaultMatchRoute = useMatchRoute +declare module '@tanstack/router-core' { + interface Register { + router: DefaultRouter + } +} + +const useDefaultMatchRoute = useMatchRoute test('when matching a route with params', () => { const matchRoute = useDefaultMatchRoute() @@ -158,7 +164,7 @@ test('when matching a route with params', () => { '/' | '.' | '..' | '/invoices' | '/invoices/$invoiceId' | '/comments/$id' >() - expectTypeOf(MatchRoute) + expectTypeOf(MatchRoute) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -183,7 +189,7 @@ test('when matching a route with params underneath a layout route', () => { }) test('useMatches returns a union of all matches', () => { - expectTypeOf(useMatches()).toEqualTypeOf< + expectTypeOf(useMatches()).toEqualTypeOf< Array< | RootMatch | IndexMatch @@ -197,7 +203,7 @@ test('useMatches returns a union of all matches', () => { }) test('when filtering useMatches by search', () => { - const matches = useMatches() + const matches = useMatches() expectTypeOf(isMatch<(typeof matches)[number], ''>) .parameter(1) diff --git a/packages/router-core/src/link.ts b/packages/router-core/src/link.ts index e2ec7f8253..95c8daadeb 100644 --- a/packages/router-core/src/link.ts +++ b/packages/router-core/src/link.ts @@ -14,6 +14,7 @@ import type { } from './routeInfo' import type { AnyRouter, + Register, RegisteredRouter, ViewTransitionOptions, } from './router' @@ -205,14 +206,14 @@ export type ResolveRelativePath = string extends TFrom : never export type FindDescendantToPaths< - TRouter extends AnyRouter, + TRegister extends Register, TPrefix extends string, -> = `${TPrefix}/${string}` & RouteToPath +> = `${TPrefix}/${string}` & RouteToPath export type InferDescendantToPaths< - TRouter extends AnyRouter, + TRegister extends Register, TPrefix extends string, - TPaths = FindDescendantToPaths, + TPaths = FindDescendantToPaths, > = TPaths extends `${TPrefix}/` ? never : TPaths extends `${TPrefix}/${infer TRest}` @@ -220,79 +221,79 @@ export type InferDescendantToPaths< : never export type RelativeToPath< - TRouter extends AnyRouter, + TRegister extends Register, TTo extends string, TResolvedPath extends string, > = - | (TResolvedPath & RouteToPath extends never + | (TResolvedPath & RouteToPath extends never ? never - : ToPath) - | `${RemoveTrailingSlashes}/${InferDescendantToPaths>}` + : ToPath) + | `${RemoveTrailingSlashes}/${InferDescendantToPaths>}` export type RelativeToParentPath< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string, TTo extends string, TResolvedPath extends string = ResolveRelativePath, > = - | RelativeToPath + | RelativeToPath | (TTo extends `${string}..` | `${string}../` ? TResolvedPath extends '/' | '' ? never : FindDescendantToPaths< - TRouter, + TRegister, RemoveTrailingSlashes > extends never ? never - : `${RemoveTrailingSlashes}/${ParentPath}` + : `${RemoveTrailingSlashes}/${ParentPath}` : never) export type RelativeToCurrentPath< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string, TTo extends string, TResolvedPath extends string = ResolveRelativePath, -> = RelativeToPath | CurrentPath +> = RelativeToPath | CurrentPath -export type AbsoluteToPath = +export type AbsoluteToPath = | (string extends TFrom - ? CurrentPath + ? CurrentPath : TFrom extends `/` ? never - : CurrentPath) + : CurrentPath) | (string extends TFrom - ? ParentPath + ? ParentPath : TFrom extends `/` ? never - : ParentPath) - | RouteToPath + : ParentPath) + | RouteToPath | (TFrom extends '/' ? never : string extends TFrom ? never - : InferDescendantToPaths>) + : InferDescendantToPaths>) export type RelativeToPathAutoComplete< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string, TTo extends string, > = string extends TTo ? string : string extends TFrom - ? AbsoluteToPath + ? AbsoluteToPath : TTo & `..${string}` extends never ? TTo & `.${string}` extends never - ? AbsoluteToPath - : RelativeToCurrentPath - : RelativeToParentPath + ? AbsoluteToPath + : RelativeToCurrentPath + : RelativeToParentPath export type NavigateOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = ToOptions & NavigateOptionProps +> = ToOptions & NavigateOptionProps /** * The NavigateOptions type is used to describe the options that can be used when describing a navigation action in TanStack Router. @@ -356,40 +357,41 @@ export interface NavigateOptionProps { } export type ToOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = ToSubOptions & MaskOptions +> = ToSubOptions & + MaskOptions export interface MaskOptions< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TMaskFrom extends string, in out TMaskTo extends string, > { _fromLocation?: ParsedLocation - mask?: ToMaskOptions + mask?: ToMaskOptions } export type ToMaskOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TMaskFrom extends string = string, TMaskTo extends string = '.', -> = ToSubOptions & { +> = ToSubOptions & { unmaskOnReload?: boolean } export type ToSubOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', -> = ToSubOptionsProps & - SearchParamOptions & - PathParamOptions +> = ToSubOptionsProps & + SearchParamOptions & + PathParamOptions export interface RequiredToOptions< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom extends string, in out TTo extends string | undefined, > { @@ -399,11 +401,11 @@ export interface RequiredToOptions< * @example "/dashboard" or "../profile" * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/NavigateOptionsType#href) */ - to: ToPathOption & {} + to: ToPathOption & {} } export interface OptionalToOptions< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom extends string, in out TTo extends string | undefined, > { @@ -413,96 +415,112 @@ export interface OptionalToOptions< * @example "/dashboard" or "../profile" * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/NavigateOptionsType#href) */ - to?: ToPathOption & {} + to?: ToPathOption & {} } export type MakeToRequired< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string, TTo extends string | undefined, > = string extends TFrom ? string extends TTo - ? OptionalToOptions - : TTo & CatchAllPaths extends never - ? RequiredToOptions - : OptionalToOptions - : OptionalToOptions + ? OptionalToOptions + : TTo extends CatchAllPaths + ? RequiredToOptions + : OptionalToOptions + : OptionalToOptions export type ToSubOptionsProps< - TRouter extends AnyRouter = RegisteredRouter, - TFrom extends RoutePaths | string = string, + TRegister extends Register = Register, + TFrom extends + | (RegisteredRouter extends infer TRouter extends AnyRouter + ? RoutePaths + : never) + | string = string, TTo extends string | undefined = '.', -> = MakeToRequired & { +> = MakeToRequired & { hash?: true | Updater state?: true | NonNullableUpdater - from?: FromPathOption & {} + from?: FromPathOption & {} unsafeRelative?: 'path' } export type ParamsReducerFn< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TParamVariant extends ParamVariant, in out TFrom, in out TTo, > = ( - current: Expand>, -) => Expand> + current: Expand>, +) => Expand> type ParamsReducer< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, TTo, > = - | Expand> - | (ParamsReducerFn & {}) + | Expand> + | (ParamsReducerFn & {}) type ParamVariant = 'PATH' | 'SEARCH' export type ResolveRoute< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TTo, TPath = ResolveRelativePath, > = TPath extends string ? TFrom extends TPath - ? RouteByPath - : RouteByToPath + ? RegisteredRouter extends infer TRouter extends AnyRouter + ? RouteByPath + : never + : RouteByToPath : never type ResolveFromParamType = TParamVariant extends 'PATH' ? 'allParams' : 'fullSearchSchema' type ResolveFromAllParams< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, > = TParamVariant extends 'PATH' - ? AllParams - : FullSearchSchema + ? RegisteredRouter extends infer TRouter extends AnyRouter + ? AllParams + : never + : RegisteredRouter extends infer TRouter extends AnyRouter + ? FullSearchSchema + : never type ResolveFromParams< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, > = string extends TFrom - ? ResolveFromAllParams - : RouteByPath< - TRouter['routeTree'], - TFrom - >['types'][ResolveFromParamType] + ? ResolveFromAllParams + : RegisteredRouter extends infer TRouter extends AnyRouter + ? RouteByPath< + TRouter['routeTree'], + TFrom + >['types'][ResolveFromParamType] + : never type ResolveToParamType = TParamVariant extends 'PATH' ? 'allParams' : 'fullSearchSchemaInput' type ResolveAllToParams< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, > = TParamVariant extends 'PATH' - ? AllParams - : FullSearchSchemaInput + ? RegisteredRouter extends infer TRouter extends AnyRouter + ? AllParams + : never + : RegisteredRouter extends infer TRouter extends AnyRouter + ? FullSearchSchemaInput + : never export type ResolveToParams< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, TTo, @@ -511,49 +529,49 @@ export type ResolveToParams< ? undefined extends TPath ? never : string extends TPath - ? ResolveAllToParams - : TPath extends CatchAllPaths - ? ResolveAllToParams + ? ResolveAllToParams + : TPath extends CatchAllPaths + ? ResolveAllToParams : ResolveRoute< - TRouter, + TRegister, TFrom, TTo >['types'][ResolveToParamType] : never type ResolveRelativeToParams< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, TTo, - TToParams = ResolveToParams, + TToParams = ResolveToParams, > = TParamVariant extends 'SEARCH' ? TToParams : string extends TFrom ? TToParams : MakeDifferenceOptional< - ResolveFromParams, + ResolveFromParams, TToParams > export interface MakeOptionalSearchParams< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom, in out TTo, > { - search?: true | (ParamsReducer & {}) + search?: true | (ParamsReducer & {}) } export interface MakeOptionalPathParams< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom, in out TTo, > { - params?: true | (ParamsReducer & {}) + params?: true | (ParamsReducer & {}) } type MakeRequiredParamsReducer< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, TTo, @@ -561,32 +579,37 @@ type MakeRequiredParamsReducer< | (string extends TFrom ? never : ResolveFromParams< - TRouter, + TRegister, TParamVariant, TFrom - > extends ResolveRelativeToParams + > extends ResolveRelativeToParams< + TRegister, + TParamVariant, + TFrom, + TTo + > ? true : never) - | (ParamsReducer & {}) + | (ParamsReducer & {}) export interface MakeRequiredPathParams< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom, in out TTo, > { - params: MakeRequiredParamsReducer & {} + params: MakeRequiredParamsReducer & {} } export interface MakeRequiredSearchParams< - in out TRouter extends AnyRouter, + in out TRegister extends Register, in out TFrom, in out TTo, > { - search: MakeRequiredParamsReducer & {} + search: MakeRequiredParamsReducer & {} } export type IsRequired< - TRouter extends AnyRouter, + TRegister extends Register, TParamVariant extends ParamVariant, TFrom, TTo, @@ -594,39 +617,44 @@ export type IsRequired< ResolveRelativePath extends infer TPath ? undefined extends TPath ? never - : TPath extends CatchAllPaths + : TPath extends CatchAllPaths ? never : IsRequiredParams< - ResolveRelativeToParams + ResolveRelativeToParams > : never -export type SearchParamOptions = - IsRequired extends never - ? MakeOptionalSearchParams - : MakeRequiredSearchParams +export type SearchParamOptions = + IsRequired extends never + ? MakeOptionalSearchParams + : MakeRequiredSearchParams -export type PathParamOptions = - IsRequired extends never - ? MakeOptionalPathParams - : MakeRequiredPathParams +export type PathParamOptions = + IsRequired extends never + ? MakeOptionalPathParams + : MakeRequiredPathParams export type ToPathOption< - TRouter extends AnyRouter = AnyRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = string, > = ConstrainLiteral< TTo, RelativeToPathAutoComplete< - TRouter, + TRegister, NoInfer extends string ? NoInfer : '', NoInfer & string > > -export type FromPathOption = ConstrainLiteral< +export type FromPathOption< + TRegister extends Register, TFrom, - RoutePaths +> = ConstrainLiteral< + TFrom, + RegisteredRouter extends infer TRouter extends AnyRouter + ? RoutePaths + : never > /** @@ -692,12 +720,13 @@ export interface LinkOptionsProps { } export type LinkOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = NavigateOptions & LinkOptionsProps +> = NavigateOptions & + LinkOptionsProps export type LinkCurrentTargetElement = { preloadTimeout?: null | ReturnType diff --git a/packages/router-core/src/redirect.ts b/packages/router-core/src/redirect.ts index d2093a0eb6..896a0243b4 100644 --- a/packages/router-core/src/redirect.ts +++ b/packages/router-core/src/redirect.ts @@ -1,5 +1,5 @@ import type { NavigateOptions } from './link' -import type { AnyRouter, RegisteredRouter } from './router' +import type { AnyRouter, RegisteredRouter, Register } from './router' export type AnyRedirect = Redirect @@ -7,18 +7,18 @@ export type AnyRedirect = Redirect * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType) */ export type Redirect< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '.', > = Response & { - options: NavigateOptions + options: NavigateOptions redirectHandled?: boolean } export type RedirectOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, @@ -44,15 +44,15 @@ export type RedirectOptions< * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType#headers-property) */ headers?: HeadersInit -} & NavigateOptions +} & NavigateOptions export type ResolvedRedirect< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string = '', TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = Redirect +> = Redirect /** * Create a redirect Response understood by TanStack Router. @@ -72,14 +72,14 @@ export type ResolvedRedirect< * @link https://tanstack.com/router/latest/docs/framework/react/api/router/redirectFunction */ export function redirect< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TTo extends string | undefined = '.', const TFrom extends string = string, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - opts: RedirectOptions, -): Redirect { + opts: RedirectOptions, +): Redirect { opts.statusCode = opts.statusCode || opts.code || 307 if (!opts.reloadDocument && typeof opts.href === 'string') { @@ -99,14 +99,14 @@ export function redirect< headers, }) - ;(response as Redirect).options = + ;(response as Redirect).options = opts if (opts.throw) { throw response } - return response as Redirect + return response as Redirect } /** Check whether a value is a TanStack Router redirect Response. */ diff --git a/packages/router-core/src/routeInfo.ts b/packages/router-core/src/routeInfo.ts index 6c9249e091..a9303890db 100644 --- a/packages/router-core/src/routeInfo.ts +++ b/packages/router-core/src/routeInfo.ts @@ -1,7 +1,12 @@ import type { InferFileRouteTypes } from './fileRoute' import type { AddTrailingSlash, RemoveTrailingSlashes } from './link' import type { AnyRoute } from './route' -import type { AnyRouter, TrailingSlashOption } from './router' +import type { + AnyRouter, + Register, + RegisteredRouter, + TrailingSlashOption, +} from './router' import type { PartialMergeAll } from './utils' export type ParseRoute = TRouteTree extends { @@ -59,30 +64,30 @@ export type RouteIds = ? CodeRouteIds : InferFileRouteTypes['id'] -export type ParentPath = - TrailingSlashOptionByRouter extends 'always' +export type ParentPath = + TrailingSlashOptionByRouter extends 'always' ? '../' - : TrailingSlashOptionByRouter extends 'never' + : TrailingSlashOptionByRouter extends 'never' ? '..' : '../' | '..' -export type CurrentPath = - TrailingSlashOptionByRouter extends 'always' +export type CurrentPath = + TrailingSlashOptionByRouter extends 'always' ? './' - : TrailingSlashOptionByRouter extends 'never' + : TrailingSlashOptionByRouter extends 'never' ? '.' : './' | '.' -export type ToPath = - TrailingSlashOptionByRouter extends 'always' +export type ToPath = + TrailingSlashOptionByRouter extends 'always' ? AddTrailingSlash - : TrailingSlashOptionByRouter extends 'never' + : TrailingSlashOptionByRouter extends 'never' ? RemoveTrailingSlashes : AddTrailingSlash | RemoveTrailingSlashes -export type CatchAllPaths = - | CurrentPath - | ParentPath +export type CatchAllPaths = + | CurrentPath + | ParentPath export type CodeRoutesByPath = ParseRoute extends infer TRoutes extends AnyRoute @@ -138,76 +143,92 @@ export type RouteToPathByTrailingSlashOption = { never: RouteToPathNeverTrailingSlash } -export type TrailingSlashOptionByRouter = - TrailingSlashOption extends TRouter['options']['trailingSlash'] - ? 'never' - : NonNullable +export type TrailingSlashOptionByRouter = + RegisteredRouter extends infer TRouter extends AnyRouter + ? TrailingSlashOption extends TRouter['options']['trailingSlash'] + ? 'never' + : NonNullable + : never export type RouteToByRouter< - TRouter extends AnyRouter, + TRegister extends Register, TRoute extends AnyRoute, -> = RouteToPathByTrailingSlashOption[TrailingSlashOptionByRouter] +> = RouteToPathByTrailingSlashOption[TrailingSlashOptionByRouter] -export type CodeRouteToPath = - ParseRouteWithoutBranches extends infer TRoute extends - AnyRoute - ? TRoute extends any - ? RouteToByRouter +export type CodeRouteToPath = + RegisteredRouter extends infer TRouter extends AnyRouter + ? ParseRouteWithoutBranches< + TRouter['routeTree'] + > extends infer TRoute extends AnyRoute + ? TRoute extends any + ? RouteToByRouter + : never : never : never export type FileRouteToPath< - TRouter extends AnyRouter, - TTo = InferFileRouteTypes['to'], - TTrailingSlashOption = TrailingSlashOptionByRouter, + TRegister extends Register, + TTo = RegisteredRouter extends infer TRouter extends AnyRouter + ? InferFileRouteTypes['to'] + : never, + TTrailingSlashOption = TrailingSlashOptionByRouter, > = 'never' extends TTrailingSlashOption ? TTo : 'always' extends TTrailingSlashOption ? AddTrailingSlash : TTo | AddTrailingSlash -export type RouteToPath = unknown extends TRouter +export type RouteToPath = unknown extends TRegister ? string - : InferFileRouteTypes extends never - ? CodeRouteToPath - : FileRouteToPath - -export type CodeRoutesByToPath = - ParseRouteWithoutBranches extends infer TRoutes extends - AnyRoute - ? { - [TRoute in TRoutes as RouteToByRouter]: TRoute - } + : RegisteredRouter extends infer TRouter extends AnyRouter + ? InferFileRouteTypes extends never + ? CodeRouteToPath + : FileRouteToPath : never -export type RoutesByToPath = - InferFileRouteTypes extends never - ? CodeRoutesByToPath - : InferFileRouteTypes['fileRoutesByTo'] +export type CodeRoutesByToPath = + RegisteredRouter extends infer TRouter extends AnyRouter + ? ParseRouteWithoutBranches< + TRouter['routeTree'] + > extends infer TRoutes extends AnyRoute + ? { + [TRoute in TRoutes as RouteToByRouter]: TRoute + } + : never + : never -export type CodeRouteByToPath = Extract< - RoutesByToPath[TTo & keyof RoutesByToPath], +export type RoutesByToPath = + RegisteredRouter extends infer TRouter extends AnyRouter + ? InferFileRouteTypes extends never + ? CodeRoutesByToPath + : InferFileRouteTypes['fileRoutesByTo'] + : never + +export type CodeRouteByToPath = Extract< + RoutesByToPath[TTo & keyof RoutesByToPath], AnyRoute > -export type FileRouteByToPath = - 'never' extends TrailingSlashOptionByRouter - ? CodeRouteByToPath - : 'always' extends TrailingSlashOptionByRouter +export type FileRouteByToPath = + 'never' extends TrailingSlashOptionByRouter + ? CodeRouteByToPath + : 'always' extends TrailingSlashOptionByRouter ? TTo extends '/' - ? CodeRouteByToPath + ? CodeRouteByToPath : TTo extends `${infer TPath}/` - ? CodeRouteByToPath + ? CodeRouteByToPath : never : CodeRouteByToPath< - TRouter, + TRegister, TTo extends '/' ? TTo : RemoveTrailingSlashes > -export type RouteByToPath = - InferFileRouteTypes extends never - ? CodeRouteByToPath - : FileRouteByToPath +export type RouteByToPath = + RegisteredRouter extends infer TRouter extends AnyRouter + ? InferFileRouteTypes extends never + ? CodeRouteByToPath + : FileRouteByToPath + : never export type FullSearchSchema = ParseRoute extends infer TRoutes extends AnyRoute diff --git a/packages/router-core/src/router.ts b/packages/router-core/src/router.ts index 54da83a33e..885548753a 100644 --- a/packages/router-core/src/router.ts +++ b/packages/router-core/src/router.ts @@ -114,7 +114,7 @@ export type RegisteredSsr = TRegister extends { : false export type RegisteredRouter = TRegister extends { - router: infer TRouter + router: infer TRouter extends AnyRouter } ? TRouter : AnyRouter @@ -2060,7 +2060,7 @@ export class RouterCore< hash: true, state: true, _includeValidateSearch: true, - }) + } as any) if ( this.latestLocation.publicHref !== nextLocation.publicHref || @@ -2068,7 +2068,7 @@ export class RouterCore< ) { const href = this.getParsedLocationHref(nextLocation) - throw redirect({ href }) + throw redirect({ href } as any) } } diff --git a/packages/router-core/src/typePrimitives.ts b/packages/router-core/src/typePrimitives.ts index 5f7d4b8e2f..f0c8057fc7 100644 --- a/packages/router-core/src/typePrimitives.ts +++ b/packages/router-core/src/typePrimitives.ts @@ -7,7 +7,7 @@ import type { } from './link' import type { RedirectOptions } from './redirect' import type { RouteIds } from './routeInfo' -import type { AnyRouter, RegisteredRouter } from './router' +import type { AnyRouter, Register, RegisteredRouter } from './router' import type { UseParamsResult } from './useParams' import type { UseSearchResult } from './useSearch' import type { Constrain, ConstrainLiteral } from './utils' @@ -169,11 +169,11 @@ export type ValidateUseSearchResult< export type ValidateUseParamsResult< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = Constrain< TOptions, UseParamsResult< - TRouter, + TRegister, InferFrom, InferStrict, InferSelected diff --git a/packages/router-core/src/useNavigate.ts b/packages/router-core/src/useNavigate.ts index ca0282bcce..8fb9ec30a5 100644 --- a/packages/router-core/src/useNavigate.ts +++ b/packages/router-core/src/useNavigate.ts @@ -1,9 +1,12 @@ import type { NavigateOptions } from './link' -import type { RegisteredRouter } from './router' +import type { Register, RegisteredRouter } from './router' -export type UseNavigateResult = < - TRouter extends RegisteredRouter, - TTo extends string | undefined, +export type UseNavigateResult< + TRegister extends Register = Register, + TDefaultFrom extends string = string, +> = < + TRouter extends RegisteredRouter = RegisteredRouter, + TTo extends string | undefined = undefined, TFrom extends string = TDefaultFrom, TMaskFrom extends string = TFrom, TMaskTo extends string = '', diff --git a/packages/router-core/src/useParams.ts b/packages/router-core/src/useParams.ts index 4938ed7f05..0f649d9452 100644 --- a/packages/router-core/src/useParams.ts +++ b/packages/router-core/src/useParams.ts @@ -1,20 +1,32 @@ import type { AllParams, RouteById } from './routeInfo' -import type { AnyRouter } from './router' +import type { AnyRoute } from './route' +import type { AnyRouter, Register, RegisteredRouter } from './router' import type { Expand } from './utils' export type ResolveUseParams< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, > = TStrict extends false - ? AllParams - : Expand['types']['allParams']> + ? AllParams< + RegisteredRouter['routeTree'] extends AnyRoute + ? RegisteredRouter['routeTree'] + : AnyRoute + > + : Expand< + RouteById< + RegisteredRouter['routeTree'] extends AnyRoute + ? RegisteredRouter['routeTree'] + : AnyRoute, + TFrom + >['types']['allParams'] + > export type UseParamsResult< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected - ? ResolveUseParams + ? ResolveUseParams : TSelected diff --git a/packages/router-core/src/utils.ts b/packages/router-core/src/utils.ts index eb8d3025e7..e272d0ef6a 100644 --- a/packages/router-core/src/utils.ts +++ b/packages/router-core/src/utils.ts @@ -1,5 +1,6 @@ import type { RouteIds } from './routeInfo' -import type { AnyRouter } from './router' +import type { AnyRoute } from './route' +import type { AnyRouter, Register, RegisteredRouter } from './router' export type Awaitable = T | Promise export type NoInfer = [T][T extends any ? 0 : never] @@ -397,7 +398,7 @@ export type ThrowOrOptional = TThrow extends true : T | undefined export type StrictOrFrom< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean = true, > = TStrict extends false @@ -406,7 +407,14 @@ export type StrictOrFrom< strict: TStrict } : { - from: ConstrainLiteral> + from: ConstrainLiteral< + TFrom, + RouteIds< + RegisteredRouter['routeTree'] extends AnyRoute + ? RegisteredRouter['routeTree'] + : AnyRoute + > + > strict?: TStrict } From 68fe9bc46a461aab13e5dca36884161867a4a82d Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Mon, 22 Dec 2025 08:36:23 +0100 Subject: [PATCH 2/3] solid --- packages/router-core/src/index.ts | 1 + packages/solid-router/src/Matches.tsx | 85 +-- packages/solid-router/src/RouterProvider.tsx | 25 +- packages/solid-router/src/fileRoute.ts | 40 +- packages/solid-router/src/link.tsx | 69 ++- packages/solid-router/src/route.tsx | 132 +++-- .../solid-router/src/structuralSharing.ts | 52 ++ packages/solid-router/src/typePrimitives.ts | 52 +- packages/solid-router/src/useBlocker.tsx | 46 +- packages/solid-router/src/useLoaderData.tsx | 31 +- packages/solid-router/src/useLoaderDeps.tsx | 33 +- packages/solid-router/src/useLocation.tsx | 20 +- packages/solid-router/src/useMatch.tsx | 35 +- packages/solid-router/src/useNavigate.tsx | 22 +- packages/solid-router/src/useParams.tsx | 69 ++- packages/solid-router/src/useRouteContext.ts | 31 +- packages/solid-router/src/useRouter.tsx | 6 +- packages/solid-router/src/useRouterState.tsx | 26 +- packages/solid-router/src/useSearch.tsx | 72 ++- .../solid-router/tests/Matches.test-d.tsx | 58 +- .../solid-router/tests/debug-link.test-d.tsx | 29 + packages/solid-router/tests/link.test-d.tsx | 518 ++++++++++-------- 22 files changed, 909 insertions(+), 543 deletions(-) create mode 100644 packages/solid-router/src/structuralSharing.ts create mode 100644 packages/solid-router/tests/debug-link.test-d.tsx diff --git a/packages/router-core/src/index.ts b/packages/router-core/src/index.ts index 73019ccbb6..de435e7f94 100644 --- a/packages/router-core/src/index.ts +++ b/packages/router-core/src/index.ts @@ -37,6 +37,7 @@ export type { MaskOptions, ToSubOptionsProps, RequiredToOptions, + MakeToRequired, } from './link' export { componentTypes } from './load-matches' diff --git a/packages/solid-router/src/Matches.tsx b/packages/solid-router/src/Matches.tsx index efef3252ea..54974e8072 100644 --- a/packages/solid-router/src/Matches.tsx +++ b/packages/solid-router/src/Matches.tsx @@ -10,7 +10,6 @@ import { SafeFragment } from './SafeFragment' import { Match } from './Match' import type { AnyRoute, - AnyRouter, DeepPartial, Expand, MakeOptionalPathParams, @@ -19,6 +18,7 @@ import type { MaskOptions, MatchRouteOptions, NoInfer, + Register, RegisteredRouter, ResolveRelativePath, ResolveRoute, @@ -109,18 +109,20 @@ function MatchesInner() { } export type UseMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = ToSubOptionsProps & - DeepPartial> & - DeepPartial> & - MaskOptions & +> = ToSubOptionsProps, TFrom, TTo> & + DeepPartial< + MakeOptionalSearchParams, TFrom, TTo> + > & + DeepPartial, TFrom, TTo>> & + MaskOptions, TMaskFrom, TMaskTo> & MatchRouteOptions -export function useMatchRoute() { +export function useMatchRoute() { const router = useRouter() const status = useRouterState({ @@ -133,9 +135,16 @@ export function useMatchRoute() { const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - opts: UseMatchRouteOptions, + opts: UseMatchRouteOptions, ): Solid.Accessor< - false | Expand['types']['allParams']> + | false + | Expand< + ResolveRoute< + RegisteredRouter, + TFrom, + TTo + >['types']['allParams'] + > > => { const { pending, caseSensitive, fuzzy, includeSearch, ...rest } = opts @@ -154,17 +163,17 @@ export function useMatchRoute() { } export type MakeMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = UseMatchRouteOptions & { +> = UseMatchRouteOptions & { // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns children?: | (( params?: RouteByPath< - TRouter['routeTree'], + RegisteredRouter['routeTree'], ResolveRelativePath> >['types']['allParams'], ) => Solid.JSX.Element) @@ -172,12 +181,14 @@ export type MakeMatchRouteOptions< } export function MatchRoute< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', ->(props: MakeMatchRouteOptions): any { +>( + props: MakeMatchRouteOptions, +): any { const status = useRouterState({ select: (s) => s.status, }) @@ -198,41 +209,49 @@ export function MatchRoute< ) } -export interface UseMatchesBaseOptions { - select?: (matches: Array>) => TSelected +export interface UseMatchesBaseOptions { + select?: ( + matches: Array>>, + ) => TSelected } export type UseMatchesResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? Array> : TSelected +> = unknown extends TSelected + ? Array>> + : TSelected export function useMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Solid.Accessor> { + opts?: UseMatchesBaseOptions, +): Solid.Accessor> { return useRouterState({ - select: (state: RouterState) => { + select: (state: RouterState['routeTree']>) => { const matches = state.matches return opts?.select - ? opts.select(matches as Array>) + ? opts.select( + matches as Array>>, + ) : matches }, - } as any) as Solid.Accessor> + } as any) as Solid.Accessor> } export function useParentMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Solid.Accessor> { + opts?: UseMatchesBaseOptions, +): Solid.Accessor> { const contextMatchId = Solid.useContext(matchContext) return useMatches({ - select: (matches: Array>) => { + select: ( + matches: Array>>, + ) => { matches = matches.slice( 0, matches.findIndex((d) => d.id === contextMatchId()), @@ -243,15 +262,17 @@ export function useParentMatches< } export function useChildMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Solid.Accessor> { + opts?: UseMatchesBaseOptions, +): Solid.Accessor> { const contextMatchId = Solid.useContext(matchContext) return useMatches({ - select: (matches: Array>) => { + select: ( + matches: Array>>, + ) => { matches = matches.slice( matches.findIndex((d) => d.id === contextMatchId()) + 1, ) diff --git a/packages/solid-router/src/RouterProvider.tsx b/packages/solid-router/src/RouterProvider.tsx index 1092d9b43c..7121645417 100644 --- a/packages/solid-router/src/RouterProvider.tsx +++ b/packages/solid-router/src/RouterProvider.tsx @@ -3,19 +3,20 @@ import { SafeFragment } from './SafeFragment' import { Matches } from './Matches' import type { AnyRouter, + Register, RegisteredRouter, RouterOptions, } from '@tanstack/router-core' import type * as Solid from 'solid-js' export function RouterContextProvider< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, >({ router, children, ...rest -}: RouterProps & { +}: RouterProps & { children: () => Solid.JSX.Element }) { // Allow the router to update options on the router instance @@ -42,9 +43,9 @@ export function RouterContextProvider< } export function RouterProvider< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, ->({ router, ...rest }: RouterProps) { +>({ router, ...rest }: RouterProps) { return ( {() => } @@ -53,25 +54,25 @@ export function RouterProvider< } export type RouterProps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDehydrated extends Record = Record, > = Omit< RouterOptions< - TRouter['routeTree'], - NonNullable, + RegisteredRouter['routeTree'], + NonNullable['options']['trailingSlash']>, false, - TRouter['history'], + RegisteredRouter['history'], TDehydrated >, 'context' > & { - router: TRouter + router: RegisteredRouter context?: Partial< RouterOptions< - TRouter['routeTree'], - NonNullable, + RegisteredRouter['routeTree'], + NonNullable['options']['trailingSlash']>, false, - TRouter['history'], + RegisteredRouter['history'], TDehydrated >['context'] > diff --git a/packages/solid-router/src/fileRoute.ts b/packages/solid-router/src/fileRoute.ts index 0d741017eb..4fcf5f6f01 100644 --- a/packages/solid-router/src/fileRoute.ts +++ b/packages/solid-router/src/fileRoute.ts @@ -14,7 +14,6 @@ import type { UseSearchRoute } from './useSearch' import type { AnyContext, AnyRoute, - AnyRouter, Constrain, ConstrainLiteral, FileBaseRouteOptions, @@ -182,13 +181,13 @@ export function FileRouteLoader< declare module '@tanstack/router-core' { export interface LazyRoute { - useMatch: UseMatchRoute - useRouteContext: UseRouteContextRoute - useSearch: UseSearchRoute - useParams: UseParamsRoute - useLoaderDeps: UseLoaderDepsRoute - useLoaderData: UseLoaderDataRoute - useNavigate: () => UseNavigateResult + useMatch: UseMatchRoute + useRouteContext: UseRouteContextRoute + useSearch: UseSearchRoute + useParams: UseParamsRoute + useLoaderDeps: UseLoaderDepsRoute + useLoaderData: UseLoaderDataRoute + useNavigate: () => UseNavigateResult } } @@ -205,53 +204,58 @@ export class LazyRoute { this.options = opts } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.options.id, } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ from: this.options.id, select: (d: any) => (opts?.select ? opts.select(d.context) : d.context), }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { return useSearch({ select: opts?.select, from: this.options.id, } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { return useParams({ select: opts?.select, from: this.options.id, } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.options.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.options.id } as any) } - useNavigate = (): UseNavigateResult => { + useNavigate = (): UseNavigateResult => { const router = useRouter() return useNavigate({ from: router.routesById[this.options.id].fullPath }) } } export function createLazyRoute< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TId extends string = string, - TRoute extends AnyRoute = RouteById, ->(id: ConstrainLiteral>) { + TRoute extends AnyRoute = RouteById< + RegisteredRouter['routeTree'], + TId + >, +>( + id: ConstrainLiteral['routeTree']>>, +) { return (opts: LazyRouteOptions) => { return new LazyRoute({ id: id, diff --git a/packages/solid-router/src/link.tsx b/packages/solid-router/src/link.tsx index dc9a6c478b..5dd681351d 100644 --- a/packages/solid-router/src/link.tsx +++ b/packages/solid-router/src/link.tsx @@ -16,10 +16,12 @@ import { useRouter } from './useRouter' import { useIntersectionObserver } from './utils' import type { - AnyRouter, Constrain, LinkCurrentTargetElement, LinkOptions, + MakeToRequired, + NavigateOptions, + Register, RegisteredRouter, RoutePaths, } from '@tanstack/router-core' @@ -29,13 +31,17 @@ import type { } from './typePrimitives' export function useLinkProps< - TRouter extends AnyRouter = RegisteredRouter, - TFrom extends RoutePaths | string = string, - TTo extends string = '', - TMaskFrom extends RoutePaths | string = TFrom, - TMaskTo extends string = '', + TRegister extends Register = Register, + const TFrom extends + | RoutePaths['routeTree']> + | string = string, + const TTo extends string = '', + const TMaskFrom extends + | RoutePaths['routeTree']> + | string = TFrom, + const TMaskTo extends string = '', >( - options: UseLinkPropsOptions, + options: UseLinkPropsOptions, ): Solid.ComponentProps<'a'> { const router = useRouter() const [isTransitioning, setIsTransitioning] = Solid.createSignal(false) @@ -313,7 +319,7 @@ export function useLinkProps< startTransition: local.startTransition, viewTransition: local.viewTransition, ignoreBlocker: local.ignoreBlocker, - }) + } as any) } } @@ -443,22 +449,26 @@ export function useLinkProps< } export type UseLinkPropsOptions< - TRouter extends AnyRouter = RegisteredRouter, - TFrom extends RoutePaths | string = string, + TRegister extends Register = Register, + TFrom extends + | RoutePaths['routeTree']> + | string = string, TTo extends string | undefined = '.', - TMaskFrom extends RoutePaths | string = TFrom, + TMaskFrom extends + | RoutePaths['routeTree']> + | string = TFrom, TMaskTo extends string = '.', -> = ActiveLinkOptions<'a', TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & +> = ActiveLinkOptions<'a', TRegister, TFrom, TTo, TMaskFrom, TMaskTo> & Omit, 'style'> & { style?: Solid.JSX.CSSProperties } export type ActiveLinkOptions< TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = LinkOptions & +> = LinkOptions, TFrom, TTo, TMaskFrom, TMaskTo> & ActiveLinkOptionProps type ActiveLinkProps = Partial< @@ -482,12 +492,13 @@ export interface ActiveLinkOptionProps { export type LinkProps< TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', -> = ActiveLinkOptions & +> = MakeToRequired & + ActiveLinkOptions & LinkPropsChildren export interface LinkPropsChildren { @@ -506,17 +517,17 @@ type LinkComponentSolidProps = TComp extends Solid.ValidComponent export type LinkComponentProps< TComp = 'a', - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.', > = LinkComponentSolidProps & - LinkProps + LinkProps export type CreateLinkProps = LinkProps< any, - any, + Register, string, string, string, @@ -527,13 +538,13 @@ export type LinkComponent< in out TComp, in out TDefaultFrom extends string = string, > = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = TDefaultFrom, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - props: LinkComponentProps, + props: LinkComponentProps, ) => Solid.JSX.Element export interface LinkComponentRoute< @@ -541,13 +552,13 @@ export interface LinkComponentRoute< > { defaultFrom: TDefaultFrom < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TTo extends string | undefined = undefined, const TMaskTo extends string = '', >( props: LinkComponentProps< 'a', - TRouter, + TRegister, this['defaultFrom'], TTo, this['defaultFrom'], @@ -559,7 +570,7 @@ export interface LinkComponentRoute< export function createLink( Comp: Constrain Solid.JSX.Element>, ): LinkComponent { - return (props) => + return (props) => } export const Link: LinkComponent<'a'> = (props) => { @@ -612,17 +623,17 @@ function isCtrlEvent(e: MouseEvent) { export type LinkOptionsFnOptions< TOptions, TComp, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = TOptions extends ReadonlyArray - ? ValidateLinkOptionsArray - : ValidateLinkOptions + ? ValidateLinkOptionsArray + : ValidateLinkOptions export type LinkOptionsFn = < const TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, >( - options: LinkOptionsFnOptions, + options: LinkOptionsFnOptions, ) => TOptions export const linkOptions: LinkOptionsFn<'a'> = (options) => { diff --git a/packages/solid-router/src/route.tsx b/packages/solid-router/src/route.tsx index 3f29f7128e..2b550afae4 100644 --- a/packages/solid-router/src/route.tsx +++ b/packages/solid-router/src/route.tsx @@ -15,7 +15,6 @@ import { useRouter } from './useRouter' import type { AnyContext, AnyRoute, - AnyRouter, ConstrainLiteral, ErrorComponentProps, NotFoundError, @@ -67,28 +66,27 @@ declare module '@tanstack/router-core' { in out TId extends string, in out TFullPath extends string, > { - useMatch: UseMatchRoute - useRouteContext: UseRouteContextRoute - useSearch: UseSearchRoute - useParams: UseParamsRoute - useLoaderDeps: UseLoaderDepsRoute - useLoaderData: UseLoaderDataRoute - useNavigate: () => UseNavigateResult + useMatch: UseMatchRoute + useRouteContext: UseRouteContextRoute + useSearch: UseSearchRoute + useParams: UseParamsRoute + useLoaderDeps: UseLoaderDepsRoute + useLoaderData: UseLoaderDataRoute + useNavigate: () => UseNavigateResult Link: LinkComponentRoute } } -export function getRouteApi< - const TId, - TRouter extends AnyRouter = RegisteredRouter, ->(id: ConstrainLiteral>) { - return new RouteApi({ id }) +export function getRouteApi( + id: ConstrainLiteral['routeTree']>>, +) { + return new RouteApi({ id }) } export class RouteApi< TId, - TRouter extends AnyRouter = RegisteredRouter, -> extends BaseRouteApi { + TRegister extends Register = Register, +> extends BaseRouteApi> { /** * @deprecated Use the `getRouteApi` function instead. */ @@ -96,44 +94,46 @@ export class RouteApi< super({ id }) } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, + structuralSharing: opts?.structuralSharing, } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ from: this.id as any, select: (d) => (opts?.select ? opts.select(d.context) : d.context), }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { return useSearch({ select: opts?.select, from: this.id, } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { return useParams({ select: opts?.select, from: this.id, } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id, strict: false } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id, strict: false } as any) } useNavigate = (): UseNavigateResult< - RouteTypesById['fullPath'] + TRegister, + RouteTypesById, TId>['fullPath'] > => { const router = useRouter() return useNavigate({ from: router.routesById[this.id as string].fullPath }) @@ -143,17 +143,19 @@ export class RouteApi< return notFound({ routeId: this.id as string, ...opts }) } - Link: LinkComponentRoute['fullPath']> = (( - props, - ) => { + Link: LinkComponentRoute< + RouteTypesById, TId>['fullPath'] + > = ((props) => { const router = useRouter() const fullPath = router.routesById[this.id as string].fullPath - return - }) as LinkComponentRoute['fullPath']> + return + }) as LinkComponentRoute< + RouteTypesById, TId>['fullPath'] + > } export class Route< - in out TRegister = unknown, + in out TRegister extends Register = Register, in out TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, in out TPath extends RouteConstraints['TPath'] = '/', in out TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath< @@ -176,7 +178,7 @@ export class Route< in out TChildren = unknown, in out TFileRouteTypes = unknown, in out TSSR = unknown, - in out TMiddlewares = unknown, + in out TServerMiddlewares = unknown, in out THandlers = undefined, > extends BaseRoute< @@ -196,7 +198,7 @@ export class Route< TChildren, TFileRouteTypes, TSSR, - TMiddlewares, + TServerMiddlewares, THandlers > implements @@ -217,7 +219,7 @@ export class Route< TChildren, TFileRouteTypes, TSSR, - TMiddlewares, + TServerMiddlewares, THandlers > { @@ -240,21 +242,22 @@ export class Route< TRouteContextFn, TBeforeLoadFn, TSSR, - TMiddlewares, + TServerMiddlewares, THandlers >, ) { super(options) } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, + structuralSharing: opts?.structuralSharing, } as any) as any } - useRouteContext: UseRouteContextRoute = (opts?) => { + useRouteContext: UseRouteContextRoute = (opts?) => { return useMatch({ ...opts, from: this.id, @@ -262,39 +265,39 @@ export class Route< }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { return useSearch({ select: opts?.select, from: this.id, } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { return useParams({ select: opts?.select, from: this.id, } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id } as any) } - useNavigate = (): UseNavigateResult => { + useNavigate = (): UseNavigateResult => { return useNavigate({ from: this.fullPath }) } Link: LinkComponentRoute = ((props) => { - return + return }) as LinkComponentRoute } export function createRoute< - TRegister = unknown, + TRegister extends Register = Register, TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute, TPath extends RouteConstraints['TPath'] = '/', TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath< @@ -315,6 +318,7 @@ export function createRoute< TLoaderFn = undefined, TChildren = unknown, TSSR = unknown, + const TServerMiddlewares = unknown, THandlers = undefined, >( options: RouteOptions< @@ -332,6 +336,7 @@ export function createRoute< TRouteContextFn, TBeforeLoadFn, TSSR, + TServerMiddlewares, THandlers >, ): Route< @@ -351,6 +356,7 @@ export function createRoute< TChildren, unknown, TSSR, + TServerMiddlewares, THandlers > { return new Route< @@ -370,6 +376,7 @@ export function createRoute< TChildren, unknown, TSSR, + TServerMiddlewares, THandlers >(options) } @@ -384,18 +391,20 @@ export type AnyRootRoute = RootRoute< any, any, any, + any, any > export function createRootRouteWithContext() { return < - TRegister = Register, + TRegister extends Register = Register, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TSearchValidator = undefined, TLoaderDeps extends Record = {}, TLoaderFn = undefined, TSSR = unknown, + TServerMiddlewares = unknown, THandlers = undefined, >( options?: RootRouteOptions< @@ -407,6 +416,7 @@ export function createRootRouteWithContext() { TLoaderDeps, TLoaderFn, TSSR, + TServerMiddlewares, THandlers >, ) => { @@ -419,6 +429,7 @@ export function createRootRouteWithContext() { TLoaderDeps, TLoaderFn, TSSR, + TServerMiddlewares, THandlers >(options as any) } @@ -430,7 +441,7 @@ export function createRootRouteWithContext() { export const rootRouteWithContext = createRootRouteWithContext export class RootRoute< - in out TRegister = Register, + in out TRegister extends Register = Register, in out TSearchValidator = undefined, in out TRouterContext = {}, in out TRouteContextFn = AnyContext, @@ -440,6 +451,7 @@ export class RootRoute< in out TChildren = unknown, in out TFileRouteTypes = unknown, in out TSSR = unknown, + in out TServerMiddlewares = unknown, in out THandlers = undefined, > extends BaseRootRoute< @@ -453,6 +465,7 @@ export class RootRoute< TChildren, TFileRouteTypes, TSSR, + TServerMiddlewares, THandlers > implements @@ -467,6 +480,7 @@ export class RootRoute< TChildren, TFileRouteTypes, TSSR, + TServerMiddlewares, THandlers > { @@ -483,20 +497,22 @@ export class RootRoute< TLoaderDeps, TLoaderFn, TSSR, + TServerMiddlewares, THandlers >, ) { super(options) } - useMatch: UseMatchRoute = (opts) => { + useMatch: UseMatchRoute = (opts) => { return useMatch({ select: opts?.select, from: this.id, + structuralSharing: opts?.structuralSharing, } as any) as any } - useRouteContext: UseRouteContextRoute = (opts) => { + useRouteContext: UseRouteContextRoute = (opts) => { return useMatch({ ...opts, from: this.id, @@ -504,29 +520,29 @@ export class RootRoute< }) as any } - useSearch: UseSearchRoute = (opts) => { + useSearch: UseSearchRoute = (opts) => { return useSearch({ select: opts?.select, from: this.id, } as any) as any } - useParams: UseParamsRoute = (opts) => { + useParams: UseParamsRoute = (opts) => { return useParams({ select: opts?.select, from: this.id, } as any) as any } - useLoaderDeps: UseLoaderDepsRoute = (opts) => { + useLoaderDeps: UseLoaderDepsRoute = (opts) => { return useLoaderDeps({ ...opts, from: this.id } as any) } - useLoaderData: UseLoaderDataRoute = (opts) => { + useLoaderData: UseLoaderDataRoute = (opts) => { return useLoaderData({ ...opts, from: this.id } as any) } - useNavigate = (): UseNavigateResult<'/'> => { + useNavigate = (): UseNavigateResult => { return useNavigate({ from: this.fullPath }) } @@ -542,7 +558,7 @@ export function createRouteMask< >( opts: { routeTree: TRouteTree - } & ToMaskOptions, TFrom, TTo>, + } & ToMaskOptions, ): RouteMask { return opts as any } @@ -565,7 +581,7 @@ export type ErrorRouteComponent = AsyncRouteComponent export type NotFoundRouteComponent = RouteTypes['component'] export class NotFoundRoute< - TRegister, + TRegister extends Register, TParentRoute extends AnyRootRoute, TRouterContext = AnyContext, TRouteContextFn = AnyContext, @@ -575,7 +591,7 @@ export class NotFoundRoute< TLoaderFn = undefined, TChildren = unknown, TSSR = unknown, - THandlers = undefined, + TServerMiddlewares = unknown, > extends Route< TRegister, TParentRoute, @@ -592,7 +608,7 @@ export class NotFoundRoute< TLoaderFn, TChildren, TSSR, - THandlers + TServerMiddlewares > { constructor( options: Omit< @@ -611,7 +627,7 @@ export class NotFoundRoute< TRouteContextFn, TBeforeLoadFn, TSSR, - THandlers + TServerMiddlewares >, | 'caseSensitive' | 'parseParams' @@ -629,7 +645,7 @@ export class NotFoundRoute< } export function createRootRoute< - TRegister = Register, + TRegister extends Register = Register, TSearchValidator = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, @@ -637,6 +653,7 @@ export function createRootRoute< TLoaderDeps extends Record = {}, TLoaderFn = undefined, TSSR = unknown, + const TServerMiddlewares = unknown, THandlers = undefined, >( options?: RootRouteOptions< @@ -648,6 +665,7 @@ export function createRootRoute< TLoaderDeps, TLoaderFn, TSSR, + TServerMiddlewares, THandlers >, ): RootRoute< @@ -661,6 +679,7 @@ export function createRootRoute< unknown, unknown, TSSR, + TServerMiddlewares, THandlers > { return new RootRoute< @@ -674,6 +693,7 @@ export function createRootRoute< unknown, unknown, TSSR, + TServerMiddlewares, THandlers >(options) } diff --git a/packages/solid-router/src/structuralSharing.ts b/packages/solid-router/src/structuralSharing.ts new file mode 100644 index 0000000000..bbe9856637 --- /dev/null +++ b/packages/solid-router/src/structuralSharing.ts @@ -0,0 +1,52 @@ +import type { + Constrain, + OptionalStructuralSharing, + Register, + RegisteredRouter, + ValidateJSON, +} from '@tanstack/router-core' + +export type DefaultStructuralSharingEnabled< + TRegister extends Register = Register, +> = + boolean extends RegisteredRouter['options']['defaultStructuralSharing'] + ? // for now, default to false. + // TODO in V2: default to true + false + : NonNullable< + RegisteredRouter['options']['defaultStructuralSharing'] + > + +export interface RequiredStructuralSharing { + readonly structuralSharing: Constrain +} + +export type StructuralSharingOption< + TRegister extends Register, + TSelected, + TStructuralSharing, +> = unknown extends TSelected + ? OptionalStructuralSharing + : unknown extends RegisteredRouter['routeTree'] + ? OptionalStructuralSharing + : TSelected extends ValidateJSON + ? OptionalStructuralSharing + : DefaultStructuralSharingEnabled extends true + ? RequiredStructuralSharing + : OptionalStructuralSharing + +export type StructuralSharingEnabled< + TRegister extends Register, + TStructuralSharing, +> = boolean extends TStructuralSharing + ? DefaultStructuralSharingEnabled + : TStructuralSharing + +export type ValidateSelected< + TRegister extends Register, + TSelected, + TStructuralSharing, +> = + StructuralSharingEnabled extends true + ? ValidateJSON + : TSelected diff --git a/packages/solid-router/src/typePrimitives.ts b/packages/solid-router/src/typePrimitives.ts index b134cb8959..abf9d0931e 100644 --- a/packages/solid-router/src/typePrimitives.ts +++ b/packages/solid-router/src/typePrimitives.ts @@ -12,10 +12,11 @@ import type { InferStrict, InferTo, RegisteredRouter, + Register, } from '@tanstack/router-core' export type ValidateLinkOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions = unknown, TDefaultFrom extends string = string, TComp = 'a', @@ -23,7 +24,7 @@ export type ValidateLinkOptions< TOptions, LinkComponentProps< TComp, - TRouter, + TRegister, InferFrom, InferTo, InferMaskFrom, @@ -31,44 +32,55 @@ export type ValidateLinkOptions< > > -export type ValidateLinkOptionsArray< - TRouter extends AnyRouter = RegisteredRouter, - TOptions extends ReadonlyArray = ReadonlyArray, - TDefaultFrom extends string = string, - TComp = 'a', -> = { - [K in keyof TOptions]: ValidateLinkOptions< - TRouter, - TOptions[K], - TDefaultFrom, - TComp - > +/** + * @private + */ +export type InferStructuralSharing = TOptions extends { + structuralSharing: infer TStructuralSharing } + ? TStructuralSharing + : unknown export type ValidateUseSearchOptions< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = Constrain< TOptions, UseSearchOptions< - TRouter, + TRegister, InferFrom, InferStrict, InferShouldThrow, - InferSelected + InferSelected, + InferStructuralSharing > > export type ValidateUseParamsOptions< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = Constrain< TOptions, UseParamsOptions< - TRouter, + TRegister, InferFrom, InferStrict, InferShouldThrow, - InferSelected + InferSelected, + InferStructuralSharing > > + +export type ValidateLinkOptionsArray< + TRegister extends Register = Register, + TOptions extends ReadonlyArray = ReadonlyArray, + TDefaultFrom extends string = string, + TComp = 'a', +> = { + [K in keyof TOptions]: ValidateLinkOptions< + TRegister, + TOptions[K], + TDefaultFrom, + TComp + > +} diff --git a/packages/solid-router/src/useBlocker.tsx b/packages/solid-router/src/useBlocker.tsx index 25c8039aba..0a6cef607d 100644 --- a/packages/solid-router/src/useBlocker.tsx +++ b/packages/solid-router/src/useBlocker.tsx @@ -8,8 +8,8 @@ import type { import type { SolidNode } from './route' import type { AnyRoute, - AnyRouter, ParseRoute, + Register, RegisteredRouter, } from '@tanstack/router-core' @@ -28,8 +28,10 @@ interface ShouldBlockFnLocation< type AnyShouldBlockFnLocation = ShouldBlockFnLocation type MakeShouldBlockFnLocationUnion< - TRouter extends AnyRouter = RegisteredRouter, - TRoute extends AnyRoute = ParseRoute, + TRegister extends Register = Register, + TRoute extends AnyRoute = ParseRoute< + RegisteredRouter['routeTree'] + >, > = TRoute extends any ? ShouldBlockFnLocation< TRoute['id'], @@ -39,11 +41,11 @@ type MakeShouldBlockFnLocationUnion< > : never -type BlockerResolver = +type BlockerResolver = | { status: 'blocked' - current: MakeShouldBlockFnLocationUnion - next: MakeShouldBlockFnLocationUnion + current: MakeShouldBlockFnLocationUnion + next: MakeShouldBlockFnLocationUnion action: HistoryAction proceed: () => void reset: () => void @@ -57,20 +59,20 @@ type BlockerResolver = reset: undefined } -type ShouldBlockFnArgs = { - current: MakeShouldBlockFnLocationUnion - next: MakeShouldBlockFnLocationUnion +type ShouldBlockFnArgs = { + current: MakeShouldBlockFnLocationUnion + next: MakeShouldBlockFnLocationUnion action: HistoryAction } -export type ShouldBlockFn = ( - args: ShouldBlockFnArgs, +export type ShouldBlockFn = ( + args: ShouldBlockFnArgs, ) => boolean | Promise export type UseBlockerOpts< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, > = { - shouldBlockFn: ShouldBlockFn + shouldBlockFn: ShouldBlockFn enableBeforeUnload?: boolean | (() => boolean) disabled?: boolean withResolver?: TWithResolver @@ -135,11 +137,13 @@ function _resolveBlockerOpts( } export function useBlocker< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = false, >( - opts: UseBlockerOpts, -): TWithResolver extends true ? Solid.Accessor> : void + opts: UseBlockerOpts, +): TWithResolver extends true + ? Solid.Accessor> + : void /** * @deprecated Use the shouldBlockFn property instead @@ -293,9 +297,9 @@ const _resolvePromptBlockerArgs = ( } export function Block< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, ->(opts: PromptProps): SolidNode +>(opts: PromptProps): SolidNode /** * @deprecated Use the UseBlockerOpts property instead @@ -323,9 +327,9 @@ type LegacyPromptProps = { } type PromptProps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TWithResolver extends boolean = boolean, - TParams = TWithResolver extends true ? BlockerResolver : void, -> = UseBlockerOpts & { + TParams = TWithResolver extends true ? BlockerResolver : void, +> = UseBlockerOpts & { children?: SolidNode | ((params: TParams) => SolidNode) } diff --git a/packages/solid-router/src/useLoaderData.tsx b/packages/solid-router/src/useLoaderData.tsx index c248ac7178..76fe27e747 100644 --- a/packages/solid-router/src/useLoaderData.tsx +++ b/packages/solid-router/src/useLoaderData.tsx @@ -1,7 +1,7 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { - AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderData, StrictOrFrom, @@ -9,37 +9,42 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDataBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > { - select?: (match: ResolveUseLoaderData) => TSelected + select?: ( + match: ResolveUseLoaderData, TFrom, TStrict>, + ) => TSelected } export type UseLoaderDataOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TSelected, -> = StrictOrFrom & - UseLoaderDataBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseLoaderDataBaseOptions -export type UseLoaderDataRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseLoaderDataRoute = < TSelected = unknown, >( - opts?: UseLoaderDataBaseOptions, -) => Accessor> + opts?: UseLoaderDataBaseOptions, +) => Accessor< + UseLoaderDataResult, TId, true, TSelected> +> export function useLoaderData< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseLoaderDataOptions, -): Accessor> { + opts: UseLoaderDataOptions, +): Accessor< + UseLoaderDataResult, TFrom, TStrict, TSelected> +> { return useMatch({ from: opts.from!, strict: opts.strict, diff --git a/packages/solid-router/src/useLoaderDeps.tsx b/packages/solid-router/src/useLoaderDeps.tsx index 19b88a1c92..15f981b40a 100644 --- a/packages/solid-router/src/useLoaderDeps.tsx +++ b/packages/solid-router/src/useLoaderDeps.tsx @@ -1,7 +1,7 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { - AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderDeps, StrictOrFrom, @@ -9,39 +9,44 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDepsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TSelected, > { - select?: (deps: ResolveUseLoaderDeps) => TSelected + select?: ( + deps: ResolveUseLoaderDeps, TFrom>, + ) => TSelected } export type UseLoaderDepsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TSelected, -> = StrictOrFrom & - UseLoaderDepsBaseOptions +> = StrictOrFrom, TFrom> & + UseLoaderDepsBaseOptions -export type UseLoaderDepsRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseLoaderDepsRoute = < TSelected = unknown, >( - opts?: UseLoaderDepsBaseOptions, -) => Accessor> + opts?: UseLoaderDepsBaseOptions, +) => Accessor, TId, TSelected>> export function useLoaderDeps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TSelected = unknown, >( - opts: UseLoaderDepsOptions, -): Accessor> { + opts: UseLoaderDepsOptions, +): Accessor< + UseLoaderDepsResult, TFrom, TSelected> +> { const { select, ...rest } = opts return useMatch({ ...rest, select: (s) => { return select ? select(s.loaderDeps) : s.loaderDeps }, - }) as Accessor> + }) as Accessor< + UseLoaderDepsResult, TFrom, TSelected> + > } diff --git a/packages/solid-router/src/useLocation.tsx b/packages/solid-router/src/useLocation.tsx index 14a065925e..cacc3dfff1 100644 --- a/packages/solid-router/src/useLocation.tsx +++ b/packages/solid-router/src/useLocation.tsx @@ -1,30 +1,32 @@ import { useRouterState } from './useRouterState' import type { - AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' import type { Accessor } from 'solid-js' -export interface UseLocationBaseOptions { - select?: (state: RouterState['location']) => TSelected +export interface UseLocationBaseOptions { + select?: ( + state: RouterState['routeTree']>['location'], + ) => TSelected } export type UseLocationResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, > = unknown extends TSelected - ? RouterState['location'] + ? RouterState['routeTree']>['location'] : TSelected export function useLocation< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseLocationBaseOptions, -): Accessor> { + opts?: UseLocationBaseOptions, +): Accessor> { return useRouterState({ select: (state: any) => opts?.select ? opts.select(state.location) : state.location, - } as any) as Accessor> + } as any) as Accessor> } diff --git a/packages/solid-router/src/useMatch.tsx b/packages/solid-router/src/useMatch.tsx index 40a99e1487..3ac6f24195 100644 --- a/packages/solid-router/src/useMatch.tsx +++ b/packages/solid-router/src/useMatch.tsx @@ -6,6 +6,7 @@ import type { AnyRouter, MakeRouteMatch, MakeRouteMatchUnion, + Register, RegisteredRouter, StrictOrFrom, ThrowConstraint, @@ -13,61 +14,65 @@ import type { } from '@tanstack/router-core' export interface UseMatchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, > { select?: ( - match: MakeRouteMatch, + match: MakeRouteMatch< + RegisteredRouter['routeTree'], + TFrom, + TStrict + >, ) => TSelected shouldThrow?: TThrow + structuralSharing?: boolean } -export type UseMatchRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseMatchRoute = < TSelected = unknown, >( - opts?: UseMatchBaseOptions, -) => Solid.Accessor> + opts?: UseMatchBaseOptions, +) => Solid.Accessor> export type UseMatchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseMatchBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseMatchBaseOptions export type UseMatchResult< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected ? TStrict extends true - ? MakeRouteMatch - : MakeRouteMatchUnion + ? MakeRouteMatch['routeTree'], TFrom, TStrict> + : MakeRouteMatchUnion> : TSelected export function useMatch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, >( opts: UseMatchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected >, ): Solid.Accessor< - ThrowOrOptional, TThrow> + ThrowOrOptional, TThrow> > { const nearestMatchId = Solid.useContext( opts.from ? dummyMatchContext : matchContext, diff --git a/packages/solid-router/src/useNavigate.tsx b/packages/solid-router/src/useNavigate.tsx index 40e51ced6b..30d67cbaeb 100644 --- a/packages/solid-router/src/useNavigate.tsx +++ b/packages/solid-router/src/useNavigate.tsx @@ -1,19 +1,19 @@ import * as Solid from 'solid-js' import { useRouter } from './useRouter' import type { - AnyRouter, FromPathOption, NavigateOptions, + Register, RegisteredRouter, UseNavigateResult, } from '@tanstack/router-core' export function useNavigate< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TDefaultFrom extends string = string, >(_defaultOpts?: { - from?: FromPathOption -}): UseNavigateResult { + from?: FromPathOption, TDefaultFrom> +}): UseNavigateResult { const router = useRouter() return ((options: NavigateOptions) => { @@ -21,16 +21,24 @@ export function useNavigate< ...options, from: options.from ?? _defaultOpts?.from, }) - }) as UseNavigateResult + }) as UseNavigateResult } export function Navigate< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', ->(props: NavigateOptions): null { +>( + props: NavigateOptions< + RegisteredRouter, + TFrom, + TTo, + TMaskFrom, + TMaskTo + >, +): null { const { navigate } = useRouter() Solid.onMount(() => { diff --git a/packages/solid-router/src/useParams.tsx b/packages/solid-router/src/useParams.tsx index 1788f69fe9..7b32e8df19 100644 --- a/packages/solid-router/src/useParams.tsx +++ b/packages/solid-router/src/useParams.tsx @@ -1,7 +1,11 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { - AnyRouter, + StructuralSharingOption, + ValidateSelected, +} from './structuralSharing' +import type { + Register, RegisteredRouter, ResolveUseParams, StrictOrFrom, @@ -11,60 +15,89 @@ import type { } from '@tanstack/router-core' export interface UseParamsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, + TStructuralSharing, > { - select?: (params: ResolveUseParams) => TSelected + select?: ( + params: ResolveUseParams, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > shouldThrow?: TThrow } export type UseParamsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseParamsBaseOptions + TStructuralSharing, +> = StrictOrFrom & + UseParamsBaseOptions< + TRegister, + TFrom, + TStrict, + TThrow, + TSelected, + TStructuralSharing + > & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseParamsRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseParamsRoute = < TSelected = unknown, + TStructuralSharing extends boolean = boolean, >( opts?: UseParamsBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, - TSelected - >, -) => Accessor> + TSelected, + TStructuralSharing + > & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => Accessor> export function useParams< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, + TStructuralSharing extends boolean = boolean, >( opts: UseParamsOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, - TSelected - >, + TSelected, + TStructuralSharing + > = {} as any, ): Accessor< - ThrowOrOptional, TThrow> + ThrowOrOptional, TThrow> > { return useMatch({ from: opts.from!, shouldThrow: opts.shouldThrow, strict: opts.strict, - select: (match) => { + structuralSharing: opts.structuralSharing, + select: (match: any) => { const params = opts.strict === false ? match.params : match._strictParams return opts.select ? opts.select(params) : params diff --git a/packages/solid-router/src/useRouteContext.ts b/packages/solid-router/src/useRouteContext.ts index 6b6cf7392d..c37a6fec4b 100644 --- a/packages/solid-router/src/useRouteContext.ts +++ b/packages/solid-router/src/useRouteContext.ts @@ -1,31 +1,44 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { - AnyRouter, + Register, RegisteredRouter, UseRouteContextBaseOptions, UseRouteContextOptions, UseRouteContextResult, } from '@tanstack/router-core' -export type UseRouteContextRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseRouteContextRoute = < TSelected = unknown, >( - opts?: UseRouteContextBaseOptions, -) => Accessor> + opts?: UseRouteContextBaseOptions< + RegisteredRouter, + TFrom, + true, + TSelected + >, +) => Accessor< + UseRouteContextResult, TFrom, true, TSelected> +> export function useRouteContext< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseRouteContextOptions, -): Accessor> { + opts: UseRouteContextOptions< + RegisteredRouter, + TFrom, + TStrict, + TSelected + >, +): Accessor< + UseRouteContextResult, TFrom, TStrict, TSelected> +> { return useMatch({ ...(opts as any), - select: (match) => + select: (match: any) => opts.select ? opts.select(match.context) : match.context, }) as any } diff --git a/packages/solid-router/src/useRouter.tsx b/packages/solid-router/src/useRouter.tsx index 0a5565c57b..99eb4f1537 100644 --- a/packages/solid-router/src/useRouter.tsx +++ b/packages/solid-router/src/useRouter.tsx @@ -1,11 +1,11 @@ import * as Solid from 'solid-js' import warning from 'tiny-warning' import { getRouterContext } from './routerContext' -import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core' +import type { Register, RegisteredRouter } from '@tanstack/router-core' -export function useRouter(opts?: { +export function useRouter(opts?: { warn?: boolean -}): TRouter { +}): RegisteredRouter { const value = Solid.useContext(getRouterContext() as any) warning( !((opts?.warn ?? true) && !value), diff --git a/packages/solid-router/src/useRouterState.tsx b/packages/solid-router/src/useRouterState.tsx index 0abff0a5b2..df9a93e80b 100644 --- a/packages/solid-router/src/useRouterState.tsx +++ b/packages/solid-router/src/useRouterState.tsx @@ -2,7 +2,7 @@ import { useStore } from '@tanstack/solid-store' import { useRouter } from './useRouter' import type { - AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' @@ -34,23 +34,27 @@ function deepEqual(a: any, b: any): boolean { return true } -export type UseRouterStateOptions = { - router?: TRouter - select?: (state: RouterState) => TSelected +export type UseRouterStateOptions = { + router?: RegisteredRouter + select?: ( + state: RouterState['routeTree']>, + ) => TSelected } export type UseRouterStateResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? RouterState : TSelected +> = unknown extends TSelected + ? RouterState['routeTree']> + : TSelected export function useRouterState< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseRouterStateOptions, -): Accessor> { - const contextRouter = useRouter({ + opts?: UseRouterStateOptions, +): Accessor> { + const contextRouter = useRouter({ warn: opts?.router === undefined, }) const router = opts?.router || contextRouter @@ -68,5 +72,5 @@ export function useRouterState< // return new object references but with the same values. equal: deepEqual, }, - ) as Accessor> + ) as Accessor> } diff --git a/packages/solid-router/src/useSearch.tsx b/packages/solid-router/src/useSearch.tsx index f795646cc2..f6712eac73 100644 --- a/packages/solid-router/src/useSearch.tsx +++ b/packages/solid-router/src/useSearch.tsx @@ -1,7 +1,11 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { - AnyRouter, + StructuralSharingOption, + ValidateSelected, +} from './structuralSharing' +import type { + Register, RegisteredRouter, ResolveUseSearch, StrictOrFrom, @@ -11,59 +15,93 @@ import type { } from '@tanstack/router-core' export interface UseSearchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, + TStructuralSharing, > { - select?: (state: ResolveUseSearch) => TSelected + select?: ( + state: ResolveUseSearch, TFrom, TStrict>, + ) => ValidateSelected< + RegisteredRouter, + TSelected, + TStructuralSharing + > shouldThrow?: TThrow } export type UseSearchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseSearchBaseOptions + TStructuralSharing, +> = StrictOrFrom, TFrom, TStrict> & + UseSearchBaseOptions< + TRegister, + TFrom, + TStrict, + TThrow, + TSelected, + TStructuralSharing + > & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + > -export type UseSearchRoute = < - TRouter extends AnyRouter = RegisteredRouter, +export type UseSearchRoute = < TSelected = unknown, + TStructuralSharing extends boolean = boolean, >( opts?: UseSearchBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, - TSelected - >, -) => Accessor> + TSelected, + TStructuralSharing + > & + StructuralSharingOption< + RegisteredRouter, + TSelected, + TStructuralSharing + >, +) => Accessor< + UseSearchResult, TFrom, true, TSelected> +> export function useSearch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, + TStructuralSharing extends boolean = boolean, >( opts: UseSearchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, - TSelected - >, + TSelected, + TStructuralSharing + > = {} as any, ): Accessor< - ThrowOrOptional, TThrow> + ThrowOrOptional< + UseSearchResult, TFrom, TStrict, TSelected>, + TThrow + > > { return useMatch({ from: opts.from!, strict: opts.strict, shouldThrow: opts.shouldThrow, + structuralSharing: opts.structuralSharing, select: (match: any) => { return opts.select ? opts.select(match.search) : match.search }, diff --git a/packages/solid-router/tests/Matches.test-d.tsx b/packages/solid-router/tests/Matches.test-d.tsx index b107435db6..991dfb368a 100644 --- a/packages/solid-router/tests/Matches.test-d.tsx +++ b/packages/solid-router/tests/Matches.test-d.tsx @@ -8,7 +8,7 @@ import { useMatchRoute, useMatches, } from '../src' -import type { AnyRouteMatch, RouteMatch } from '@tanstack/router-core' +import type { AnyRouteMatch, Register, RouteMatch } from '@tanstack/router-core' import type * as Solid from 'solid-js' const rootRoute = createRootRoute() @@ -145,9 +145,15 @@ const defaultRouter = createRouter({ routeTree, }) +declare module '@tanstack/router-core' { + interface Register { + router: typeof defaultRouter + } +} + type DefaultRouter = typeof defaultRouter -const useDefaultMatchRoute = useMatchRoute +const useDefaultMatchRoute = useMatchRoute test('when matching a route with params', () => { const matchRoute = useDefaultMatchRoute() @@ -159,46 +165,50 @@ test('when matching a route with params', () => { '/' | '.' | '..' | '/invoices' | '/invoices/$invoiceId' | '/comments/$id' >() - expectTypeOf(MatchRoute) + expectTypeOf( + MatchRoute<{ router: DefaultRouter }, string, '/invoices/$invoiceId'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< '/' | '.' | '..' | '/invoices' | '/invoices/$invoiceId' | '/comments/$id' >() - expectTypeOf( - matchRoute({ - to: '/invoices/$invoiceId', - }), - ).toEqualTypeOf>() + const match = matchRoute({ + to: '/invoices/$invoiceId', + }) + + expectTypeOf(match()).toEqualTypeOf() }) test('when matching a route with params underneath a layout route', () => { const matchRoute = useDefaultMatchRoute() - expectTypeOf( - matchRoute({ - to: '/comments/$id', - }), - ).toEqualTypeOf>() + const match = matchRoute({ + to: '/comments/$id', + }) + + expectTypeOf(match()).toEqualTypeOf() }) test('useMatches returns a union of all matches', () => { - expectTypeOf(useMatches()()).toEqualTypeOf< - Array< - | RootMatch - | IndexMatch - | InvoicesMatch - | InvoicesIndexMatch - | InvoiceMatch - | LayoutMatch - | CommentsMatch + expectTypeOf(useMatches()).toEqualTypeOf< + Solid.Accessor< + Array< + | RootMatch + | IndexMatch + | InvoicesMatch + | InvoicesIndexMatch + | InvoiceMatch + | LayoutMatch + | CommentsMatch + > > > }) test('when filtering useMatches by search', () => { - const matches = useMatches()() + const matches = useMatches()() expectTypeOf(isMatch<(typeof matches)[number], ''>) .parameter(1) @@ -213,7 +223,7 @@ test('when filtering useMatches by search', () => { }) test('when filtering useMatches by loaderData with an array', () => { - const matches = useMatches()() + const matches = useMatches()() expectTypeOf(isMatch<(typeof matches)[number], ''>) .parameter(1) diff --git a/packages/solid-router/tests/debug-link.test-d.tsx b/packages/solid-router/tests/debug-link.test-d.tsx new file mode 100644 index 0000000000..d23cf5c936 --- /dev/null +++ b/packages/solid-router/tests/debug-link.test-d.tsx @@ -0,0 +1,29 @@ +import { expectTypeOf, test } from 'vitest' +import { Link, createRouter, createRoute, createRootRoute } from '../src' +import type { LinkComponentProps } from '../src' + +const rootRoute = createRootRoute() +const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/' }) +const routeTree = rootRoute.addChildren([indexRoute]) +const router = createRouter({ routeTree }) + +type MyRouter = typeof router + +test('debug link types', () => { + // Test 1: Instantiate Link with explicit router + const MyLink = Link<{ router: MyRouter }, '/', '/'> + + // Check the type of MyLink + // It should be a function taking props + + type MyLinkProps = Parameters[0] + + // Expect 'to' to be specific + expectTypeOf().toEqualTypeOf<'/' | '.' | '..'>() + + // Check what parameter(0) returns on the instantiated function + expectTypeOf(MyLink) + .parameter(0) + .toHaveProperty('to') + .toEqualTypeOf<'/' | '.' | '..'>() +}) diff --git a/packages/solid-router/tests/link.test-d.tsx b/packages/solid-router/tests/link.test-d.tsx index 515f107c0f..8b9fd6ee9e 100644 --- a/packages/solid-router/tests/link.test-d.tsx +++ b/packages/solid-router/tests/link.test-d.tsx @@ -167,20 +167,24 @@ type RouterNeverTrailingSlashes = typeof routerNeverTrailingSlashes type RouterPreserveTrailingSlashes = typeof routerPreserveTrailingSlashes test('when navigating to the root', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, string, '/'> + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + string, + '/' + > const RouterAlwaysTrailingSlashLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/' > const RouterNeverTrailingSlashLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/' > const RouterPreserveTrailingSlashLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, '/' > @@ -434,7 +438,7 @@ test('when navigating to the root', () => { }) test('when navigating from a route with no params and no search to the root', () => { - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '/'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -455,7 +459,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '/'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -476,7 +480,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', '/'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -497,7 +501,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '/'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -518,7 +522,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts/', '/'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -552,7 +556,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -560,7 +564,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -568,7 +572,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', '/'>) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -576,7 +580,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -584,7 +588,9 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '/posts' | '/posts/', '/'>, + ) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -592,7 +598,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -600,7 +606,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -608,7 +614,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', '/'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -616,7 +622,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -624,7 +630,9 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '/posts' | '/posts/', '/'>, + ) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -632,31 +640,33 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', '/'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '/'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '/posts' | '/posts/', '/'>, + ) .parameter(0) .toHaveProperty('search') .parameter(0) @@ -664,111 +674,111 @@ test('when navigating from a route with no params and no search to the root', () }) test('when navigating from a route with no params and no search to the current route', () => { - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '.'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '.'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId/' | undefined | './'>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '.'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId/' | './$postId' | undefined | './' | '.'>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts/', '.'>) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts/', '.'>) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts/', '.'>) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts/', '.'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts/', './'>) .parameter(0) .toHaveProperty('search') .parameter(0) @@ -776,7 +786,7 @@ test('when navigating from a route with no params and no search to the current r }) test('when navigating from a route with no params and no search to the parent route', () => { - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -794,7 +804,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouterObjects }, '/posts', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -812,7 +822,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts', '../'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -830,7 +840,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -848,7 +858,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterPreserveTrailingSlashes }, '/posts', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -879,26 +889,7 @@ test('when navigating from a route with no params and no search to the parent ro }) test('cannot navigate to a branch with an index', () => { - expectTypeOf(Link) - .parameter(0) - .toHaveProperty('to') - .toEqualTypeOf< - | '/' - | '/posts' - | '/posts/$postId' - | '/invoices' - | '/invoices/$invoiceId' - | '/invoices/$invoiceId/edit' - | '/invoices/$invoiceId/details' - | '/invoices/$invoiceId/details/$detailId' - | '/invoices/$invoiceId/details/$detailId/lines' - | '/invoices/$invoiceId/details/$detailId/lines/form' - | '/invoices/$invoiceId/details/$detailId/lines/form/edit' - | '.' - | '..' - >() - - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, string, '/invoices/$invoiceId'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -918,7 +909,32 @@ test('cannot navigate to a branch with an index', () => { >() expectTypeOf( - Link, + Link<{ router: DefaultRouterObjects }, string, '/invoices/$invoiceId'>, + ) + .parameter(0) + .toHaveProperty('to') + .toEqualTypeOf< + | '/' + | '/posts' + | '/posts/$postId' + | '/invoices' + | '/invoices/$invoiceId' + | '/invoices/$invoiceId/edit' + | '/invoices/$invoiceId/details' + | '/invoices/$invoiceId/details/$detailId' + | '/invoices/$invoiceId/details/$detailId/lines' + | '/invoices/$invoiceId/details/$detailId/lines/form' + | '/invoices/$invoiceId/details/$detailId/lines/form/edit' + | '.' + | '..' + >() + + expectTypeOf( + Link< + { router: RouterAlwaysTrailingSlashes }, + string, + '/invoices/$invoiceId' + >, ) .parameter(0) .toHaveProperty('to') @@ -938,7 +954,13 @@ test('cannot navigate to a branch with an index', () => { | '../' >() - expectTypeOf(Link) + expectTypeOf( + Link< + { router: RouterNeverTrailingSlashes }, + string, + '/invoices/$invoiceId' + >, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -958,7 +980,11 @@ test('cannot navigate to a branch with an index', () => { >() expectTypeOf( - Link, + Link< + { router: RouterPreserveTrailingSlashes }, + string, + '/invoices/$invoiceId' + >, ) .parameter(0) .toHaveProperty('to') @@ -992,8 +1018,12 @@ test('cannot navigate to a branch with an index', () => { }) test('from autocompletes to all absolute routes', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, '/', '/'> + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + '/', + '/' + > expectTypeOf(DefaultRouterLink) .parameter(0) @@ -1037,8 +1067,12 @@ test('from autocompletes to all absolute routes', () => { }) test('from does not allow invalid routes', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, '/invalid', '/'> + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + '/invalid', + '/' + > expectTypeOf(DefaultRouterLink) .parameter(0) @@ -1082,20 +1116,24 @@ test('from does not allow invalid routes', () => { }) test('when navigating to the same route', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, string, string> + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + string, + string + > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, string > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, string > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, string > @@ -1202,21 +1240,25 @@ test('when navigating to the same route', () => { }) test('when navigating to the parent route', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, string, '..'> + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + string, + '..' + > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '../' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '..' > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '..' > @@ -1323,27 +1365,31 @@ test('when navigating to the parent route', () => { }) test('when navigating from a route with params to the same route', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link< + { router: DefaultRouter }, + '/posts/$postId', + string + > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/posts/$postId', string > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/posts/$postId', string > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/posts/$postId', string > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/posts/$postId', string > @@ -1400,28 +1446,32 @@ test('when navigating from a route with params to the same route', () => { }) test('when navigating to a route with params', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link< + { router: DefaultRouter }, + string, + '/posts/$postId' + > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, '/posts/$postId/' | '/posts/$postId' > @@ -1541,31 +1591,31 @@ test('when navigating to a route with params', () => { test('when navigating from a route with no params to a route with params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices', './$invoiceId/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices', './$invoiceId/edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices', './$invoiceId/edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices', './$invoiceId/edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices', './$invoiceId/edit' | './invoicesId/edit/' > @@ -1665,31 +1715,31 @@ test('when navigating from a route with no params to a route with params', () => test('when navigating from a route to a route with the same params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/$invoiceId', './edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId', './edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId', './edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', './edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', './edit' | './edit/' > @@ -1801,31 +1851,31 @@ test('when navigating from a route to a route with the same params', () => { test('when navigating from a route with params to a route with different params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/$invoiceId', '../../posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId', '../../posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId', '../../posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', '../../posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/$invoiceId', '../../posts/$postId' | '../../posts/$postId/' > @@ -1933,31 +1983,31 @@ test('when navigating from a route with params to a route with different params' test('when navigating from a route with params to a route with an additional param', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/$invoiceId', './details/$detailId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId', './details/$detailId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId', './details/$detailId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', './details/$detailId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/$invoiceId', './details/$detailId' | './details/$detailId' > @@ -2056,31 +2106,31 @@ test('when navigating from a route with params to a route with an additional par test('when navigating to a union of routes with params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/invoices/$invoiceId/edit' | '/invoices/$invoiceId/edit/' @@ -2207,31 +2257,31 @@ test('when navigating to a union of routes with params', () => { test('when navigating to a union of routes including the root', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/' | '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/' | '/invoices/$invoiceId/edit' @@ -2368,28 +2418,32 @@ test('when navigating to a union of routes including the root', () => { }) test('when navigating from a route with search params to the same route', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link< + { router: DefaultRouter }, + '/invoices/$invoiceId', + string + > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId', string > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId', string > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', string > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId', string > @@ -2445,31 +2499,31 @@ test('when navigating from a route with search params to the same route', () => test('when navigating to a route with search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/invoices/$invoiceId/edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/invoices/$invoiceId/edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, '/invoices/$invoiceId/edit' | '/invoices/$invoiceId/edit/' > @@ -2618,31 +2672,31 @@ test('when navigating to a route with search params', () => { test('when navigating to a route with optional search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/details/$detailId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/invoices/$invoiceId/details/$detailId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/invoices/$invoiceId/details/$detailId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/invoices/$invoiceId/details/$detailId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/invoices/$invoiceId/details/$detailId' | '/invoices/$invoiceId/details/$detailId/' @@ -2813,31 +2867,31 @@ test('when navigating to a route with optional search params', () => { test('when navigating from a route with no search params to a route with search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/', './$invoiceId/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/', './$invoiceId/edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/', './$invoiceId/edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/', './$invoiceId/edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/', './$invoiceId/edit/' | './$invoiceId/edit' > @@ -2967,31 +3021,31 @@ test('when navigating from a route with no search params to a route with search test('when navigating to a union of routes with search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/invoices/$invoiceId/edit' | '/posts/$postId' @@ -3153,31 +3207,31 @@ test('when navigating to a union of routes with search params', () => { test('when navigating to a union of routes with search params including the root', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/' | '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/' | '/invoices/$invoiceId/edit' @@ -3354,24 +3408,28 @@ test('when navigating to a union of routes with search params including the root }) test('when navigating from the root to /posts', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link<{ router: DefaultRouter }, '/', '/posts'> - const DefaultRouterObjectsLink = Link + const DefaultRouterObjectsLink = Link< + { router: DefaultRouterObjects }, + '/', + '/posts' + > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/', '/posts/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/', '/posts' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/', '/posts' | '/posts/' > @@ -3493,7 +3551,7 @@ test('when navigating from the root to /posts', () => { test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3507,7 +3565,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3521,7 +3579,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines/' >, @@ -3535,7 +3593,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3549,7 +3607,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', | '/invoices/$invoiceId/details/$detailId/lines/' | '/invoices/$invoiceId/details/$detailId/lines' @@ -3563,7 +3621,11 @@ test('when navigating to a route with SearchSchemaInput', () => { >() expectTypeOf( - Link, + Link< + { router: DefaultRouter }, + string, + '/invoices/$invoiceId/details/$detailId/lines' + >, ) .parameter(0) .toHaveProperty('search') @@ -3575,7 +3637,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3590,7 +3652,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines/' >, @@ -3605,7 +3667,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3620,7 +3682,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', | '/invoices/$invoiceId/details/$detailId/lines/' | '/invoices/$invoiceId/details/$detailId/lines' @@ -3636,7 +3698,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouter, + { router: DefaultRouter }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3648,7 +3710,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3660,7 +3722,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines/' >, @@ -3672,7 +3734,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines/' >, @@ -3684,7 +3746,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, '/invoices/$invoiceId/details/$detailId/lines', | '/invoices/$invoiceId/details/$detailId/lines/' | '/invoices/$invoiceId/details/$detailId/lines' @@ -3701,20 +3763,24 @@ test('when passing a component with props to createLink and navigating to the ro )) - const DefaultRouterLink = MyLink - const DefaultRouterObjectsLink = MyLink + const DefaultRouterLink = MyLink<{ router: DefaultRouter }, string, '/'> + const DefaultRouterObjectsLink = MyLink< + { router: DefaultRouterObjects }, + string, + '/' + > const RouterAlwaysTrailingSlashLink = MyLink< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/' > const RouterNeverTrailingSlashLink = MyLink< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/' > const RouterPreserveTrailingSlashLink = MyLink< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, '/' > @@ -4033,84 +4099,98 @@ test('ResolveRelativePath', () => { }) test('navigation edge cases', () => { - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/', '../'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '/', '..' | '../'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '', '../'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '', '..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '', '..' | '../'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts', '...'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterAlwaysTrailingSlashes }, '/posts', '.../'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: RouterNeverTrailingSlashes }, '/posts', '...'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterPreserveTrailingSlashes }, '/posts', '...' | '.../'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) - .parameter(0) - .toHaveProperty('to') - .toEqualTypeOf() - - expectTypeOf(Link) - .parameter(0) - .toHaveProperty('to') - .toEqualTypeOf() - - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts/$postId', '../../..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() expectTypeOf( Link< - RouterPreserveTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, + '/posts/$postId', + '../../../' + >, + ) + .parameter(0) + .toHaveProperty('to') + .toEqualTypeOf() + + expectTypeOf( + Link<{ router: RouterNeverTrailingSlashes }, '/posts/$postId', '../../..'>, + ) + .parameter(0) + .toHaveProperty('to') + .toEqualTypeOf() + + expectTypeOf( + Link< + { router: RouterPreserveTrailingSlashes }, '/posts/$postId', '../../..' | '../../../' >, @@ -4119,7 +4199,7 @@ test('navigation edge cases', () => { .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link<{ router: DefaultRouter }, '/posts/$postId', '../..'>) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4137,7 +4217,9 @@ test('navigation edge cases', () => { | undefined >() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterAlwaysTrailingSlashes }, '/posts/$postId', '../../'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4155,7 +4237,9 @@ test('navigation edge cases', () => { | undefined >() - expectTypeOf(Link) + expectTypeOf( + Link<{ router: RouterNeverTrailingSlashes }, '/posts/$postId', '../../'>, + ) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4174,7 +4258,11 @@ test('navigation edge cases', () => { >() expectTypeOf( - Link, + Link< + { router: RouterPreserveTrailingSlashes }, + '/posts/$postId', + '../../' | '../..' + >, ) .parameter(0) .toHaveProperty('to') @@ -4504,30 +4592,30 @@ test('linkOptions', () => { test('when navigating to a route with conflicting validateSearch', () => { const DefaultRouterLink = Link< - DefaultRouter, + { router: DefaultRouter }, string, '/invoices/$invoiceId/details/$detailId/lines/form/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + { router: DefaultRouterObjects }, string, '/invoices/$invoiceId/details/$detailId/lines/form/edit' > const RouterAlwaysTrailingSlashLink = Link< - RouterAlwaysTrailingSlashes, + { router: RouterAlwaysTrailingSlashes }, string, '/invoices/$invoiceId/details/$detailId/lines/form/edit/' > const RouterNeverTrailingSlashLink = Link< - RouterNeverTrailingSlashes, + { router: RouterNeverTrailingSlashes }, string, '/invoices/$invoiceId/details/$detailId/lines/form/edit' > const RouterPreserveTrailingSlashLink = Link< - RouterPreserveTrailingSlashes, + { router: RouterPreserveTrailingSlashes }, string, | '/invoices/$invoiceId/details/$detailId/lines/form/edit/' | '/invoices/$invoiceId/details/$detailId/lines/form/edit' From 36f576431eae2e011d11352601c80df80d1e48fd Mon Sep 17 00:00:00 2001 From: Manuel Schiller Date: Tue, 23 Dec 2025 13:58:16 +0100 Subject: [PATCH 3/3] wip --- packages/react-router/src/link.tsx | 6 +- .../react-router/src/structuralSharing.ts | 35 +- packages/react-router/src/useLoaderData.tsx | 49 +- packages/react-router/src/useLoaderDeps.tsx | 51 +- packages/react-router/src/useParams.tsx | 49 +- packages/router-core/src/typePrimitives.ts | 40 +- packages/router-core/src/useLoaderData.ts | 11 +- packages/router-core/src/useLoaderDeps.ts | 18 +- packages/router-core/src/useParams.ts | 17 +- packages/router-core/src/useSearch.ts | 11 +- packages/router-core/src/utils.ts | 9 +- packages/solid-router/src/Matches.tsx | 19 +- packages/solid-router/src/link.tsx | 4 +- .../solid-router/src/structuralSharing.ts | 36 +- packages/solid-router/src/useLoaderData.tsx | 33 +- packages/solid-router/src/useLoaderDeps.tsx | 30 +- packages/solid-router/src/useParams.tsx | 18 +- packages/solid-router/src/useSearch.tsx | 14 +- packages/vue-router/src/Matches.tsx | 73 +-- packages/vue-router/src/index.tsx | 5 +- packages/vue-router/src/typePrimitives.ts | 92 +++- packages/vue-router/src/useLoaderData.tsx | 25 +- packages/vue-router/src/useLoaderDeps.tsx | 27 +- packages/vue-router/src/useLocation.tsx | 22 +- packages/vue-router/src/useMatch.tsx | 33 +- packages/vue-router/src/useParams.tsx | 28 +- packages/vue-router/src/useRouteContext.ts | 39 +- packages/vue-router/src/useRouter.tsx | 12 +- packages/vue-router/src/useRouterState.tsx | 34 +- packages/vue-router/src/useSearch.tsx | 28 +- packages/vue-router/tests/Matches.test-d.tsx | 14 +- packages/vue-router/tests/link.test-d.tsx | 457 +++++++----------- 32 files changed, 688 insertions(+), 651 deletions(-) diff --git a/packages/react-router/src/link.tsx b/packages/react-router/src/link.tsx index 2695f88531..115833dd68 100644 --- a/packages/react-router/src/link.tsx +++ b/packages/react-router/src/link.tsx @@ -41,7 +41,7 @@ import type { export function useLinkProps< TRegister extends Register = Register, const TFrom extends string = string, - const TTo extends string | undefined = undefined, + const TTo extends string | undefined = '.', const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( @@ -504,7 +504,7 @@ export type LinkComponent< > = < TRegister extends Register = Register, const TFrom extends string = TDefaultFrom, - const TTo extends string | undefined = undefined, + const TTo extends string | undefined = '.', const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( @@ -517,7 +517,7 @@ export interface LinkComponentRoute< defaultFrom: TDefaultFrom < TRegister extends Register = Register, - const TTo extends string | undefined = undefined, + const TTo extends string | undefined = '.', const TMaskTo extends string = '', >( props: LinkComponentProps< diff --git a/packages/react-router/src/structuralSharing.ts b/packages/react-router/src/structuralSharing.ts index 34356cab33..f393bbc636 100644 --- a/packages/react-router/src/structuralSharing.ts +++ b/packages/react-router/src/structuralSharing.ts @@ -8,46 +8,55 @@ import type { } from '@tanstack/router-core' export type DefaultStructuralSharingEnabled< - TRegister extends Register = Register, -> = - boolean extends RegisteredRouter['options']['defaultStructuralSharing'] + TRouterOrRegister extends AnyRouter | Register, +> = ( + TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister +) extends infer TRouter extends AnyRouter + ? boolean extends TRouter['options']['defaultStructuralSharing'] ? // for now, default to false. // TODO in V2: default to true false - : NonNullable< - RegisteredRouter['options']['defaultStructuralSharing'] - > + : NonNullable + : never export interface RequiredStructuralSharing { readonly structuralSharing: Constrain } export type StructuralSharingOption< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TSelected, TStructuralSharing, > = unknown extends TSelected ? OptionalStructuralSharing - : unknown extends RegisteredRouter['routeTree'] + : ( + TRouterOrRegister extends Register + ? RegisteredRouter['routeTree'] + : TRouterOrRegister extends AnyRouter + ? TRouterOrRegister['routeTree'] + : never + ) extends unknown ? OptionalStructuralSharing : TSelected extends ValidateJSON ? OptionalStructuralSharing - : DefaultStructuralSharingEnabled extends true + : DefaultStructuralSharingEnabled extends true ? RequiredStructuralSharing : OptionalStructuralSharing export type StructuralSharingEnabled< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TStructuralSharing, > = boolean extends TStructuralSharing - ? DefaultStructuralSharingEnabled + ? DefaultStructuralSharingEnabled : TStructuralSharing export type ValidateSelected< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TSelected, TStructuralSharing, > = - StructuralSharingEnabled extends true + StructuralSharingEnabled extends true ? ValidateJSON : TSelected diff --git a/packages/react-router/src/useLoaderData.tsx b/packages/react-router/src/useLoaderData.tsx index a55183e3fd..55b1ce2915 100644 --- a/packages/react-router/src/useLoaderData.tsx +++ b/packages/react-router/src/useLoaderData.tsx @@ -6,65 +6,52 @@ import type { import type { AnyRouter, Register, - RegisteredRouter, ResolveUseLoaderData, StrictOrFrom, UseLoaderDataResult, } from '@tanstack/router-core' export interface UseLoaderDataBaseOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TSelected, TStructuralSharing, > { select?: ( - match: ResolveUseLoaderData, TFrom, TStrict>, - ) => ValidateSelected< - RegisteredRouter, - TSelected, - TStructuralSharing - > + match: ResolveUseLoaderData, + ) => ValidateSelected } export type UseLoaderDataOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom extends string | undefined, TStrict extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom, TFrom, TStrict> & +> = StrictOrFrom & UseLoaderDataBaseOptions< - TRegister, + TRouterOrRegister, TFrom, TStrict, TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - > + StructuralSharingOption -export type UseLoaderDataRoute = < - TSelected = unknown, - TStructuralSharing extends boolean = boolean, ->( +export type UseLoaderDataRoute< + TRouterOrRegister extends AnyRouter | Register, + out TId, +> = ( opts?: UseLoaderDataBaseOptions< - TRegister, + TRouterOrRegister, TId, true, TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - >, -) => UseLoaderDataResult, TId, true, TSelected> + StructuralSharingOption, +) => UseLoaderDataResult /** * Read and select the current route's loader data with type‑safety. @@ -78,20 +65,20 @@ export type UseLoaderDataRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLoaderDataHook */ export function useLoaderData< - TRegister extends Register = Register, + TRouterOrRegister extends AnyRouter | Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( opts: UseLoaderDataOptions< - TRegister, + TRouterOrRegister, TFrom, TStrict, TSelected, TStructuralSharing >, -): UseLoaderDataResult, TFrom, TStrict, TSelected> { +): UseLoaderDataResult { return useMatch({ from: opts.from!, strict: opts.strict, @@ -100,7 +87,7 @@ export function useLoaderData< return opts.select ? opts.select(s.loaderData) : s.loaderData }, } as any) as UseLoaderDataResult< - RegisteredRouter, + TRouterOrRegister, TFrom, TStrict, TSelected diff --git a/packages/react-router/src/useLoaderDeps.tsx b/packages/react-router/src/useLoaderDeps.tsx index 309256c9f6..52a46fc464 100644 --- a/packages/react-router/src/useLoaderDeps.tsx +++ b/packages/react-router/src/useLoaderDeps.tsx @@ -6,52 +6,48 @@ import type { import type { AnyRouter, Register, - RegisteredRouter, ResolveUseLoaderDeps, StrictOrFrom, UseLoaderDepsResult, } from '@tanstack/router-core' export interface UseLoaderDepsBaseOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TSelected, TStructuralSharing, > { select?: ( - deps: ResolveUseLoaderDeps, TFrom>, - ) => ValidateSelected< - RegisteredRouter, - TSelected, - TStructuralSharing - > + deps: ResolveUseLoaderDeps, + ) => ValidateSelected } export type UseLoaderDepsOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom extends string | undefined, TSelected, TStructuralSharing, -> = StrictOrFrom, TFrom> & - UseLoaderDepsBaseOptions & - StructuralSharingOption< - RegisteredRouter, +> = StrictOrFrom & + UseLoaderDepsBaseOptions< + TRouterOrRegister, + TFrom, TSelected, TStructuralSharing - > + > & + StructuralSharingOption -export type UseLoaderDepsRoute = < - TSelected = unknown, - TStructuralSharing extends boolean = boolean, ->( +export type UseLoaderDepsRoute< + TRouterOrRegister extends AnyRouter | Register, + out TId, +> = ( opts?: UseLoaderDepsBaseOptions< - TRegister, + TRouterOrRegister, TId, TSelected, TStructuralSharing > & - StructuralSharingOption, TSelected, false>, -) => UseLoaderDepsResult, TId, TSelected> + StructuralSharingOption, +) => UseLoaderDepsResult /** * Read and select the current route's loader dependencies object. @@ -65,18 +61,23 @@ export type UseLoaderDepsRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLoaderDepsHook */ export function useLoaderDeps< - TRegister extends Register = Register, + TRouterOrRegister extends AnyRouter | Register = Register, const TFrom extends string | undefined = undefined, TSelected = unknown, TStructuralSharing extends boolean = boolean, >( - opts: UseLoaderDepsOptions, -): UseLoaderDepsResult, TFrom, TSelected> { + opts: UseLoaderDepsOptions< + TRouterOrRegister, + TFrom, + TSelected, + TStructuralSharing + >, +): UseLoaderDepsResult { const { select, ...rest } = opts return useMatch({ ...rest, select: (s) => { return select ? select(s.loaderDeps) : s.loaderDeps }, - }) as UseLoaderDepsResult, TFrom, TSelected> + }) as UseLoaderDepsResult } diff --git a/packages/react-router/src/useParams.tsx b/packages/react-router/src/useParams.tsx index 0d00d7b284..6d0cbc09a0 100644 --- a/packages/react-router/src/useParams.tsx +++ b/packages/react-router/src/useParams.tsx @@ -4,6 +4,7 @@ import type { ValidateSelected, } from './structuralSharing' import type { + AnyRouter, Register, RegisteredRouter, ResolveUseParams, @@ -14,7 +15,7 @@ import type { } from '@tanstack/router-core' export interface UseParamsBaseOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TThrow extends boolean, @@ -22,55 +23,43 @@ export interface UseParamsBaseOptions< TStructuralSharing, > { select?: ( - params: ResolveUseParams, TFrom, TStrict>, - ) => ValidateSelected< - RegisteredRouter, - TSelected, - TStructuralSharing - > + params: ResolveUseParams, + ) => ValidateSelected shouldThrow?: TThrow } export type UseParamsOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom, TFrom, TStrict> & +> = StrictOrFrom & UseParamsBaseOptions< - TRegister, + TRouterOrRegister, TFrom, TStrict, TThrow, TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - > + StructuralSharingOption -export type UseParamsRoute = < - TSelected = unknown, - TStructuralSharing extends boolean = boolean, ->( +export type UseParamsRoute< + TRouterOrRegister extends AnyRouter | Register, + out TFrom, +> = ( opts?: UseParamsBaseOptions< - TRegister, + TRouterOrRegister, TFrom, /* TStrict */ true, /* TThrow */ true, TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - >, -) => UseParamsResult, TFrom, true, TSelected> + StructuralSharingOption, +) => UseParamsResult /** * Access the current route's path parameters with type-safety. @@ -85,7 +74,7 @@ export type UseParamsRoute = < * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useParamsHook */ export function useParams< - TRegister extends Register = Register, + TRouterOrRegister extends AnyRouter | Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, @@ -93,7 +82,7 @@ export function useParams< TStructuralSharing extends boolean = boolean, >( opts: UseParamsOptions< - TRegister, + TRouterOrRegister, TFrom, TStrict, ThrowConstraint, @@ -101,10 +90,10 @@ export function useParams< TStructuralSharing > = {} as any, ): ThrowOrOptional< - UseParamsResult, TFrom, TStrict, TSelected>, + UseParamsResult, TThrow > { - return useMatch({ + return useMatch({ from: opts.from!, shouldThrow: opts.shouldThrow, structuralSharing: opts.structuralSharing, diff --git a/packages/router-core/src/typePrimitives.ts b/packages/router-core/src/typePrimitives.ts index f0c8057fc7..ae94f40634 100644 --- a/packages/router-core/src/typePrimitives.ts +++ b/packages/router-core/src/typePrimitives.ts @@ -13,27 +13,27 @@ import type { UseSearchResult } from './useSearch' import type { Constrain, ConstrainLiteral } from './utils' export type ValidateFromPath< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom = string, -> = FromPathOption +> = FromPathOption export type ValidateToPath< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TTo extends string | undefined = undefined, TFrom extends string = string, -> = ToPathOption +> = ToPathOption export type ValidateSearch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TTo extends string | undefined = undefined, TFrom extends string = string, -> = SearchParamOptions +> = SearchParamOptions export type ValidateParams< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TTo extends string | undefined = undefined, TFrom extends string = string, -> = PathParamOptions +> = PathParamOptions /** * @private @@ -72,13 +72,13 @@ export type InferMaskFrom = TOptions extends { : string export type ValidateNavigateOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions = unknown, TDefaultFrom extends string = string, > = Constrain< TOptions, NavigateOptions< - TRouter, + TRegister, InferFrom, InferTo, InferMaskFrom, @@ -87,25 +87,25 @@ export type ValidateNavigateOptions< > export type ValidateNavigateOptionsArray< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions extends ReadonlyArray = ReadonlyArray, TDefaultFrom extends string = string, > = { [K in keyof TOptions]: ValidateNavigateOptions< - TRouter, + TRegister, TOptions[K], TDefaultFrom > } export type ValidateRedirectOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions = unknown, TDefaultFrom extends string = string, > = Constrain< TOptions, RedirectOptions< - TRouter, + TRegister, InferFrom, InferTo, InferMaskFrom, @@ -114,21 +114,21 @@ export type ValidateRedirectOptions< > export type ValidateRedirectOptionsArray< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions extends ReadonlyArray = ReadonlyArray, TDefaultFrom extends string = string, > = { [K in keyof TOptions]: ValidateRedirectOptions< - TRouter, + TRegister, TOptions[K], TDefaultFrom > } export type ValidateId< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TId extends string = string, -> = ConstrainLiteral> +> = ConstrainLiteral['routeTree']>> /** * @private @@ -159,9 +159,9 @@ export type InferSelected = TOptions extends { export type ValidateUseSearchResult< TOptions, - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, > = UseSearchResult< - TRouter, + TRegister, InferFrom, InferStrict, InferSelected diff --git a/packages/router-core/src/useLoaderData.ts b/packages/router-core/src/useLoaderData.ts index f3167fc7e4..3d69e6b7fc 100644 --- a/packages/router-core/src/useLoaderData.ts +++ b/packages/router-core/src/useLoaderData.ts @@ -1,20 +1,23 @@ import type { AllLoaderData, RouteById } from './routeInfo' -import type { AnyRouter } from './router' +import type { AnyRouter, Register, RegisteredRouter } from './router' import type { Expand } from './utils' export type ResolveUseLoaderData< - TRouter extends AnyRouter, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, + TRouter extends AnyRouter = TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister, > = TStrict extends false ? AllLoaderData : Expand['types']['loaderData']> export type UseLoaderDataResult< - TRouter extends AnyRouter, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected - ? ResolveUseLoaderData + ? ResolveUseLoaderData : TSelected diff --git a/packages/router-core/src/useLoaderDeps.ts b/packages/router-core/src/useLoaderDeps.ts index 4a1634702c..3ae30fd139 100644 --- a/packages/router-core/src/useLoaderDeps.ts +++ b/packages/router-core/src/useLoaderDeps.ts @@ -1,13 +1,19 @@ import type { RouteById } from './routeInfo' -import type { AnyRouter } from './router' +import type { AnyRouter, Register, RegisteredRouter } from './router' import type { Expand } from './utils' -export type ResolveUseLoaderDeps = Expand< - RouteById['types']['loaderDeps'] -> +export type ResolveUseLoaderDeps< + TRouterOrRegister extends AnyRouter | Register, + TFrom, + TRouter extends AnyRouter = TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister, +> = Expand['types']['loaderDeps']> export type UseLoaderDepsResult< - TRouter extends AnyRouter, + TRouterOrRegister extends AnyRouter | Register, TFrom, TSelected, -> = unknown extends TSelected ? ResolveUseLoaderDeps : TSelected +> = unknown extends TSelected + ? ResolveUseLoaderDeps + : TSelected diff --git a/packages/router-core/src/useParams.ts b/packages/router-core/src/useParams.ts index 0f649d9452..f3ad0638a9 100644 --- a/packages/router-core/src/useParams.ts +++ b/packages/router-core/src/useParams.ts @@ -4,29 +4,28 @@ import type { AnyRouter, Register, RegisteredRouter } from './router' import type { Expand } from './utils' export type ResolveUseParams< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, + TRouter extends AnyRouter = TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister, > = TStrict extends false ? AllParams< - RegisteredRouter['routeTree'] extends AnyRoute - ? RegisteredRouter['routeTree'] - : AnyRoute + TRouter['routeTree'] extends AnyRoute ? TRouter['routeTree'] : AnyRoute > : Expand< RouteById< - RegisteredRouter['routeTree'] extends AnyRoute - ? RegisteredRouter['routeTree'] - : AnyRoute, + TRouter['routeTree'] extends AnyRoute ? TRouter['routeTree'] : AnyRoute, TFrom >['types']['allParams'] > export type UseParamsResult< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected - ? ResolveUseParams + ? ResolveUseParams : TSelected diff --git a/packages/router-core/src/useSearch.ts b/packages/router-core/src/useSearch.ts index 2abe0ecaa3..88e02840ac 100644 --- a/packages/router-core/src/useSearch.ts +++ b/packages/router-core/src/useSearch.ts @@ -1,20 +1,23 @@ import type { FullSearchSchema, RouteById } from './routeInfo' -import type { AnyRouter } from './router' +import type { AnyRouter, Register, RegisteredRouter } from './router' import type { Expand } from './utils' export type UseSearchResult< - TRouter extends AnyRouter, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected - ? ResolveUseSearch + ? ResolveUseSearch : TSelected export type ResolveUseSearch< - TRouter extends AnyRouter, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, + TRouter extends AnyRouter = TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister, > = TStrict extends false ? FullSearchSchema : Expand['types']['fullSearchSchema']> diff --git a/packages/router-core/src/utils.ts b/packages/router-core/src/utils.ts index e272d0ef6a..dd55a46e68 100644 --- a/packages/router-core/src/utils.ts +++ b/packages/router-core/src/utils.ts @@ -398,9 +398,12 @@ export type ThrowOrOptional = TThrow extends true : T | undefined export type StrictOrFrom< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean = true, + TRouter extends AnyRouter = TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister, > = TStrict extends false ? { from?: never @@ -410,8 +413,8 @@ export type StrictOrFrom< from: ConstrainLiteral< TFrom, RouteIds< - RegisteredRouter['routeTree'] extends AnyRoute - ? RegisteredRouter['routeTree'] + TRouter['routeTree'] extends AnyRoute + ? TRouter['routeTree'] : AnyRoute > > diff --git a/packages/solid-router/src/Matches.tsx b/packages/solid-router/src/Matches.tsx index 54974e8072..6171602907 100644 --- a/packages/solid-router/src/Matches.tsx +++ b/packages/solid-router/src/Matches.tsx @@ -114,12 +114,10 @@ export type UseMatchRouteOptions< TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = ToSubOptionsProps, TFrom, TTo> & - DeepPartial< - MakeOptionalSearchParams, TFrom, TTo> - > & - DeepPartial, TFrom, TTo>> & - MaskOptions, TMaskFrom, TMaskTo> & +> = ToSubOptionsProps & + DeepPartial> & + DeepPartial> & + MaskOptions & MatchRouteOptions export function useMatchRoute() { @@ -140,7 +138,7 @@ export function useMatchRoute() { | false | Expand< ResolveRoute< - RegisteredRouter, + TRegister, TFrom, TTo >['types']['allParams'] @@ -172,9 +170,10 @@ export type MakeMatchRouteOptions< // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns children?: | (( - params?: RouteByPath< - RegisteredRouter['routeTree'], - ResolveRelativePath> + params?: ResolveRoute< + TRegister, + TFrom, + TTo >['types']['allParams'], ) => Solid.JSX.Element) | Solid.JSX.Element diff --git a/packages/solid-router/src/link.tsx b/packages/solid-router/src/link.tsx index 5dd681351d..2dae5997f8 100644 --- a/packages/solid-router/src/link.tsx +++ b/packages/solid-router/src/link.tsx @@ -540,7 +540,7 @@ export type LinkComponent< > = < TRegister extends Register = Register, const TFrom extends string = TDefaultFrom, - const TTo extends string | undefined = undefined, + const TTo extends string | undefined = '.', const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( @@ -553,7 +553,7 @@ export interface LinkComponentRoute< defaultFrom: TDefaultFrom < TRegister extends Register = Register, - const TTo extends string | undefined = undefined, + const TTo extends string | undefined = '.', const TMaskTo extends string = '', >( props: LinkComponentProps< diff --git a/packages/solid-router/src/structuralSharing.ts b/packages/solid-router/src/structuralSharing.ts index bbe9856637..f393bbc636 100644 --- a/packages/solid-router/src/structuralSharing.ts +++ b/packages/solid-router/src/structuralSharing.ts @@ -1,4 +1,5 @@ import type { + AnyRouter, Constrain, OptionalStructuralSharing, Register, @@ -7,46 +8,55 @@ import type { } from '@tanstack/router-core' export type DefaultStructuralSharingEnabled< - TRegister extends Register = Register, -> = - boolean extends RegisteredRouter['options']['defaultStructuralSharing'] + TRouterOrRegister extends AnyRouter | Register, +> = ( + TRouterOrRegister extends Register + ? RegisteredRouter + : TRouterOrRegister +) extends infer TRouter extends AnyRouter + ? boolean extends TRouter['options']['defaultStructuralSharing'] ? // for now, default to false. // TODO in V2: default to true false - : NonNullable< - RegisteredRouter['options']['defaultStructuralSharing'] - > + : NonNullable + : never export interface RequiredStructuralSharing { readonly structuralSharing: Constrain } export type StructuralSharingOption< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TSelected, TStructuralSharing, > = unknown extends TSelected ? OptionalStructuralSharing - : unknown extends RegisteredRouter['routeTree'] + : ( + TRouterOrRegister extends Register + ? RegisteredRouter['routeTree'] + : TRouterOrRegister extends AnyRouter + ? TRouterOrRegister['routeTree'] + : never + ) extends unknown ? OptionalStructuralSharing : TSelected extends ValidateJSON ? OptionalStructuralSharing - : DefaultStructuralSharingEnabled extends true + : DefaultStructuralSharingEnabled extends true ? RequiredStructuralSharing : OptionalStructuralSharing export type StructuralSharingEnabled< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TStructuralSharing, > = boolean extends TStructuralSharing - ? DefaultStructuralSharingEnabled + ? DefaultStructuralSharingEnabled : TStructuralSharing export type ValidateSelected< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TSelected, TStructuralSharing, > = - StructuralSharingEnabled extends true + StructuralSharingEnabled extends true ? ValidateJSON : TSelected diff --git a/packages/solid-router/src/useLoaderData.tsx b/packages/solid-router/src/useLoaderData.tsx index 76fe27e747..c536c3a3cf 100644 --- a/packages/solid-router/src/useLoaderData.tsx +++ b/packages/solid-router/src/useLoaderData.tsx @@ -1,50 +1,47 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { + AnyRouter, Register, - RegisteredRouter, ResolveUseLoaderData, StrictOrFrom, UseLoaderDataResult, } from '@tanstack/router-core' export interface UseLoaderDataBaseOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TStrict extends boolean, TSelected, > { select?: ( - match: ResolveUseLoaderData, TFrom, TStrict>, + match: ResolveUseLoaderData, ) => TSelected } export type UseLoaderDataOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom extends string | undefined, TStrict extends boolean, TSelected, -> = StrictOrFrom, TFrom, TStrict> & - UseLoaderDataBaseOptions +> = StrictOrFrom & + UseLoaderDataBaseOptions -export type UseLoaderDataRoute = < - TSelected = unknown, ->( - opts?: UseLoaderDataBaseOptions, -) => Accessor< - UseLoaderDataResult, TId, true, TSelected> -> +export type UseLoaderDataRoute< + TRouterOrRegister extends AnyRouter | Register, + out TId, +> = ( + opts?: UseLoaderDataBaseOptions, +) => Accessor> export function useLoaderData< - TRegister extends Register = Register, + TRouterOrRegister extends AnyRouter | Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseLoaderDataOptions, -): Accessor< - UseLoaderDataResult, TFrom, TStrict, TSelected> -> { + opts: UseLoaderDataOptions, +): Accessor> { return useMatch({ from: opts.from!, strict: opts.strict, diff --git a/packages/solid-router/src/useLoaderDeps.tsx b/packages/solid-router/src/useLoaderDeps.tsx index 15f981b40a..dc44186bbd 100644 --- a/packages/solid-router/src/useLoaderDeps.tsx +++ b/packages/solid-router/src/useLoaderDeps.tsx @@ -1,52 +1,48 @@ import { useMatch } from './useMatch' import type { Accessor } from 'solid-js' import type { + AnyRouter, Register, - RegisteredRouter, ResolveUseLoaderDeps, StrictOrFrom, UseLoaderDepsResult, } from '@tanstack/router-core' export interface UseLoaderDepsBaseOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom, TSelected, > { select?: ( - deps: ResolveUseLoaderDeps, TFrom>, + deps: ResolveUseLoaderDeps, ) => TSelected } export type UseLoaderDepsOptions< - TRegister extends Register, + TRouterOrRegister extends AnyRouter | Register, TFrom extends string | undefined, TSelected, -> = StrictOrFrom, TFrom> & - UseLoaderDepsBaseOptions +> = StrictOrFrom & + UseLoaderDepsBaseOptions -export type UseLoaderDepsRoute = < +export type UseLoaderDepsRoute = < TSelected = unknown, >( - opts?: UseLoaderDepsBaseOptions, -) => Accessor, TId, TSelected>> + opts?: UseLoaderDepsBaseOptions, +) => Accessor> export function useLoaderDeps< - TRegister extends Register = Register, + TRouterOrRegister extends AnyRouter | Register = Register, const TFrom extends string | undefined = undefined, TSelected = unknown, >( - opts: UseLoaderDepsOptions, -): Accessor< - UseLoaderDepsResult, TFrom, TSelected> -> { + opts: UseLoaderDepsOptions, +): Accessor> { const { select, ...rest } = opts return useMatch({ ...rest, select: (s) => { return select ? select(s.loaderDeps) : s.loaderDeps }, - }) as Accessor< - UseLoaderDepsResult, TFrom, TSelected> - > + }) as Accessor> } diff --git a/packages/solid-router/src/useParams.tsx b/packages/solid-router/src/useParams.tsx index 7b32e8df19..01605f5c22 100644 --- a/packages/solid-router/src/useParams.tsx +++ b/packages/solid-router/src/useParams.tsx @@ -24,11 +24,7 @@ export interface UseParamsBaseOptions< > { select?: ( params: ResolveUseParams, - ) => ValidateSelected< - RegisteredRouter, - TSelected, - TStructuralSharing - > + ) => ValidateSelected shouldThrow?: TThrow } @@ -48,11 +44,7 @@ export type UseParamsOptions< TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - > + StructuralSharingOption export type UseParamsRoute = < TSelected = unknown, @@ -66,11 +58,7 @@ export type UseParamsRoute = < TSelected, TStructuralSharing > & - StructuralSharingOption< - RegisteredRouter, - TSelected, - TStructuralSharing - >, + StructuralSharingOption, ) => Accessor> export function useParams< diff --git a/packages/solid-router/src/useSearch.tsx b/packages/solid-router/src/useSearch.tsx index f6712eac73..ef75daf4cf 100644 --- a/packages/solid-router/src/useSearch.tsx +++ b/packages/solid-router/src/useSearch.tsx @@ -23,9 +23,9 @@ export interface UseSearchBaseOptions< TStructuralSharing, > { select?: ( - state: ResolveUseSearch, TFrom, TStrict>, + state: ResolveUseSearch, ) => ValidateSelected< - RegisteredRouter, + TRegister, TSelected, TStructuralSharing > @@ -39,7 +39,7 @@ export type UseSearchOptions< TThrow extends boolean, TSelected, TStructuralSharing, -> = StrictOrFrom, TFrom, TStrict> & +> = StrictOrFrom & UseSearchBaseOptions< TRegister, TFrom, @@ -49,7 +49,7 @@ export type UseSearchOptions< TStructuralSharing > & StructuralSharingOption< - RegisteredRouter, + TRegister, TSelected, TStructuralSharing > @@ -67,12 +67,12 @@ export type UseSearchRoute = < TStructuralSharing > & StructuralSharingOption< - RegisteredRouter, + TRegister, TSelected, TStructuralSharing >, ) => Accessor< - UseSearchResult, TFrom, true, TSelected> + UseSearchResult > export function useSearch< @@ -93,7 +93,7 @@ export function useSearch< > = {} as any, ): Accessor< ThrowOrOptional< - UseSearchResult, TFrom, TStrict, TSelected>, + UseSearchResult, TThrow > > { diff --git a/packages/vue-router/src/Matches.tsx b/packages/vue-router/src/Matches.tsx index bb982c72c9..9c4b1afc4c 100644 --- a/packages/vue-router/src/Matches.tsx +++ b/packages/vue-router/src/Matches.tsx @@ -16,6 +16,7 @@ import type { MaskOptions, MatchRouteOptions, NoInfer, + Register, RegisteredRouter, ResolveRelativePath, ResolveRoute, @@ -146,18 +147,18 @@ const MatchesInner = Vue.defineComponent({ }) export type UseMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = ToSubOptionsProps & - DeepPartial> & - DeepPartial> & - MaskOptions & +> = ToSubOptionsProps & + DeepPartial> & + DeepPartial> & + MaskOptions & MatchRouteOptions -export function useMatchRoute() { +export function useMatchRoute() { const router = useRouter() // Track state changes to trigger re-computation @@ -176,9 +177,9 @@ export function useMatchRoute() { const TMaskFrom extends string = TFrom, const TMaskTo extends string = '', >( - opts: UseMatchRouteOptions, + opts: UseMatchRouteOptions, ): Vue.Ref< - false | ResolveRoute['types']['allParams'] + false | ResolveRoute['types']['allParams'] > => { const { pending, caseSensitive, fuzzy, includeSearch, ...rest } = opts @@ -199,17 +200,17 @@ export function useMatchRoute() { } export type MakeMatchRouteOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '', -> = UseMatchRouteOptions & { +> = UseMatchRouteOptions & { // If a function is passed as a child, it will be given the `isActive` boolean to aid in further styling on the element it returns children?: | (( params?: RouteByPath< - TRouter['routeTree'], + RegisteredRouter['routeTree'], ResolveRelativePath> >['types']['allParams'], ) => Vue.VNode) @@ -219,11 +220,11 @@ export type MakeMatchRouteOptions< // Create a type for the MatchRoute component that includes the generics export interface MatchRouteComponentType { < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TFrom extends string = string, TTo extends string | undefined = undefined, >( - props: MakeMatchRouteOptions, + props: MakeMatchRouteOptions, ): Vue.VNode new (): { $props: { @@ -294,43 +295,51 @@ export const MatchRoute = Vue.defineComponent({ }, }) as unknown as MatchRouteComponentType -export interface UseMatchesBaseOptions { - select?: (matches: Array>) => TSelected +export interface UseMatchesBaseOptions { + select?: ( + matches: Array>>, + ) => TSelected } export type UseMatchesResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? Array> : TSelected +> = unknown extends TSelected + ? Array>> + : TSelected export function useMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Vue.Ref> { + opts?: UseMatchesBaseOptions, +): Vue.Ref> { return useRouterState({ - select: (state: RouterState) => { + select: (state: RouterState['routeTree']>) => { const matches = state?.matches || [] return opts?.select - ? opts.select(matches as Array>) + ? opts.select( + matches as Array>>, + ) : matches }, - } as any) as Vue.Ref> + } as any) as Vue.Ref> } export function useParentMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Vue.Ref> { + opts?: UseMatchesBaseOptions, +): Vue.Ref> { // Use matchContext with proper type const contextMatchId = Vue.inject>(matchContext) const safeMatchId = Vue.computed(() => contextMatchId?.value || '') return useMatches({ - select: (matches: Array>) => { + select: ( + matches: Array>>, + ) => { matches = matches.slice( 0, matches.findIndex((d) => d.id === safeMatchId.value), @@ -341,17 +350,19 @@ export function useParentMatches< } export function useChildMatches< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchesBaseOptions, -): Vue.Ref> { + opts?: UseMatchesBaseOptions, +): Vue.Ref> { // Use matchContext with proper type const contextMatchId = Vue.inject>(matchContext) const safeMatchId = Vue.computed(() => contextMatchId?.value || '') return useMatches({ - select: (matches: Array>) => { + select: ( + matches: Array>>, + ) => { matches = matches.slice( matches.findIndex((d) => d.id === safeMatchId.value) + 1, ) diff --git a/packages/vue-router/src/index.tsx b/packages/vue-router/src/index.tsx index 3e6b161516..0cc5b6cf0d 100644 --- a/packages/vue-router/src/index.tsx +++ b/packages/vue-router/src/index.tsx @@ -313,9 +313,6 @@ export type { ValidateUseSearchOptions, ValidateUseParamsOptions, ValidateLinkOptionsArray, -} from './typePrimitives' - -export type { ValidateFromPath, ValidateToPath, ValidateSearch, @@ -334,7 +331,7 @@ export type { InferSelected, ValidateUseSearchResult, ValidateUseParamsResult, -} from '@tanstack/router-core' +} from './typePrimitives' export { ScriptOnce } from './ScriptOnce' export { Asset } from './Asset' diff --git a/packages/vue-router/src/typePrimitives.ts b/packages/vue-router/src/typePrimitives.ts index b134cb8959..02684df8f6 100644 --- a/packages/vue-router/src/typePrimitives.ts +++ b/packages/vue-router/src/typePrimitives.ts @@ -11,11 +11,95 @@ import type { InferShouldThrow, InferStrict, InferTo, + Register, RegisteredRouter, + ValidateFromPath as ValidateFromPathCore, + ValidateId as ValidateIdCore, + ValidateNavigateOptions as ValidateNavigateOptionsCore, + ValidateNavigateOptionsArray as ValidateNavigateOptionsArrayCore, + ValidateParams as ValidateParamsCore, + ValidateRedirectOptions as ValidateRedirectOptionsCore, + ValidateRedirectOptionsArray as ValidateRedirectOptionsArrayCore, + ValidateSearch as ValidateSearchCore, + ValidateToPath as ValidateToPathCore, + ValidateUseParamsResult as ValidateUseParamsResultCore, + ValidateUseSearchResult as ValidateUseSearchResultCore, } from '@tanstack/router-core' +export type { + InferFrom, + InferMaskFrom, + InferMaskTo, + InferSelected, + InferShouldThrow, + InferStrict, + InferTo, +} from '@tanstack/router-core' + +export type ValidateFromPath< + TRegister extends Register = Register, + TFrom = string, +> = ValidateFromPathCore + +export type ValidateToPath< + TRegister extends Register = Register, + TTo extends string | undefined = undefined, + TFrom extends string = string, +> = ValidateToPathCore + +export type ValidateSearch< + TRegister extends Register = Register, + TTo extends string | undefined = undefined, + TFrom extends string = string, +> = ValidateSearchCore + +export type ValidateParams< + TRegister extends Register = Register, + TTo extends string | undefined = undefined, + TFrom extends string = string, +> = ValidateParamsCore + +export type ValidateNavigateOptions< + TRegister extends Register = Register, + TOptions = unknown, + TDefaultFrom extends string = string, +> = ValidateNavigateOptionsCore + +export type ValidateNavigateOptionsArray< + TRegister extends Register = Register, + TOptions extends ReadonlyArray = ReadonlyArray, + TDefaultFrom extends string = string, +> = ValidateNavigateOptionsArrayCore + +export type ValidateRedirectOptions< + TRegister extends Register = Register, + TOptions = unknown, + TDefaultFrom extends string = string, +> = ValidateRedirectOptionsCore + +export type ValidateRedirectOptionsArray< + TRegister extends Register = Register, + TOptions extends ReadonlyArray = ReadonlyArray, + TDefaultFrom extends string = string, +> = ValidateRedirectOptionsArrayCore + +export type ValidateId< + TRegister extends Register = Register, + TId extends string = string, +> = ValidateIdCore + +export type ValidateUseSearchResult< + TOptions, + TRegister extends Register = Register, +> = ValidateUseSearchResultCore + +export type ValidateUseParamsResult< + TOptions, + TRegister extends Register = Register, +> = ValidateUseParamsResultCore + export type ValidateLinkOptions< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions = unknown, TDefaultFrom extends string = string, TComp = 'a', @@ -23,7 +107,7 @@ export type ValidateLinkOptions< TOptions, LinkComponentProps< TComp, - TRouter, + TRegister, InferFrom, InferTo, InferMaskFrom, @@ -32,13 +116,13 @@ export type ValidateLinkOptions< > export type ValidateLinkOptionsArray< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TOptions extends ReadonlyArray = ReadonlyArray, TDefaultFrom extends string = string, TComp = 'a', > = { [K in keyof TOptions]: ValidateLinkOptions< - TRouter, + TRegister, TOptions[K], TDefaultFrom, TComp diff --git a/packages/vue-router/src/useLoaderData.tsx b/packages/vue-router/src/useLoaderData.tsx index 32314df9e1..9d983f66c5 100644 --- a/packages/vue-router/src/useLoaderData.tsx +++ b/packages/vue-router/src/useLoaderData.tsx @@ -2,6 +2,7 @@ import { useMatch } from './useMatch' import type * as Vue from 'vue' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderData, StrictOrFrom, @@ -9,37 +10,39 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDataBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > { - select?: (match: ResolveUseLoaderData) => TSelected + select?: ( + match: ResolveUseLoaderData, TFrom, TStrict>, + ) => TSelected } export type UseLoaderDataOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TSelected, -> = StrictOrFrom & - UseLoaderDataBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseLoaderDataBaseOptions export type UseLoaderDataRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseLoaderDataBaseOptions, -) => Vue.Ref> + opts?: UseLoaderDataBaseOptions, +) => Vue.Ref, TId, true, TSelected>> export function useLoaderData< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseLoaderDataOptions, -): Vue.Ref> { + opts: UseLoaderDataOptions, +): Vue.Ref, TFrom, TStrict, TSelected>> { return useMatch({ from: opts.from!, strict: opts.strict, diff --git a/packages/vue-router/src/useLoaderDeps.tsx b/packages/vue-router/src/useLoaderDeps.tsx index 91e5acb308..b54455ecf5 100644 --- a/packages/vue-router/src/useLoaderDeps.tsx +++ b/packages/vue-router/src/useLoaderDeps.tsx @@ -1,6 +1,7 @@ import { useMatch } from './useMatch' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseLoaderDeps, StrictOrFrom, @@ -8,39 +9,39 @@ import type { } from '@tanstack/router-core' export interface UseLoaderDepsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TSelected, > { - select?: (deps: ResolveUseLoaderDeps) => TSelected + select?: (deps: ResolveUseLoaderDeps, TFrom>) => TSelected } export type UseLoaderDepsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TSelected, -> = StrictOrFrom & - UseLoaderDepsBaseOptions +> = StrictOrFrom, TFrom> & + UseLoaderDepsBaseOptions export type UseLoaderDepsRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseLoaderDepsBaseOptions, -) => UseLoaderDepsResult + opts?: UseLoaderDepsBaseOptions, +) => UseLoaderDepsResult, TId, TSelected> export function useLoaderDeps< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TSelected = unknown, >( - opts: UseLoaderDepsOptions, -): UseLoaderDepsResult { + opts: UseLoaderDepsOptions, +): UseLoaderDepsResult, TFrom, TSelected> { const { select, ...rest } = opts return useMatch({ ...rest, - select: (s) => { + select: (s: any) => { return select ? select(s.loaderDeps) : s.loaderDeps }, - }) as UseLoaderDepsResult + }) as UseLoaderDepsResult, TFrom, TSelected> } diff --git a/packages/vue-router/src/useLocation.tsx b/packages/vue-router/src/useLocation.tsx index 518f03ba9f..e8785599f1 100644 --- a/packages/vue-router/src/useLocation.tsx +++ b/packages/vue-router/src/useLocation.tsx @@ -1,30 +1,36 @@ import { useRouterState } from './useRouterState' import type { AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' import type * as Vue from 'vue' -export interface UseLocationBaseOptions { - select?: (state: RouterState['location']) => TSelected +export interface UseLocationBaseOptions< + TRegister extends Register, + TSelected, +> { + select?: ( + state: RouterState['routeTree']>['location'], + ) => TSelected } export type UseLocationResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, > = unknown extends TSelected - ? RouterState['location'] + ? RouterState['routeTree']>['location'] : TSelected export function useLocation< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseLocationBaseOptions, -): Vue.Ref> { + opts?: UseLocationBaseOptions, +): Vue.Ref> { return useRouterState({ select: (state: any) => opts?.select ? opts.select(state.location) : state.location, - } as any) as Vue.Ref> + } as any) as Vue.Ref> } diff --git a/packages/vue-router/src/useMatch.tsx b/packages/vue-router/src/useMatch.tsx index 0c527f6681..f7eba27b80 100644 --- a/packages/vue-router/src/useMatch.tsx +++ b/packages/vue-router/src/useMatch.tsx @@ -5,6 +5,7 @@ import type { AnyRouter, MakeRouteMatch, MakeRouteMatchUnion, + Register, RegisteredRouter, StrictOrFrom, ThrowConstraint, @@ -12,61 +13,65 @@ import type { } from '@tanstack/router-core' export interface UseMatchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, > { select?: ( - match: MakeRouteMatch, + match: MakeRouteMatch< + RegisteredRouter['routeTree'], + TFrom, + TStrict + >, ) => TSelected shouldThrow?: TThrow } export type UseMatchRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseMatchBaseOptions, -) => Vue.Ref> + opts?: UseMatchBaseOptions, +) => Vue.Ref> export type UseMatchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseMatchBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseMatchBaseOptions export type UseMatchResult< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TSelected, > = unknown extends TSelected ? TStrict extends true - ? MakeRouteMatch - : MakeRouteMatchUnion + ? MakeRouteMatch['routeTree'], TFrom, TStrict> + : MakeRouteMatchUnion> : TSelected export function useMatch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, >( opts: UseMatchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected >, ): Vue.Ref< - ThrowOrOptional, TThrow> + ThrowOrOptional, TThrow> > { const nearestMatchId = opts.from ? injectDummyMatch() : injectMatch() diff --git a/packages/vue-router/src/useParams.tsx b/packages/vue-router/src/useParams.tsx index d0d9e5d6f3..e3e3c8a2d6 100644 --- a/packages/vue-router/src/useParams.tsx +++ b/packages/vue-router/src/useParams.tsx @@ -2,6 +2,7 @@ import { useMatch } from './useMatch' import type * as Vue from 'vue' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseParams, StrictOrFrom, @@ -11,54 +12,59 @@ import type { } from '@tanstack/router-core' export interface UseParamsBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, > { - select?: (params: ResolveUseParams) => TSelected + select?: ( + params: ResolveUseParams, TFrom, TStrict>, + ) => TSelected shouldThrow?: TThrow } export type UseParamsOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom extends string | undefined, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseParamsBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseParamsBaseOptions export type UseParamsRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( opts?: UseParamsBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, TSelected >, -) => Vue.Ref> +) => Vue.Ref, TFrom, true, TSelected>> export function useParams< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, >( opts: UseParamsOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected >, ): Vue.Ref< - ThrowOrOptional, TThrow> + ThrowOrOptional< + UseParamsResult, TFrom, TStrict, TSelected>, + TThrow + > > { return useMatch({ from: opts.from!, diff --git a/packages/vue-router/src/useRouteContext.ts b/packages/vue-router/src/useRouteContext.ts index ff974cb162..c888b5fcd2 100644 --- a/packages/vue-router/src/useRouteContext.ts +++ b/packages/vue-router/src/useRouteContext.ts @@ -2,6 +2,7 @@ import { useMatch } from './useMatch' import type * as Vue from 'vue' import type { AnyRouter, + Register, RegisteredRouter, UseRouteContextBaseOptions, UseRouteContextOptions, @@ -9,23 +10,47 @@ import type { } from '@tanstack/router-core' export type UseRouteContextRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseRouteContextBaseOptions, -) => Vue.Ref> + opts?: UseRouteContextBaseOptions< + RegisteredRouter, + TFrom, + true, + TSelected + >, +) => Vue.Ref< + UseRouteContextResult< + RegisteredRouter, + TFrom, + true, + TSelected + > +> export function useRouteContext< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TSelected = unknown, >( - opts: UseRouteContextOptions, -): Vue.Ref> { + opts: UseRouteContextOptions< + RegisteredRouter, + TFrom, + TStrict, + TSelected + >, +): Vue.Ref< + UseRouteContextResult< + RegisteredRouter, + TFrom, + TStrict, + TSelected + > +> { return useMatch({ ...(opts as any), - select: (match) => + select: (match: any) => opts.select ? opts.select(match.context) : match.context, }) as any } diff --git a/packages/vue-router/src/useRouter.tsx b/packages/vue-router/src/useRouter.tsx index a8354ce9b3..8b60c8430f 100644 --- a/packages/vue-router/src/useRouter.tsx +++ b/packages/vue-router/src/useRouter.tsx @@ -1,11 +1,15 @@ import * as Vue from 'vue' import warning from 'tiny-warning' import { getRouterContext } from './routerContext' -import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core' +import type { + AnyRouter, + Register, + RegisteredRouter, +} from '@tanstack/router-core' -export function useRouter(opts?: { - warn?: boolean -}): TRouter { +export function useRouter< + TRegister extends Register = Register, +>(opts?: { warn?: boolean }): RegisteredRouter { const value = Vue.inject(getRouterContext() as any, null) warning( !((opts?.warn ?? true) && !value), diff --git a/packages/vue-router/src/useRouterState.tsx b/packages/vue-router/src/useRouterState.tsx index 7937d3b6d3..c62160201b 100644 --- a/packages/vue-router/src/useRouterState.tsx +++ b/packages/vue-router/src/useRouterState.tsx @@ -3,41 +3,49 @@ import * as Vue from 'vue' import { useRouter } from './useRouter' import type { AnyRouter, + Register, RegisteredRouter, RouterState, } from '@tanstack/router-core' -export type UseRouterStateOptions = { - router?: TRouter - select?: (state: RouterState) => TSelected +export type UseRouterStateOptions< + TRegister extends Register, + TSelected, +> = { + router?: RegisteredRouter + select?: ( + state: RouterState['routeTree']>, + ) => TSelected } export type UseRouterStateResult< - TRouter extends AnyRouter, + TRegister extends Register, TSelected, -> = unknown extends TSelected ? RouterState : TSelected +> = unknown extends TSelected + ? RouterState['routeTree']> + : TSelected export function useRouterState< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( - opts?: UseRouterStateOptions, -): Vue.Ref> { - const contextRouter = useRouter({ + opts?: UseRouterStateOptions, +): Vue.Ref> { + const contextRouter = useRouter({ warn: opts?.router === undefined, }) - const router = opts?.router || contextRouter + const router = (opts?.router || contextRouter) as AnyRouter // Return a safe default if router is undefined if (!router || !router.__store) { return Vue.ref(undefined) as Vue.Ref< - UseRouterStateResult + UseRouterStateResult > } return useStore(router.__store, (state) => { - if (opts?.select) return opts.select(state) + if (opts?.select) return opts.select(state as any) return state - }) as Vue.Ref> + }) as Vue.Ref> } diff --git a/packages/vue-router/src/useSearch.tsx b/packages/vue-router/src/useSearch.tsx index c534bd43e3..f88530c923 100644 --- a/packages/vue-router/src/useSearch.tsx +++ b/packages/vue-router/src/useSearch.tsx @@ -2,6 +2,7 @@ import { useMatch } from './useMatch' import type * as Vue from 'vue' import type { AnyRouter, + Register, RegisteredRouter, ResolveUseSearch, StrictOrFrom, @@ -11,54 +12,59 @@ import type { } from '@tanstack/router-core' export interface UseSearchBaseOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, > { - select?: (state: ResolveUseSearch) => TSelected + select?: ( + state: ResolveUseSearch, TFrom, TStrict>, + ) => TSelected shouldThrow?: TThrow } export type UseSearchOptions< - TRouter extends AnyRouter, + TRegister extends Register, TFrom, TStrict extends boolean, TThrow extends boolean, TSelected, -> = StrictOrFrom & - UseSearchBaseOptions +> = StrictOrFrom, TFrom, TStrict> & + UseSearchBaseOptions export type UseSearchRoute = < - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, TSelected = unknown, >( opts?: UseSearchBaseOptions< - TRouter, + TRegister, TFrom, /* TStrict */ true, /* TThrow */ true, TSelected >, -) => Vue.Ref> +) => Vue.Ref, TFrom, true, TSelected>> export function useSearch< - TRouter extends AnyRouter = RegisteredRouter, + TRegister extends Register = Register, const TFrom extends string | undefined = undefined, TStrict extends boolean = true, TThrow extends boolean = true, TSelected = unknown, >( opts: UseSearchOptions< - TRouter, + TRegister, TFrom, TStrict, ThrowConstraint, TSelected >, ): Vue.Ref< - ThrowOrOptional, TThrow> + ThrowOrOptional< + UseSearchResult, TFrom, TStrict, TSelected>, + TThrow + > > { return useMatch({ from: opts.from!, diff --git a/packages/vue-router/tests/Matches.test-d.tsx b/packages/vue-router/tests/Matches.test-d.tsx index 533e957343..20354e95b9 100644 --- a/packages/vue-router/tests/Matches.test-d.tsx +++ b/packages/vue-router/tests/Matches.test-d.tsx @@ -147,7 +147,11 @@ const defaultRouter = createRouter({ type DefaultRouter = typeof defaultRouter -const useDefaultMatchRoute = useMatchRoute +interface DefaultRegister { + router: DefaultRouter +} + +const useDefaultMatchRoute = useMatchRoute test('when matching a route with params', () => { const matchRoute = useDefaultMatchRoute() @@ -156,7 +160,7 @@ test('when matching a route with params', () => { .parameter(0) .toHaveProperty('to') - expectTypeOf(MatchRoute) + expectTypeOf(MatchRoute) .parameter(0) .toHaveProperty('to') @@ -176,7 +180,7 @@ test('when matching a route with params underneath a layout route', () => { }) test('useMatches returns a union of all matches', () => { - expectTypeOf(useMatches().value).toEqualTypeOf< + expectTypeOf(useMatches().value).toEqualTypeOf< Array< | RootMatch | IndexMatch @@ -190,7 +194,7 @@ test('useMatches returns a union of all matches', () => { }) test('when filtering useMatches by search', () => { - const matches = useMatches().value + const matches = useMatches().value expectTypeOf(isMatch<(typeof matches)[number], ''>) .parameter(1) @@ -205,7 +209,7 @@ test('when filtering useMatches by search', () => { }) test('when filtering useMatches by loaderData with an array', () => { - const matches = useMatches().value + const matches = useMatches().value expectTypeOf(isMatch<(typeof matches)[number], ''>) .parameter(1) diff --git a/packages/vue-router/tests/link.test-d.tsx b/packages/vue-router/tests/link.test-d.tsx index 4f1d693c6f..5968b4ba26 100644 --- a/packages/vue-router/tests/link.test-d.tsx +++ b/packages/vue-router/tests/link.test-d.tsx @@ -158,29 +158,49 @@ const routerPreserveTrailingSlashes = createRouter({ type DefaultRouter = typeof defaultRouter +interface DefaultRegister { + router: DefaultRouter +} + type DefaultRouterObjects = typeof defaultRouterObjects +interface DefaultRegisterObjects { + router: DefaultRouterObjects +} + type RouterAlwaysTrailingSlashes = typeof routerAlwaysTrailingSlashes +interface AlwaysTrailingSlashesRegister { + router: RouterAlwaysTrailingSlashes +} + type RouterNeverTrailingSlashes = typeof routerNeverTrailingSlashes +interface NeverTrailingSlashesRegister { + router: RouterNeverTrailingSlashes +} + type RouterPreserveTrailingSlashes = typeof routerPreserveTrailingSlashes +interface PreserveTrailingSlashesRegister { + router: RouterPreserveTrailingSlashes +} + test('when navigating to the root', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link + const DefaultRouterObjectsLink = Link const RouterAlwaysTrailingSlashLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/' > const RouterNeverTrailingSlashLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/' > const RouterPreserveTrailingSlashLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, '/' > @@ -434,7 +454,7 @@ test('when navigating to the root', () => { }) test('when navigating from a route with no params and no search to the root', () => { - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -455,7 +475,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -476,7 +496,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -497,7 +517,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -518,7 +538,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -552,7 +572,7 @@ test('when navigating from a route with no params and no search to the root', () | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -560,7 +580,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -568,7 +588,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -576,7 +596,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -584,7 +604,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude().toEqualTypeOf<{ @@ -592,7 +612,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }> - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -600,7 +620,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -608,7 +628,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -616,7 +636,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -624,7 +644,7 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ @@ -632,31 +652,31 @@ test('when navigating from a route with no params and no search to the root', () rootIndexPage: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) @@ -664,111 +684,111 @@ test('when navigating from a route with no params and no search to the root', () }) test('when navigating from a route with no params and no search to the current route', () => { - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId/' | undefined | './'>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId' | undefined | '.'>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf<'./$postId/' | './$postId' | undefined | './' | '.'>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .exclude() .toEqualTypeOf<{ rootPage?: number } | undefined | true>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .returns.toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) .toEqualTypeOf<{ rootPage?: number }>() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('search') .parameter(0) @@ -776,7 +796,7 @@ test('when navigating from a route with no params and no search to the current r }) test('when navigating from a route with no params and no search to the parent route', () => { - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -794,7 +814,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -812,7 +832,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -830,7 +850,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -848,7 +868,7 @@ test('when navigating from a route with no params and no search to the parent ro | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -879,7 +899,7 @@ test('when navigating from a route with no params and no search to the parent ro }) test('cannot navigate to a branch with an index', () => { - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -898,7 +918,7 @@ test('cannot navigate to a branch with an index', () => { | '..' >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -918,7 +938,7 @@ test('cannot navigate to a branch with an index', () => { >() expectTypeOf( - Link, + Link, ) .parameter(0) .toHaveProperty('to') @@ -938,7 +958,7 @@ test('cannot navigate to a branch with an index', () => { | '../' >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -958,7 +978,7 @@ test('cannot navigate to a branch with an index', () => { >() expectTypeOf( - Link, + Link, ) .parameter(0) .toHaveProperty('to') @@ -992,8 +1012,8 @@ test('cannot navigate to a branch with an index', () => { }) test('from autocompletes to all absolute routes', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link + const DefaultRouterObjectsLink = Link expectTypeOf(DefaultRouterLink) .parameter(0) @@ -1037,8 +1057,8 @@ test('from autocompletes to all absolute routes', () => { }) test('from does not allow invalid routes', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link + const DefaultRouterObjectsLink = Link expectTypeOf(DefaultRouterLink) .parameter(0) @@ -1082,8 +1102,8 @@ test('from does not allow invalid routes', () => { }) test('when navigating to the same route', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link + const DefaultRouterObjectsLink = Link const RouterAlwaysTrailingSlashesLink = Link< RouterAlwaysTrailingSlashes, string, @@ -1202,8 +1222,8 @@ test('when navigating to the same route', () => { }) test('when navigating to the parent route', () => { - const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterLink = Link + const DefaultRouterObjectsLink = Link const RouterAlwaysTrailingSlashesLink = Link< RouterAlwaysTrailingSlashes, @@ -1323,7 +1343,7 @@ test('when navigating to the parent route', () => { }) test('when navigating from a route with params to the same route', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link const DefaultRouterObjectsLink = Link< DefaultRouterObjects, '/posts/$postId', @@ -1400,7 +1420,7 @@ test('when navigating from a route with params to the same route', () => { }) test('when navigating to a route with params', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link const DefaultRouterObjectsLink = Link< DefaultRouterObjects, @@ -1541,31 +1561,31 @@ test('when navigating to a route with params', () => { test('when navigating from a route with no params to a route with params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, '/invoices', './$invoiceId/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices', './$invoiceId/edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices', './$invoiceId/edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices', './$invoiceId/edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + PreserveTrailingSlashesRegister, '/invoices', './$invoiceId/edit' | './invoicesId/edit/' > @@ -1665,31 +1685,31 @@ test('when navigating from a route with no params to a route with params', () => test('when navigating from a route to a route with the same params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, '/invoices/$invoiceId', './edit' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices/$invoiceId', './edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices/$invoiceId', './edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', './edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', './edit' | './edit/' > @@ -1801,31 +1821,31 @@ test('when navigating from a route to a route with the same params', () => { test('when navigating from a route with params to a route with different params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, '/invoices/$invoiceId', '../../posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices/$invoiceId', '../../posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices/$invoiceId', '../../posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', '../../posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, '/invoices/$invoiceId', '../../posts/$postId' | '../../posts/$postId/' > @@ -1933,31 +1953,31 @@ test('when navigating from a route with params to a route with different params' test('when navigating from a route with params to a route with an additional param', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, '/invoices/$invoiceId', './details/$detailId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices/$invoiceId', './details/$detailId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices/$invoiceId', './details/$detailId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', './details/$detailId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, '/invoices/$invoiceId', './details/$detailId' | './details/$detailId' > @@ -2056,31 +2076,31 @@ test('when navigating from a route with params to a route with an additional par test('when navigating to a union of routes with params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, | '/invoices/$invoiceId/edit' | '/invoices/$invoiceId/edit/' @@ -2207,31 +2227,31 @@ test('when navigating to a union of routes with params', () => { test('when navigating to a union of routes including the root', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/' | '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, | '/' | '/invoices/$invoiceId/edit' @@ -2368,28 +2388,28 @@ test('when navigating to a union of routes including the root', () => { }) test('when navigating from a route with search params to the same route', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices/$invoiceId', string > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices/$invoiceId', string > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', string > const RouterPreserveTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId', string > @@ -2445,31 +2465,31 @@ test('when navigating from a route with search params to the same route', () => test('when navigating to a route with search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/invoices/$invoiceId/edit' > const DefaultRouterObjectsLink = Link< - DefaultRouter, + DefaultRegister, string, '/invoices/$invoiceId/edit' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/invoices/$invoiceId/edit/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/invoices/$invoiceId/edit' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, '/invoices/$invoiceId/edit' | '/invoices/$invoiceId/edit/' > @@ -2618,31 +2638,31 @@ test('when navigating to a route with search params', () => { test('when navigating to a route with optional search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/invoices/$invoiceId/details/$detailId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, string, '/invoices/$invoiceId/details/$detailId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/invoices/$invoiceId/details/$detailId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/invoices/$invoiceId/details/$detailId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, | '/invoices/$invoiceId/details/$detailId' | '/invoices/$invoiceId/details/$detailId/' @@ -2967,31 +2987,31 @@ test('when navigating from a route with no search params to a route with search test('when navigating to a union of routes with search params', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, | '/invoices/$invoiceId/edit' | '/posts/$postId' @@ -3153,31 +3173,31 @@ test('when navigating to a union of routes with search params', () => { test('when navigating to a union of routes with search params including the root', () => { const DefaultRouterLink = Link< - DefaultRouter, + DefaultRegister, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const DefaultRouterObjectsLink = Link< - DefaultRouterObjects, + DefaultRegisterObjects, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, string, '/' | '/invoices/$invoiceId/edit/' | '/posts/$postId/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, string, '/' | '/invoices/$invoiceId/edit' | '/posts/$postId' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, string, | '/' | '/invoices/$invoiceId/edit' @@ -3354,24 +3374,24 @@ test('when navigating to a union of routes with search params including the root }) test('when navigating from the root to /posts', () => { - const DefaultRouterLink = Link + const DefaultRouterLink = Link - const DefaultRouterObjectsLink = Link + const DefaultRouterObjectsLink = Link const RouterAlwaysTrailingSlashesLink = Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/', '/posts/' > const RouterNeverTrailingSlashesLink = Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/', '/posts' > const RouterPreserveTrailingSlashesLink = Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, '/', '/posts' | '/posts/' > @@ -3493,7 +3513,7 @@ test('when navigating from the root to /posts', () => { test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouter, + DefaultRegister, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3507,7 +3527,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - DefaultRouterObjects, + DefaultRegisterObjects, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3521,7 +3541,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterAlwaysTrailingSlashes, + AlwaysTrailingSlashesRegister, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines/' >, @@ -3535,7 +3555,7 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterNeverTrailingSlashes, + NeverTrailingSlashesRegister, '/invoices/$invoiceId/details/$detailId/lines', '/invoices/$invoiceId/details/$detailId/lines' >, @@ -3549,10 +3569,10 @@ test('when navigating to a route with SearchSchemaInput', () => { expectTypeOf( Link< - RouterPreserveTrailingSlashes, + PreserveTrailingSlashesRegister, '/invoices/$invoiceId/details/$detailId/lines', - | '/invoices/$invoiceId/details/$detailId/lines/' | '/invoices/$invoiceId/details/$detailId/lines' + | '/invoices/$invoiceId/details/$detailId/lines/' >, ) .parameter(0) @@ -3561,139 +3581,6 @@ test('when navigating to a route with SearchSchemaInput', () => { .toEqualTypeOf< { rootPage?: number; page?: number; linesPage?: number } | undefined >() - - expectTypeOf( - Link, - ) - .parameter(0) - .toHaveProperty('search') - .returns.toEqualTypeOf<{ - rootPage?: number - page?: number - linesPage?: number - }>() - - expectTypeOf( - Link< - DefaultRouterObjects, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .returns.toEqualTypeOf<{ - rootPage?: number - page?: number - linesPage?: number - }>() - - expectTypeOf( - Link< - RouterAlwaysTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines/' - >, - ) - .parameter(0) - .toHaveProperty('search') - .returns.toEqualTypeOf<{ - rootPage?: number - page?: number - linesPage?: number - }>() - - expectTypeOf( - Link< - RouterNeverTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .returns.toEqualTypeOf<{ - rootPage?: number - page?: number - linesPage?: number - }>() - - expectTypeOf( - Link< - RouterPreserveTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - | '/invoices/$invoiceId/details/$detailId/lines/' - | '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .returns.toEqualTypeOf<{ - rootPage?: number - page?: number - linesPage?: number - }>() - - expectTypeOf( - Link< - DefaultRouter, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .parameter(0) - .toEqualTypeOf<{ rootPage?: number; page?: number; linesPage: number }>() - - expectTypeOf( - Link< - DefaultRouterObjects, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .parameter(0) - .toEqualTypeOf<{ rootPage?: number; page?: number; linesPage: number }>() - - expectTypeOf( - Link< - RouterAlwaysTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines/' - >, - ) - .parameter(0) - .toHaveProperty('search') - .parameter(0) - .toEqualTypeOf<{ rootPage?: number; page?: number; linesPage: number }>() - - expectTypeOf( - Link< - RouterNeverTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - '/invoices/$invoiceId/details/$detailId/lines/' - >, - ) - .parameter(0) - .toHaveProperty('search') - .parameter(0) - .toEqualTypeOf<{ rootPage?: number; page?: number; linesPage: number }>() - - expectTypeOf( - Link< - RouterPreserveTrailingSlashes, - '/invoices/$invoiceId/details/$detailId/lines', - | '/invoices/$invoiceId/details/$detailId/lines/' - | '/invoices/$invoiceId/details/$detailId/lines' - >, - ) - .parameter(0) - .toHaveProperty('search') - .parameter(0) - .toEqualTypeOf<{ rootPage?: number; page?: number; linesPage: number }>() }) test('when passing a component with props to createLink and navigating to the root', () => { @@ -3701,8 +3588,8 @@ test('when passing a component with props to createLink and navigating to the ro )) - const DefaultRouterLink = MyLink - const DefaultRouterObjectsLink = MyLink + const DefaultRouterLink = MyLink + const DefaultRouterObjectsLink = MyLink const RouterAlwaysTrailingSlashLink = MyLink< RouterAlwaysTrailingSlashes, string, @@ -4028,77 +3915,77 @@ test('ResolveRelativePath', () => { }) test('navigation edge cases', () => { - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf() @@ -4114,7 +4001,7 @@ test('navigation edge cases', () => { .toHaveProperty('to') .toEqualTypeOf() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4132,7 +4019,7 @@ test('navigation edge cases', () => { | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4150,7 +4037,7 @@ test('navigation edge cases', () => { | undefined >() - expectTypeOf(Link) + expectTypeOf(Link) .parameter(0) .toHaveProperty('to') .toEqualTypeOf< @@ -4169,7 +4056,7 @@ test('navigation edge cases', () => { >() expectTypeOf( - Link, + Link, ) .parameter(0) .toHaveProperty('to')