@kubb/plugin-swr 5.9.0-canary.20261109T201601 → 5.9.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 +561 -533
- 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 +560 -532
- package/dist/index.js.map +1 -1
- package/docs/guides/calling-operations.md +8 -6
- package/docs/options.md +4 -2
- package/docs/overview.md +4 -2
- package/kubb-extension.json +9 -6
- package/package.json +9 -8
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
|
/**
|
|
@@ -259,7 +260,7 @@ type Options = OutputOptions & {
|
|
|
259
260
|
/**
|
|
260
261
|
* Tags, operations, or paths to exclude from generation.
|
|
261
262
|
*/
|
|
262
|
-
exclude?: Array<Exclude
|
|
263
|
+
exclude?: Array<Exclude>;
|
|
263
264
|
/**
|
|
264
265
|
* Tags, operations, or paths to include in generation.
|
|
265
266
|
*/
|
|
@@ -364,5 +365,4 @@ export declare const pluginSwr: import("@kubb/kit").PluginFactory<PluginSwr>;
|
|
|
364
365
|
* ```
|
|
365
366
|
*/
|
|
366
367
|
export declare const resolverSwr: ResolverSwr;
|
|
367
|
-
export { type PluginSwr, type ResolverSwr, type Transformer, pluginSwr as default };
|
|
368
|
-
//# sourceMappingURL=index.d.cts.map
|
|
368
|
+
export { type PluginSwr, type ResolverSwr, type Transformer, pluginSwr 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
|
/**
|
|
@@ -259,7 +260,7 @@ type Options = OutputOptions & {
|
|
|
259
260
|
/**
|
|
260
261
|
* Tags, operations, or paths to exclude from generation.
|
|
261
262
|
*/
|
|
262
|
-
exclude?: Array<Exclude
|
|
263
|
+
exclude?: Array<Exclude>;
|
|
263
264
|
/**
|
|
264
265
|
* Tags, operations, or paths to include in generation.
|
|
265
266
|
*/
|
|
@@ -364,5 +365,4 @@ export declare const pluginSwr: import("@kubb/kit").PluginFactory<PluginSwr>;
|
|
|
364
365
|
* ```
|
|
365
366
|
*/
|
|
366
367
|
export declare const resolverSwr: ResolverSwr;
|
|
367
|
-
export { type PluginSwr, type ResolverSwr, type Transformer, pluginSwr as default };
|
|
368
|
-
//# sourceMappingURL=index.d.ts.map
|
|
368
|
+
export { type PluginSwr, type ResolverSwr, type Transformer, pluginSwr as default };
|