openapi-typesafe-react-query 1.0.0-rc.1 → 1.0.0-rc.3

package/README.md

@@ -1,20 +1,21 @@
 # openapi-typesafe-react-query
 
-openapi-typesafe-react-query is a small, type-safe wrapper (about 2.5 kB) around [@tanstack/react-query](https://tanstack.com/query/latest/docs/framework/react/overview) to work with OpenAPI schema.
+openapi-typesafe-react-query is a small, type-safe wrapper (about 1 kB minified) around [@tanstack/react-query](https://tanstack.com/query/latest/docs/framework/react/overview) to work with OpenAPI schema.
 
 It works by using [openapi-typesafe-fetch](../openapi-typesafe-fetch) and [openapi-typesafe](../openapi-typesafe) so URLs, parameters, request bodies and responses are checked against your schema, with no manual types,
 no `any` and no `as` assertions.
 
 A maintained, drop-in successor to `openapi-react-query` (see the [repository README](../../README.md)).
 
-> **Status: in development; not published to npm yet.**
+> **Release candidate.** The current version is a 1.0.0 release candidate (`1.0.0-rc.N`);
+> names and output can still change before 1.0.0.
 
 ## Setup
 
 Install this library along with [openapi-typesafe-fetch](../openapi-typesafe-fetch) and [openapi-typesafe](../openapi-typesafe):
 
 ```bash
-npm i openapi-typesafe-react-query openapi-typesafe-fetch
+npm i openapi-typesafe-react-query openapi-typesafe-fetch @tanstack/react-query
 npm i -D openapi-typesafe typescript
 ```
 
@@ -45,10 +46,10 @@ const MyComponent = () => {
     },
   });
 
-  if (isPending || !data) return "Loading...";
-
   if (error) return `An error occurred: ${error.message}`;
 
+  if (isPending || !data) return "Loading...";
+
   return <div>{data.title}</div>;
 };
 ```
@@ -62,6 +63,12 @@ const MyComponent = () => {
 + import createClient from "openapi-typesafe-react-query";
 ```
 
