@kubb/plugin-vue-query 3.0.0-beta.3 → 3.0.0-beta.5

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.
@@ -1,7 +1,7 @@
1
1
  import { Operation } from '@kubb/oas';
2
2
  import { OperationSchemas } from '@kubb/plugin-oas';
3
3
  import { ReactNode } from 'react';
4
- import { P as PluginVueQuery, I as Infinite } from './types-FQruQAe4.cjs';
4
+ import { P as PluginVueQuery, I as Infinite } from './types-BGseXQR_.cjs';
5
5
  import { FunctionParams } from '@kubb/react';
6
6
  import '@kubb/core';
7
7
 
@@ -1,7 +1,7 @@
1
1
  import { Operation } from '@kubb/oas';
2
2
  import { OperationSchemas } from '@kubb/plugin-oas';
3
3
  import { ReactNode } from 'react';
4
- import { P as PluginVueQuery, I as Infinite } from './types-FQruQAe4.js';
4
+ import { P as PluginVueQuery, I as Infinite } from './types-BGseXQR_.js';
5
5
  import { FunctionParams } from '@kubb/react';
6
6
  import '@kubb/core';
7
7
 
@@ -1,5 +1,5 @@
1
1
  import * as _kubb_plugin_oas from '@kubb/plugin-oas';
2
- import { P as PluginVueQuery } from './types-FQruQAe4.cjs';
2
+ import { P as PluginVueQuery } from './types-BGseXQR_.cjs';
3
3
  import '@kubb/core';
4
4
  import '@kubb/oas';
5
5
 
@@ -1,5 +1,5 @@
1
1
  import * as _kubb_plugin_oas from '@kubb/plugin-oas';
2
- import { P as PluginVueQuery } from './types-FQruQAe4.js';
2
+ import { P as PluginVueQuery } from './types-BGseXQR_.js';
3
3
  import '@kubb/core';
4
4
  import '@kubb/oas';
5
5
 
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _kubb_core from '@kubb/core';
2
- import { O as Options, P as PluginVueQuery } from './types-FQruQAe4.cjs';
2
+ import { O as Options, P as PluginVueQuery } from './types-BGseXQR_.cjs';
3
3
  import '@kubb/oas';
4
4
  import '@kubb/plugin-oas';
5
5
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _kubb_core from '@kubb/core';
2
- import { O as Options, P as PluginVueQuery } from './types-FQruQAe4.js';
2
+ import { O as Options, P as PluginVueQuery } from './types-BGseXQR_.js';
3
3
  import '@kubb/oas';
4
4
  import '@kubb/plugin-oas';
5
5
 
