feat: add createSuspenseQueryHook for suspense-enabled queries

[jtomaszewski]

Summary

• Add createSuspenseQueryHook factory function that creates a typed hook with suspense: true enabled by default
• The returned data is always defined (non-optional), since React Suspense guarantees data is available before the component renders
• Config type omits suspense option (always enabled)

New exports

• createSuspenseQueryHook - factory function for creating suspense hooks
• SuspenseSWRResponse - response type with non-optional data
• SuspenseSWRConfig - config type with suspense option omitted

Usage

import { createSuspenseQueryHook } from 'swr-openapi';

const useSuspenseQuery = createSuspenseQueryHook(client, "api");

// data is Pet[], not Pet[] | undefined
const { data } = useSuspenseQuery("/pets");

[htunnicliff]

It looks like the types for suspense weren't working because the SWR configuration type was not being passed down to useSWR 🤦‍♂️

I was able to remedy that in #42 and release that fix in v5.6.0.

Want to give that a try?

[jtomaszewski]

It helps, yes.

Although, I'd still be up for merging this. In my app example, we use suspense: true nearly everywhere. Even with that fix, we still need to write useQuery(..., ..., { suspense: true }) everywhere, which may feel boilerplate'y a bit, especially with simple requests such as useQuery("/posts", {}, { suspense: true }), which could be simplified to useSuspenseQuery("/posts") instead, or maybe just useQuery("/posts") if somebody would want to force suspense globally for their app.

Unfortunately, building that useSuspenseQuery wrapper on top of useQuery currently is difficult from the type definition side, as seen below:

That's minimal code required for that, and because of its' complexity, I can't even tell yet whether that actually works. (Before making this PR, I had something like that too, and I think it had some bug.)

Having it in this library (with it being covered by tests ;) ), would help me quite a bit.