+## Versioning
+
+Semantic versioning from 1.0.0, with one version for all openapi-typesafe packages. What the
+version promises, and what may grow in a minor release, is listed under
+[Versioning](https://github.com/openapi-typesafe/openapi-typesafe/blob/main/docs/compatibility.md#versioning).
+
 ## License
 
 [MIT](./LICENSE)

package/dist/index.cjs

@@ -33,8 +33,15 @@ function createClient(client) {
   });
   return {
     queryOptions,
-    useQuery: (method, path, ...[init, options, queryClient]) => reactQuery.useQuery(queryOptions(method, path, init, options), queryClient),
-    useSuspenseQuery: (method, path, ...[init, options, queryClient]) => reactQuery.useSuspenseQuery(queryOptions(method, path, init, options), queryClient),
+    useQuery: (method, path, ...[init, options, queryClient]) => reactQuery.useQuery(
+      queryOptions(method, path, init, options),
+      queryClient
+    ),
+    useSuspenseQuery: (method, path, ...[init, options, queryClient]) => reactQuery.useSuspenseQuery(
+      queryOptions(method, path, init, options),
+      queryClient
+    ),
+    // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)
     useInfiniteQuery: (method, path, init, options, queryClient) => {
       const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;
       const { queryKey } = queryOptions(method, path, init);
@@ -45,13 +52,18 @@ function createClient(client) {
           queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER],
           // The request comes from the arguments; the key only identifies the cache entry.
           queryFn: async ({ pageParam, signal }) => {
-            const result = await fn(path, pageInit(init, { pageParamName, pageParam, signal }));
+            const result = await fn(
+              path,
+              // biome-ignore lint/suspicious/noExplicitAny: a generic init; see queryFn
+              pageInit(init, { pageParamName, pageParam, signal })
+            );
             throwIfFailed(result);
             return result.data;
           },
           ...restOptions,
           // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack
           // passes the previous data of this query, with its own page params, and takes it back.
+          // biome-ignore lint/suspicious/noExplicitAny: TanStack's type carries its own page params
           placeholderData
         },
         queryClient

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  type DataTag,\n  type InfiniteData,\n  type QueryClient,\n  type QueryFunctionContext,\n  type SkipToken,\n  type UseInfiniteQueryOptions,\n  type UseInfiniteQueryResult,\n  type UseMutationOptions,\n  type UseMutationResult,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryOptions,\n  type UseSuspenseQueryResult,\n  useInfiniteQuery,\n  useMutation,\n  useQuery,\n  useSuspenseQuery,\n} from \"@tanstack/react-query\";\nimport type {\n  ClientMethod,\n  DefaultParamsOption,\n  Client as FetchClient,\n  FetchResponse,\n  IsInitOptional,\n  MaybeOptionalInit,\n  PathOperation,\n} from \"openapi-typesafe-fetch\";\nimport type { HttpMethod, MediaType, PathsWithMethod } from \"openapi-typesafe-helpers\";\n\n// Helper type to dynamically infer the type from the `select` property\ntype InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;\n\n/**\n * Query data of a response type: a success without a body is `undefined` in the fetch client and\n * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).\n */\ntype QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;\n\ntype InitWithUnknowns<Init> = Init & { [key: string]: unknown };\n\n/**\n * The arguments after the path: the init, required when the operation requires a parameter or a\n * body, then `Rest`. `IsInitOptional` keeps the init optional in\n * `Parameters<typeof $api.queryOptions>`, where it is the union of all inits (upstream #2178).\n */\ntype InitArguments<Init, Rest extends unknown[]> =\n  IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];\n\nexport type QueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init = MaybeOptionalInit<Paths[Path], Method>,\n> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];\n\n/**\n * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different\n * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream\n * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime\n * named export next to the default export would change what `require()` returns.\n */\nconst INFINITE_QUERY_KEY_MARKER = \"infinite\";\n\nexport type InfiniteQueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];\n\nexport type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  path: Path,\n  ...[init, options]: InitArguments<Init, [Options?]>\n) => NoInfer<\n  Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryFn\" | \"queryKey\"\n  > & {\n    queryKey: DataTag<QueryKey<Paths, Method, Path>, QueryData<Response[\"data\"]>, Response[\"error\"]>;\n    queryFn: Exclude<\n      UseQueryOptions<\n        QueryData<Response[\"data\"]>,\n        Response[\"error\"],\n        InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n        QueryKey<Paths, Method, Path>\n      >[\"queryFn\"],\n      SkipToken | undefined\n    >;\n  }\n>;\n\nexport type UseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseQueryResult<InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>, Response[\"error\"]>;\n\n/**\n * The type of the page params: the initial one and the ones `getNextPageParam` and\n * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a\n * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot\n * infer the return type of a callback that computes it from an unannotated `lastPageParam`,\n * whose type depends on that return type, and gives `never` or `unknown`.\n */\ntype PageParam<Initial, Next, Previous> =\n  IsUntyped<Next> extends true\n    ? unknown\n    : [Previous] extends [NoPreviousPageParam]\n      ? NullishToUnknown<Initial | NonNullable<Next>>\n      : IsUntyped<Previous> extends true\n        ? unknown\n        : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;\n\n/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */\ndeclare const NO_PREVIOUS_PAGE_PARAM: unique symbol;\ntype NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;\n\ntype IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;\n\n/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */\ntype NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;\n\n/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */\ntype PageParamFunction<Result> = (...args: never) => Result;\n\n/**\n * Inference sites of the page param types. Intersected before `Options`, so TanStack's own\n * inference in the implementation reads the full signatures of `Options`.\n */\ninterface PageParamSources<Initial, Next, Previous> {\n  initialPageParam: Initial;\n  getNextPageParam: PageParamFunction<Next>;\n  getPreviousPageParam?: PageParamFunction<Previous>;\n}\n\n/**\n * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types\n * a `(previousData) => previousData` callback while it still infers the page param, so it got\n * `unknown` there and failed against the typed page param.\n */\ntype InfinitePlaceholderData<\n  Data,\n  Error,\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = UseInfiniteQueryOptions<\n  Data,\n  Error,\n  InfiniteData<Data, unknown>,\n  InfiniteQueryKey<Paths, Method, Path>,\n  unknown\n>[\"placeholderData\"];\n\nexport type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseInfiniteQueryOptions<\n      Response[\"data\"],\n      Response[\"error\"],\n      InferSelectReturnType<InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>, Options[\"select\"]>,\n      InfiniteQueryKey<Paths, Method, Path>,\n      PageParam<Initial, Next, Previous>\n    >,\n    \"queryKey\" | \"queryFn\" | \"placeholderData\"\n  > & {\n    placeholderData?: InfinitePlaceholderData<Response[\"data\"], Response[\"error\"], Paths, Method, Path>;\n    pageParamName?: string;\n  },\n  Initial = unknown,\n  Next = never,\n  Previous = NoPreviousPageParam,\n>(\n  method: Method,\n  url: Path,\n  init: InitWithUnknowns<Init>,\n  options: PageParamSources<Initial, Next, Previous> & Options,\n  queryClient?: QueryClient,\n) => UseInfiniteQueryResult<\n  InferSelectReturnType<InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\nexport type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseSuspenseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseSuspenseQueryResult<InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>, Response[\"error\"]>;\n\nexport type UseMutationMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  TOnMutateResult = unknown,\n>(\n  method: Method,\n  url: Path,\n  options?: Omit<\n    UseMutationOptions<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>,\n    \"mutationKey\" | \"mutationFn\"\n  >,\n  queryClient?: QueryClient,\n) => UseMutationResult<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>;\n\nexport interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaType> {\n  queryOptions: QueryOptionsFunction<Paths, Media>;\n  useQuery: UseQueryMethod<Paths, Media>;\n  useSuspenseQuery: UseSuspenseQueryMethod<Paths, Media>;\n  useInfiniteQuery: UseInfiniteQueryMethod<Paths, Media>;\n  useMutation: UseMutationMethod<Paths, Media>;\n}\n\nexport type MethodResponse<\n  CreatedClient extends OpenapiQueryClient<any, any>,\n  Method extends HttpMethod,\n  Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media>\n    ? PathsWithMethod<Paths, Method>\n    : never,\n  Options = object,\n> =\n  CreatedClient extends OpenapiQueryClient<infer Paths extends { [key: string]: any }, infer Media extends MediaType>\n    ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>[\"data\"]>\n    : never;\n\n/**\n * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response with\n * an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as `0`.\n */\nfunction throwIfFailed(result: { error?: unknown; response: Response }): void {\n  if (result.error !== undefined || !result.response.ok) {\n    throw result.error;\n  }\n}\n\n/** The query parameter that carries the page param unless `pageParamName` names another. */\nconst DEFAULT_PAGE_PARAM_NAME = \"cursor\";\n\ninterface PageRequest {\n  readonly pageParamName: string;\n  readonly pageParam: unknown;\n  readonly signal: AbortSignal;\n}\n\n/**\n * The request init of one page. An `undefined` page param (the first page with\n * `initialPageParam: undefined`) is left out instead of being sent as `0` (upstream #2715, #2340,\n * ADR-022), so a cursor API gets no cursor on the first page.\n */\nfunction pageInit(init: unknown, { pageParamName, pageParam, signal }: PageRequest) {\n  const { params, ...rest } = (init ?? {}) as { params?: { query?: DefaultParamsOption } };\n  const page = pageParam === undefined ? {} : { [pageParamName]: pageParam };\n  return { ...rest, signal, params: { ...params, query: { ...params?.query, ...page } } };\n}\n\n// TODO: Add the ability to bring queryClient as argument\nexport default function createClient<Paths extends {}, Media extends MediaType = MediaType>(\n  client: FetchClient<Paths, Media>,\n): OpenapiQueryClient<Paths, Media> {\n  const queryFn = async <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>({\n    queryKey,\n    signal,\n  }: QueryFunctionContext<QueryKey<Paths, Method, Path>>) => {\n    // While `Path` is generic, TypeScript cannot work out that the key is a tuple: the init is a\n    // conditional type per operation (`MaybeOptionalInit`), and the key's type waits for it.\n    const [method, path, init] = queryKey as readonly [Method, Path, unknown?];\n    const mth = method.toUpperCase() as Uppercase<typeof method>;\n    const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n    const result = await fn(path, { signal, ...(init as any) }); // TODO: find a way to avoid as any\n    throwIfFailed(result);\n    // TanStack Query rejects `undefined` query data. The fetch client gives `undefined` for every\n    // success without a body: a 204, `Content-Length: 0`, an empty chunked body, a HEAD request\n    // (upstream #2234). A parsed body is never `undefined`, so this changes nothing else.\n    return result.data ?? null;\n  };\n\n  const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({\n    queryKey: (init === undefined ? ([method, path] as const) : ([method, path, init] as const)) as DataTag<\n      QueryKey<Paths, typeof method, typeof path>,\n      any,\n      any\n    >,\n    queryFn,\n    ...options,\n  });\n\n  return {\n    queryOptions,\n    useQuery: (method, path, ...[init, options, queryClient]) =>\n      useQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),\n    useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>\n      useSuspenseQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),\n    useInfiniteQuery: (method, path, init, options, queryClient) => {\n      const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;\n      const { queryKey } = queryOptions(method, path, init);\n      const mth = method.toUpperCase() as Uppercase<typeof method>;\n      const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n      return useInfiniteQuery(\n        {\n          queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER] as const,\n          // The request comes from the arguments; the key only identifies the cache entry.\n          queryFn: async ({ pageParam, signal }) => {\n            const result = await fn(path, pageInit(init, { pageParamName, pageParam, signal }) as any);\n            throwIfFailed(result);\n            // An empty page stays `undefined`, as in upstream: TanStack Query rejects only\n            // `undefined` query data, and the infinite query data is the `{ pages }` object.\n            return result.data;\n          },\n          ...restOptions,\n          // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack\n          // passes the previous data of this query, with its own page params, and takes it back.\n          placeholderData: placeholderData as any,\n        },\n        queryClient,\n      );\n    },\n    useMutation: (method, path, options, queryClient) =>\n      useMutation(\n        {\n          mutationKey: [method, path],\n          mutationFn: async (init) => {\n            const mth = method.toUpperCase() as Uppercase<typeof method>;\n            const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n            const result = await fn(path, init as InitWithUnknowns<typeof init>);\n            throwIfFailed(result);\n            // TanStack Query accepts `undefined` mutation data, so a success without a body stays\n            // `undefined`, as in upstream; only query data needs `null` (upstream #2234). The cast\n            // only bridges the generic types: `Response[\"data\"]` still has `undefined` for an\n            // operation with a response without a body.\n            const { data } = result;\n            return data as Exclude<typeof data, undefined>;\n          },\n          ...options,\n        },\n        queryClient,\n      ),\n  };\n}\n"],"names":["useQuery","useSuspenseQuery","useInfiniteQuery","useMutation"],"mappings":";;;;AA8DA,MAAM,yBAAA,GAA4B,UAAA;AA0NlC,SAAS,cAAc,MAAA,EAAuD;AAC5E,EAAA,IAAI,OAAO,KAAA,KAAU,MAAA,IAAa,CAAC,MAAA,CAAO,SAAS,EAAA,EAAI;AACrD,IAAA,MAAM,MAAA,CAAO,KAAA;AAAA,EACf;AACF;AAGA,MAAM,uBAAA,GAA0B,QAAA;AAahC,SAAS,SAAS,IAAA,EAAe,EAAE,aAAA,EAAe,SAAA,EAAW,QAAO,EAAgB;AAClF,EAAA,MAAM,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,GAAK,QAAQ,EAAC;AACtC,EAAA,MAAM,IAAA,GAAO,cAAc,MAAA,GAAY,KAAK,EAAE,CAAC,aAAa,GAAG,SAAA,EAAU;AACzE,EAAA,OAAO,EAAE,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,GAAG,IAAA,IAAO,EAAE;AACxF;AAGA,SAAwB,aACtB,MAAA,EACkC;AAClC,EAAA,MAAM,UAAU,OAA+E;AAAA,IAC7F,QAAA;AAAA,IACA;AAAA,GACF,KAA2D;AAGzD,IAAA,MAAM,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA,GAAI,QAAA;AAC7B,IAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,IAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,IAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,EAAE,MAAA,EAAQ,GAAI,MAAc,CAAA;AAC1D,IAAA,aAAA,CAAc,MAAM,CAAA;AAIpB,IAAA,OAAO,OAAO,IAAA,IAAQ,IAAA;AAAA,EACxB,CAAA;AAEA,EAAA,MAAM,eAAmD,CAAC,MAAA,EAAQ,SAAS,CAAC,IAAA,EAAM,OAAO,CAAA,MAAO;AAAA,IAC9F,QAAA,EAAW,IAAA,KAAS,MAAA,GAAa,CAAC,MAAA,EAAQ,IAAI,CAAA,GAAe,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA;AAAA,IAKhF,OAAA;AAAA,IACA,GAAG;AAAA,GACL,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,YAAA;AAAA,IACA,UAAU,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,MAAM,OAAA,EAAS,WAAW,CAAA,KACrDA,mBAAA,CAAS,aAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,GAAG,WAAW,CAAA;AAAA,IAClG,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,MAAM,OAAA,EAAS,WAAW,CAAA,KAC7DC,2BAAA,CAAiB,aAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,GAAG,WAAW,CAAA;AAAA,IAC1G,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAM,SAAS,WAAA,KAAgB;AAC9D,MAAA,MAAM,EAAE,aAAA,GAAgB,uBAAA,EAAyB,eAAA,EAAiB,GAAG,aAAY,GAAI,OAAA;AACrF,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,YAAA,CAAa,MAAA,EAAQ,MAAM,IAAI,CAAA;AACpD,MAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,MAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,MAAA,OAAOC,2BAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU,CAAC,GAAG,QAAA,EAAU,yBAAyB,CAAA;AAAA;AAAA,UAEjD,OAAA,EAAS,OAAO,EAAE,SAAA,EAAW,QAAO,KAAM;AACxC,YAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,QAAA,CAAS,IAAA,EAAM,EAAE,aAAA,EAAe,SAAA,EAAW,MAAA,EAAQ,CAAQ,CAAA;AACzF,YAAA,aAAA,CAAc,MAAM,CAAA;AAGpB,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,UAChB,CAAA;AAAA,UACA,GAAG,WAAA;AAAA;AAAA;AAAA,UAGH;AAAA,SACF;AAAA,QACA;AAAA,OACF;AAAA,IACF,CAAA;AAAA,IACA,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAA,EAAM,SAAS,WAAA,KACnCC,sBAAA;AAAA,MACE;AAAA,QACE,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAI,CAAA;AAAA,QAC1B,UAAA,EAAY,OAAO,IAAA,KAAS;AAC1B,UAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,UAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,UAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,IAAqC,CAAA;AACnE,UAAA,aAAA,CAAc,MAAM,CAAA;AAKpB,UAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,UAAA,OAAO,IAAA;AAAA,QACT,CAAA;AAAA,QACA,GAAG;AAAA,OACL;AAAA,MACA;AAAA;AACF,GACJ;AACF;;"}
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  type DataTag,\n  type InfiniteData,\n  type QueryClient,\n  type QueryFunctionContext,\n  type SkipToken,\n  type UseInfiniteQueryOptions,\n  type UseInfiniteQueryResult,\n  type UseMutationOptions,\n  type UseMutationResult,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryOptions,\n  type UseSuspenseQueryResult,\n  useInfiniteQuery,\n  useMutation,\n  useQuery,\n  useSuspenseQuery,\n} from \"@tanstack/react-query\";\nimport type {\n  ClientMethod,\n  DefaultParamsOption,\n  Client as FetchClient,\n  FetchResponse,\n  MaybeOptionalInit,\n  PathOperation,\n} from \"openapi-typesafe-fetch\";\nimport type {\n  HttpMethod,\n  MediaType,\n  PathsWithMethod,\n  RequiredKeysOf,\n} from \"openapi-typesafe-helpers\";\n\n// Helper type to dynamically infer the type from the `select` property\ntype InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;\n\n/**\n * Query data of a response type: a success without a body is `undefined` in the fetch client and\n * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).\n */\ntype QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;\n\ntype InitWithUnknowns<Init> = Init & { [key: string]: unknown };\n\n/**\n * The arguments after the path: the init, required when the operation requires a parameter or a\n * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client\n * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when\n * their `extends` types are the same, so a hook type copied from openapi-react-query takes these\n * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,\n * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).\n */\ntype InitArguments<Init, Rest extends unknown[]> =\n  RequiredKeysOf<Init> extends never\n    ? [InitWithUnknowns<Init>?, ...Rest]\n    : [InitWithUnknowns<Init>, ...Rest];\n\nexport type QueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init = MaybeOptionalInit<Paths[Path], Method>,\n> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];\n\n/**\n * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different\n * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream\n * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime\n * named export next to the default export would change what `require()` returns.\n */\nconst INFINITE_QUERY_KEY_MARKER = \"infinite\";\n\nexport type InfiniteQueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];\n\nexport type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  path: Path,\n  ...[init, options]: InitArguments<Init, [Options?]>\n) => NoInfer<\n  Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryFn\" | \"queryKey\"\n  > & {\n    queryKey: DataTag<\n      QueryKey<Paths, Method, Path>,\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"]\n    >;\n    queryFn: Exclude<\n      UseQueryOptions<\n        QueryData<Response[\"data\"]>,\n        Response[\"error\"],\n        InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n        QueryKey<Paths, Method, Path>\n      >[\"queryFn\"],\n      SkipToken | undefined\n    >;\n  }\n>;\n\nexport type UseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseQueryResult<\n  InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\n/**\n * The type of the page params: the initial one and the ones `getNextPageParam` and\n * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a\n * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot\n * infer the return type of a callback that computes it from an unannotated `lastPageParam`,\n * whose type depends on that return type, and gives `never` or `unknown`.\n */\ntype PageParam<Initial, Next, Previous> =\n  IsUntyped<Next> extends true\n    ? unknown\n    : [Previous] extends [NoPreviousPageParam]\n      ? NullishToUnknown<Initial | NonNullable<Next>>\n      : IsUntyped<Previous> extends true\n        ? unknown\n        : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;\n\n/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */\ndeclare const NO_PREVIOUS_PAGE_PARAM: unique symbol;\ntype NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;\n\ntype IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;\n\n/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */\ntype NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;\n\n/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */\ntype PageParamFunction<Result> = (...args: never) => Result;\n\n/**\n * Inference sites of the page param types. Intersected before `Options`, so TanStack's own\n * inference in the implementation reads the full signatures of `Options`.\n */\ninterface PageParamSources<Initial, Next, Previous> {\n  initialPageParam: Initial;\n  getNextPageParam: PageParamFunction<Next>;\n  getPreviousPageParam?: PageParamFunction<Previous>;\n}\n\n/**\n * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types\n * a `(previousData) => previousData` callback while it still infers the page param, so it got\n * `unknown` there and failed against the typed page param.\n */\ntype InfinitePlaceholderData<\n  Data,\n  Error,\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = UseInfiniteQueryOptions<\n  Data,\n  Error,\n  InfiniteData<Data, unknown>,\n  InfiniteQueryKey<Paths, Method, Path>,\n  unknown\n>[\"placeholderData\"];\n\nexport type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseInfiniteQueryOptions<\n      Response[\"data\"],\n      Response[\"error\"],\n      InferSelectReturnType<\n        InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>,\n        Options[\"select\"]\n      >,\n      InfiniteQueryKey<Paths, Method, Path>,\n      PageParam<Initial, Next, Previous>\n    >,\n    \"queryKey\" | \"queryFn\" | \"placeholderData\"\n  > & {\n    placeholderData?: InfinitePlaceholderData<\n      Response[\"data\"],\n      Response[\"error\"],\n      Paths,\n      Method,\n      Path\n    >;\n    pageParamName?: string;\n  },\n  Initial = unknown,\n  Next = never,\n  Previous = NoPreviousPageParam,\n  // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)\n>(\n  method: Method,\n  url: Path,\n  init: InitWithUnknowns<Init>,\n  options: PageParamSources<Initial, Next, Previous> & Options,\n  queryClient?: QueryClient,\n) => UseInfiniteQueryResult<\n  InferSelectReturnType<\n    InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>,\n    Options[\"select\"]\n  >,\n  Response[\"error\"]\n>;\n\nexport type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseSuspenseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseSuspenseQueryResult<\n  InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\nexport type UseMutationMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  TOnMutateResult = unknown,\n>(\n  method: Method,\n  url: Path,\n  options?: Omit<\n    UseMutationOptions<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>,\n    \"mutationKey\" | \"mutationFn\"\n  >,\n  queryClient?: QueryClient,\n) => UseMutationResult<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>;\n\nexport interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaType> {\n  queryOptions: QueryOptionsFunction<Paths, Media>;\n  useQuery: UseQueryMethod<Paths, Media>;\n  useSuspenseQuery: UseSuspenseQueryMethod<Paths, Media>;\n  useInfiniteQuery: UseInfiniteQueryMethod<Paths, Media>;\n  useMutation: UseMutationMethod<Paths, Media>;\n}\n\nexport type MethodResponse<\n  // biome-ignore lint/suspicious/noExplicitAny: matches a client of any paths, as upstream's\n  CreatedClient extends OpenapiQueryClient<any, any>,\n  Method extends HttpMethod,\n  Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media>\n    ? PathsWithMethod<Paths, Method>\n    : never,\n  Options = object,\n> =\n  CreatedClient extends OpenapiQueryClient<\n    // biome-ignore lint/suspicious/noExplicitAny: unknown rejects the generated interfaces\n    infer Paths extends { [key: string]: any },\n    infer Media extends MediaType\n  >\n    ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>[\"data\"]>\n    : never;\n\n/**\n * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response\n * with an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as\n * `0`.\n */\nfunction throwIfFailed(result: { error?: unknown; response: Response }): void {\n  if (result.error !== undefined || !result.response.ok) {\n    throw result.error;\n  }\n}\n\n/** The query parameter that carries the page param unless `pageParamName` names another. */\nconst DEFAULT_PAGE_PARAM_NAME = \"cursor\";\n\ninterface PageRequest {\n  readonly pageParamName: string;\n  readonly pageParam: unknown;\n  readonly signal: AbortSignal;\n}\n\n/**\n * The request init of one page. An `undefined` page param (the first page with\n * `initialPageParam: undefined`) is left out instead of being sent as `0` (upstream #2715, #2340,\n * ADR-022), so a cursor API gets no cursor on the first page.\n */\nfunction pageInit(init: unknown, { pageParamName, pageParam, signal }: PageRequest) {\n  const { params, ...rest } = (init ?? {}) as { params?: { query?: DefaultParamsOption } };\n  const page = pageParam === undefined ? {} : { [pageParamName]: pageParam };\n  return { ...rest, signal, params: { ...params, query: { ...params?.query, ...page } } };\n}\n\n/**\n * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React\n * context is passed to each hook as its last argument; `createClient` does not take one.\n */\n// biome-ignore lint/complexity/noExcessiveLinesPerFunction: inherited, kept until 1.1 (ADR-036)\nexport default function createClient<Paths extends {}, Media extends MediaType = MediaType>(\n  client: FetchClient<Paths, Media>,\n): OpenapiQueryClient<Paths, Media> {\n  const queryFn = async <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>({\n    queryKey,\n    signal,\n  }: QueryFunctionContext<QueryKey<Paths, Method, Path>>) => {\n    // While `Path` is generic, TypeScript cannot work out that the key is a tuple: the init is a\n    // conditional type per operation (`MaybeOptionalInit`), and the key's type waits for it.\n    const [method, path, init] = queryKey as readonly [Method, Path, unknown?];\n    const mth = method.toUpperCase() as Uppercase<typeof method>;\n    const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n    // The init is `unknown` here. An `any` init lets the call infer the generic response type\n    // that `queryOptions` declares; a typed init makes TypeScript compare two unresolved\n    // conditional types, which it cannot do.\n    // biome-ignore lint/suspicious/noExplicitAny: see the comment above\n    const result = await fn(path, { signal, ...(init as any) });\n    throwIfFailed(result);\n    // TanStack Query rejects `undefined` query data. The fetch client gives `undefined` for every\n    // success without a body: a 204, `Content-Length: 0`, an empty chunked body, a HEAD request\n    // (upstream #2234). A parsed body is never `undefined`, so this changes nothing else.\n    return result.data ?? null;\n  };\n\n  const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({\n    queryKey: (init === undefined\n      ? ([method, path] as const)\n      : ([method, path, init] as const)) as DataTag<\n      QueryKey<Paths, typeof method, typeof path>,\n      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the data type\n      any,\n      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the error type\n      any\n    >,\n    queryFn,\n    ...options,\n  });\n\n  return {\n    queryOptions,\n    useQuery: (method, path, ...[init, options, queryClient]) =>\n      useQuery(\n        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),\n        queryClient,\n      ),\n    useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>\n      useSuspenseQuery(\n        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),\n        queryClient,\n      ),\n    // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)\n    useInfiniteQuery: (method, path, init, options, queryClient) => {\n      const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;\n      const { queryKey } = queryOptions(method, path, init);\n      const mth = method.toUpperCase() as Uppercase<typeof method>;\n      const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n      return useInfiniteQuery(\n        {\n          queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER] as const,\n          // The request comes from the arguments; the key only identifies the cache entry.\n          queryFn: async ({ pageParam, signal }) => {\n            const result = await fn(\n              path,\n              // biome-ignore lint/suspicious/noExplicitAny: a generic init; see queryFn\n              pageInit(init, { pageParamName, pageParam, signal }) as any,\n            );\n            throwIfFailed(result);\n            // An empty page stays `undefined`, as in upstream: TanStack Query rejects only\n            // `undefined` query data, and the infinite query data is the `{ pages }` object.\n            return result.data;\n          },\n          ...restOptions,\n          // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack\n          // passes the previous data of this query, with its own page params, and takes it back.\n          // biome-ignore lint/suspicious/noExplicitAny: TanStack's type carries its own page params\n          placeholderData: placeholderData as any,\n        },\n        queryClient,\n      );\n    },\n    useMutation: (method, path, options, queryClient) =>\n      useMutation(\n        {\n          mutationKey: [method, path],\n          mutationFn: async (init) => {\n            const mth = method.toUpperCase() as Uppercase<typeof method>;\n            const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n            const result = await fn(path, init as InitWithUnknowns<typeof init>);\n            throwIfFailed(result);\n            // TanStack Query accepts `undefined` mutation data, so a success without a body stays\n            // `undefined`, as in upstream; only query data needs `null` (upstream #2234). The cast\n            // only bridges the generic types: `Response[\"data\"]` still has `undefined` for an\n            // operation with a response without a body.\n            const { data } = result;\n            return data as Exclude<typeof data, undefined>;\n          },\n          ...options,\n        },\n        queryClient,\n      ),\n  };\n}\n"],"names":["useQuery","useSuspenseQuery","useInfiniteQuery","useMutation"],"mappings":";;;;AAuEA,MAAM,yBAAA,GAA4B,UAAA;AA2PlC,SAAS,cAAc,MAAA,EAAuD;AAC5E,EAAA,IAAI,OAAO,KAAA,KAAU,MAAA,IAAa,CAAC,MAAA,CAAO,SAAS,EAAA,EAAI;AACrD,IAAA,MAAM,MAAA,CAAO,KAAA;AAAA,EACf;AACF;AAGA,MAAM,uBAAA,GAA0B,QAAA;AAahC,SAAS,SAAS,IAAA,EAAe,EAAE,aAAA,EAAe,SAAA,EAAW,QAAO,EAAgB;AAClF,EAAA,MAAM,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,GAAK,QAAQ,EAAC;AACtC,EAAA,MAAM,IAAA,GAAO,cAAc,MAAA,GAAY,KAAK,EAAE,CAAC,aAAa,GAAG,SAAA,EAAU;AACzE,EAAA,OAAO,EAAE,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,GAAG,IAAA,IAAO,EAAE;AACxF;AAOA,SAAwB,aACtB,MAAA,EACkC;AAClC,EAAA,MAAM,UAAU,OAA+E;AAAA,IAC7F,QAAA;AAAA,IACA;AAAA,GACF,KAA2D;AAGzD,IAAA,MAAM,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA,GAAI,QAAA;AAC7B,IAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,IAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AAKrB,IAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,EAAE,MAAA,EAAQ,GAAI,MAAc,CAAA;AAC1D,IAAA,aAAA,CAAc,MAAM,CAAA;AAIpB,IAAA,OAAO,OAAO,IAAA,IAAQ,IAAA;AAAA,EACxB,CAAA;AAEA,EAAA,MAAM,eAAmD,CAAC,MAAA,EAAQ,SAAS,CAAC,IAAA,EAAM,OAAO,CAAA,MAAO;AAAA,IAC9F,QAAA,EAAW,IAAA,KAAS,MAAA,GACf,CAAC,MAAA,EAAQ,IAAI,CAAA,GACb,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA;AAAA,IAOxB,OAAA;AAAA,IACA,GAAG;AAAA,GACL,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,YAAA;AAAA,IACA,QAAA,EAAU,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,IAAA,EAAM,OAAA,EAAS,WAAW,CAAA,KACrDA,mBAAA;AAAA,MACE,YAAA,CAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,CAAA;AAAA,MACzE;AAAA,KACF;AAAA,IACF,gBAAA,EAAkB,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,IAAA,EAAM,OAAA,EAAS,WAAW,CAAA,KAC7DC,2BAAA;AAAA,MACE,YAAA,CAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,CAAA;AAAA,MACzE;AAAA,KACF;AAAA;AAAA,IAEF,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAM,SAAS,WAAA,KAAgB;AAC9D,MAAA,MAAM,EAAE,aAAA,GAAgB,uBAAA,EAAyB,eAAA,EAAiB,GAAG,aAAY,GAAI,OAAA;AACrF,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,YAAA,CAAa,MAAA,EAAQ,MAAM,IAAI,CAAA;AACpD,MAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,MAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,MAAA,OAAOC,2BAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU,CAAC,GAAG,QAAA,EAAU,yBAAyB,CAAA;AAAA;AAAA,UAEjD,OAAA,EAAS,OAAO,EAAE,SAAA,EAAW,QAAO,KAAM;AACxC,YAAA,MAAM,SAAS,MAAM,EAAA;AAAA,cACnB,IAAA;AAAA;AAAA,cAEA,SAAS,IAAA,EAAM,EAAE,aAAA,EAAe,SAAA,EAAW,QAAQ;AAAA,aACrD;AACA,YAAA,aAAA,CAAc,MAAM,CAAA;AAGpB,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,UAChB,CAAA;AAAA,UACA,GAAG,WAAA;AAAA;AAAA;AAAA;AAAA,UAIH;AAAA,SACF;AAAA,QACA;AAAA,OACF;AAAA,IACF,CAAA;AAAA,IACA,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAA,EAAM,SAAS,WAAA,KACnCC,sBAAA;AAAA,MACE;AAAA,QACE,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAI,CAAA;AAAA,QAC1B,UAAA,EAAY,OAAO,IAAA,KAAS;AAC1B,UAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,UAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,UAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,IAAqC,CAAA;AACnE,UAAA,aAAA,CAAc,MAAM,CAAA;AAKpB,UAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,UAAA,OAAO,IAAA;AAAA,QACT,CAAA;AAAA,QACA,GAAG;AAAA,OACL;AAAA,MACA;AAAA;AACF,GACJ;AACF;;"}

