feat: expose querykey getter and fix some querykey stuff

[juliusmarminge]

• Closes feat: expose queryKey #3295
• Closes bug: query invalidation doesn't accept filters #3455
• Closes bug: query invalidation can only target trpc queries #3456

🎯 Changes

What changes are made in this PR? Is it a feature or a bug fix?

• Adds a getQueryKey helper for routers and procedures

• fixes some other queryKey related bugs (see bug: query invalidation doesn't accept filters #3455 and bug: query invalidation can only target trpc queries #3456)

Docs link: https://www-git-julius-querykeys-trpc.vercel.app/docs/useContext#-the-function-i-want-isnt-here

API

Since we can't distinguish routers and procedures in runtime, we can't dynamically decide the QueryType to call getArrayQueryKey with. Therefore, I made these explicit arguments that the user inputs:

getQueryKey(undefined, "any")   // for routers
getQueryKey(TInput, "infinite") // for infinite queries
getQueryKey(TInput, "query")    // for regular queries

The default QueryType is any.

Usage is as follows:

import { useQueryClient } from "@tanstack/react-query";
import { trpc } from "~/utils/trpc";

const MyComp = () => {
  const qc = useQueryClient();
  const qKey = trpc.post.getQueryKey(undefined, "any");
  setQueryDefaults(qKey, { staleTime: 30 * 60 * 1000 });
}

Another usage is for route prefetching:

trpc/examples/tanstack-router/client/src/utils/router.tsx

Lines 55 to 61 in 377e271

	loader: async () => {
	const postKey = trpc.post.all.getQueryKey(undefined, 'query');
	queryClient.getQueryData(postKey) ??
	(await queryClient.prefetchQuery(postKey, getPosts));
	return {};
	},

✅ Checklist

• I have followed the steps listed in the Contributing guide.
• If necessary, I have added documentation related to the changes made.
• I have added or updated the tests related to the changes made.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
next-prisma-starter	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Dec 23, 2022 at 9:17AM (UTC)
og-image	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Dec 23, 2022 at 9:17AM (UTC)
todomvc	🔄 Building (Inspect)		💬 Add your feedback	Dec 23, 2022 at 9:17AM (UTC)
www	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Dec 23, 2022 at 9:17AM (UTC)

[juliusmarminge]

nvm I found it and fixed it here instead

[KATT]

Hmm, is this a breaking change?

[KATT]

Isn't this changing the behaviour? 🤔

Looks like a breaking change?

[juliusmarminge]

I mean yea theoretically although it wasnt working before so its more of a fix?

[juliusmarminge]

Mentioned this here: https://discord.com/channels/867764511159091230/1055437438266392646/1055450208424706099

We always take the first arg as input no matter what the types said so any filters applied would actually end up being supressed

[KATT]

Breaking chaange?

[juliusmarminge]

See above

[TkDodo]

awesome - thanks for this ❤️