@kubb/plugin-react-query 5.3.0 → 5.3.1

package/OVERVIEW.md

@@ -0,0 +1,20 @@
+# React Query
+
+Generates TanStack Query helpers for React from your OpenAPI spec. By default you get `queryOptions` and `mutationOptions` factories with their cache keys. Set `hooks: true` to also get `useQuery`, `useSuspenseQuery`, `useInfiniteQuery`, and `useMutation` hooks.
+
+The plugin ships no HTTP client. Each helper calls a function generated by a client plugin.
+
+## Setup
+
+- Add `@kubb/plugin-ts` and a client plugin: `@kubb/plugin-fetch` or `@kubb/plugin-axios`.
+- Install `@tanstack/react-query` v5 or higher in the app that uses the generated code.
+- Configure validation on the client plugin, not here.
+
+## Options worth knowing
+
+- `client` picks `fetch` or `axios` when both client plugins are registered. A single client is detected automatically.
+- `hooks` adds the `use*` hooks on top of the option factories.
+- `suspense` adds `useSuspenseQuery` hooks.
+- `infinite` adds infinite queries for pagination. Set `infinite.queryParam` to the query parameter that holds the page cursor.
+- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`), and where the TanStack Query runtime is imported from. Set either to `false` to skip it.
+- `customOptions` routes every hook through your own function that returns extra options.

package/dist/index.cjs

@@ -350,8 +350,14 @@ function createGroupConfig(group) {
 	};
 }
 //#endregion
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
 //#region package.json
-var version = "5.3.0";
+var version = "5.3.1";
 //#endregion
 //#region ../../internals/client/src/resolveClient.ts
 /**
@@ -2472,7 +2478,7 @@ const pluginReactQuery = (0, kubb_kit.definePlugin)({
 	meta: {
 		name: pluginReactQueryName,
 		version,
-		compatibility: { kubb: ">=5.8.0" }
+		compatibility
 	},
 	dependencies: { [_kubb_plugin_ts.pluginTsName]: {} },
 	setup(options) {