feat(openapi-react-query): support for useInfiniteQuery()

[jungwoo3490]

Changes

close #1828

Hi @kerwanp :)

I added useInfiniteQuery() to openapi-react-query.

How to Review

Any feedback is welcome. I'll review it and make updates!

Checklist

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

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 688bc2f7003299272c162cb2f15947cd5429aa88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[jungwoo3490]

@drwpow @kerwanp Can you check this PR? 👀

[tommymarshall]

Is there any reason not to introduce this?

[kerwanp]

@tommymarshall @jungwoo3490 this pull request does not seem to be ready to be merged as tests are still failing. And with the latest changes it now has conflicts with main branch.

I would be happy to review a pull request introducing those changes with successful tests and resolved conflicts.

[tommymarshall]

@tommymarshall @jungwoo3490 this pull request does not seem to be ready to be merged as tests are still failing. And with the latest changes it now has conflicts with main branch.

I would be happy to review a pull request introducing those changes with successful tests and resolved conflicts.

Looks like it it's a build error with existing code -- worth re-running or getting the branch up-to-date @jungwoo3490 ?

[jungwoo3490]

@kerwanp @tommymarshall I'll update my branch and resolve the conflict as soon as possible!

[Mattias-]

Thank you for helping out @jungwoo3490! It would be a nice feature to have.

[jungwoo3490]

@kerwanp @drwpow @tommymarshall I've resolved all the conflict errors and confirmed that it’s ready to merge into the main branch. Could you double-check again please?

[kerwanp]

I am confused, how do you use the pageParam in the request? It does not seem to be provided and there is no option to define where to use it (path params, query params, body)

[snndmnsz]

When will be released? Any news?

[MikeBurkeMed]

Hi all, this hook is part of the core tanstack query and is one of the main reasons why devs choose tanstack query as opposed to other libs, I see a lot of work has been done already (Many thanks for them!) but we're wondering if we can help in anyway to have this merged? I, for one, would be very happy to help. Thanks.

[awmichel]

I managed to hack together a working implementation with a few tweaks from what has been done here. I quickly extracted this from some production code, so it will take some effort to get working for individual or project use cases.

This implementation makes some assumptions about the page param being in the query params rather than the body of a POST request. There are a few ignored types, the generated paths type doesn't align with the interface (Record<string, Record<HttpMethod, {}>>) defined by many of the internal types, so there're are some ignored type errors.

I know I have found a way in the past to convert a dot-separated string into an object path with TypeScript, something like that might also work for the page param so it doesn't need to be a function call, but could still support different params sources.

https://gist.github.com/awmichel/0e3aa3d5df6f7891e794895d2c695107

Edit: Ahh, yes, this StackOverflow post has some good references for strongly typed nested object paths. https://stackoverflow.com/questions/77976781/typescript-type-for-getting-all-nested-key-paths-of-an-object-including-arrays

[musjj]

@awmichel

Thanks, this is really cool! Does the page param work only for query params, or can you use this for JSON bodies too?

[awmichel]

@musjj It only works for query params, but line 60 of the gist is where the page param is being merged into initWithPage, so if you consistently need the page param in a JSON body, you could change query to body on lines 58 and 59.

[lukasedw]

Hey guys, I continued this PR here #2117, I really need this feature so any reviews are welcomed! Cc.: @HagenMorano @kerwanp @drwpow