@artinet/sdk 0.5.16 → 0.5.18
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/README.md +108 -58
- package/dist/browser/browser.d.ts +9 -0
- package/dist/browser/browser.js +10 -0
- package/dist/browser/client/a2a-client.d.ts +126 -0
- package/dist/browser/client/a2a-client.js +221 -0
- package/dist/browser/client/index.d.ts +1 -0
- package/dist/browser/client/index.js +1 -0
- package/dist/browser/services/a2a/helpers/message-builder.d.ts +12 -0
- package/dist/browser/services/a2a/helpers/message-builder.js +61 -0
- package/dist/browser/transport/rpc/parser.d.ts +15 -0
- package/dist/browser/transport/rpc/parser.js +48 -0
- package/dist/browser/transport/rpc/rpc-client.d.ts +80 -0
- package/dist/browser/transport/rpc/rpc-client.js +189 -0
- package/dist/browser/transport/streaming/event-stream.d.ts +25 -0
- package/dist/browser/transport/streaming/event-stream.js +99 -0
- package/dist/browser/types/ext.d.ts +13 -0
- package/dist/browser/types/ext.js +10 -0
- package/dist/browser/types/index.d.ts +4 -0
- package/dist/browser/types/index.js +4 -0
- package/dist/browser/types/interfaces/client.d.ts +135 -0
- package/dist/browser/types/interfaces/client.js +5 -0
- package/dist/browser/types/interfaces/index.d.ts +3 -0
- package/dist/browser/types/interfaces/index.js +3 -0
- package/dist/browser/types/interfaces/services/a2a/builder.d.ts +37 -0
- package/dist/browser/types/interfaces/services/a2a/builder.js +5 -0
- package/dist/browser/types/interfaces/services/a2a/context.d.ts +162 -0
- package/dist/browser/types/interfaces/services/a2a/context.js +5 -0
- package/dist/browser/types/interfaces/services/a2a/engine.d.ts +7 -0
- package/dist/browser/types/interfaces/services/a2a/engine.js +5 -0
- package/dist/browser/types/interfaces/services/a2a/index.d.ts +5 -0
- package/dist/browser/types/interfaces/services/a2a/index.js +5 -0
- package/dist/browser/types/interfaces/services/a2a/legacy.d.ts +93 -0
- package/dist/browser/types/interfaces/services/a2a/legacy.js +5 -0
- package/dist/browser/types/interfaces/services/a2a/service.d.ts +413 -0
- package/dist/browser/types/interfaces/services/a2a/service.js +5 -0
- package/dist/browser/types/interfaces/services/core/context/command.d.ts +25 -0
- package/dist/browser/types/interfaces/services/core/context/command.js +5 -0
- package/dist/browser/types/interfaces/services/core/context/context.d.ts +207 -0
- package/dist/browser/types/interfaces/services/core/context/context.js +5 -0
- package/dist/browser/types/interfaces/services/core/context/index.d.ts +3 -0
- package/dist/browser/types/interfaces/services/core/context/index.js +3 -0
- package/dist/browser/types/interfaces/services/core/context/types.d.ts +11 -0
- package/dist/browser/types/interfaces/services/core/context/types.js +5 -0
- package/dist/browser/types/interfaces/services/core/execution/engine.d.ts +106 -0
- package/dist/browser/types/interfaces/services/core/execution/engine.js +5 -0
- package/dist/browser/types/interfaces/services/core/execution/environment.d.ts +11 -0
- package/dist/browser/types/interfaces/services/core/execution/environment.js +5 -0
- package/dist/browser/types/interfaces/services/core/execution/execute.d.ts +7 -0
- package/dist/browser/types/interfaces/services/core/execution/execute.js +5 -0
- package/dist/browser/types/interfaces/services/core/execution/index.d.ts +3 -0
- package/dist/browser/types/interfaces/services/core/execution/index.js +3 -0
- package/dist/browser/types/interfaces/services/core/index.d.ts +4 -0
- package/dist/browser/types/interfaces/services/core/index.js +4 -0
- package/dist/browser/types/interfaces/services/core/managers/cancellation.d.ts +9 -0
- package/dist/browser/types/interfaces/services/core/managers/cancellation.js +5 -0
- package/dist/browser/types/interfaces/services/core/managers/connection.d.ts +9 -0
- package/dist/browser/types/interfaces/services/core/managers/connection.js +5 -0
- package/dist/browser/types/interfaces/services/core/managers/context.d.ts +17 -0
- package/dist/browser/types/interfaces/services/core/managers/context.js +5 -0
- package/dist/browser/types/interfaces/services/core/managers/event.d.ts +328 -0
- package/dist/browser/types/interfaces/services/core/managers/event.js +5 -0
- package/dist/browser/types/interfaces/services/core/managers/index.d.ts +6 -0
- package/dist/browser/types/interfaces/services/core/managers/index.js +6 -0
- package/dist/browser/types/interfaces/services/core/managers/stream.d.ts +217 -0
- package/dist/browser/types/interfaces/services/core/managers/stream.js +5 -0
- package/dist/browser/types/interfaces/services/core/managers/task.d.ts +9 -0
- package/dist/browser/types/interfaces/services/core/managers/task.js +1 -0
- package/dist/browser/types/interfaces/services/core/service.d.ts +115 -0
- package/dist/browser/types/interfaces/services/core/service.js +5 -0
- package/dist/browser/types/interfaces/services/index.d.ts +4 -0
- package/dist/browser/types/interfaces/services/index.js +4 -0
- package/dist/browser/types/interfaces/services/mcp/index.d.ts +1 -0
- package/dist/browser/types/interfaces/services/mcp/index.js +1 -0
- package/dist/browser/types/interfaces/services/mcp/service.d.ts +49 -0
- package/dist/browser/types/interfaces/services/mcp/service.js +5 -0
- package/dist/browser/types/interfaces/services/protocol.d.ts +33 -0
- package/dist/browser/types/interfaces/services/protocol.js +34 -0
- package/dist/browser/types/interfaces/storage.d.ts +8 -0
- package/dist/browser/types/interfaces/storage.js +5 -0
- package/dist/browser/types/schemas/a2a/agent.d.ts +2583 -0
- package/dist/browser/types/schemas/a2a/agent.js +323 -0
- package/dist/browser/types/schemas/a2a/auth.d.ts +908 -0
- package/dist/browser/types/schemas/a2a/auth.js +283 -0
- package/dist/browser/types/schemas/a2a/error.d.ts +396 -0
- package/dist/browser/types/schemas/a2a/error.js +163 -0
- package/dist/browser/types/schemas/a2a/index.d.ts +11 -0
- package/dist/browser/types/schemas/a2a/index.js +11 -0
- package/dist/browser/types/schemas/a2a/kind.d.ts +11 -0
- package/dist/browser/types/schemas/a2a/kind.js +20 -0
- package/dist/browser/types/schemas/a2a/message.d.ts +10343 -0
- package/dist/browser/types/schemas/a2a/message.js +130 -0
- package/dist/browser/types/schemas/a2a/notification.d.ts +1517 -0
- package/dist/browser/types/schemas/a2a/notification.js +203 -0
- package/dist/browser/types/schemas/a2a/parameters.d.ts +956 -0
- package/dist/browser/types/schemas/a2a/parameters.js +241 -0
- package/dist/browser/types/schemas/a2a/protocol.d.ts +14363 -0
- package/dist/browser/types/schemas/a2a/protocol.js +59 -0
- package/dist/browser/types/schemas/a2a/rpc.d.ts +182 -0
- package/dist/browser/types/schemas/a2a/rpc.js +126 -0
- package/dist/browser/types/schemas/a2a/task.d.ts +5886 -0
- package/dist/browser/types/schemas/a2a/task.js +134 -0
- package/dist/browser/types/schemas/a2a/transport.d.ts +31 -0
- package/dist/browser/types/schemas/a2a/transport.js +28 -0
- package/dist/browser/types/schemas/index.d.ts +1 -0
- package/dist/browser/types/schemas/index.js +1 -0
- package/dist/browser/types/utils/index.d.ts +1 -0
- package/dist/browser/types/utils/index.js +1 -0
- package/dist/browser/types/utils/transform.d.ts +64 -0
- package/dist/browser/types/utils/transform.js +35 -0
- package/dist/browser/utils/common/constants.d.ts +11 -0
- package/dist/browser/utils/common/constants.js +38 -0
- package/dist/browser/utils/common/errors.d.ts +24 -0
- package/dist/browser/utils/common/errors.js +42 -0
- package/dist/browser/utils/common/utils.d.ts +9 -0
- package/dist/browser/utils/common/utils.js +11 -0
- package/dist/browser/utils/logging/index.d.ts +2 -0
- package/dist/browser/utils/logging/index.js +2 -0
- package/dist/browser/utils/logging/log.d.ts +33 -0
- package/dist/browser/utils/logging/log.js +75 -0
- package/dist/browser/utils/logging/logger.d.ts +18 -0
- package/dist/browser/utils/logging/logger.js +18 -0
- package/dist/client/a2a-client.d.ts +2 -1
- package/dist/client/a2a-client.js +13 -4
- package/dist/server/express/errors.js +1 -1
- package/dist/server/express/middeware.d.ts +2 -2
- package/dist/server/express/middeware.js +26 -6
- package/dist/server/express/server.d.ts +26 -25
- package/dist/server/express/server.js +32 -6
- package/dist/services/a2a/factory/builder.d.ts +24 -24
- package/dist/services/a2a/factory/builder.js +6 -1
- package/dist/services/a2a/factory/service.js +2 -1
- package/dist/services/a2a/helpers/agentcard-builder.d.ts +7 -0
- package/dist/services/a2a/helpers/agentcard-builder.js +23 -0
- package/dist/services/a2a/helpers/history.d.ts +2 -0
- package/dist/services/a2a/helpers/history.js +3 -0
- package/dist/services/a2a/helpers/index.d.ts +3 -0
- package/dist/services/a2a/helpers/index.js +3 -0
- package/dist/services/a2a/methods/get-task.d.ts +46 -46
- package/dist/services/a2a/methods/get-task.js +2 -0
- package/dist/services/a2a/methods/send-message.js +18 -1
- package/dist/services/a2a/service.d.ts +154 -153
- package/dist/services/a2a/service.js +20 -6
- package/dist/services/mcp/service.js +0 -1
- package/dist/transport/rpc/parser.js +2 -2
- package/dist/transport/rpc/rpc-client.js +2 -2
- package/dist/transport/trpc/a2a/factory/router.d.ts +1084 -1084
- package/dist/transport/trpc/a2a/routes/info.d.ts +36 -36
- package/dist/transport/trpc/a2a/routes/message/route.d.ts +225 -225
- package/dist/transport/trpc/a2a/routes/tasks/route.d.ts +257 -257
- package/dist/transport/trpc/a2a/trpc.d.ts +120 -120
- package/dist/types/interfaces/services/a2a/service.d.ts +6 -1
- package/dist/types/schemas/a2a/agent.d.ts +818 -818
- package/dist/types/schemas/a2a/agent.js +1 -23
- package/dist/types/schemas/a2a/auth.d.ts +197 -197
- package/dist/types/schemas/a2a/auth.js +4 -19
- package/dist/types/schemas/a2a/error.d.ts +24 -24
- package/dist/types/schemas/a2a/message.d.ts +4499 -4499
- package/dist/types/schemas/a2a/message.js +2 -10
- package/dist/types/schemas/a2a/notification.d.ts +403 -403
- package/dist/types/schemas/a2a/notification.js +3 -7
- package/dist/types/schemas/a2a/parameters.d.ts +264 -264
- package/dist/types/schemas/a2a/parameters.js +1 -14
- package/dist/types/schemas/a2a/protocol.d.ts +5988 -5988
- package/dist/types/schemas/a2a/rpc.d.ts +20 -20
- package/dist/types/schemas/a2a/rpc.js +0 -5
- package/dist/types/schemas/a2a/task.d.ts +2513 -2513
- package/dist/types/schemas/a2a/task.js +10 -11
- package/dist/utils/common/constants.js +1 -1
- package/dist/utils/common/errors.d.ts +2 -1
- package/dist/utils/common/errors.js +2 -1
- package/dist/utils/common/schema-validation.d.ts +2 -0
- package/dist/utils/common/schema-validation.js +12 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +1 -0
- package/package.json +20 -17
|
@@ -0,0 +1,908 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright 2025 The Artinet Project
|
|
3
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
*/
|
|
5
|
+
import { z } from "zod";
|
|
6
|
+
/**
|
|
7
|
+
* @description Type of a security scheme.
|
|
8
|
+
*/
|
|
9
|
+
export declare const SecuritySchemeTypeSchema: z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>;
|
|
10
|
+
export declare const SecuritySchemeType: z.Values<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>;
|
|
11
|
+
export type SecuritySchemeType = z.infer<typeof SecuritySchemeTypeSchema>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Base properties shared by all security schemes.
|
|
14
|
+
*/
|
|
15
|
+
export declare const SecuritySchemeBaseSchema: z.ZodObject<{
|
|
16
|
+
/**
|
|
17
|
+
* @required Type of the security scheme.
|
|
18
|
+
*/
|
|
19
|
+
type: z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>;
|
|
20
|
+
/**
|
|
21
|
+
* @optional Description of this security scheme.
|
|
22
|
+
*/
|
|
23
|
+
description: z.ZodOptional<z.ZodString>;
|
|
24
|
+
}, "strip", z.ZodTypeAny, {
|
|
25
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
26
|
+
description?: string | undefined;
|
|
27
|
+
}, {
|
|
28
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
29
|
+
description?: string | undefined;
|
|
30
|
+
}>;
|
|
31
|
+
export type SecuritySchemeBase = z.infer<typeof SecuritySchemeBaseSchema>;
|
|
32
|
+
/**
|
|
33
|
+
* @description Defines a security scheme using an API key.
|
|
34
|
+
*/
|
|
35
|
+
export declare const APIKeySecuritySchemeSchema: z.ZodObject<{
|
|
36
|
+
description: z.ZodOptional<z.ZodString>;
|
|
37
|
+
} & {
|
|
38
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "apiKey", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
39
|
+
in: z.ZodEnum<["query", "header", "cookie"]>;
|
|
40
|
+
name: z.ZodString;
|
|
41
|
+
}, "strip", z.ZodTypeAny, {
|
|
42
|
+
type: "apiKey";
|
|
43
|
+
in: "query" | "header" | "cookie";
|
|
44
|
+
name: string;
|
|
45
|
+
description?: string | undefined;
|
|
46
|
+
}, {
|
|
47
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
48
|
+
in: "query" | "header" | "cookie";
|
|
49
|
+
name: string;
|
|
50
|
+
description?: string | undefined;
|
|
51
|
+
}>;
|
|
52
|
+
export type APIKeySecurityScheme = z.infer<typeof APIKeySecuritySchemeSchema>;
|
|
53
|
+
/**
|
|
54
|
+
* @description HTTP Authentication security scheme.
|
|
55
|
+
*/
|
|
56
|
+
export declare const HTTPAuthSecuritySchemeSchema: z.ZodObject<{
|
|
57
|
+
description: z.ZodOptional<z.ZodString>;
|
|
58
|
+
} & {
|
|
59
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "http", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
60
|
+
scheme: z.ZodString;
|
|
61
|
+
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
62
|
+
}, "strip", z.ZodTypeAny, {
|
|
63
|
+
type: "http";
|
|
64
|
+
scheme: string;
|
|
65
|
+
description?: string | undefined;
|
|
66
|
+
bearerFormat?: string | undefined;
|
|
67
|
+
}, {
|
|
68
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
69
|
+
scheme: string;
|
|
70
|
+
description?: string | undefined;
|
|
71
|
+
bearerFormat?: string | undefined;
|
|
72
|
+
}>;
|
|
73
|
+
export type HTTPAuthSecurityScheme = z.infer<typeof HTTPAuthSecuritySchemeSchema>;
|
|
74
|
+
/**
|
|
75
|
+
* @description Configuration details for a supported Authorization Code OAuth Flow
|
|
76
|
+
*/
|
|
77
|
+
export declare const AuthorizationCodeOAuthFlowSchema: z.ZodObject<{
|
|
78
|
+
/**
|
|
79
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
80
|
+
* standard requires the use of TLS
|
|
81
|
+
*/
|
|
82
|
+
authorizationUrl: z.ZodString;
|
|
83
|
+
/**
|
|
84
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
85
|
+
* requires the use of TLS.
|
|
86
|
+
*/
|
|
87
|
+
tokenUrl: z.ZodString;
|
|
88
|
+
/**
|
|
89
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
90
|
+
* standard requires the use of TLS.
|
|
91
|
+
*/
|
|
92
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
93
|
+
/**
|
|
94
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
95
|
+
* description for it. The map MAY be empty.
|
|
96
|
+
*/
|
|
97
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
98
|
+
}, "strip", z.ZodTypeAny, {
|
|
99
|
+
authorizationUrl: string;
|
|
100
|
+
tokenUrl: string;
|
|
101
|
+
scopes: Record<string, string>;
|
|
102
|
+
refreshUrl?: string | undefined;
|
|
103
|
+
}, {
|
|
104
|
+
authorizationUrl: string;
|
|
105
|
+
tokenUrl: string;
|
|
106
|
+
scopes: Record<string, string>;
|
|
107
|
+
refreshUrl?: string | undefined;
|
|
108
|
+
}>;
|
|
109
|
+
export type AuthorizationCodeOAuthFlow = z.infer<typeof AuthorizationCodeOAuthFlowSchema>;
|
|
110
|
+
/**
|
|
111
|
+
* @description Configuration details for a supported Client Credentials OAuth Flow
|
|
112
|
+
*/
|
|
113
|
+
export declare const ClientCredentialsOAuthFlowSchema: z.ZodObject<{
|
|
114
|
+
/**
|
|
115
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
116
|
+
* requires the use of TLS.
|
|
117
|
+
*/
|
|
118
|
+
tokenUrl: z.ZodString;
|
|
119
|
+
/**
|
|
120
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
121
|
+
* standard requires the use of TLS.
|
|
122
|
+
*/
|
|
123
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
124
|
+
/**
|
|
125
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
126
|
+
* description for it. The map MAY be empty.
|
|
127
|
+
*/
|
|
128
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
129
|
+
}, "strip", z.ZodTypeAny, {
|
|
130
|
+
tokenUrl: string;
|
|
131
|
+
scopes: Record<string, string>;
|
|
132
|
+
refreshUrl?: string | undefined;
|
|
133
|
+
}, {
|
|
134
|
+
tokenUrl: string;
|
|
135
|
+
scopes: Record<string, string>;
|
|
136
|
+
refreshUrl?: string | undefined;
|
|
137
|
+
}>;
|
|
138
|
+
export type ClientCredentialsOAuthFlow = z.infer<typeof ClientCredentialsOAuthFlowSchema>;
|
|
139
|
+
/**
|
|
140
|
+
* @description Configuration details for a supported Implicit OAuth Flow
|
|
141
|
+
*/
|
|
142
|
+
export declare const ImplicitOAuthFlowSchema: z.ZodObject<{
|
|
143
|
+
/**
|
|
144
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
145
|
+
* standard requires the use of TLS
|
|
146
|
+
*/
|
|
147
|
+
authorizationUrl: z.ZodString;
|
|
148
|
+
/**
|
|
149
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
150
|
+
* standard requires the use of TLS.
|
|
151
|
+
*/
|
|
152
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
153
|
+
/**
|
|
154
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
155
|
+
* description for it. The map MAY be empty.
|
|
156
|
+
*/
|
|
157
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
158
|
+
}, "strip", z.ZodTypeAny, {
|
|
159
|
+
authorizationUrl: string;
|
|
160
|
+
scopes: Record<string, string>;
|
|
161
|
+
refreshUrl?: string | undefined;
|
|
162
|
+
}, {
|
|
163
|
+
authorizationUrl: string;
|
|
164
|
+
scopes: Record<string, string>;
|
|
165
|
+
refreshUrl?: string | undefined;
|
|
166
|
+
}>;
|
|
167
|
+
export type ImplicitOAuthFlow = z.infer<typeof ImplicitOAuthFlowSchema>;
|
|
168
|
+
/**
|
|
169
|
+
* @description Configuration details for a supported Password OAuth Flow
|
|
170
|
+
*/
|
|
171
|
+
export declare const PasswordOAuthFlowSchema: z.ZodObject<{
|
|
172
|
+
/**
|
|
173
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
174
|
+
* requires the use of TLS.
|
|
175
|
+
*/
|
|
176
|
+
tokenUrl: z.ZodString;
|
|
177
|
+
/**
|
|
178
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
179
|
+
* standard requires the use of TLS.
|
|
180
|
+
*/
|
|
181
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
182
|
+
/**
|
|
183
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
184
|
+
* description for it. The map MAY be empty.
|
|
185
|
+
*/
|
|
186
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
187
|
+
}, "strip", z.ZodTypeAny, {
|
|
188
|
+
tokenUrl: string;
|
|
189
|
+
scopes: Record<string, string>;
|
|
190
|
+
refreshUrl?: string | undefined;
|
|
191
|
+
}, {
|
|
192
|
+
tokenUrl: string;
|
|
193
|
+
scopes: Record<string, string>;
|
|
194
|
+
refreshUrl?: string | undefined;
|
|
195
|
+
}>;
|
|
196
|
+
export type PasswordOAuthFlow = z.infer<typeof PasswordOAuthFlowSchema>;
|
|
197
|
+
/**
|
|
198
|
+
* @description The configuration of supported OAuth Flows
|
|
199
|
+
*/
|
|
200
|
+
export declare const OAuthFlowsSchema: z.ZodObject<{
|
|
201
|
+
/**
|
|
202
|
+
* @optional Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
|
|
203
|
+
*/
|
|
204
|
+
authorizationCode: z.ZodOptional<z.ZodObject<{
|
|
205
|
+
/**
|
|
206
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
207
|
+
* standard requires the use of TLS
|
|
208
|
+
*/
|
|
209
|
+
authorizationUrl: z.ZodString;
|
|
210
|
+
/**
|
|
211
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
212
|
+
* requires the use of TLS.
|
|
213
|
+
*/
|
|
214
|
+
tokenUrl: z.ZodString;
|
|
215
|
+
/**
|
|
216
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
217
|
+
* standard requires the use of TLS.
|
|
218
|
+
*/
|
|
219
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
220
|
+
/**
|
|
221
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
222
|
+
* description for it. The map MAY be empty.
|
|
223
|
+
*/
|
|
224
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
225
|
+
}, "strip", z.ZodTypeAny, {
|
|
226
|
+
authorizationUrl: string;
|
|
227
|
+
tokenUrl: string;
|
|
228
|
+
scopes: Record<string, string>;
|
|
229
|
+
refreshUrl?: string | undefined;
|
|
230
|
+
}, {
|
|
231
|
+
authorizationUrl: string;
|
|
232
|
+
tokenUrl: string;
|
|
233
|
+
scopes: Record<string, string>;
|
|
234
|
+
refreshUrl?: string | undefined;
|
|
235
|
+
}>>;
|
|
236
|
+
/**
|
|
237
|
+
* @optional Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0
|
|
238
|
+
*/
|
|
239
|
+
clientCredentials: z.ZodOptional<z.ZodObject<{
|
|
240
|
+
/**
|
|
241
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
242
|
+
* requires the use of TLS.
|
|
243
|
+
*/
|
|
244
|
+
tokenUrl: z.ZodString;
|
|
245
|
+
/**
|
|
246
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
247
|
+
* standard requires the use of TLS.
|
|
248
|
+
*/
|
|
249
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
250
|
+
/**
|
|
251
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
252
|
+
* description for it. The map MAY be empty.
|
|
253
|
+
*/
|
|
254
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
255
|
+
}, "strip", z.ZodTypeAny, {
|
|
256
|
+
tokenUrl: string;
|
|
257
|
+
scopes: Record<string, string>;
|
|
258
|
+
refreshUrl?: string | undefined;
|
|
259
|
+
}, {
|
|
260
|
+
tokenUrl: string;
|
|
261
|
+
scopes: Record<string, string>;
|
|
262
|
+
refreshUrl?: string | undefined;
|
|
263
|
+
}>>;
|
|
264
|
+
/**
|
|
265
|
+
* @optional Configuration for the OAuth Implicit flow
|
|
266
|
+
*/
|
|
267
|
+
implicit: z.ZodOptional<z.ZodObject<{
|
|
268
|
+
/**
|
|
269
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
270
|
+
* standard requires the use of TLS
|
|
271
|
+
*/
|
|
272
|
+
authorizationUrl: z.ZodString;
|
|
273
|
+
/**
|
|
274
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
275
|
+
* standard requires the use of TLS.
|
|
276
|
+
*/
|
|
277
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
278
|
+
/**
|
|
279
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
280
|
+
* description for it. The map MAY be empty.
|
|
281
|
+
*/
|
|
282
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
283
|
+
}, "strip", z.ZodTypeAny, {
|
|
284
|
+
authorizationUrl: string;
|
|
285
|
+
scopes: Record<string, string>;
|
|
286
|
+
refreshUrl?: string | undefined;
|
|
287
|
+
}, {
|
|
288
|
+
authorizationUrl: string;
|
|
289
|
+
scopes: Record<string, string>;
|
|
290
|
+
refreshUrl?: string | undefined;
|
|
291
|
+
}>>;
|
|
292
|
+
/**
|
|
293
|
+
* @optional Configuration for the OAuth Resource Owner Password flow
|
|
294
|
+
*/
|
|
295
|
+
password: z.ZodOptional<z.ZodObject<{
|
|
296
|
+
/**
|
|
297
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
298
|
+
* requires the use of TLS.
|
|
299
|
+
*/
|
|
300
|
+
tokenUrl: z.ZodString;
|
|
301
|
+
/**
|
|
302
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
303
|
+
* standard requires the use of TLS.
|
|
304
|
+
*/
|
|
305
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
306
|
+
/**
|
|
307
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
308
|
+
* description for it. The map MAY be empty.
|
|
309
|
+
*/
|
|
310
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
311
|
+
}, "strip", z.ZodTypeAny, {
|
|
312
|
+
tokenUrl: string;
|
|
313
|
+
scopes: Record<string, string>;
|
|
314
|
+
refreshUrl?: string | undefined;
|
|
315
|
+
}, {
|
|
316
|
+
tokenUrl: string;
|
|
317
|
+
scopes: Record<string, string>;
|
|
318
|
+
refreshUrl?: string | undefined;
|
|
319
|
+
}>>;
|
|
320
|
+
}, "strip", z.ZodTypeAny, {
|
|
321
|
+
authorizationCode?: {
|
|
322
|
+
authorizationUrl: string;
|
|
323
|
+
tokenUrl: string;
|
|
324
|
+
scopes: Record<string, string>;
|
|
325
|
+
refreshUrl?: string | undefined;
|
|
326
|
+
} | undefined;
|
|
327
|
+
clientCredentials?: {
|
|
328
|
+
tokenUrl: string;
|
|
329
|
+
scopes: Record<string, string>;
|
|
330
|
+
refreshUrl?: string | undefined;
|
|
331
|
+
} | undefined;
|
|
332
|
+
implicit?: {
|
|
333
|
+
authorizationUrl: string;
|
|
334
|
+
scopes: Record<string, string>;
|
|
335
|
+
refreshUrl?: string | undefined;
|
|
336
|
+
} | undefined;
|
|
337
|
+
password?: {
|
|
338
|
+
tokenUrl: string;
|
|
339
|
+
scopes: Record<string, string>;
|
|
340
|
+
refreshUrl?: string | undefined;
|
|
341
|
+
} | undefined;
|
|
342
|
+
}, {
|
|
343
|
+
authorizationCode?: {
|
|
344
|
+
authorizationUrl: string;
|
|
345
|
+
tokenUrl: string;
|
|
346
|
+
scopes: Record<string, string>;
|
|
347
|
+
refreshUrl?: string | undefined;
|
|
348
|
+
} | undefined;
|
|
349
|
+
clientCredentials?: {
|
|
350
|
+
tokenUrl: string;
|
|
351
|
+
scopes: Record<string, string>;
|
|
352
|
+
refreshUrl?: string | undefined;
|
|
353
|
+
} | undefined;
|
|
354
|
+
implicit?: {
|
|
355
|
+
authorizationUrl: string;
|
|
356
|
+
scopes: Record<string, string>;
|
|
357
|
+
refreshUrl?: string | undefined;
|
|
358
|
+
} | undefined;
|
|
359
|
+
password?: {
|
|
360
|
+
tokenUrl: string;
|
|
361
|
+
scopes: Record<string, string>;
|
|
362
|
+
refreshUrl?: string | undefined;
|
|
363
|
+
} | undefined;
|
|
364
|
+
}>;
|
|
365
|
+
export type OAuthFlows = z.infer<typeof OAuthFlowsSchema>;
|
|
366
|
+
/**
|
|
367
|
+
* @description OAuth2 security scheme configuration.
|
|
368
|
+
*/
|
|
369
|
+
export declare const OAuth2SecuritySchemeSchema: z.ZodObject<{
|
|
370
|
+
description: z.ZodOptional<z.ZodString>;
|
|
371
|
+
} & {
|
|
372
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "oauth2", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
373
|
+
flows: z.ZodObject<{
|
|
374
|
+
/**
|
|
375
|
+
* @optional Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
|
|
376
|
+
*/
|
|
377
|
+
authorizationCode: z.ZodOptional<z.ZodObject<{
|
|
378
|
+
/**
|
|
379
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
380
|
+
* standard requires the use of TLS
|
|
381
|
+
*/
|
|
382
|
+
authorizationUrl: z.ZodString;
|
|
383
|
+
/**
|
|
384
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
385
|
+
* requires the use of TLS.
|
|
386
|
+
*/
|
|
387
|
+
tokenUrl: z.ZodString;
|
|
388
|
+
/**
|
|
389
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
390
|
+
* standard requires the use of TLS.
|
|
391
|
+
*/
|
|
392
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
393
|
+
/**
|
|
394
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
395
|
+
* description for it. The map MAY be empty.
|
|
396
|
+
*/
|
|
397
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
398
|
+
}, "strip", z.ZodTypeAny, {
|
|
399
|
+
authorizationUrl: string;
|
|
400
|
+
tokenUrl: string;
|
|
401
|
+
scopes: Record<string, string>;
|
|
402
|
+
refreshUrl?: string | undefined;
|
|
403
|
+
}, {
|
|
404
|
+
authorizationUrl: string;
|
|
405
|
+
tokenUrl: string;
|
|
406
|
+
scopes: Record<string, string>;
|
|
407
|
+
refreshUrl?: string | undefined;
|
|
408
|
+
}>>;
|
|
409
|
+
/**
|
|
410
|
+
* @optional Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0
|
|
411
|
+
*/
|
|
412
|
+
clientCredentials: z.ZodOptional<z.ZodObject<{
|
|
413
|
+
/**
|
|
414
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
415
|
+
* requires the use of TLS.
|
|
416
|
+
*/
|
|
417
|
+
tokenUrl: z.ZodString;
|
|
418
|
+
/**
|
|
419
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
420
|
+
* standard requires the use of TLS.
|
|
421
|
+
*/
|
|
422
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
423
|
+
/**
|
|
424
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
425
|
+
* description for it. The map MAY be empty.
|
|
426
|
+
*/
|
|
427
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
428
|
+
}, "strip", z.ZodTypeAny, {
|
|
429
|
+
tokenUrl: string;
|
|
430
|
+
scopes: Record<string, string>;
|
|
431
|
+
refreshUrl?: string | undefined;
|
|
432
|
+
}, {
|
|
433
|
+
tokenUrl: string;
|
|
434
|
+
scopes: Record<string, string>;
|
|
435
|
+
refreshUrl?: string | undefined;
|
|
436
|
+
}>>;
|
|
437
|
+
/**
|
|
438
|
+
* @optional Configuration for the OAuth Implicit flow
|
|
439
|
+
*/
|
|
440
|
+
implicit: z.ZodOptional<z.ZodObject<{
|
|
441
|
+
/**
|
|
442
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
443
|
+
* standard requires the use of TLS
|
|
444
|
+
*/
|
|
445
|
+
authorizationUrl: z.ZodString;
|
|
446
|
+
/**
|
|
447
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
448
|
+
* standard requires the use of TLS.
|
|
449
|
+
*/
|
|
450
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
451
|
+
/**
|
|
452
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
453
|
+
* description for it. The map MAY be empty.
|
|
454
|
+
*/
|
|
455
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
456
|
+
}, "strip", z.ZodTypeAny, {
|
|
457
|
+
authorizationUrl: string;
|
|
458
|
+
scopes: Record<string, string>;
|
|
459
|
+
refreshUrl?: string | undefined;
|
|
460
|
+
}, {
|
|
461
|
+
authorizationUrl: string;
|
|
462
|
+
scopes: Record<string, string>;
|
|
463
|
+
refreshUrl?: string | undefined;
|
|
464
|
+
}>>;
|
|
465
|
+
/**
|
|
466
|
+
* @optional Configuration for the OAuth Resource Owner Password flow
|
|
467
|
+
*/
|
|
468
|
+
password: z.ZodOptional<z.ZodObject<{
|
|
469
|
+
/**
|
|
470
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
471
|
+
* requires the use of TLS.
|
|
472
|
+
*/
|
|
473
|
+
tokenUrl: z.ZodString;
|
|
474
|
+
/**
|
|
475
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
476
|
+
* standard requires the use of TLS.
|
|
477
|
+
*/
|
|
478
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
479
|
+
/**
|
|
480
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
481
|
+
* description for it. The map MAY be empty.
|
|
482
|
+
*/
|
|
483
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
484
|
+
}, "strip", z.ZodTypeAny, {
|
|
485
|
+
tokenUrl: string;
|
|
486
|
+
scopes: Record<string, string>;
|
|
487
|
+
refreshUrl?: string | undefined;
|
|
488
|
+
}, {
|
|
489
|
+
tokenUrl: string;
|
|
490
|
+
scopes: Record<string, string>;
|
|
491
|
+
refreshUrl?: string | undefined;
|
|
492
|
+
}>>;
|
|
493
|
+
}, "strip", z.ZodTypeAny, {
|
|
494
|
+
authorizationCode?: {
|
|
495
|
+
authorizationUrl: string;
|
|
496
|
+
tokenUrl: string;
|
|
497
|
+
scopes: Record<string, string>;
|
|
498
|
+
refreshUrl?: string | undefined;
|
|
499
|
+
} | undefined;
|
|
500
|
+
clientCredentials?: {
|
|
501
|
+
tokenUrl: string;
|
|
502
|
+
scopes: Record<string, string>;
|
|
503
|
+
refreshUrl?: string | undefined;
|
|
504
|
+
} | undefined;
|
|
505
|
+
implicit?: {
|
|
506
|
+
authorizationUrl: string;
|
|
507
|
+
scopes: Record<string, string>;
|
|
508
|
+
refreshUrl?: string | undefined;
|
|
509
|
+
} | undefined;
|
|
510
|
+
password?: {
|
|
511
|
+
tokenUrl: string;
|
|
512
|
+
scopes: Record<string, string>;
|
|
513
|
+
refreshUrl?: string | undefined;
|
|
514
|
+
} | undefined;
|
|
515
|
+
}, {
|
|
516
|
+
authorizationCode?: {
|
|
517
|
+
authorizationUrl: string;
|
|
518
|
+
tokenUrl: string;
|
|
519
|
+
scopes: Record<string, string>;
|
|
520
|
+
refreshUrl?: string | undefined;
|
|
521
|
+
} | undefined;
|
|
522
|
+
clientCredentials?: {
|
|
523
|
+
tokenUrl: string;
|
|
524
|
+
scopes: Record<string, string>;
|
|
525
|
+
refreshUrl?: string | undefined;
|
|
526
|
+
} | undefined;
|
|
527
|
+
implicit?: {
|
|
528
|
+
authorizationUrl: string;
|
|
529
|
+
scopes: Record<string, string>;
|
|
530
|
+
refreshUrl?: string | undefined;
|
|
531
|
+
} | undefined;
|
|
532
|
+
password?: {
|
|
533
|
+
tokenUrl: string;
|
|
534
|
+
scopes: Record<string, string>;
|
|
535
|
+
refreshUrl?: string | undefined;
|
|
536
|
+
} | undefined;
|
|
537
|
+
}>;
|
|
538
|
+
oauth2MetadataUrl: z.ZodOptional<z.ZodString>;
|
|
539
|
+
}, "strip", z.ZodTypeAny, {
|
|
540
|
+
type: "oauth2";
|
|
541
|
+
flows: {
|
|
542
|
+
authorizationCode?: {
|
|
543
|
+
authorizationUrl: string;
|
|
544
|
+
tokenUrl: string;
|
|
545
|
+
scopes: Record<string, string>;
|
|
546
|
+
refreshUrl?: string | undefined;
|
|
547
|
+
} | undefined;
|
|
548
|
+
clientCredentials?: {
|
|
549
|
+
tokenUrl: string;
|
|
550
|
+
scopes: Record<string, string>;
|
|
551
|
+
refreshUrl?: string | undefined;
|
|
552
|
+
} | undefined;
|
|
553
|
+
implicit?: {
|
|
554
|
+
authorizationUrl: string;
|
|
555
|
+
scopes: Record<string, string>;
|
|
556
|
+
refreshUrl?: string | undefined;
|
|
557
|
+
} | undefined;
|
|
558
|
+
password?: {
|
|
559
|
+
tokenUrl: string;
|
|
560
|
+
scopes: Record<string, string>;
|
|
561
|
+
refreshUrl?: string | undefined;
|
|
562
|
+
} | undefined;
|
|
563
|
+
};
|
|
564
|
+
description?: string | undefined;
|
|
565
|
+
oauth2MetadataUrl?: string | undefined;
|
|
566
|
+
}, {
|
|
567
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
568
|
+
flows: {
|
|
569
|
+
authorizationCode?: {
|
|
570
|
+
authorizationUrl: string;
|
|
571
|
+
tokenUrl: string;
|
|
572
|
+
scopes: Record<string, string>;
|
|
573
|
+
refreshUrl?: string | undefined;
|
|
574
|
+
} | undefined;
|
|
575
|
+
clientCredentials?: {
|
|
576
|
+
tokenUrl: string;
|
|
577
|
+
scopes: Record<string, string>;
|
|
578
|
+
refreshUrl?: string | undefined;
|
|
579
|
+
} | undefined;
|
|
580
|
+
implicit?: {
|
|
581
|
+
authorizationUrl: string;
|
|
582
|
+
scopes: Record<string, string>;
|
|
583
|
+
refreshUrl?: string | undefined;
|
|
584
|
+
} | undefined;
|
|
585
|
+
password?: {
|
|
586
|
+
tokenUrl: string;
|
|
587
|
+
scopes: Record<string, string>;
|
|
588
|
+
refreshUrl?: string | undefined;
|
|
589
|
+
} | undefined;
|
|
590
|
+
};
|
|
591
|
+
description?: string | undefined;
|
|
592
|
+
oauth2MetadataUrl?: string | undefined;
|
|
593
|
+
}>;
|
|
594
|
+
export type OAuth2SecurityScheme = z.infer<typeof OAuth2SecuritySchemeSchema>;
|
|
595
|
+
/**
|
|
596
|
+
* @description OpenID Connect security scheme.
|
|
597
|
+
*/
|
|
598
|
+
export declare const OpenIdConnectSecuritySchemeSchema: z.ZodObject<{
|
|
599
|
+
description: z.ZodOptional<z.ZodString>;
|
|
600
|
+
} & {
|
|
601
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "openIdConnect", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
602
|
+
openIdConnectUrl: z.ZodString;
|
|
603
|
+
}, "strip", z.ZodTypeAny, {
|
|
604
|
+
type: "openIdConnect";
|
|
605
|
+
openIdConnectUrl: string;
|
|
606
|
+
description?: string | undefined;
|
|
607
|
+
}, {
|
|
608
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
609
|
+
openIdConnectUrl: string;
|
|
610
|
+
description?: string | undefined;
|
|
611
|
+
}>;
|
|
612
|
+
export type OpenIdConnectSecurityScheme = z.infer<typeof OpenIdConnectSecuritySchemeSchema>;
|
|
613
|
+
/**
|
|
614
|
+
* @description Mutual TLS (mTLS) security scheme.
|
|
615
|
+
*/
|
|
616
|
+
export declare const MutualTLSSecuritySchemeSchema: z.ZodObject<{
|
|
617
|
+
description: z.ZodOptional<z.ZodString>;
|
|
618
|
+
} & {
|
|
619
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "mutualTLS", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
620
|
+
}, "strip", z.ZodTypeAny, {
|
|
621
|
+
type: "mutualTLS";
|
|
622
|
+
description?: string | undefined;
|
|
623
|
+
}, {
|
|
624
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
625
|
+
description?: string | undefined;
|
|
626
|
+
}>;
|
|
627
|
+
export type MutualTLSSecurityScheme = z.infer<typeof MutualTLSSecuritySchemeSchema>;
|
|
628
|
+
export declare const SecuritySchemeSchema: z.ZodUnion<[z.ZodObject<{
|
|
629
|
+
description: z.ZodOptional<z.ZodString>;
|
|
630
|
+
} & {
|
|
631
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "apiKey", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
632
|
+
in: z.ZodEnum<["query", "header", "cookie"]>;
|
|
633
|
+
name: z.ZodString;
|
|
634
|
+
}, "strip", z.ZodTypeAny, {
|
|
635
|
+
type: "apiKey";
|
|
636
|
+
in: "query" | "header" | "cookie";
|
|
637
|
+
name: string;
|
|
638
|
+
description?: string | undefined;
|
|
639
|
+
}, {
|
|
640
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
641
|
+
in: "query" | "header" | "cookie";
|
|
642
|
+
name: string;
|
|
643
|
+
description?: string | undefined;
|
|
644
|
+
}>, z.ZodObject<{
|
|
645
|
+
description: z.ZodOptional<z.ZodString>;
|
|
646
|
+
} & {
|
|
647
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "http", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
648
|
+
scheme: z.ZodString;
|
|
649
|
+
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
650
|
+
}, "strip", z.ZodTypeAny, {
|
|
651
|
+
type: "http";
|
|
652
|
+
scheme: string;
|
|
653
|
+
description?: string | undefined;
|
|
654
|
+
bearerFormat?: string | undefined;
|
|
655
|
+
}, {
|
|
656
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
657
|
+
scheme: string;
|
|
658
|
+
description?: string | undefined;
|
|
659
|
+
bearerFormat?: string | undefined;
|
|
660
|
+
}>, z.ZodObject<{
|
|
661
|
+
description: z.ZodOptional<z.ZodString>;
|
|
662
|
+
} & {
|
|
663
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "oauth2", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
664
|
+
flows: z.ZodObject<{
|
|
665
|
+
/**
|
|
666
|
+
* @optional Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
|
|
667
|
+
*/
|
|
668
|
+
authorizationCode: z.ZodOptional<z.ZodObject<{
|
|
669
|
+
/**
|
|
670
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
671
|
+
* standard requires the use of TLS
|
|
672
|
+
*/
|
|
673
|
+
authorizationUrl: z.ZodString;
|
|
674
|
+
/**
|
|
675
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
676
|
+
* requires the use of TLS.
|
|
677
|
+
*/
|
|
678
|
+
tokenUrl: z.ZodString;
|
|
679
|
+
/**
|
|
680
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
681
|
+
* standard requires the use of TLS.
|
|
682
|
+
*/
|
|
683
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
684
|
+
/**
|
|
685
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
686
|
+
* description for it. The map MAY be empty.
|
|
687
|
+
*/
|
|
688
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
689
|
+
}, "strip", z.ZodTypeAny, {
|
|
690
|
+
authorizationUrl: string;
|
|
691
|
+
tokenUrl: string;
|
|
692
|
+
scopes: Record<string, string>;
|
|
693
|
+
refreshUrl?: string | undefined;
|
|
694
|
+
}, {
|
|
695
|
+
authorizationUrl: string;
|
|
696
|
+
tokenUrl: string;
|
|
697
|
+
scopes: Record<string, string>;
|
|
698
|
+
refreshUrl?: string | undefined;
|
|
699
|
+
}>>;
|
|
700
|
+
/**
|
|
701
|
+
* @optional Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0
|
|
702
|
+
*/
|
|
703
|
+
clientCredentials: z.ZodOptional<z.ZodObject<{
|
|
704
|
+
/**
|
|
705
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
706
|
+
* requires the use of TLS.
|
|
707
|
+
*/
|
|
708
|
+
tokenUrl: z.ZodString;
|
|
709
|
+
/**
|
|
710
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
711
|
+
* standard requires the use of TLS.
|
|
712
|
+
*/
|
|
713
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
714
|
+
/**
|
|
715
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
716
|
+
* description for it. The map MAY be empty.
|
|
717
|
+
*/
|
|
718
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
719
|
+
}, "strip", z.ZodTypeAny, {
|
|
720
|
+
tokenUrl: string;
|
|
721
|
+
scopes: Record<string, string>;
|
|
722
|
+
refreshUrl?: string | undefined;
|
|
723
|
+
}, {
|
|
724
|
+
tokenUrl: string;
|
|
725
|
+
scopes: Record<string, string>;
|
|
726
|
+
refreshUrl?: string | undefined;
|
|
727
|
+
}>>;
|
|
728
|
+
/**
|
|
729
|
+
* @optional Configuration for the OAuth Implicit flow
|
|
730
|
+
*/
|
|
731
|
+
implicit: z.ZodOptional<z.ZodObject<{
|
|
732
|
+
/**
|
|
733
|
+
* @required The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
|
|
734
|
+
* standard requires the use of TLS
|
|
735
|
+
*/
|
|
736
|
+
authorizationUrl: z.ZodString;
|
|
737
|
+
/**
|
|
738
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
739
|
+
* standard requires the use of TLS.
|
|
740
|
+
*/
|
|
741
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
742
|
+
/**
|
|
743
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
744
|
+
* description for it. The map MAY be empty.
|
|
745
|
+
*/
|
|
746
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
747
|
+
}, "strip", z.ZodTypeAny, {
|
|
748
|
+
authorizationUrl: string;
|
|
749
|
+
scopes: Record<string, string>;
|
|
750
|
+
refreshUrl?: string | undefined;
|
|
751
|
+
}, {
|
|
752
|
+
authorizationUrl: string;
|
|
753
|
+
scopes: Record<string, string>;
|
|
754
|
+
refreshUrl?: string | undefined;
|
|
755
|
+
}>>;
|
|
756
|
+
/**
|
|
757
|
+
* @optional Configuration for the OAuth Resource Owner Password flow
|
|
758
|
+
*/
|
|
759
|
+
password: z.ZodOptional<z.ZodObject<{
|
|
760
|
+
/**
|
|
761
|
+
* @required The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
|
|
762
|
+
* requires the use of TLS.
|
|
763
|
+
*/
|
|
764
|
+
tokenUrl: z.ZodString;
|
|
765
|
+
/**
|
|
766
|
+
* @optional The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
|
|
767
|
+
* standard requires the use of TLS.
|
|
768
|
+
*/
|
|
769
|
+
refreshUrl: z.ZodOptional<z.ZodString>;
|
|
770
|
+
/**
|
|
771
|
+
* @required The available scopes for the OAuth2 security scheme. A map between the scope name and a short
|
|
772
|
+
* description for it. The map MAY be empty.
|
|
773
|
+
*/
|
|
774
|
+
scopes: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
775
|
+
}, "strip", z.ZodTypeAny, {
|
|
776
|
+
tokenUrl: string;
|
|
777
|
+
scopes: Record<string, string>;
|
|
778
|
+
refreshUrl?: string | undefined;
|
|
779
|
+
}, {
|
|
780
|
+
tokenUrl: string;
|
|
781
|
+
scopes: Record<string, string>;
|
|
782
|
+
refreshUrl?: string | undefined;
|
|
783
|
+
}>>;
|
|
784
|
+
}, "strip", z.ZodTypeAny, {
|
|
785
|
+
authorizationCode?: {
|
|
786
|
+
authorizationUrl: string;
|
|
787
|
+
tokenUrl: string;
|
|
788
|
+
scopes: Record<string, string>;
|
|
789
|
+
refreshUrl?: string | undefined;
|
|
790
|
+
} | undefined;
|
|
791
|
+
clientCredentials?: {
|
|
792
|
+
tokenUrl: string;
|
|
793
|
+
scopes: Record<string, string>;
|
|
794
|
+
refreshUrl?: string | undefined;
|
|
795
|
+
} | undefined;
|
|
796
|
+
implicit?: {
|
|
797
|
+
authorizationUrl: string;
|
|
798
|
+
scopes: Record<string, string>;
|
|
799
|
+
refreshUrl?: string | undefined;
|
|
800
|
+
} | undefined;
|
|
801
|
+
password?: {
|
|
802
|
+
tokenUrl: string;
|
|
803
|
+
scopes: Record<string, string>;
|
|
804
|
+
refreshUrl?: string | undefined;
|
|
805
|
+
} | undefined;
|
|
806
|
+
}, {
|
|
807
|
+
authorizationCode?: {
|
|
808
|
+
authorizationUrl: string;
|
|
809
|
+
tokenUrl: string;
|
|
810
|
+
scopes: Record<string, string>;
|
|
811
|
+
refreshUrl?: string | undefined;
|
|
812
|
+
} | undefined;
|
|
813
|
+
clientCredentials?: {
|
|
814
|
+
tokenUrl: string;
|
|
815
|
+
scopes: Record<string, string>;
|
|
816
|
+
refreshUrl?: string | undefined;
|
|
817
|
+
} | undefined;
|
|
818
|
+
implicit?: {
|
|
819
|
+
authorizationUrl: string;
|
|
820
|
+
scopes: Record<string, string>;
|
|
821
|
+
refreshUrl?: string | undefined;
|
|
822
|
+
} | undefined;
|
|
823
|
+
password?: {
|
|
824
|
+
tokenUrl: string;
|
|
825
|
+
scopes: Record<string, string>;
|
|
826
|
+
refreshUrl?: string | undefined;
|
|
827
|
+
} | undefined;
|
|
828
|
+
}>;
|
|
829
|
+
oauth2MetadataUrl: z.ZodOptional<z.ZodString>;
|
|
830
|
+
}, "strip", z.ZodTypeAny, {
|
|
831
|
+
type: "oauth2";
|
|
832
|
+
flows: {
|
|
833
|
+
authorizationCode?: {
|
|
834
|
+
authorizationUrl: string;
|
|
835
|
+
tokenUrl: string;
|
|
836
|
+
scopes: Record<string, string>;
|
|
837
|
+
refreshUrl?: string | undefined;
|
|
838
|
+
} | undefined;
|
|
839
|
+
clientCredentials?: {
|
|
840
|
+
tokenUrl: string;
|
|
841
|
+
scopes: Record<string, string>;
|
|
842
|
+
refreshUrl?: string | undefined;
|
|
843
|
+
} | undefined;
|
|
844
|
+
implicit?: {
|
|
845
|
+
authorizationUrl: string;
|
|
846
|
+
scopes: Record<string, string>;
|
|
847
|
+
refreshUrl?: string | undefined;
|
|
848
|
+
} | undefined;
|
|
849
|
+
password?: {
|
|
850
|
+
tokenUrl: string;
|
|
851
|
+
scopes: Record<string, string>;
|
|
852
|
+
refreshUrl?: string | undefined;
|
|
853
|
+
} | undefined;
|
|
854
|
+
};
|
|
855
|
+
description?: string | undefined;
|
|
856
|
+
oauth2MetadataUrl?: string | undefined;
|
|
857
|
+
}, {
|
|
858
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
859
|
+
flows: {
|
|
860
|
+
authorizationCode?: {
|
|
861
|
+
authorizationUrl: string;
|
|
862
|
+
tokenUrl: string;
|
|
863
|
+
scopes: Record<string, string>;
|
|
864
|
+
refreshUrl?: string | undefined;
|
|
865
|
+
} | undefined;
|
|
866
|
+
clientCredentials?: {
|
|
867
|
+
tokenUrl: string;
|
|
868
|
+
scopes: Record<string, string>;
|
|
869
|
+
refreshUrl?: string | undefined;
|
|
870
|
+
} | undefined;
|
|
871
|
+
implicit?: {
|
|
872
|
+
authorizationUrl: string;
|
|
873
|
+
scopes: Record<string, string>;
|
|
874
|
+
refreshUrl?: string | undefined;
|
|
875
|
+
} | undefined;
|
|
876
|
+
password?: {
|
|
877
|
+
tokenUrl: string;
|
|
878
|
+
scopes: Record<string, string>;
|
|
879
|
+
refreshUrl?: string | undefined;
|
|
880
|
+
} | undefined;
|
|
881
|
+
};
|
|
882
|
+
description?: string | undefined;
|
|
883
|
+
oauth2MetadataUrl?: string | undefined;
|
|
884
|
+
}>, z.ZodObject<{
|
|
885
|
+
description: z.ZodOptional<z.ZodString>;
|
|
886
|
+
} & {
|
|
887
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "openIdConnect", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
888
|
+
openIdConnectUrl: z.ZodString;
|
|
889
|
+
}, "strip", z.ZodTypeAny, {
|
|
890
|
+
type: "openIdConnect";
|
|
891
|
+
openIdConnectUrl: string;
|
|
892
|
+
description?: string | undefined;
|
|
893
|
+
}, {
|
|
894
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
895
|
+
openIdConnectUrl: string;
|
|
896
|
+
description?: string | undefined;
|
|
897
|
+
}>, z.ZodObject<{
|
|
898
|
+
description: z.ZodOptional<z.ZodString>;
|
|
899
|
+
} & {
|
|
900
|
+
type: z.ZodEffects<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]>, "mutualTLS", "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect">;
|
|
901
|
+
}, "strip", z.ZodTypeAny, {
|
|
902
|
+
type: "mutualTLS";
|
|
903
|
+
description?: string | undefined;
|
|
904
|
+
}, {
|
|
905
|
+
type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
|
|
906
|
+
description?: string | undefined;
|
|
907
|
+
}>]>;
|
|
908
|
+
export type SecurityScheme = z.infer<typeof SecuritySchemeSchema>;
|