@kubb/plugin-vue-query 5.3.0-canary.20261012T190229 → 5.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/OVERVIEW.md +18 -0
- package/dist/index.cjs +87 -24
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +45 -1
- package/dist/index.js +87 -25
- package/dist/index.js.map +1 -1
- package/kubb-extension.json +208 -0
- package/package.json +12 -9
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://kubb.dev/schemas/kubb-extension.json",
|
|
3
|
+
"kind": "plugin",
|
|
4
|
+
"name": "plugin-vue-query",
|
|
5
|
+
"export": "pluginVueQuery",
|
|
6
|
+
"displayName": "Vue Query",
|
|
7
|
+
"description": "Generates TanStack Query composables for Vue from your OpenAPI spec, so every read and write is a typed useQuery, useInfiniteQuery, or useMutation.",
|
|
8
|
+
"category": "framework",
|
|
9
|
+
"icon": {
|
|
10
|
+
"light": "https://kubb.dev/feature/tanstack.svg"
|
|
11
|
+
},
|
|
12
|
+
"tags": ["vue-query", "tanstack-query", "vue", "composables", "data-fetching", "codegen", "openapi"],
|
|
13
|
+
"docs": "https://kubb.dev/plugins/plugin-vue-query",
|
|
14
|
+
"compatibility": {
|
|
15
|
+
"kubb": ">=5.8.0",
|
|
16
|
+
"node": ">=22"
|
|
17
|
+
},
|
|
18
|
+
"role": "consumer",
|
|
19
|
+
"options": [
|
|
20
|
+
{
|
|
21
|
+
"key": "outputPath",
|
|
22
|
+
"path": ["output", "path"],
|
|
23
|
+
"label": "Output Path",
|
|
24
|
+
"description": "Output folder for generated files",
|
|
25
|
+
"type": "text",
|
|
26
|
+
"default": "hooks"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"key": "barrel",
|
|
30
|
+
"path": ["output", "barrel"],
|
|
31
|
+
"label": "Barrel",
|
|
32
|
+
"description": "How index.ts barrel files are generated",
|
|
33
|
+
"type": "select",
|
|
34
|
+
"default": {
|
|
35
|
+
"type": "named"
|
|
36
|
+
},
|
|
37
|
+
"choices": [
|
|
38
|
+
{
|
|
39
|
+
"label": "named",
|
|
40
|
+
"value": {
|
|
41
|
+
"type": "named"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"label": "named (nested)",
|
|
46
|
+
"value": {
|
|
47
|
+
"type": "named",
|
|
48
|
+
"nested": true
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"label": "all",
|
|
53
|
+
"value": {
|
|
54
|
+
"type": "all"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"label": "all (nested)",
|
|
59
|
+
"value": {
|
|
60
|
+
"type": "all",
|
|
61
|
+
"nested": true
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"label": "false (disabled)",
|
|
66
|
+
"value": false
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"key": "outputMode",
|
|
72
|
+
"path": ["output", "mode"],
|
|
73
|
+
"label": "Output Mode",
|
|
74
|
+
"description": "How the plugin consolidates its code into files. File mode writes everything into a single file, so the output path must include a file extension and cannot be grouped.",
|
|
75
|
+
"type": "select",
|
|
76
|
+
"default": "directory",
|
|
77
|
+
"choices": [
|
|
78
|
+
{
|
|
79
|
+
"label": "directory (one file per schema)",
|
|
80
|
+
"value": "directory"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"label": "file (single file)",
|
|
84
|
+
"value": "file"
|
|
85
|
+
}
|
|
86
|
+
]
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"key": "client",
|
|
90
|
+
"path": ["client"],
|
|
91
|
+
"label": "Client",
|
|
92
|
+
"description": "HTTP client the generated hooks call. Only needed to disambiguate when both plugin-fetch and plugin-axios are enabled",
|
|
93
|
+
"type": "select",
|
|
94
|
+
"default": null,
|
|
95
|
+
"choices": [
|
|
96
|
+
{
|
|
97
|
+
"label": "auto-detect",
|
|
98
|
+
"value": null
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"label": "fetch",
|
|
102
|
+
"value": "fetch"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"label": "axios",
|
|
106
|
+
"value": "axios"
|
|
107
|
+
}
|
|
108
|
+
]
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"key": "group",
|
|
112
|
+
"path": ["group"],
|
|
113
|
+
"label": "Group",
|
|
114
|
+
"description": "Group generated operations by OpenAPI tag or path",
|
|
115
|
+
"type": "select",
|
|
116
|
+
"default": null,
|
|
117
|
+
"choices": [
|
|
118
|
+
{
|
|
119
|
+
"label": "none",
|
|
120
|
+
"value": null
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"label": "by tag",
|
|
124
|
+
"value": {
|
|
125
|
+
"type": "tag"
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"label": "by path",
|
|
130
|
+
"value": {
|
|
131
|
+
"type": "path"
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"key": "excludeTags",
|
|
138
|
+
"path": ["exclude"],
|
|
139
|
+
"label": "Exclude Tags",
|
|
140
|
+
"description": "Comma-separated OpenAPI tags to exclude from generation",
|
|
141
|
+
"type": "list",
|
|
142
|
+
"item": {
|
|
143
|
+
"type": "tag",
|
|
144
|
+
"pattern": "$item"
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"key": "includeTags",
|
|
149
|
+
"path": ["include"],
|
|
150
|
+
"label": "Include Tags",
|
|
151
|
+
"description": "Comma-separated OpenAPI tags to include. Only operations with these tags are generated",
|
|
152
|
+
"type": "list",
|
|
153
|
+
"item": {
|
|
154
|
+
"type": "tag",
|
|
155
|
+
"pattern": "$item"
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"key": "hooks",
|
|
160
|
+
"path": ["hooks"],
|
|
161
|
+
"label": "Hooks",
|
|
162
|
+
"description": "Generate use* functions instead of only queryOptions and mutation helpers",
|
|
163
|
+
"type": "boolean",
|
|
164
|
+
"default": false
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"key": "infiniteQueryParam",
|
|
168
|
+
"path": ["infinite", "queryParam"],
|
|
169
|
+
"label": "Infinite Query Param",
|
|
170
|
+
"description": "Enable infinite queries, set the pageParam key (e.g. \"id\"). Leave empty to disable.",
|
|
171
|
+
"type": "text"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"key": "queryMethods",
|
|
175
|
+
"path": ["query", "methods"],
|
|
176
|
+
"label": "Query Methods",
|
|
177
|
+
"description": "Comma-separated HTTP methods treated as queries (default: GET)",
|
|
178
|
+
"type": "list",
|
|
179
|
+
"default": ["GET"],
|
|
180
|
+
"itemCase": "upper"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"key": "queryImportPath",
|
|
184
|
+
"path": ["query", "importPath"],
|
|
185
|
+
"label": "Query Import Path",
|
|
186
|
+
"description": "Module specifier the generated query hook imports from",
|
|
187
|
+
"type": "text",
|
|
188
|
+
"default": "@tanstack/vue-query"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"key": "mutationMethods",
|
|
192
|
+
"path": ["mutation", "methods"],
|
|
193
|
+
"label": "Mutation Methods",
|
|
194
|
+
"description": "Comma-separated HTTP methods treated as mutations (default: POST, PUT, PATCH, DELETE)",
|
|
195
|
+
"type": "list",
|
|
196
|
+
"default": ["POST", "PUT", "PATCH", "DELETE"],
|
|
197
|
+
"itemCase": "upper"
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"key": "mutationImportPath",
|
|
201
|
+
"path": ["mutation", "importPath"],
|
|
202
|
+
"label": "Mutation Import Path",
|
|
203
|
+
"description": "Module specifier the generated mutation hook imports from",
|
|
204
|
+
"type": "text",
|
|
205
|
+
"default": "@tanstack/vue-query"
|
|
206
|
+
}
|
|
207
|
+
]
|
|
208
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/plugin-vue-query",
|
|
3
|
-
"version": "5.3.
|
|
3
|
+
"version": "5.3.1",
|
|
4
4
|
"description": "Generate type-safe TanStack Query (Vue Query) composables with Kubb. Covers useQuery, useMutation, useInfiniteQuery, and queryOptions with Vue 3 Composition API support.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"code-generation",
|
|
@@ -43,6 +43,8 @@
|
|
|
43
43
|
],
|
|
44
44
|
"files": [
|
|
45
45
|
"dist",
|
|
46
|
+
"kubb-extension.json",
|
|
47
|
+
"OVERVIEW.md",
|
|
46
48
|
"!/**/**.test.**",
|
|
47
49
|
"!/**/__tests__/**",
|
|
48
50
|
"!/**/__snapshots__/**"
|
|
@@ -68,26 +70,27 @@
|
|
|
68
70
|
"import": "./dist/index.js",
|
|
69
71
|
"require": "./dist/index.cjs"
|
|
70
72
|
},
|
|
71
|
-
"./package.json": "./package.json"
|
|
73
|
+
"./package.json": "./package.json",
|
|
74
|
+
"./kubb-extension.json": "./kubb-extension.json"
|
|
72
75
|
},
|
|
73
76
|
"publishConfig": {
|
|
74
77
|
"access": "public",
|
|
75
78
|
"registry": "https://registry.npmjs.org/"
|
|
76
79
|
},
|
|
77
80
|
"dependencies": {
|
|
78
|
-
"@kubb/plugin-ts": "^5.
|
|
81
|
+
"@kubb/plugin-ts": "^5.0.8"
|
|
79
82
|
},
|
|
80
83
|
"devDependencies": {
|
|
81
|
-
"@internals/client": "0.
|
|
82
|
-
"@internals/shared": "0.
|
|
83
|
-
"@internals/tanstack-query": "0.
|
|
84
|
-
"@internals/utils": "0.
|
|
84
|
+
"@internals/client": "0.0.0",
|
|
85
|
+
"@internals/shared": "0.0.0",
|
|
86
|
+
"@internals/tanstack-query": "0.0.0",
|
|
87
|
+
"@internals/utils": "0.0.0",
|
|
85
88
|
"@tanstack/vue-query": "^5.104.1",
|
|
86
|
-
"kubb": "^5.8.
|
|
89
|
+
"kubb": "^5.8.1"
|
|
87
90
|
},
|
|
88
91
|
"peerDependencies": {
|
|
89
92
|
"@tanstack/vue-query": "^5.0.0",
|
|
90
|
-
"kubb": "^5.8.
|
|
93
|
+
"kubb": "^5.8.1"
|
|
91
94
|
},
|
|
92
95
|
"peerDependenciesMeta": {
|
|
93
96
|
"@tanstack/vue-query": {
|