package/dist/index.d.cts

@@ -1,14 +1,32 @@
 import { UseQueryOptions, DataTag, SkipToken, QueryClient, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseInfiniteQueryOptions, InfiniteData, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import { MaybeOptionalInit, FetchResponse, PathOperation, IsInitOptional, Client } from 'openapi-typesafe-fetch';
-import { HttpMethod, PathsWithMethod, MediaType } from 'openapi-typesafe-helpers';
+import { MaybeOptionalInit, FetchResponse, PathOperation, Client } from 'openapi-typesafe-fetch';
+import { HttpMethod, PathsWithMethod, MediaType, RequiredKeysOf } from 'openapi-typesafe-helpers';
 
 type InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;
+/**
+ * Query data of a response type: a success without a body is `undefined` in the fetch client and
+ * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).
+ */
 type QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;
 type InitWithUnknowns<Init> = Init & {
     [key: string]: unknown;
 };
-type InitArguments<Init, Rest extends unknown[]> = IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
+/**
+ * The arguments after the path: the init, required when the operation requires a parameter or a
+ * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client
+ * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when
+ * their `extends` types are the same, so a hook type copied from openapi-react-query takes these
+ * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,
+ * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).
+ */
+type InitArguments<Init, Rest extends unknown[]> = RequiredKeysOf<Init> extends never ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
 type QueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init = MaybeOptionalInit<Paths[Path], Method>> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];
+/**
+ * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different
+ * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream
+ * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime
+ * named export next to the default export would change what `require()` returns.
+ */
 declare const INFINITE_QUERY_KEY_MARKER = "infinite";
 type InfiniteQueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];
 type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, path: Path, ...[init, options]: InitArguments<Init, [Options?]>) => NoInfer<Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryFn" | "queryKey"> & {
