feat(openapi-react-query): add prefixQueryKey option

[jeiea]

Background

Close #1979.

Current openapi-react-query has a potential issue because useQuery calls from different clients are assigned the same key, even though they're querying different endpoints.

For example:

import { default as createFetchClient } from 'openapi-fetch'
import createClient from 'openapi-react-query'

const client1 = createClient(createFetchClient({ baseUrl: 'https://api1.example.com' }))
const client2 = createClient(createFetchClient({ baseUrl: 'https://api2.example.com' }))

function useSomething() {
  return [client1.useQuery('get', '/a'), client2.useQuery('get', '/a')]
}

Here, both queries receive the same key, even though they are querying different sources.

This try to resolve the problem.

Changes

• Added a prefixQueryKey parameter to differentiate cache identities.

How to Review

• I haven't changed the documentation, but if you think it's necessary, please comment.
• I got the comment about prefixQueryKey's type, and I ended up using unknown type.
  See packages/openapi-react-query/test/index.test.tsx:270, and feel free to leave a comment if you have any other thoughts.

Checklist

• Unit tests updated
• docs/ updated (if necessary)
• pnpm run update:examples run (only applicable for openapi-typescript)

[netlify]

❌ Deploy Preview for openapi-ts failed.

Name	Link
🔨 Latest commit	1f048dc
🔍 Latest deploy log	https://app.netlify.com/projects/openapi-ts/deploys/684daa4165b1500008c46a2c

[changeset-bot]

🦋 Changeset detected

Latest commit: 1f048dc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
openapi-react-query	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[RobertBjorklundDev]

Awesome that this is on the way, I'm facing the same problem right now in my code and the only good option is to have an easy way of prefixing the queryKeys for a specific client!

[jeiea]

@htunnicliff @kerwanp Please give me any kind of comments.

What’s your first impression of this PR? Are there any immediate concerns? Would you prefer to explore a different direction?

Even if you’re still thinking it through, it’d be great if you could share your thoughts.