@kubb/plugin-react-query 5.10.0-canary.20261109T201601 → 5.10.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/dist/index.cjs +607 -570
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +9 -9
- package/dist/index.d.ts +9 -9
- package/dist/index.js +606 -569
- package/dist/index.js.map +1 -1
- package/docs/guides/calling-operations.md +9 -7
- package/docs/options.md +38 -20
- package/docs/overview.md +5 -3
- package/kubb-extension.json +9 -6
- package/package.json +10 -9
package/dist/index.d.cts
CHANGED
|
@@ -1,8 +1,5 @@
|
|
|
1
|
-
import { Exclude
|
|
2
|
-
import "@kubb/plugin-zod";
|
|
1
|
+
import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "@kubb/kit";
|
|
3
2
|
import { ResolverTs } from "@kubb/plugin-ts";
|
|
4
|
-
import "@kubb/renderer-jsx";
|
|
5
|
-
import "@kubb/adapter-oas";
|
|
6
3
|
/**
|
|
7
4
|
* The client selector accepted by a consumer's `client` option. Each calls a registered contract
|
|
8
5
|
* client plugin.
|
|
@@ -18,8 +15,8 @@ type ResolvedContractClient = {
|
|
|
18
15
|
pluginName: string;
|
|
19
16
|
};
|
|
20
17
|
/**
|
|
21
|
-
* The
|
|
22
|
-
*
|
|
18
|
+
* The per-operation type names a generated client references: the grouped input, the per-status
|
|
19
|
+
* responses record its `RequestResult` is keyed on, and the headers each response declares.
|
|
23
20
|
*/
|
|
24
21
|
type OperationTypeNames = {
|
|
25
22
|
response: {
|
|
@@ -31,6 +28,10 @@ type OperationTypeNames = {
|
|
|
31
28
|
* Resolves the name of the operation's per-status responses record type.
|
|
32
29
|
*/
|
|
33
30
|
responses(node: ast.OperationNode): string;
|
|
31
|
+
/**
|
|
32
|
+
* Resolves the name of the type of the headers one response declares. Left out, results keep untyped headers.
|
|
33
|
+
*/
|
|
34
|
+
headers?(node: ast.OperationNode, statusCode: ast.StatusCode): string;
|
|
34
35
|
};
|
|
35
36
|
};
|
|
36
37
|
/**
|
|
@@ -433,7 +434,7 @@ type Options = OutputOptions & {
|
|
|
433
434
|
/**
|
|
434
435
|
* Skip operations matching at least one entry in the list.
|
|
435
436
|
*/
|
|
436
|
-
exclude?: Array<Exclude
|
|
437
|
+
exclude?: Array<Exclude>;
|
|
437
438
|
/**
|
|
438
439
|
* Restrict generation to operations matching at least one entry in the list.
|
|
439
440
|
*/
|
|
@@ -590,5 +591,4 @@ export declare const pluginReactQuery: import("@kubb/kit").PluginFactory<PluginR
|
|
|
590
591
|
* ```
|
|
591
592
|
*/
|
|
592
593
|
export declare const resolverReactQuery: ResolverReactQuery;
|
|
593
|
-
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|
|
594
|
-
//# sourceMappingURL=index.d.cts.map
|
|
594
|
+
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,5 @@
|
|
|
1
|
-
import { Exclude
|
|
2
|
-
import "@kubb/plugin-zod";
|
|
1
|
+
import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "@kubb/kit";
|
|
3
2
|
import { ResolverTs } from "@kubb/plugin-ts";
|
|
4
|
-
import "@kubb/renderer-jsx";
|
|
5
|
-
import "@kubb/adapter-oas";
|
|
6
3
|
/**
|
|
7
4
|
* The client selector accepted by a consumer's `client` option. Each calls a registered contract
|
|
8
5
|
* client plugin.
|
|
@@ -18,8 +15,8 @@ type ResolvedContractClient = {
|
|
|
18
15
|
pluginName: string;
|
|
19
16
|
};
|
|
20
17
|
/**
|
|
21
|
-
* The
|
|
22
|
-
*
|
|
18
|
+
* The per-operation type names a generated client references: the grouped input, the per-status
|
|
19
|
+
* responses record its `RequestResult` is keyed on, and the headers each response declares.
|
|
23
20
|
*/
|
|
24
21
|
type OperationTypeNames = {
|
|
25
22
|
response: {
|
|
@@ -31,6 +28,10 @@ type OperationTypeNames = {
|
|
|
31
28
|
* Resolves the name of the operation's per-status responses record type.
|
|
32
29
|
*/
|
|
33
30
|
responses(node: ast.OperationNode): string;
|
|
31
|
+
/**
|
|
32
|
+
* Resolves the name of the type of the headers one response declares. Left out, results keep untyped headers.
|
|
33
|
+
*/
|
|
34
|
+
headers?(node: ast.OperationNode, statusCode: ast.StatusCode): string;
|
|
34
35
|
};
|
|
35
36
|
};
|
|
36
37
|
/**
|
|
@@ -433,7 +434,7 @@ type Options = OutputOptions & {
|
|
|
433
434
|
/**
|
|
434
435
|
* Skip operations matching at least one entry in the list.
|
|
435
436
|
*/
|
|
436
|
-
exclude?: Array<Exclude
|
|
437
|
+
exclude?: Array<Exclude>;
|
|
437
438
|
/**
|
|
438
439
|
* Restrict generation to operations matching at least one entry in the list.
|
|
439
440
|
*/
|
|
@@ -590,5 +591,4 @@ export declare const pluginReactQuery: import("@kubb/kit").PluginFactory<PluginR
|
|
|
590
591
|
* ```
|
|
591
592
|
*/
|
|
592
593
|
export declare const resolverReactQuery: ResolverReactQuery;
|
|
593
|
-
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|
|
594
|
-
//# sourceMappingURL=index.d.ts.map
|
|
594
|
+
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|