@@ -16,17 +34,36 @@ type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method e
     queryFn: Exclude<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>["queryFn"], SkipToken | undefined>;
 }>;
 type UseQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, url: Path, ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>) => UseQueryResult<InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, Response["error"]>;
+/**
+ * The type of the page params: the initial one and the ones `getNextPageParam` and
+ * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a
+ * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot
+ * infer the return type of a callback that computes it from an unannotated `lastPageParam`,
+ * whose type depends on that return type, and gives `never` or `unknown`.
+ */
 type PageParam<Initial, Next, Previous> = IsUntyped<Next> extends true ? unknown : [Previous] extends [NoPreviousPageParam] ? NullishToUnknown<Initial | NonNullable<Next>> : IsUntyped<Previous> extends true ? unknown : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;
+/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */
 declare const NO_PREVIOUS_PAGE_PARAM: unique symbol;
 type NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;
 type IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;
+/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */
 type NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;
+/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */
 type PageParamFunction<Result> = (...args: never) => Result;
+/**
+ * Inference sites of the page param types. Intersected before `Options`, so TanStack's own
+ * inference in the implementation reads the full signatures of `Options`.
+ */
 interface PageParamSources<Initial, Next, Previous> {
     initialPageParam: Initial;
     getNextPageParam: PageParamFunction<Next>;
     getPreviousPageParam?: PageParamFunction<Previous>;
 }
+/**
+ * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types
+ * a `(previousData) => previousData` callback while it still infers the page param, so it got
+ * `unknown` there and failed against the typed page param.
+ */
 type InfinitePlaceholderData<Data, Error, Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = UseInfiniteQueryOptions<Data, Error, InfiniteData<Data, unknown>, InfiniteQueryKey<Paths, Method, Path>, unknown>["placeholderData"];
 type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseInfiniteQueryOptions<Response["data"], Response["error"], InferSelectReturnType<InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>, Options["select"]>, InfiniteQueryKey<Paths, Method, Path>, PageParam<Initial, Next, Previous>>, "queryKey" | "queryFn" | "placeholderData"> & {
     placeholderData?: InfinitePlaceholderData<Response["data"], Response["error"], Paths, Method, Path>;
@@ -44,6 +81,10 @@ interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaTy
 type MethodResponse<CreatedClient extends OpenapiQueryClient<any, any>, Method extends HttpMethod, Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media> ? PathsWithMethod<Paths, Method> : never, Options = object> = CreatedClient extends OpenapiQueryClient<infer Paths extends {
     [key: string]: any;
 }, infer Media extends MediaType> ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]> : never;
+/**
+ * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React
+ * context is passed to each hook as its last argument; `createClient` does not take one.
+ */
 declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>): OpenapiQueryClient<Paths, Media>;
 
 declare namespace createClient {

package/dist/index.d.mts

@@ -1,14 +1,32 @@
 import { UseQueryOptions, DataTag, SkipToken, QueryClient, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseInfiniteQueryOptions, InfiniteData, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import { MaybeOptionalInit, FetchResponse, PathOperation, IsInitOptional, Client } from 'openapi-typesafe-fetch';
-import { HttpMethod, PathsWithMethod, MediaType } from 'openapi-typesafe-helpers';
+import { MaybeOptionalInit, FetchResponse, PathOperation, Client } from 'openapi-typesafe-fetch';
+import { HttpMethod, PathsWithMethod, MediaType, RequiredKeysOf } from 'openapi-typesafe-helpers';
 
 type InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;
+/**
+ * Query data of a response type: a success without a body is `undefined` in the fetch client and
+ * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).
+ */
 type QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;
 type InitWithUnknowns<Init> = Init & {
     [key: string]: unknown;
 };
-type InitArguments<Init, Rest extends unknown[]> = IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
+/**
+ * The arguments after the path: the init, required when the operation requires a parameter or a
+ * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client
+ * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when
+ * their `extends` types are the same, so a hook type copied from openapi-react-query takes these
+ * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,
+ * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).
+ */
+type InitArguments<Init, Rest extends unknown[]> = RequiredKeysOf<Init> extends never ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
 type QueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init = MaybeOptionalInit<Paths[Path], Method>> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];
+/**
+ * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different
+ * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream
+ * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime
+ * named export next to the default export would change what `require()` returns.
+ */
 declare const INFINITE_QUERY_KEY_MARKER = "infinite";
 type InfiniteQueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];
 type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, path: Path, ...[init, options]: InitArguments<Init, [Options?]>) => NoInfer<Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryFn" | "queryKey"> & {
@@ -16,17 +34,36 @@ type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method e
     queryFn: Exclude<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>["queryFn"], SkipToken | undefined>;
 }>;
 type UseQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, url: Path, ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>) => UseQueryResult<InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, Response["error"]>;
+/**
+ * The type of the page params: the initial one and the ones `getNextPageParam` and
+ * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a
+ * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot
+ * infer the return type of a callback that computes it from an unannotated `lastPageParam`,
+ * whose type depends on that return type, and gives `never` or `unknown`.
+ */
 type PageParam<Initial, Next, Previous> = IsUntyped<Next> extends true ? unknown : [Previous] extends [NoPreviousPageParam] ? NullishToUnknown<Initial | NonNullable<Next>> : IsUntyped<Previous> extends true ? unknown : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;
+/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */
 declare const NO_PREVIOUS_PAGE_PARAM: unique symbol;
 type NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;
 type IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;
+/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */
 type NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;
+/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */
 type PageParamFunction<Result> = (...args: never) => Result;
+/**
+ * Inference sites of the page param types. Intersected before `Options`, so TanStack's own
+ * inference in the implementation reads the full signatures of `Options`.
+ */
 interface PageParamSources<Initial, Next, Previous> {
     initialPageParam: Initial;
     getNextPageParam: PageParamFunction<Next>;
     getPreviousPageParam?: PageParamFunction<Previous>;
 }
+/**
+ * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types
+ * a `(previousData) => previousData` callback while it still infers the page param, so it got
+ * `unknown` there and failed against the typed page param.
+ */
 type InfinitePlaceholderData<Data, Error, Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = UseInfiniteQueryOptions<Data, Error, InfiniteData<Data, unknown>, InfiniteQueryKey<Paths, Method, Path>, unknown>["placeholderData"];
 type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseInfiniteQueryOptions<Response["data"], Response["error"], InferSelectReturnType<InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>, Options["select"]>, InfiniteQueryKey<Paths, Method, Path>, PageParam<Initial, Next, Previous>>, "queryKey" | "queryFn" | "placeholderData"> & {
     placeholderData?: InfinitePlaceholderData<Response["data"], Response["error"], Paths, Method, Path>;
@@ -44,6 +81,10 @@ interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaTy
 type MethodResponse<CreatedClient extends OpenapiQueryClient<any, any>, Method extends HttpMethod, Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media> ? PathsWithMethod<Paths, Method> : never, Options = object> = CreatedClient extends OpenapiQueryClient<infer Paths extends {
     [key: string]: any;
 }, infer Media extends MediaType> ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]> : never;
+/**
+ * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React
+ * context is passed to each hook as its last argument; `createClient` does not take one.
+ */
 declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>): OpenapiQueryClient<Paths, Media>;
 
 export { createClient as default };

package/dist/index.d.ts

@@ -1,14 +1,32 @@
 import { UseQueryOptions, DataTag, SkipToken, QueryClient, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseInfiniteQueryOptions, InfiniteData, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import { MaybeOptionalInit, FetchResponse, PathOperation, IsInitOptional, Client } from 'openapi-typesafe-fetch';
-import { HttpMethod, PathsWithMethod, MediaType } from 'openapi-typesafe-helpers';
+import { MaybeOptionalInit, FetchResponse, PathOperation, Client } from 'openapi-typesafe-fetch';
+import { HttpMethod, PathsWithMethod, MediaType, RequiredKeysOf } from 'openapi-typesafe-helpers';
 
 type InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;
+/**
+ * Query data of a response type: a success without a body is `undefined` in the fetch client and
+ * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).
+ */
 type QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;
 type InitWithUnknowns<Init> = Init & {
     [key: string]: unknown;
 };
-type InitArguments<Init, Rest extends unknown[]> = IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
+/**
+ * The arguments after the path: the init, required when the operation requires a parameter or a
+ * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client
+ * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when
+ * their `extends` types are the same, so a hook type copied from openapi-react-query takes these
+ * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,
+ * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).
+ */
+type InitArguments<Init, Rest extends unknown[]> = RequiredKeysOf<Init> extends never ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
 type QueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init = MaybeOptionalInit<Paths[Path], Method>> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];
+/**
+ * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different
+ * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream
+ * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime
+ * named export next to the default export would change what `require()` returns.
+ */
 declare const INFINITE_QUERY_KEY_MARKER = "infinite";
 type InfiniteQueryKey<Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];
 type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, path: Path, ...[init, options]: InitArguments<Init, [Options?]>) => NoInfer<Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryFn" | "queryKey"> & {
@@ -16,17 +34,36 @@ type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <Method e
     queryFn: Exclude<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>["queryFn"], SkipToken | undefined>;
 }>;
 type UseQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseQueryOptions<QueryData<Response["data"]>, Response["error"], InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, QueryKey<Paths, Method, Path>>, "queryKey" | "queryFn">>(method: Method, url: Path, ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>) => UseQueryResult<InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, Response["error"]>;
+/**
+ * The type of the page params: the initial one and the ones `getNextPageParam` and
+ * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a
+ * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot
+ * infer the return type of a callback that computes it from an unannotated `lastPageParam`,
+ * whose type depends on that return type, and gives `never` or `unknown`.
+ */
 type PageParam<Initial, Next, Previous> = IsUntyped<Next> extends true ? unknown : [Previous] extends [NoPreviousPageParam] ? NullishToUnknown<Initial | NonNullable<Next>> : IsUntyped<Previous> extends true ? unknown : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;
+/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */
 declare const NO_PREVIOUS_PAGE_PARAM: unique symbol;
 type NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;
 type IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;
+/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */
 type NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;
+/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */
 type PageParamFunction<Result> = (...args: never) => Result;
+/**
+ * Inference sites of the page param types. Intersected before `Options`, so TanStack's own
+ * inference in the implementation reads the full signatures of `Options`.
+ */
 interface PageParamSources<Initial, Next, Previous> {
     initialPageParam: Initial;
     getNextPageParam: PageParamFunction<Next>;
     getPreviousPageParam?: PageParamFunction<Previous>;
 }
+/**
+ * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types
+ * a `(previousData) => previousData` callback while it still infers the page param, so it got
+ * `unknown` there and failed against the typed page param.
+ */
 type InfinitePlaceholderData<Data, Error, Paths extends {}, Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>> = UseInfiniteQueryOptions<Data, Error, InfiniteData<Data, unknown>, InfiniteQueryKey<Paths, Method, Path>, unknown>["placeholderData"];
 type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, Options extends Omit<UseInfiniteQueryOptions<Response["data"], Response["error"], InferSelectReturnType<InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>, Options["select"]>, InfiniteQueryKey<Paths, Method, Path>, PageParam<Initial, Next, Previous>>, "queryKey" | "queryFn" | "placeholderData"> & {
     placeholderData?: InfinitePlaceholderData<Response["data"], Response["error"], Paths, Method, Path>;
@@ -44,6 +81,10 @@ interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaTy
 type MethodResponse<CreatedClient extends OpenapiQueryClient<any, any>, Method extends HttpMethod, Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media> ? PathsWithMethod<Paths, Method> : never, Options = object> = CreatedClient extends OpenapiQueryClient<infer Paths extends {
     [key: string]: any;
 }, infer Media extends MediaType> ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]> : never;
+/**
+ * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React
+ * context is passed to each hook as its last argument; `createClient` does not take one.
+ */
 declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>): OpenapiQueryClient<Paths, Media>;
 
 export { createClient as default };

package/dist/index.mjs

