@kubb/plugin-vue-query 5.3.2 → 5.3.4

package/dist/index.cjs

@@ -359,7 +359,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.3.2";
+var version = "5.3.4";
 //#endregion
 //#region ../../internals/tanstack-query/src/utils.ts
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
+import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
 import "@kubb/plugin-ts";
 import "kubb/jsx";
 import "@kubb/plugin-zod";
@@ -351,7 +351,7 @@ type ResolvedOptions = {
   hooks: boolean;
   resolver: ResolverVueQuery;
 };
-type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, ResolverVueQuery>;
+type PluginVueQuery = PluginType<'plugin-vue-query', Options, ResolvedOptions, ResolverVueQuery>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {

package/dist/index.js

@@ -329,7 +329,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.3.2";
+var version = "5.3.4";
 //#endregion
 //#region ../../internals/tanstack-query/src/utils.ts
 /**

package/docs/overview.md

@@ -1,24 +1,28 @@
 # Vue Query
 
-Generates TanStack Query helpers for Vue from your OpenAPI spec. By default you get `queryOptions` factories with their query and mutation keys. Set `hooks: true` to also get `useQuery`, `useInfiniteQuery`, and `useMutation` composables with reactive parameters.
+The Vue Query plugin generates TanStack Query helpers for Vue from your OpenAPI spec. By default you get `queryOptions` factories with their query keys, plus a key for each mutation. Set `hooks: true` to also get `useQuery` and `useMutation` composables with reactive parameters.
 
 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/vue-query` v5 or higher in the app that uses the generated code.
+- Add `@kubb/plugin-ts` and a client plugin: `@kubb/plugin-fetch` or `@kubb/plugin-axios`. Leave `sdk` unset on the client plugin.
+- Install `@tanstack/vue-query` 5.41 or a later v5 release and `vue` 3.3 or a later v3 release 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*` composables on top of the option factories.
-- `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.
+- `hooks` adds the `use*` composables on top of the query option factories.
+- `infinite` adds `useInfiniteQuery` composables for pagination. It needs `hooks: true` and covers the operations that take the query parameter named in `infinite.queryParam`, which defaults to `'id'`.
+- `query` and `mutation` set which HTTP methods become queries (`GET`) and mutations (`POST`, `PUT`, `PATCH`, `DELETE`). They also set where the TanStack Query runtime is imported from. Set either to `false` to skip those helpers.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-vue-query/options) for every option and its default.
 
 ## Example
 
+The config below generates `useQuery` and `useMutation` composables that call the Fetch client.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -35,7 +39,3 @@ export default defineConfig({
   ],
 })
 ```
-
-## See also
-
-- [TanStack Query for Vue](https://tanstack.com/query/latest/docs/framework/vue/overview)

package/kubb-extension.json

@@ -4,7 +4,7 @@
   "name": "plugin-vue-query",
   "export": "pluginVueQuery",
   "displayName": "Vue Query",
-  "description": "Generates TanStack Query composables for Vue from your OpenAPI spec, so every read and write is a typed useQuery, useInfiniteQuery, or useMutation.",
+  "description": "Generates typed TanStack Query helpers for Vue from your OpenAPI spec: queryOptions factories with their query and mutation keys. Set hooks to also get useQuery and useMutation composables, plus useInfiniteQuery when infinite is set.",
   "category": "framework",
   "icon": {
     "light": "https://kubb.dev/feature/tanstack.svg"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-vue-query",
-  "version": "5.3.2",
+  "version": "5.3.4",
   "description": "Generate type-safe TanStack Query (Vue Query) composables with Kubb. Covers useQuery, useMutation, useInfiniteQuery, and queryOptions with Vue 3 Composition API support.",
   "keywords": [
     "code-generation",
@@ -78,7 +78,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.9"
+    "@kubb/plugin-ts": "^5.0.11"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
@@ -86,15 +86,20 @@
     "@internals/tanstack-query": "0.0.0",
     "@internals/utils": "0.0.0",
     "@tanstack/vue-query": "^5.104.1",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2",
+    "vue": "^3.5.43"
   },
   "peerDependencies": {
-    "@tanstack/vue-query": "^5.0.0",
-    "kubb": "^5.8.3"
+    "@tanstack/vue-query": "^5.41.0",
+    "kubb": "^5.9.2",
+    "vue": ">=3.3.0"
   },
   "peerDependenciesMeta": {
     "@tanstack/vue-query": {
       "optional": true
+    },
+    "vue": {
+      "optional": true
     }
   },
   "engines": {