Correctly typing params for navigate from useNavigate after upgrade from 1.45 to 1.58

[dotintegral]

Hey everyone 👋

We have a function in our app called goBack. It's main purpose would be to add some search params to the URL, when user goes back (for example, clicking a "back arrow"on a subpage to go back to the main page).

We have typed it as follows:

type NavigateParam = Parameters<UseNavigateResult<string>>[0];

export function goBack(context: OurContext): NavigateParam {

  return {
    to: '/valid/route',
    search: {
        key: 'value',
   }
  }
}

and then we would use it simply:

// in page
const navigate = useNavigate();
// in jsx
<MyButton onClick={() => navigate(goBack(myContext))} />

However, after we upgraded from 1.45.x to 1.58.x, I get a TypeScript error:

Object literal may only specify known properties, and 'key' does not exist in type 'ParamsReducerFn<Router<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, ({ location }: BeforeLoadContextOptions<any, undefined, {}, { queryClient: QueryClient; }, AnyContext>) => Promise<...>, {}, () => Promise<...>, RootRouteChildren, FileRouteTypes>, TrailingSlashOption, Record<...>, Record<...>>, "...'.

51             key: 'value',
               ~~~

  ../../node_modules/.pnpm/@[email protected][email protected][email protected]/node_modules/@tanstack/react-router/dist/esm/link.d.ts:61:5
    61     search?: true | (ParamsReducer<TRouter, 'SEARCH', TFrom, TTo> & {});
           ~~~~~~
    The expected type comes from property 'search' which is declared here on type 'NavigateOptions<Router<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, ({ location }: BeforeLoadContextOptions<any, undefined, {}, { queryClient: QueryClient; }, AnyContext>) => Promise<...>, {}, () => Promise<...>, RootRouteChildren, FileRouteTypes>, TrailingSlashOption, Record<...>, Record<...>>, s...'

Can you please help me to figure out how to correctly type the return value for function, so then I can use that value as the input for navigate? 🤔