@kubb/plugin-svelte-query 3.0.0-beta.3 → 3.0.0-beta.4

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 PluginSvelteQuery } from './types-DJAXpPpT.cjs';
4
+ import { P as PluginSvelteQuery } from './types-CvXX_phR.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 PluginSvelteQuery } from './types-DJAXpPpT.js';
4
+ import { P as PluginSvelteQuery } from './types-CvXX_phR.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 PluginSvelteQuery } from './types-DJAXpPpT.cjs';
2
+ import { P as PluginSvelteQuery } from './types-CvXX_phR.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 PluginSvelteQuery } from './types-DJAXpPpT.js';
2
+ import { P as PluginSvelteQuery } from './types-CvXX_phR.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 PluginSvelteQuery } from './types-DJAXpPpT.cjs';
2
+ import { O as Options, P as PluginSvelteQuery } from './types-CvXX_phR.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 PluginSvelteQuery } from './types-DJAXpPpT.js';
2
+ import { O as Options, P as PluginSvelteQuery } from './types-CvXX_phR.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';
@@ -124,7 +118,8 @@ type Mutation = {
124
118
  };
125
119
  type Options = {
126
120
  /**
127
- * @default 'hooks'
121
+ * Specify the export location for the files and define the behavior of the output
122
+ * @default { path: 'hooks', barrelType: 'named' }
128
123
  */
129
124
  output?: Output;
130
125
  /**
@@ -132,15 +127,6 @@ type Options = {
132
127
  */
133
128
  group?: Group;
134
129
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
135
- /**
136
- * ReturnType that needs to be used when calling client().
137
- *
138
- * `Data` will return ResponseConfig[data].
139
- *
140
- * `Full` will return ResponseConfig.
141
- * @default `'data'`
142
- * @private
143
- */
144
130
  /**
145
131
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
146
132
  */
@@ -155,12 +141,9 @@ type Options = {
155
141
  override?: Array<Override<ResolvedOptions>>;
156
142
  /**
157
143
  * How to pass your pathParams.
158
- *
159
- * `object` will return the pathParams as an object.
160
- *
161
- * `inline` will return the pathParams as comma separated params.
162
- * @default `'inline'`
163
- * @private
144
+ * - 'object' will return the pathParams as an object.
145
+ * - 'inline' will return the pathParams as comma separated params.
146
+ * @default 'inline'
164
147
  */
165
148
  pathParamsType?: PluginClient['options']['pathParamsType'];
166
149
  /**
@@ -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';
@@ -124,7 +118,8 @@ type Mutation = {
124
118
  };
125
119
  type Options = {
126
120
  /**
127
- * @default 'hooks'
121
+ * Specify the export location for the files and define the behavior of the output
122
+ * @default { path: 'hooks', barrelType: 'named' }
128
123
  */
129
124
  output?: Output;
130
125
  /**
@@ -132,15 +127,6 @@ type Options = {
132
127
  */
133
128
  group?: Group;
134
129
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
135
- /**
136
- * ReturnType that needs to be used when calling client().
137
- *
138
- * `Data` will return ResponseConfig[data].
139
- *
140
- * `Full` will return ResponseConfig.
141
- * @default `'data'`
142
- * @private
143
- */
144
130
  /**
145
131
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
146
132
  */
@@ -155,12 +141,9 @@ type Options = {
155
141
  override?: Array<Override<ResolvedOptions>>;
156
142
  /**
157
143
  * How to pass your pathParams.
158
- *
159
- * `object` will return the pathParams as an object.
160
- *
161
- * `inline` will return the pathParams as comma separated params.
162
- * @default `'inline'`
163
- * @private
144
+ * - 'object' will return the pathParams as an object.
145
+ * - 'inline' will return the pathParams as comma separated params.
146
+ * @default 'inline'
164
147
  */
165
148
  pathParamsType?: PluginClient['options']['pathParamsType'];
166
149
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/plugin-svelte-query",
3
- "version": "3.0.0-beta.3",
3
+ "version": "3.0.0-beta.4",
4
4
  "description": "Generator svelte-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.4",
66
+ "@kubb/fs": "3.0.0-beta.4",
67
+ "@kubb/oas": "3.0.0-beta.4",
68
+ "@kubb/plugin-oas": "3.0.0-beta.4",
69
+ "@kubb/plugin-ts": "3.0.0-beta.4",
70
+ "@kubb/plugin-zod": "3.0.0-beta.4",
71
+ "@kubb/react": "3.0.0-beta.4"
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.4",
79
+ "@kubb/config-tsup": "3.0.0-beta.4"
80
80
  },
81
81
  "peerDependencies": {
82
- "@kubb/react": "3.0.0-beta.3"
82
+ "@kubb/react": "3.0.0-beta.4"
83
83
  },
84
84
  "engines": {
85
85
  "node": ">=20"
package/src/types.ts CHANGED
@@ -46,7 +46,8 @@ type Mutation = {
46
46
 
47
47
  export type Options = {
48
48
  /**
49
- * @default 'hooks'
49
+ * Specify the export location for the files and define the behavior of the output
50
+ * @default { path: 'hooks', barrelType: 'named' }
50
51
  */
51
52
  output?: Output
52
53
  /**
@@ -56,16 +57,6 @@ export type Options = {
56
57
 
57
58
  client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>
58
59
 
59
- /**
60
- * ReturnType that needs to be used when calling client().
61
- *
62
- * `Data` will return ResponseConfig[data].
63
- *
64
- * `Full` will return ResponseConfig.
65
- * @default `'data'`
66
- * @private
67
- */
68
-
69
60
  /**
70
61
  * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
71
62
  */
@@ -80,12 +71,9 @@ export type Options = {
80
71
  override?: Array<Override<ResolvedOptions>>
81
72
  /**
82
73
  * How to pass your pathParams.
83
- *
84
- * `object` will return the pathParams as an object.
85
- *
86
- * `inline` will return the pathParams as comma separated params.
87
- * @default `'inline'`
88
- * @private
74
+ * - 'object' will return the pathParams as an object.
75
+ * - 'inline' will return the pathParams as comma separated params.
76
+ * @default 'inline'
89
77
  */
90
78
  pathParamsType?: PluginClient['options']['pathParamsType']
91
79
  /**