@@ -26,7 +26,7 @@ type Options$1 = {
26
26
  override?: Array<Override<ResolvedOptions$1>>;
27
27
  /**
28
28
  * Create `operations.ts` file with all operations grouped by methods.
29
- * @default `false`
29
+ * @default false
30
30
  */
31
31
  operations?: boolean;
32
32
  /**
@@ -38,27 +38,21 @@ type Options$1 = {
38
38
  importPath?: string;
39
39
  /**
40
40
  * ReturnType that will be used when calling the client.
41
- *
42
- * `Data` will return ResponseConfig[data].
43
- *
44
- * `Full` will return ResponseConfig.
45
- * @default `'data'`
46
- * @private
41
+ * - 'data' will return ResponseConfig[data].
42
+ * - 'full' will return ResponseConfig.
43
+ * @default 'data'
47
44
  */
48
45
  dataReturnType?: 'data' | 'full';
49
46
  /**
50
47
  * How to pass your pathParams.
51
- *
52
- * `object` will return the pathParams as an object.
53
- *
54
- * `inline` will return the pathParams as comma separated params.
55
- * @default `'inline'`
56
- * @private
48
+ * - 'object' will return the pathParams as an object.
49
+ * - 'inline' will return the pathParams as comma separated params.
50
+ * @default 'inline'
57
51
  */
58
52
  pathParamsType?: 'object' | 'inline';
59
53
  /**
60
54
  * Which parser can be used before returning the data
61
- * `'zod'` will use `@kubb/plugin-zod` to parse the data.
55
+ * - 'zod' will use `@kubb/plugin-zod` to parse the data.
62
56
  * @default 'client'
63
57
  */
64
58
  parser?: 'client' | 'zod';
@@ -140,7 +134,8 @@ type Infinite = {
140
134
  };
141
135
  type Options = {
142
136
  /**
143
- * @default 'hooks'
137
+ * Specify the export location for the files and define the behavior of the output
138
+ * @default { path: 'hooks', barrelType: 'named' }
144
139
  */
145
140
  output?: Output;
146
141
  /**
@@ -148,15 +143,6 @@ type Options = {
148
143
  */
149
144
  group?: Group;
150
145
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
151
- /**
152
- * ReturnType that needs to be used when calling client().
153
- *
154
- * `Data` will return ResponseConfig[data].
155
- *
156
- * `Full` will return ResponseConfig.
157
- * @default `'data'`
158
- * @private
159
- */
160
146
  /**
161
147
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
162
148
  */
@@ -171,12 +157,9 @@ type Options = {
171
157
  override?: Array<Override<ResolvedOptions>>;
172
158
  /**
173
159
  * How to pass your pathParams.
174
- *
175
- * `object` will return the pathParams as an object.
176
- *
177
- * `inline` will return the pathParams as comma separated params.
178
- * @default `'inline'`
179
- * @private
160
+ * - 'object' will return the pathParams as an object.
161
+ * - 'inline' will return the pathParams as comma separated params.
162
+ * @default 'inline'
180
163
  */
181
164
  pathParamsType?: PluginClient['options']['pathParamsType'];
182
165
  /**
@@ -26,7 +26,7 @@ type Options$1 = {
26
26
  override?: Array<Override<ResolvedOptions$1>>;
27
27
  /**
28
28
  * Create `operations.ts` file with all operations grouped by methods.
29
- * @default `false`
29
+ * @default false
30
30
  */
31
31
  operations?: boolean;
32
32
  /**
@@ -38,27 +38,21 @@ type Options$1 = {
38
38
  importPath?: string;
39
39
  /**
40
40
  * ReturnType that will be used when calling the client.
41
- *
42
- * `Data` will return ResponseConfig[data].
43
- *
44
- * `Full` will return ResponseConfig.
45
- * @default `'data'`
46
- * @private
41
+ * - 'data' will return ResponseConfig[data].
42
+ * - 'full' will return ResponseConfig.
43
+ * @default 'data'
47
44
  */
48
45
  dataReturnType?: 'data' | 'full';
49
46
  /**
50
47
  * How to pass your pathParams.
51
- *
52
- * `object` will return the pathParams as an object.
53
- *
54
- * `inline` will return the pathParams as comma separated params.
55
- * @default `'inline'`
56
- * @private
48
+ * - 'object' will return the pathParams as an object.
49
+ * - 'inline' will return the pathParams as comma separated params.
50
+ * @default 'inline'
57
51
  */
58
52
  pathParamsType?: 'object' | 'inline';
59
53
  /**
60
54
  * Which parser can be used before returning the data
61
- * `'zod'` will use `@kubb/plugin-zod` to parse the data.
55
+ * - 'zod' will use `@kubb/plugin-zod` to parse the data.
62
56
  * @default 'client'
63
57
  */
64
58
  parser?: 'client' | 'zod';
@@ -140,7 +134,8 @@ type Infinite = {
140
134
  };
141
135
  type Options = {
142
136
  /**
143
- * @default 'hooks'
137
+ * Specify the export location for the files and define the behavior of the output
138
+ * @default { path: 'hooks', barrelType: 'named' }
144
139
  */
145
140
  output?: Output;
146
141
  /**
@@ -148,15 +143,6 @@ type Options = {
148
143
  */
149
144
  group?: Group;
150
145
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
151
- /**
152
- * ReturnType that needs to be used when calling client().
153
- *
154
- * `Data` will return ResponseConfig[data].
155
- *
156
- * `Full` will return ResponseConfig.
157
- * @default `'data'`
158
- * @private
159
- */
160
146
  /**
161
147
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
162
148
  */
@@ -171,12 +157,9 @@ type Options = {
171
157
  override?: Array<Override<ResolvedOptions>>;
172
158
  /**
173
159
  * How to pass your pathParams.
174
- *
175
- * `object` will return the pathParams as an object.
176
- *
177
- * `inline` will return the pathParams as comma separated params.
178
- * @default `'inline'`
179
- * @private
160
+ * - 'object' will return the pathParams as an object.
161
+ * - 'inline' will return the pathParams as comma separated params.
162
+ * @default 'inline'
180
163
  */
181
164
  pathParamsType?: PluginClient['options']['pathParamsType'];
182
165
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/plugin-vue-query",
3
- "version": "3.0.0-beta.3",
3
+ "version": "3.0.0-beta.5",
4
4
  "description": "Generator vue-query hooks",
5
5
  "keywords": [
6
6
  "faker",
@@ -62,24 +62,24 @@
62
62
  "!/**/__tests__/**"
63
63
  ],
64
64
  "dependencies": {
65
- "@kubb/core": "3.0.0-beta.3",
66
- "@kubb/fs": "3.0.0-beta.3",
67
- "@kubb/oas": "3.0.0-beta.3",
68
- "@kubb/plugin-oas": "3.0.0-beta.3",
69
- "@kubb/plugin-ts": "3.0.0-beta.3",
70
- "@kubb/plugin-zod": "3.0.0-beta.3",
71
- "@kubb/react": "3.0.0-beta.3"
65
+ "@kubb/core": "3.0.0-beta.5",
66
+ "@kubb/fs": "3.0.0-beta.5",
67
+ "@kubb/oas": "3.0.0-beta.5",
68
+ "@kubb/plugin-oas": "3.0.0-beta.5",
69
+ "@kubb/plugin-ts": "3.0.0-beta.5",
70
+ "@kubb/plugin-zod": "3.0.0-beta.5",
71
+ "@kubb/react": "3.0.0-beta.5"
72
72
  },
73
73
  "devDependencies": {
74
74
  "@types/react": "^18.3.11",
75
75
  "react": "^18.3.1",
76
76
  "tsup": "^8.3.0",
77
77
  "typescript": "^5.6.2",
78
- "@kubb/config-ts": "3.0.0-beta.3",
79
- "@kubb/config-tsup": "3.0.0-beta.3"
78
+ "@kubb/config-ts": "3.0.0-beta.5",
79
+ "@kubb/config-tsup": "3.0.0-beta.5"
80
80
  },
81
81
  "peerDependencies": {
82
- "@kubb/react": "3.0.0-beta.3"
82
+ "@kubb/react": "3.0.0-beta.5"
83
83
  },
84
84
  "engines": {
85
85
  "node": ">=20"
package/src/types.ts CHANGED
@@ -63,7 +63,8 @@ export type Infinite = {
63
63
 
64
64
  export type Options = {
65
65
  /**
66
- * @default 'hooks'
66
+ * Specify the export location for the files and define the behavior of the output
67
+ * @default { path: 'hooks', barrelType: 'named' }
67
68
  */
68
69
  output?: Output
69
70
  /**
@@ -72,16 +73,6 @@ export type Options = {
72
73
  group?: Group
73
74
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>
74
75
 
75
- /**
76
- * ReturnType that needs to be used when calling client().
77
- *
78
- * `Data` will return ResponseConfig[data].
79
- *
80
- * `Full` will return ResponseConfig.
81
- * @default `'data'`
82
- * @private
83
- */
84
-
85
76
  /**
86
77
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
87
78
  */
@@ -96,12 +87,9 @@ export type Options = {
96
87
  override?: Array<Override<ResolvedOptions>>
97
88
  /**
98
89
  * How to pass your pathParams.
99
- *
100
- * `object` will return the pathParams as an object.
101
- *
102
- * `inline` will return the pathParams as comma separated params.
103
- * @default `'inline'`
104
- * @private
90
+ * - 'object' will return the pathParams as an object.
91
+ * - 'inline' will return the pathParams as comma separated params.
92
+ * @default 'inline'
105
93
  */
106
94
  pathParamsType?: PluginClient['options']['pathParamsType']
107
95
  /**