@@ -31,8 +31,15 @@ function createClient(client) {
   });
   return {
     queryOptions,
-    useQuery: (method, path, ...[init, options, queryClient]) => useQuery(queryOptions(method, path, init, options), queryClient),
-    useSuspenseQuery: (method, path, ...[init, options, queryClient]) => useSuspenseQuery(queryOptions(method, path, init, options), queryClient),
+    useQuery: (method, path, ...[init, options, queryClient]) => useQuery(
+      queryOptions(method, path, init, options),
+      queryClient
+    ),
+    useSuspenseQuery: (method, path, ...[init, options, queryClient]) => useSuspenseQuery(
+      queryOptions(method, path, init, options),
+      queryClient
+    ),
+    // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)
     useInfiniteQuery: (method, path, init, options, queryClient) => {
       const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;
       const { queryKey } = queryOptions(method, path, init);
@@ -43,13 +50,18 @@ function createClient(client) {
           queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER],
           // The request comes from the arguments; the key only identifies the cache entry.
           queryFn: async ({ pageParam, signal }) => {
-            const result = await fn(path, pageInit(init, { pageParamName, pageParam, signal }));
+            const result = await fn(
+              path,
+              // biome-ignore lint/suspicious/noExplicitAny: a generic init; see queryFn
+              pageInit(init, { pageParamName, pageParam, signal })
+            );
             throwIfFailed(result);
             return result.data;
           },
           ...restOptions,
           // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack
           // passes the previous data of this query, with its own page params, and takes it back.
+          // biome-ignore lint/suspicious/noExplicitAny: TanStack's type carries its own page params
           placeholderData
         },
         queryClient

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  type DataTag,\n  type InfiniteData,\n  type QueryClient,\n  type QueryFunctionContext,\n  type SkipToken,\n  type UseInfiniteQueryOptions,\n  type UseInfiniteQueryResult,\n  type UseMutationOptions,\n  type UseMutationResult,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryOptions,\n  type UseSuspenseQueryResult,\n  useInfiniteQuery,\n  useMutation,\n  useQuery,\n  useSuspenseQuery,\n} from \"@tanstack/react-query\";\nimport type {\n  ClientMethod,\n  DefaultParamsOption,\n  Client as FetchClient,\n  FetchResponse,\n  IsInitOptional,\n  MaybeOptionalInit,\n  PathOperation,\n} from \"openapi-typesafe-fetch\";\nimport type { HttpMethod, MediaType, PathsWithMethod } from \"openapi-typesafe-helpers\";\n\n// Helper type to dynamically infer the type from the `select` property\ntype InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;\n\n/**\n * Query data of a response type: a success without a body is `undefined` in the fetch client and\n * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).\n */\ntype QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;\n\ntype InitWithUnknowns<Init> = Init & { [key: string]: unknown };\n\n/**\n * The arguments after the path: the init, required when the operation requires a parameter or a\n * body, then `Rest`. `IsInitOptional` keeps the init optional in\n * `Parameters<typeof $api.queryOptions>`, where it is the union of all inits (upstream #2178).\n */\ntype InitArguments<Init, Rest extends unknown[]> =\n  IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];\n\nexport type QueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init = MaybeOptionalInit<Paths[Path], Method>,\n> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];\n\n/**\n * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different\n * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream\n * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime\n * named export next to the default export would change what `require()` returns.\n */\nconst INFINITE_QUERY_KEY_MARKER = \"infinite\";\n\nexport type InfiniteQueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];\n\nexport type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  path: Path,\n  ...[init, options]: InitArguments<Init, [Options?]>\n) => NoInfer<\n  Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryFn\" | \"queryKey\"\n  > & {\n    queryKey: DataTag<QueryKey<Paths, Method, Path>, QueryData<Response[\"data\"]>, Response[\"error\"]>;\n    queryFn: Exclude<\n      UseQueryOptions<\n        QueryData<Response[\"data\"]>,\n        Response[\"error\"],\n        InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n        QueryKey<Paths, Method, Path>\n      >[\"queryFn\"],\n      SkipToken | undefined\n    >;\n  }\n>;\n\nexport type UseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseQueryResult<InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>, Response[\"error\"]>;\n\n/**\n * The type of the page params: the initial one and the ones `getNextPageParam` and\n * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a\n * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot\n * infer the return type of a callback that computes it from an unannotated `lastPageParam`,\n * whose type depends on that return type, and gives `never` or `unknown`.\n */\ntype PageParam<Initial, Next, Previous> =\n  IsUntyped<Next> extends true\n    ? unknown\n    : [Previous] extends [NoPreviousPageParam]\n      ? NullishToUnknown<Initial | NonNullable<Next>>\n      : IsUntyped<Previous> extends true\n        ? unknown\n        : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;\n\n/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */\ndeclare const NO_PREVIOUS_PAGE_PARAM: unique symbol;\ntype NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;\n\ntype IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;\n\n/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */\ntype NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;\n\n/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */\ntype PageParamFunction<Result> = (...args: never) => Result;\n\n/**\n * Inference sites of the page param types. Intersected before `Options`, so TanStack's own\n * inference in the implementation reads the full signatures of `Options`.\n */\ninterface PageParamSources<Initial, Next, Previous> {\n  initialPageParam: Initial;\n  getNextPageParam: PageParamFunction<Next>;\n  getPreviousPageParam?: PageParamFunction<Previous>;\n}\n\n/**\n * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types\n * a `(previousData) => previousData` callback while it still infers the page param, so it got\n * `unknown` there and failed against the typed page param.\n */\ntype InfinitePlaceholderData<\n  Data,\n  Error,\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = UseInfiniteQueryOptions<\n  Data,\n  Error,\n  InfiniteData<Data, unknown>,\n  InfiniteQueryKey<Paths, Method, Path>,\n  unknown\n>[\"placeholderData\"];\n\nexport type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseInfiniteQueryOptions<\n      Response[\"data\"],\n      Response[\"error\"],\n      InferSelectReturnType<InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>, Options[\"select\"]>,\n      InfiniteQueryKey<Paths, Method, Path>,\n      PageParam<Initial, Next, Previous>\n    >,\n    \"queryKey\" | \"queryFn\" | \"placeholderData\"\n  > & {\n    placeholderData?: InfinitePlaceholderData<Response[\"data\"], Response[\"error\"], Paths, Method, Path>;\n    pageParamName?: string;\n  },\n  Initial = unknown,\n  Next = never,\n  Previous = NoPreviousPageParam,\n>(\n  method: Method,\n  url: Path,\n  init: InitWithUnknowns<Init>,\n  options: PageParamSources<Initial, Next, Previous> & Options,\n  queryClient?: QueryClient,\n) => UseInfiniteQueryResult<\n  InferSelectReturnType<InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\nexport type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Options extends Omit<\n    UseSuspenseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseSuspenseQueryResult<InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>, Response[\"error\"]>;\n\nexport type UseMutationMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types\n  TOnMutateResult = unknown,\n>(\n  method: Method,\n  url: Path,\n  options?: Omit<\n    UseMutationOptions<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>,\n    \"mutationKey\" | \"mutationFn\"\n  >,\n  queryClient?: QueryClient,\n) => UseMutationResult<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>;\n\nexport interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaType> {\n  queryOptions: QueryOptionsFunction<Paths, Media>;\n  useQuery: UseQueryMethod<Paths, Media>;\n  useSuspenseQuery: UseSuspenseQueryMethod<Paths, Media>;\n  useInfiniteQuery: UseInfiniteQueryMethod<Paths, Media>;\n  useMutation: UseMutationMethod<Paths, Media>;\n}\n\nexport type MethodResponse<\n  CreatedClient extends OpenapiQueryClient<any, any>,\n  Method extends HttpMethod,\n  Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media>\n    ? PathsWithMethod<Paths, Method>\n    : never,\n  Options = object,\n> =\n  CreatedClient extends OpenapiQueryClient<infer Paths extends { [key: string]: any }, infer Media extends MediaType>\n    ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>[\"data\"]>\n    : never;\n\n/**\n * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response with\n * an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as `0`.\n */\nfunction throwIfFailed(result: { error?: unknown; response: Response }): void {\n  if (result.error !== undefined || !result.response.ok) {\n    throw result.error;\n  }\n}\n\n/** The query parameter that carries the page param unless `pageParamName` names another. */\nconst DEFAULT_PAGE_PARAM_NAME = \"cursor\";\n\ninterface PageRequest {\n  readonly pageParamName: string;\n  readonly pageParam: unknown;\n  readonly signal: AbortSignal;\n}\n\n/**\n * The request init of one page. An `undefined` page param (the first page with\n * `initialPageParam: undefined`) is left out instead of being sent as `0` (upstream #2715, #2340,\n * ADR-022), so a cursor API gets no cursor on the first page.\n */\nfunction pageInit(init: unknown, { pageParamName, pageParam, signal }: PageRequest) {\n  const { params, ...rest } = (init ?? {}) as { params?: { query?: DefaultParamsOption } };\n  const page = pageParam === undefined ? {} : { [pageParamName]: pageParam };\n  return { ...rest, signal, params: { ...params, query: { ...params?.query, ...page } } };\n}\n\n// TODO: Add the ability to bring queryClient as argument\nexport default function createClient<Paths extends {}, Media extends MediaType = MediaType>(\n  client: FetchClient<Paths, Media>,\n): OpenapiQueryClient<Paths, Media> {\n  const queryFn = async <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>({\n    queryKey,\n    signal,\n  }: QueryFunctionContext<QueryKey<Paths, Method, Path>>) => {\n    // While `Path` is generic, TypeScript cannot work out that the key is a tuple: the init is a\n    // conditional type per operation (`MaybeOptionalInit`), and the key's type waits for it.\n    const [method, path, init] = queryKey as readonly [Method, Path, unknown?];\n    const mth = method.toUpperCase() as Uppercase<typeof method>;\n    const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n    const result = await fn(path, { signal, ...(init as any) }); // TODO: find a way to avoid as any\n    throwIfFailed(result);\n    // TanStack Query rejects `undefined` query data. The fetch client gives `undefined` for every\n    // success without a body: a 204, `Content-Length: 0`, an empty chunked body, a HEAD request\n    // (upstream #2234). A parsed body is never `undefined`, so this changes nothing else.\n    return result.data ?? null;\n  };\n\n  const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({\n    queryKey: (init === undefined ? ([method, path] as const) : ([method, path, init] as const)) as DataTag<\n      QueryKey<Paths, typeof method, typeof path>,\n      any,\n      any\n    >,\n    queryFn,\n    ...options,\n  });\n\n  return {\n    queryOptions,\n    useQuery: (method, path, ...[init, options, queryClient]) =>\n      useQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),\n    useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>\n      useSuspenseQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),\n    useInfiniteQuery: (method, path, init, options, queryClient) => {\n      const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;\n      const { queryKey } = queryOptions(method, path, init);\n      const mth = method.toUpperCase() as Uppercase<typeof method>;\n      const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n      return useInfiniteQuery(\n        {\n          queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER] as const,\n          // The request comes from the arguments; the key only identifies the cache entry.\n          queryFn: async ({ pageParam, signal }) => {\n            const result = await fn(path, pageInit(init, { pageParamName, pageParam, signal }) as any);\n            throwIfFailed(result);\n            // An empty page stays `undefined`, as in upstream: TanStack Query rejects only\n            // `undefined` query data, and the infinite query data is the `{ pages }` object.\n            return result.data;\n          },\n          ...restOptions,\n          // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack\n          // passes the previous data of this query, with its own page params, and takes it back.\n          placeholderData: placeholderData as any,\n        },\n        queryClient,\n      );\n    },\n    useMutation: (method, path, options, queryClient) =>\n      useMutation(\n        {\n          mutationKey: [method, path],\n          mutationFn: async (init) => {\n            const mth = method.toUpperCase() as Uppercase<typeof method>;\n            const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n            const result = await fn(path, init as InitWithUnknowns<typeof init>);\n            throwIfFailed(result);\n            // TanStack Query accepts `undefined` mutation data, so a success without a body stays\n            // `undefined`, as in upstream; only query data needs `null` (upstream #2234). The cast\n            // only bridges the generic types: `Response[\"data\"]` still has `undefined` for an\n            // operation with a response without a body.\n            const { data } = result;\n            return data as Exclude<typeof data, undefined>;\n          },\n          ...options,\n        },\n        queryClient,\n      ),\n  };\n}\n"],"names":[],"mappings":";;AA8DA,MAAM,yBAAA,GAA4B,UAAA;AA0NlC,SAAS,cAAc,MAAA,EAAuD;AAC5E,EAAA,IAAI,OAAO,KAAA,KAAU,MAAA,IAAa,CAAC,MAAA,CAAO,SAAS,EAAA,EAAI;AACrD,IAAA,MAAM,MAAA,CAAO,KAAA;AAAA,EACf;AACF;AAGA,MAAM,uBAAA,GAA0B,QAAA;AAahC,SAAS,SAAS,IAAA,EAAe,EAAE,aAAA,EAAe,SAAA,EAAW,QAAO,EAAgB;AAClF,EAAA,MAAM,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,GAAK,QAAQ,EAAC;AACtC,EAAA,MAAM,IAAA,GAAO,cAAc,MAAA,GAAY,KAAK,EAAE,CAAC,aAAa,GAAG,SAAA,EAAU;AACzE,EAAA,OAAO,EAAE,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,GAAG,IAAA,IAAO,EAAE;AACxF;AAGA,SAAwB,aACtB,MAAA,EACkC;AAClC,EAAA,MAAM,UAAU,OAA+E;AAAA,IAC7F,QAAA;AAAA,IACA;AAAA,GACF,KAA2D;AAGzD,IAAA,MAAM,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA,GAAI,QAAA;AAC7B,IAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,IAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,IAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,EAAE,MAAA,EAAQ,GAAI,MAAc,CAAA;AAC1D,IAAA,aAAA,CAAc,MAAM,CAAA;AAIpB,IAAA,OAAO,OAAO,IAAA,IAAQ,IAAA;AAAA,EACxB,CAAA;AAEA,EAAA,MAAM,eAAmD,CAAC,MAAA,EAAQ,SAAS,CAAC,IAAA,EAAM,OAAO,CAAA,MAAO;AAAA,IAC9F,QAAA,EAAW,IAAA,KAAS,MAAA,GAAa,CAAC,MAAA,EAAQ,IAAI,CAAA,GAAe,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA;AAAA,IAKhF,OAAA;AAAA,IACA,GAAG;AAAA,GACL,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,YAAA;AAAA,IACA,UAAU,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,MAAM,OAAA,EAAS,WAAW,CAAA,KACrD,QAAA,CAAS,aAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,GAAG,WAAW,CAAA;AAAA,IAClG,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,MAAM,OAAA,EAAS,WAAW,CAAA,KAC7D,gBAAA,CAAiB,aAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,GAAG,WAAW,CAAA;AAAA,IAC1G,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAM,SAAS,WAAA,KAAgB;AAC9D,MAAA,MAAM,EAAE,aAAA,GAAgB,uBAAA,EAAyB,eAAA,EAAiB,GAAG,aAAY,GAAI,OAAA;AACrF,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,YAAA,CAAa,MAAA,EAAQ,MAAM,IAAI,CAAA;AACpD,MAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,MAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,MAAA,OAAO,gBAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU,CAAC,GAAG,QAAA,EAAU,yBAAyB,CAAA;AAAA;AAAA,UAEjD,OAAA,EAAS,OAAO,EAAE,SAAA,EAAW,QAAO,KAAM;AACxC,YAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,QAAA,CAAS,IAAA,EAAM,EAAE,aAAA,EAAe,SAAA,EAAW,MAAA,EAAQ,CAAQ,CAAA;AACzF,YAAA,aAAA,CAAc,MAAM,CAAA;AAGpB,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,UAChB,CAAA;AAAA,UACA,GAAG,WAAA;AAAA;AAAA;AAAA,UAGH;AAAA,SACF;AAAA,QACA;AAAA,OACF;AAAA,IACF,CAAA;AAAA,IACA,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAA,EAAM,SAAS,WAAA,KACnC,WAAA;AAAA,MACE;AAAA,QACE,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAI,CAAA;AAAA,QAC1B,UAAA,EAAY,OAAO,IAAA,KAAS;AAC1B,UAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,UAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,UAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,IAAqC,CAAA;AACnE,UAAA,aAAA,CAAc,MAAM,CAAA;AAKpB,UAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,UAAA,OAAO,IAAA;AAAA,QACT,CAAA;AAAA,QACA,GAAG;AAAA,OACL;AAAA,MACA;AAAA;AACF,GACJ;AACF;;"}
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  type DataTag,\n  type InfiniteData,\n  type QueryClient,\n  type QueryFunctionContext,\n  type SkipToken,\n  type UseInfiniteQueryOptions,\n  type UseInfiniteQueryResult,\n  type UseMutationOptions,\n  type UseMutationResult,\n  type UseQueryOptions,\n  type UseQueryResult,\n  type UseSuspenseQueryOptions,\n  type UseSuspenseQueryResult,\n  useInfiniteQuery,\n  useMutation,\n  useQuery,\n  useSuspenseQuery,\n} from \"@tanstack/react-query\";\nimport type {\n  ClientMethod,\n  DefaultParamsOption,\n  Client as FetchClient,\n  FetchResponse,\n  MaybeOptionalInit,\n  PathOperation,\n} from \"openapi-typesafe-fetch\";\nimport type {\n  HttpMethod,\n  MediaType,\n  PathsWithMethod,\n  RequiredKeysOf,\n} from \"openapi-typesafe-helpers\";\n\n// Helper type to dynamically infer the type from the `select` property\ntype InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;\n\n/**\n * Query data of a response type: a success without a body is `undefined` in the fetch client and\n * `null` in the query, as `queryFn` resolves it (upstream #2234, #2464).\n */\ntype QueryData<Data> = undefined extends Data ? Exclude<Data, undefined> | null : Data;\n\ntype InitWithUnknowns<Init> = Init & { [key: string]: unknown };\n\n/**\n * The arguments after the path: the init, required when the operation requires a parameter or a\n * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client\n * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when\n * their `extends` types are the same, so a hook type copied from openapi-react-query takes these\n * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,\n * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).\n */\ntype InitArguments<Init, Rest extends unknown[]> =\n  RequiredKeysOf<Init> extends never\n    ? [InitWithUnknowns<Init>?, ...Rest]\n    : [InitWithUnknowns<Init>, ...Rest];\n\nexport type QueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init = MaybeOptionalInit<Paths[Path], Method>,\n> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];\n\n/**\n * The last element of an infinite query's key. `useQuery` and `useInfiniteQuery` cache different\n * data (`TData` and `InfiniteData<TData>`), so the same request must not share one key (upstream\n * #2184, ADR-022). A prefix such as `[method, path]` still matches both. Not exported: a runtime\n * named export next to the default export would change what `require()` returns.\n */\nconst INFINITE_QUERY_KEY_MARKER = \"infinite\";\n\nexport type InfiniteQueryKey<\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = readonly [...QueryKey<Paths, Method, Path>, typeof INFINITE_QUERY_KEY_MARKER];\n\nexport type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  path: Path,\n  ...[init, options]: InitArguments<Init, [Options?]>\n) => NoInfer<\n  Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryFn\" | \"queryKey\"\n  > & {\n    queryKey: DataTag<\n      QueryKey<Paths, Method, Path>,\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"]\n    >;\n    queryFn: Exclude<\n      UseQueryOptions<\n        QueryData<Response[\"data\"]>,\n        Response[\"error\"],\n        InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n        QueryKey<Paths, Method, Path>\n      >[\"queryFn\"],\n      SkipToken | undefined\n    >;\n  }\n>;\n\nexport type UseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseQueryResult<\n  InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\n/**\n * The type of the page params: the initial one and the ones `getNextPageParam` and\n * `getPreviousPageParam` return (upstream #2458). It was `unknown`. It stays `unknown` when a\n * return type is untyped, so code that compiled still compiles (roadmap §3): TypeScript cannot\n * infer the return type of a callback that computes it from an unannotated `lastPageParam`,\n * whose type depends on that return type, and gives `never` or `unknown`.\n */\ntype PageParam<Initial, Next, Previous> =\n  IsUntyped<Next> extends true\n    ? unknown\n    : [Previous] extends [NoPreviousPageParam]\n      ? NullishToUnknown<Initial | NonNullable<Next>>\n      : IsUntyped<Previous> extends true\n        ? unknown\n        : NullishToUnknown<Initial | NonNullable<Next> | NonNullable<Previous>>;\n\n/** The `Previous` type parameter when the options have no `getPreviousPageParam`. */\ndeclare const NO_PREVIOUS_PAGE_PARAM: unique symbol;\ntype NoPreviousPageParam = typeof NO_PREVIOUS_PAGE_PARAM;\n\ntype IsUntyped<T> = [T] extends [never] ? true : unknown extends T ? true : false;\n\n/** Only `undefined` or `null` names no type: a cursor API's `initialPageParam: undefined`. */\ntype NullishToUnknown<T> = [T] extends [undefined | null] ? unknown : T;\n\n/** Read only for the return type; `never` arguments add no inference for TanStack's page param. */\ntype PageParamFunction<Result> = (...args: never) => Result;\n\n/**\n * Inference sites of the page param types. Intersected before `Options`, so TanStack's own\n * inference in the implementation reads the full signatures of `Options`.\n */\ninterface PageParamSources<Initial, Next, Previous> {\n  initialPageParam: Initial;\n  getNextPageParam: PageParamFunction<Next>;\n  getPreviousPageParam?: PageParamFunction<Previous>;\n}\n\n/**\n * `placeholderData` of `useInfiniteQuery`, with an `unknown` page param as before: TypeScript types\n * a `(previousData) => previousData` callback while it still infers the page param, so it got\n * `unknown` there and failed against the typed page param.\n */\ntype InfinitePlaceholderData<\n  Data,\n  Error,\n  Paths extends {},\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n> = UseInfiniteQueryOptions<\n  Data,\n  Error,\n  InfiniteData<Data, unknown>,\n  InfiniteQueryKey<Paths, Method, Path>,\n  unknown\n>[\"placeholderData\"];\n\nexport type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseInfiniteQueryOptions<\n      Response[\"data\"],\n      Response[\"error\"],\n      InferSelectReturnType<\n        InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>,\n        Options[\"select\"]\n      >,\n      InfiniteQueryKey<Paths, Method, Path>,\n      PageParam<Initial, Next, Previous>\n    >,\n    \"queryKey\" | \"queryFn\" | \"placeholderData\"\n  > & {\n    placeholderData?: InfinitePlaceholderData<\n      Response[\"data\"],\n      Response[\"error\"],\n      Paths,\n      Method,\n      Path\n    >;\n    pageParamName?: string;\n  },\n  Initial = unknown,\n  Next = never,\n  Previous = NoPreviousPageParam,\n  // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)\n>(\n  method: Method,\n  url: Path,\n  init: InitWithUnknowns<Init>,\n  options: PageParamSources<Initial, Next, Previous> & Options,\n  queryClient?: QueryClient,\n) => UseInfiniteQueryResult<\n  InferSelectReturnType<\n    InfiniteData<Response[\"data\"], PageParam<Initial, Next, Previous>>,\n    Options[\"select\"]\n  >,\n  Response[\"error\"]\n>;\n\nexport type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  Options extends Omit<\n    UseSuspenseQueryOptions<\n      QueryData<Response[\"data\"]>,\n      Response[\"error\"],\n      InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n      QueryKey<Paths, Method, Path>\n    >,\n    \"queryKey\" | \"queryFn\"\n  >,\n>(\n  method: Method,\n  url: Path,\n  ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>\n) => UseSuspenseQueryResult<\n  InferSelectReturnType<QueryData<Response[\"data\"]>, Options[\"select\"]>,\n  Response[\"error\"]\n>;\n\nexport type UseMutationMethod<Paths extends {}, Media extends MediaType> = <\n  Method extends HttpMethod,\n  Path extends PathsWithMethod<Paths, Method>,\n  Init extends MaybeOptionalInit<Paths[Path], Method>,\n  // note: Required is used to avoid repeating NonNullable in UseQuery types\n  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,\n  TOnMutateResult = unknown,\n>(\n  method: Method,\n  url: Path,\n  options?: Omit<\n    UseMutationOptions<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>,\n    \"mutationKey\" | \"mutationFn\"\n  >,\n  queryClient?: QueryClient,\n) => UseMutationResult<Response[\"data\"], Response[\"error\"], Init, TOnMutateResult>;\n\nexport interface OpenapiQueryClient<Paths extends {}, Media extends MediaType = MediaType> {\n  queryOptions: QueryOptionsFunction<Paths, Media>;\n  useQuery: UseQueryMethod<Paths, Media>;\n  useSuspenseQuery: UseSuspenseQueryMethod<Paths, Media>;\n  useInfiniteQuery: UseInfiniteQueryMethod<Paths, Media>;\n  useMutation: UseMutationMethod<Paths, Media>;\n}\n\nexport type MethodResponse<\n  // biome-ignore lint/suspicious/noExplicitAny: matches a client of any paths, as upstream's\n  CreatedClient extends OpenapiQueryClient<any, any>,\n  Method extends HttpMethod,\n  Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media>\n    ? PathsWithMethod<Paths, Method>\n    : never,\n  Options = object,\n> =\n  CreatedClient extends OpenapiQueryClient<\n    // biome-ignore lint/suspicious/noExplicitAny: unknown rejects the generated interfaces\n    infer Paths extends { [key: string]: any },\n    infer Media extends MediaType\n  >\n    ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>[\"data\"]>\n    : never;\n\n/**\n * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response\n * with an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as\n * `0`.\n */\nfunction throwIfFailed(result: { error?: unknown; response: Response }): void {\n  if (result.error !== undefined || !result.response.ok) {\n    throw result.error;\n  }\n}\n\n/** The query parameter that carries the page param unless `pageParamName` names another. */\nconst DEFAULT_PAGE_PARAM_NAME = \"cursor\";\n\ninterface PageRequest {\n  readonly pageParamName: string;\n  readonly pageParam: unknown;\n  readonly signal: AbortSignal;\n}\n\n/**\n * The request init of one page. An `undefined` page param (the first page with\n * `initialPageParam: undefined`) is left out instead of being sent as `0` (upstream #2715, #2340,\n * ADR-022), so a cursor API gets no cursor on the first page.\n */\nfunction pageInit(init: unknown, { pageParamName, pageParam, signal }: PageRequest) {\n  const { params, ...rest } = (init ?? {}) as { params?: { query?: DefaultParamsOption } };\n  const page = pageParam === undefined ? {} : { [pageParamName]: pageParam };\n  return { ...rest, signal, params: { ...params, query: { ...params?.query, ...page } } };\n}\n\n/**\n * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React\n * context is passed to each hook as its last argument; `createClient` does not take one.\n */\n// biome-ignore lint/complexity/noExcessiveLinesPerFunction: inherited, kept until 1.1 (ADR-036)\nexport default function createClient<Paths extends {}, Media extends MediaType = MediaType>(\n  client: FetchClient<Paths, Media>,\n): OpenapiQueryClient<Paths, Media> {\n  const queryFn = async <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>({\n    queryKey,\n    signal,\n  }: QueryFunctionContext<QueryKey<Paths, Method, Path>>) => {\n    // While `Path` is generic, TypeScript cannot work out that the key is a tuple: the init is a\n    // conditional type per operation (`MaybeOptionalInit`), and the key's type waits for it.\n    const [method, path, init] = queryKey as readonly [Method, Path, unknown?];\n    const mth = method.toUpperCase() as Uppercase<typeof method>;\n    const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n    // The init is `unknown` here. An `any` init lets the call infer the generic response type\n    // that `queryOptions` declares; a typed init makes TypeScript compare two unresolved\n    // conditional types, which it cannot do.\n    // biome-ignore lint/suspicious/noExplicitAny: see the comment above\n    const result = await fn(path, { signal, ...(init as any) });\n    throwIfFailed(result);\n    // TanStack Query rejects `undefined` query data. The fetch client gives `undefined` for every\n    // success without a body: a 204, `Content-Length: 0`, an empty chunked body, a HEAD request\n    // (upstream #2234). A parsed body is never `undefined`, so this changes nothing else.\n    return result.data ?? null;\n  };\n\n  const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({\n    queryKey: (init === undefined\n      ? ([method, path] as const)\n      : ([method, path, init] as const)) as DataTag<\n      QueryKey<Paths, typeof method, typeof path>,\n      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the data type\n      any,\n      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the error type\n      any\n    >,\n    queryFn,\n    ...options,\n  });\n\n  return {\n    queryOptions,\n    useQuery: (method, path, ...[init, options, queryClient]) =>\n      useQuery(\n        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),\n        queryClient,\n      ),\n    useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>\n      useSuspenseQuery(\n        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),\n        queryClient,\n      ),\n    // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)\n    useInfiniteQuery: (method, path, init, options, queryClient) => {\n      const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;\n      const { queryKey } = queryOptions(method, path, init);\n      const mth = method.toUpperCase() as Uppercase<typeof method>;\n      const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n      return useInfiniteQuery(\n        {\n          queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER] as const,\n          // The request comes from the arguments; the key only identifies the cache entry.\n          queryFn: async ({ pageParam, signal }) => {\n            const result = await fn(\n              path,\n              // biome-ignore lint/suspicious/noExplicitAny: a generic init; see queryFn\n              pageInit(init, { pageParamName, pageParam, signal }) as any,\n            );\n            throwIfFailed(result);\n            // An empty page stays `undefined`, as in upstream: TanStack Query rejects only\n            // `undefined` query data, and the infinite query data is the `{ pages }` object.\n            return result.data;\n          },\n          ...restOptions,\n          // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack\n          // passes the previous data of this query, with its own page params, and takes it back.\n          // biome-ignore lint/suspicious/noExplicitAny: TanStack's type carries its own page params\n          placeholderData: placeholderData as any,\n        },\n        queryClient,\n      );\n    },\n    useMutation: (method, path, options, queryClient) =>\n      useMutation(\n        {\n          mutationKey: [method, path],\n          mutationFn: async (init) => {\n            const mth = method.toUpperCase() as Uppercase<typeof method>;\n            const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;\n            const result = await fn(path, init as InitWithUnknowns<typeof init>);\n            throwIfFailed(result);\n            // TanStack Query accepts `undefined` mutation data, so a success without a body stays\n            // `undefined`, as in upstream; only query data needs `null` (upstream #2234). The cast\n            // only bridges the generic types: `Response[\"data\"]` still has `undefined` for an\n            // operation with a response without a body.\n            const { data } = result;\n            return data as Exclude<typeof data, undefined>;\n          },\n          ...options,\n        },\n        queryClient,\n      ),\n  };\n}\n"],"names":[],"mappings":";;AAuEA,MAAM,yBAAA,GAA4B,UAAA;AA2PlC,SAAS,cAAc,MAAA,EAAuD;AAC5E,EAAA,IAAI,OAAO,KAAA,KAAU,MAAA,IAAa,CAAC,MAAA,CAAO,SAAS,EAAA,EAAI;AACrD,IAAA,MAAM,MAAA,CAAO,KAAA;AAAA,EACf;AACF;AAGA,MAAM,uBAAA,GAA0B,QAAA;AAahC,SAAS,SAAS,IAAA,EAAe,EAAE,aAAA,EAAe,SAAA,EAAW,QAAO,EAAgB;AAClF,EAAA,MAAM,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,GAAK,QAAQ,EAAC;AACtC,EAAA,MAAM,IAAA,GAAO,cAAc,MAAA,GAAY,KAAK,EAAE,CAAC,aAAa,GAAG,SAAA,EAAU;AACzE,EAAA,OAAO,EAAE,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,EAAE,GAAG,MAAA,EAAQ,KAAA,EAAO,GAAG,IAAA,IAAO,EAAE;AACxF;AAOA,SAAwB,aACtB,MAAA,EACkC;AAClC,EAAA,MAAM,UAAU,OAA+E;AAAA,IAC7F,QAAA;AAAA,IACA;AAAA,GACF,KAA2D;AAGzD,IAAA,MAAM,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA,GAAI,QAAA;AAC7B,IAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,IAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AAKrB,IAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,EAAE,MAAA,EAAQ,GAAI,MAAc,CAAA;AAC1D,IAAA,aAAA,CAAc,MAAM,CAAA;AAIpB,IAAA,OAAO,OAAO,IAAA,IAAQ,IAAA;AAAA,EACxB,CAAA;AAEA,EAAA,MAAM,eAAmD,CAAC,MAAA,EAAQ,SAAS,CAAC,IAAA,EAAM,OAAO,CAAA,MAAO;AAAA,IAC9F,QAAA,EAAW,IAAA,KAAS,MAAA,GACf,CAAC,MAAA,EAAQ,IAAI,CAAA,GACb,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAI,CAAA;AAAA,IAOxB,OAAA;AAAA,IACA,GAAG;AAAA,GACL,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,YAAA;AAAA,IACA,QAAA,EAAU,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,IAAA,EAAM,OAAA,EAAS,WAAW,CAAA,KACrD,QAAA;AAAA,MACE,YAAA,CAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,CAAA;AAAA,MACzE;AAAA,KACF;AAAA,IACF,gBAAA,EAAkB,CAAC,MAAA,EAAQ,IAAA,EAAA,GAAS,CAAC,IAAA,EAAM,OAAA,EAAS,WAAW,CAAA,KAC7D,gBAAA;AAAA,MACE,YAAA,CAAa,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAuC,OAAO,CAAA;AAAA,MACzE;AAAA,KACF;AAAA;AAAA,IAEF,kBAAkB,CAAC,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAM,SAAS,WAAA,KAAgB;AAC9D,MAAA,MAAM,EAAE,aAAA,GAAgB,uBAAA,EAAyB,eAAA,EAAiB,GAAG,aAAY,GAAI,OAAA;AACrF,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,YAAA,CAAa,MAAA,EAAQ,MAAM,IAAI,CAAA;AACpD,MAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,MAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,MAAA,OAAO,gBAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU,CAAC,GAAG,QAAA,EAAU,yBAAyB,CAAA;AAAA;AAAA,UAEjD,OAAA,EAAS,OAAO,EAAE,SAAA,EAAW,QAAO,KAAM;AACxC,YAAA,MAAM,SAAS,MAAM,EAAA;AAAA,cACnB,IAAA;AAAA;AAAA,cAEA,SAAS,IAAA,EAAM,EAAE,aAAA,EAAe,SAAA,EAAW,QAAQ;AAAA,aACrD;AACA,YAAA,aAAA,CAAc,MAAM,CAAA;AAGpB,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,UAChB,CAAA;AAAA,UACA,GAAG,WAAA;AAAA;AAAA;AAAA;AAAA,UAIH;AAAA,SACF;AAAA,QACA;AAAA,OACF;AAAA,IACF,CAAA;AAAA,IACA,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAA,EAAM,SAAS,WAAA,KACnC,WAAA;AAAA,MACE;AAAA,QACE,WAAA,EAAa,CAAC,MAAA,EAAQ,IAAI,CAAA;AAAA,QAC1B,UAAA,EAAY,OAAO,IAAA,KAAS;AAC1B,UAAA,MAAM,GAAA,GAAM,OAAO,WAAA,EAAY;AAC/B,UAAA,MAAM,EAAA,GAAK,OAAO,GAAG,CAAA;AACrB,UAAA,MAAM,MAAA,GAAS,MAAM,EAAA,CAAG,IAAA,EAAM,IAAqC,CAAA;AACnE,UAAA,aAAA,CAAc,MAAM,CAAA;AAKpB,UAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,UAAA,OAAO,IAAA;AAAA,QACT,CAAA;AAAA,QACA,GAAG;AAAA,OACL;AAAA,MACA;AAAA;AACF,GACJ;AACF;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-typesafe-react-query",
   "description": "Fast, type-safe @tanstack/react-query client to work with your OpenAPI schema.",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.3",
   "author": {
     "name": "Fedor Chishchin",
     "url": "https://github.com/fedorello"
@@ -50,26 +50,26 @@
     "tanstack"
   ],
   "dependencies": {
-    "openapi-typesafe-helpers": "^1.0.0-rc.1"
+    "openapi-typesafe-helpers": "^1.0.0-rc.3"
   },
   "devDependencies": {
-    "@tanstack/react-query": "5.105.1",
+    "@tanstack/react-query": "5.106.1",
     "@testing-library/react": "16.3.3",
     "@types/react": "19.3.0",
     "@types/react-dom": "19.3.0",
-    "@vitejs/plugin-react": "6.1.2",
-    "execa": "^10.2.1",
-    "jsdom": "30.1.3",
+    "@vitejs/plugin-react": "6.2.1",
+    "jsdom": "31.0.0",
     "msw": "3.0.3",
-    "openapi-typesafe": "^1.0.0-rc.1",
-    "openapi-typesafe-fetch": "^1.0.0-rc.1",
+    "openapi-typesafe": "^1.0.0-rc.3",
+    "openapi-typesafe-fetch": "^1.0.0-rc.3",
     "react": "19.3.1",
     "react-dom": "19.3.1",
-    "react-error-boundary": "6.1.6"
+    "react-error-boundary": "6.1.6",
+    "vite-node": "6.0.0"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.80.0",
-    "openapi-typesafe-fetch": "^1.0.0-rc.1"
+    "openapi-typesafe-fetch": "^1.0.0-rc.3"
   },
   "engines": {
     "node": ">=22"
@@ -78,9 +78,10 @@
     "build": "unbuild",
     "dev": "tsc -p tsconfig.build.json --watch",
     "format": "biome format . --write",
-    "lint": "pnpm run lint:js && pnpm run lint:ts",
+    "lint": "pnpm run lint:js && pnpm run lint:ts && pnpm run lint:sizes",
     "lint:js": "biome check .",
     "lint:ts": "tsc --noEmit",
+    "lint:sizes": "vite-node ../openapi-typesafe/scripts/size-rules/check-sizes.ts src",
     "generate-types": "openapi-typesafe test/fixtures/api.yaml -o test/fixtures/api.d.ts && openapi-typesafe test/fixtures/query.yaml -o test/fixtures/query.d.ts",
     "test": "pnpm run generate-types && pnpm run test:js && pnpm run test:exports",
     "test:js": "vitest run",

package/src/index.ts

@@ -22,11 +22,15 @@ import type {
   DefaultParamsOption,
   Client as FetchClient,
   FetchResponse,
-  IsInitOptional,
   MaybeOptionalInit,
   PathOperation,
 } from "openapi-typesafe-fetch";
-import type { HttpMethod, MediaType, PathsWithMethod } from "openapi-typesafe-helpers";
+import type {
+  HttpMethod,
+  MediaType,
+  PathsWithMethod,
+  RequiredKeysOf,
+} from "openapi-typesafe-helpers";
 
 // Helper type to dynamically infer the type from the `select` property
 type InferSelectReturnType<TData, TSelect> = TSelect extends (data: TData) => infer R ? R : TData;
@@ -41,11 +45,16 @@ type InitWithUnknowns<Init> = Init & { [key: string]: unknown };
 
 /**
  * The arguments after the path: the init, required when the operation requires a parameter or a
- * body, then `Rest`. `IsInitOptional` keeps the init optional in
- * `Parameters<typeof $api.queryOptions>`, where it is the union of all inits (upstream #2178).
+ * body, then `Rest`. The condition is openapi-react-query's, as `InitParam` of the fetch client
+ * is openapi-fetch's (ADR-030, decision 2): TypeScript relates two conditional types only when
+ * their `extends` types are the same, so a hook type copied from openapi-react-query takes these
+ * hooks. For a union of inits, `MaybeOptionalInit` leaves out `undefined` when one is required,
+ * so `Parameters<typeof $api.queryOptions>` still requires it then (upstream #2178).
  */
 type InitArguments<Init, Rest extends unknown[]> =
-  IsInitOptional<Init> extends true ? [InitWithUnknowns<Init>?, ...Rest] : [InitWithUnknowns<Init>, ...Rest];
+  RequiredKeysOf<Init> extends never
+    ? [InitWithUnknowns<Init>?, ...Rest]
+    : [InitWithUnknowns<Init>, ...Rest];
 
 export type QueryKey<
   Paths extends {},
@@ -72,7 +81,8 @@ export type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <
   Method extends HttpMethod,
   Path extends PathsWithMethod<Paths, Method>,
   Init extends MaybeOptionalInit<Paths[Path], Method>,
-  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types
+  // note: Required is used to avoid repeating NonNullable in UseQuery types
+  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,
   Options extends Omit<
     UseQueryOptions<
       QueryData<Response["data"]>,
@@ -96,7 +106,11 @@ export type QueryOptionsFunction<Paths extends {}, Media extends MediaType> = <
     >,
     "queryFn" | "queryKey"
   > & {
-    queryKey: DataTag<QueryKey<Paths, Method, Path>, QueryData<Response["data"]>, Response["error"]>;
+    queryKey: DataTag<
+      QueryKey<Paths, Method, Path>,
+      QueryData<Response["data"]>,
+      Response["error"]
+    >;
     queryFn: Exclude<
       UseQueryOptions<
         QueryData<Response["data"]>,
@@ -113,7 +127,8 @@ export type UseQueryMethod<Paths extends {}, Media extends MediaType> = <
   Method extends HttpMethod,
   Path extends PathsWithMethod<Paths, Method>,
   Init extends MaybeOptionalInit<Paths[Path], Method>,
-  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types
+  // note: Required is used to avoid repeating NonNullable in UseQuery types
+  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,
   Options extends Omit<
     UseQueryOptions<
       QueryData<Response["data"]>,
@@ -127,7 +142,10 @@ export type UseQueryMethod<Paths extends {}, Media extends MediaType> = <
   method: Method,
   url: Path,
   ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>
-) => UseQueryResult<InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, Response["error"]>;
+) => UseQueryResult<
+  InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>,
+  Response["error"]
+>;
 
 /**
  * The type of the page params: the initial one and the ones `getNextPageParam` and
@@ -195,18 +213,28 @@ export type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> =
     UseInfiniteQueryOptions<
       Response["data"],
       Response["error"],
-      InferSelectReturnType<InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>, Options["select"]>,
+      InferSelectReturnType<
+        InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>,
+        Options["select"]
+      >,
       InfiniteQueryKey<Paths, Method, Path>,
       PageParam<Initial, Next, Previous>
     >,
     "queryKey" | "queryFn" | "placeholderData"
   > & {
-    placeholderData?: InfinitePlaceholderData<Response["data"], Response["error"], Paths, Method, Path>;
+    placeholderData?: InfinitePlaceholderData<
+      Response["data"],
+      Response["error"],
+      Paths,
+      Method,
+      Path
+    >;
     pageParamName?: string;
   },
   Initial = unknown,
   Next = never,
   Previous = NoPreviousPageParam,
+  // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)
 >(
   method: Method,
   url: Path,
@@ -214,7 +242,10 @@ export type UseInfiniteQueryMethod<Paths extends {}, Media extends MediaType> =
   options: PageParamSources<Initial, Next, Previous> & Options,
   queryClient?: QueryClient,
 ) => UseInfiniteQueryResult<
-  InferSelectReturnType<InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>, Options["select"]>,
+  InferSelectReturnType<
+    InfiniteData<Response["data"], PageParam<Initial, Next, Previous>>,
+    Options["select"]
+  >,
   Response["error"]
 >;
 
@@ -222,7 +253,8 @@ export type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> =
   Method extends HttpMethod,
   Path extends PathsWithMethod<Paths, Method>,
   Init extends MaybeOptionalInit<Paths[Path], Method>,
-  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types
+  // note: Required is used to avoid repeating NonNullable in UseQuery types
+  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,
   Options extends Omit<
     UseSuspenseQueryOptions<
       QueryData<Response["data"]>,
@@ -236,13 +268,17 @@ export type UseSuspenseQueryMethod<Paths extends {}, Media extends MediaType> =
   method: Method,
   url: Path,
   ...[init, options, queryClient]: InitArguments<Init, [Options?, QueryClient?]>
-) => UseSuspenseQueryResult<InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>, Response["error"]>;
+) => UseSuspenseQueryResult<
+  InferSelectReturnType<QueryData<Response["data"]>, Options["select"]>,
+  Response["error"]
+>;
 
 export type UseMutationMethod<Paths extends {}, Media extends MediaType> = <
   Method extends HttpMethod,
   Path extends PathsWithMethod<Paths, Method>,
   Init extends MaybeOptionalInit<Paths[Path], Method>,
-  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>, // note: Required is used to avoid repeating NonNullable in UseQuery types
+  // note: Required is used to avoid repeating NonNullable in UseQuery types
+  Response extends Required<FetchResponse<PathOperation<Paths, Path, Method>, Init, Media>>,
   TOnMutateResult = unknown,
 >(
   method: Method,
@@ -263,6 +299,7 @@ export interface OpenapiQueryClient<Paths extends {}, Media extends MediaType =
 }
 
 export type MethodResponse<
+  // biome-ignore lint/suspicious/noExplicitAny: matches a client of any paths, as upstream's
   CreatedClient extends OpenapiQueryClient<any, any>,
   Method extends HttpMethod,
   Path extends CreatedClient extends OpenapiQueryClient<infer Paths, infer _Media>
@@ -270,13 +307,18 @@ export type MethodResponse<
     : never,
   Options = object,
 > =
-  CreatedClient extends OpenapiQueryClient<infer Paths extends { [key: string]: any }, infer Media extends MediaType>
+  CreatedClient extends OpenapiQueryClient<
+    // biome-ignore lint/suspicious/noExplicitAny: unknown rejects the generated interfaces
+    infer Paths extends { [key: string]: any },
+    infer Media extends MediaType
+  >
     ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]>
     : never;
 
 /**
- * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response with
- * an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as `0`.
+ * Throw the error of a failed fetch result. `if (error)` missed two failures: a non-OK response
+ * with an empty body (`error` is `undefined`, upstream #2070, #2829) and a falsy error body such as
+ * `0`.
  */
 function throwIfFailed(result: { error?: unknown; response: Response }): void {
   if (result.error !== undefined || !result.response.ok) {
@@ -304,7 +346,11 @@ function pageInit(init: unknown, { pageParamName, pageParam, signal }: PageReque
   return { ...rest, signal, params: { ...params, query: { ...params?.query, ...page } } };
 }
 
-// TODO: Add the ability to bring queryClient as argument
+/**
+ * Hooks and query options for a fetch client. A `QueryClient` other than the one from the React
+ * context is passed to each hook as its last argument; `createClient` does not take one.
+ */
+// biome-ignore lint/complexity/noExcessiveLinesPerFunction: inherited, kept until 1.1 (ADR-036)
 export default function createClient<Paths extends {}, Media extends MediaType = MediaType>(
   client: FetchClient<Paths, Media>,
 ): OpenapiQueryClient<Paths, Media> {
@@ -317,7 +363,11 @@ export default function createClient<Paths extends {}, Media extends MediaType =
     const [method, path, init] = queryKey as readonly [Method, Path, unknown?];
     const mth = method.toUpperCase() as Uppercase<typeof method>;
     const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;
-    const result = await fn(path, { signal, ...(init as any) }); // TODO: find a way to avoid as any
+    // The init is `unknown` here. An `any` init lets the call infer the generic response type
+    // that `queryOptions` declares; a typed init makes TypeScript compare two unresolved
+    // conditional types, which it cannot do.
+    // biome-ignore lint/suspicious/noExplicitAny: see the comment above
+    const result = await fn(path, { signal, ...(init as any) });
     throwIfFailed(result);
     // TanStack Query rejects `undefined` query data. The fetch client gives `undefined` for every
     // success without a body: a 204, `Content-Length: 0`, an empty chunked body, a HEAD request
@@ -326,9 +376,13 @@ export default function createClient<Paths extends {}, Media extends MediaType =
   };
 
   const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({
-    queryKey: (init === undefined ? ([method, path] as const) : ([method, path, init] as const)) as DataTag<
+    queryKey: (init === undefined
+      ? ([method, path] as const)
+      : ([method, path, init] as const)) as DataTag<
       QueryKey<Paths, typeof method, typeof path>,
+      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the data type
       any,
+      // biome-ignore lint/suspicious/noExplicitAny: the declared return type sets the error type
       any
     >,
     queryFn,
@@ -338,9 +392,16 @@ export default function createClient<Paths extends {}, Media extends MediaType =
   return {
     queryOptions,
     useQuery: (method, path, ...[init, options, queryClient]) =>
-      useQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),
+      useQuery(
+        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),
+        queryClient,
+      ),
     useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>
-      useSuspenseQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),
+      useSuspenseQuery(
+        queryOptions(method, path, init as InitWithUnknowns<typeof init>, options),
+        queryClient,
+      ),
+    // biome-ignore lint/complexity/useMaxParams: public signature of 1.x (ADR-036)
     useInfiniteQuery: (method, path, init, options, queryClient) => {
       const { pageParamName = DEFAULT_PAGE_PARAM_NAME, placeholderData, ...restOptions } = options;
       const { queryKey } = queryOptions(method, path, init);
@@ -351,7 +412,11 @@ export default function createClient<Paths extends {}, Media extends MediaType =
           queryKey: [...queryKey, INFINITE_QUERY_KEY_MARKER] as const,
           // The request comes from the arguments; the key only identifies the cache entry.
           queryFn: async ({ pageParam, signal }) => {
-            const result = await fn(path, pageInit(init, { pageParamName, pageParam, signal }) as any);
+            const result = await fn(
+              path,
+              // biome-ignore lint/suspicious/noExplicitAny: a generic init; see queryFn
+              pageInit(init, { pageParamName, pageParam, signal }) as any,
+            );
             throwIfFailed(result);
             // An empty page stays `undefined`, as in upstream: TanStack Query rejects only
             // `undefined` query data, and the infinite query data is the `{ pages }` object.
@@ -360,6 +425,7 @@ export default function createClient<Paths extends {}, Media extends MediaType =
           ...restOptions,
           // Typed with an `unknown` page param for the caller (`InfinitePlaceholderData`). TanStack
           // passes the previous data of this query, with its own page params, and takes it back.
+          // biome-ignore lint/suspicious/noExplicitAny: TanStack's type carries its own page params
           placeholderData: placeholderData as any,
         },
         queryClient,