@mochabug/adaptkit 0.1.0-alpha.9 → 0.2.0-alpha.2
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 +13 -5
- package/bin/index.js +388 -325
- package/bin/index.js.map +1 -1
- package/package.json +24 -21
- package/bin/gen/google/protobuf/descriptor.d.ts +0 -1799
- package/bin/gen/google/protobuf/descriptor.d.ts.map +0 -1
- package/bin/gen/mochabug/adapt/plugins/v1/plugins.client.d.ts +0 -46
- package/bin/gen/mochabug/adapt/plugins/v1/plugins.client.d.ts.map +0 -1
- package/bin/gen/mochabug/adapt/plugins/v1/plugins.d.ts +0 -797
- package/bin/gen/mochabug/adapt/plugins/v1/plugins.d.ts.map +0 -1
|
@@ -1,797 +0,0 @@
|
|
|
1
|
-
import { ServiceType } from "@protobuf-ts/runtime-rpc";
|
|
2
|
-
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
|
|
3
|
-
import type { IBinaryWriter } from "@protobuf-ts/runtime";
|
|
4
|
-
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
|
|
5
|
-
import type { IBinaryReader } from "@protobuf-ts/runtime";
|
|
6
|
-
import type { PartialMessage } from "@protobuf-ts/runtime";
|
|
7
|
-
import { MessageType } from "@protobuf-ts/runtime";
|
|
8
|
-
/**
|
|
9
|
-
* UploadPluginRequest represents a single request in the CreatePlugin streaming
|
|
10
|
-
* RPC. The client sends a series of UploadPluginRequest messages containing
|
|
11
|
-
* plugin data, starting with a manifest and followed by one or more files.
|
|
12
|
-
*
|
|
13
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.UploadPluginRequest
|
|
14
|
-
*/
|
|
15
|
-
export interface UploadPluginRequest {
|
|
16
|
-
/**
|
|
17
|
-
* @generated from protobuf oneof: data
|
|
18
|
-
*/
|
|
19
|
-
data: {
|
|
20
|
-
oneofKind: "manifest";
|
|
21
|
-
/**
|
|
22
|
-
* 'manifest' is the Manifest describing the plugin.
|
|
23
|
-
* It must be the first message in the stream.
|
|
24
|
-
*
|
|
25
|
-
* @generated from protobuf field: mochabug.adapt.plugins.v1.Manifest manifest = 1;
|
|
26
|
-
*/
|
|
27
|
-
manifest: Manifest;
|
|
28
|
-
} | {
|
|
29
|
-
oneofKind: "file";
|
|
30
|
-
/**
|
|
31
|
-
* 'file' is a File contained within the plugin.
|
|
32
|
-
* It follows the manifest in the stream.
|
|
33
|
-
*
|
|
34
|
-
* @generated from protobuf field: mochabug.adapt.plugins.v1.File file = 2;
|
|
35
|
-
*/
|
|
36
|
-
file: File;
|
|
37
|
-
} | {
|
|
38
|
-
oneofKind: undefined;
|
|
39
|
-
};
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* UploadPluginResponse represents the response from the CreatePlugin streaming
|
|
43
|
-
* RPC. The server sends a single CreatePluginResponse after successfully
|
|
44
|
-
* processing all UploadPluginResponse messages from the client.
|
|
45
|
-
*
|
|
46
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.UploadPluginResponse
|
|
47
|
-
*/
|
|
48
|
-
export interface UploadPluginResponse {
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* File represents a file within a plugin package.
|
|
52
|
-
*
|
|
53
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.File
|
|
54
|
-
*/
|
|
55
|
-
export interface File {
|
|
56
|
-
/**
|
|
57
|
-
* 'path' is the local file path relative to the manifest.json folder.
|
|
58
|
-
*
|
|
59
|
-
* Restrictions:
|
|
60
|
-
* - Must be a valid Unix file path.
|
|
61
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
62
|
-
* - Length must be less than 4096 characters.
|
|
63
|
-
*
|
|
64
|
-
* @generated from protobuf field: string path = 1;
|
|
65
|
-
*/
|
|
66
|
-
path: string;
|
|
67
|
-
/**
|
|
68
|
-
* 'data' contains the actual binary file data.
|
|
69
|
-
*
|
|
70
|
-
* Restrictions:
|
|
71
|
-
* - Size must be greater than 0 bytes.
|
|
72
|
-
* - Size must be less than 10 MB (10,485,760 bytes).
|
|
73
|
-
*
|
|
74
|
-
* @generated from protobuf field: bytes data = 2;
|
|
75
|
-
*/
|
|
76
|
-
data: Uint8Array;
|
|
77
|
-
}
|
|
78
|
-
/**
|
|
79
|
-
* Manifest describes a plugin and its properties.
|
|
80
|
-
*
|
|
81
|
-
* The ES module names and entry points follow a convention for the executor_esm and
|
|
82
|
-
* configurator_esm files:
|
|
83
|
-
* - export {<vertex-name>InternalConfigurator} for the internal endpoint of the
|
|
84
|
-
* vertex configurator
|
|
85
|
-
* - export {<vertex-name>ExternalConfigurator} for the external endpoint of the
|
|
86
|
-
* vertex configurator
|
|
87
|
-
* - export {<vertex-name>InternalExecutor} for the internal endpoint of the
|
|
88
|
-
* vertex executor
|
|
89
|
-
* - export {<vertex-name>ExternalExecutor} for the external endpoint of the
|
|
90
|
-
* vertex executor
|
|
91
|
-
*
|
|
92
|
-
* Security considerations: The platform ensures that secrets and certificates
|
|
93
|
-
* are stored and transmitted securely.
|
|
94
|
-
*
|
|
95
|
-
* *** Plugin authors must also ensure that their implementations
|
|
96
|
-
* handle sensitive data appropriately! ***
|
|
97
|
-
*
|
|
98
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.Manifest
|
|
99
|
-
*/
|
|
100
|
-
export interface Manifest {
|
|
101
|
-
/**
|
|
102
|
-
* 'name' is the alpha-numeric identifier of the plugin.
|
|
103
|
-
*
|
|
104
|
-
* Restrictions:
|
|
105
|
-
* - Must match the ECMA regex: ^[_$a-z][_$a-z0-9]*$
|
|
106
|
-
* - Length must be greater than 0 and less than 50 characters.
|
|
107
|
-
* Security implications:
|
|
108
|
-
* - Should not contain sensitive information.
|
|
109
|
-
*
|
|
110
|
-
* @generated from protobuf field: string name = 1;
|
|
111
|
-
*/
|
|
112
|
-
name: string;
|
|
113
|
-
/**
|
|
114
|
-
* 'version' is the plugin's version, following SemVer 2.0.
|
|
115
|
-
*
|
|
116
|
-
* Restrictions:
|
|
117
|
-
* - Must be compatible with: https://semver.org/
|
|
118
|
-
* - Must match the ECMA regex:
|
|
119
|
-
* ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
|
|
120
|
-
* - Length must be less than 150 characters.
|
|
121
|
-
*
|
|
122
|
-
* @generated from protobuf field: string version = 2;
|
|
123
|
-
*/
|
|
124
|
-
version: string;
|
|
125
|
-
/**
|
|
126
|
-
* 'label' is a human-friendly label displayed in the UI.
|
|
127
|
-
*
|
|
128
|
-
* Restrictions:
|
|
129
|
-
* - Length must be greater than 0 and less than 25 characters.
|
|
130
|
-
* Security implications:
|
|
131
|
-
* - Should not contain sensitive information.
|
|
132
|
-
*
|
|
133
|
-
* @generated from protobuf field: string label = 3;
|
|
134
|
-
*/
|
|
135
|
-
label: string;
|
|
136
|
-
/**
|
|
137
|
-
* 'description' is a short, human-friendly description displayed in the UI.
|
|
138
|
-
*
|
|
139
|
-
* Restrictions:
|
|
140
|
-
* - Length must be greater than 0 and less than 250 characters.
|
|
141
|
-
* Security implications:
|
|
142
|
-
* - Should not contain sensitive information.
|
|
143
|
-
*
|
|
144
|
-
* @generated from protobuf field: string description = 4;
|
|
145
|
-
*/
|
|
146
|
-
description: string;
|
|
147
|
-
/**
|
|
148
|
-
* 'homepage' is the plugin's homepage URL.
|
|
149
|
-
*
|
|
150
|
-
* Restrictions:
|
|
151
|
-
* - Must be a valid URL.
|
|
152
|
-
* Security implications:
|
|
153
|
-
* - Should not contain sensitive information.
|
|
154
|
-
*
|
|
155
|
-
* @generated from protobuf field: optional string homepage = 5;
|
|
156
|
-
*/
|
|
157
|
-
homepage?: string;
|
|
158
|
-
/**
|
|
159
|
-
* 'repository' is the plugin's repository URL.
|
|
160
|
-
*
|
|
161
|
-
* Restrictions:
|
|
162
|
-
* - Must be a valid URL.
|
|
163
|
-
* Security implications:
|
|
164
|
-
* - Should not contain sensitive information.
|
|
165
|
-
*
|
|
166
|
-
* @generated from protobuf field: optional string repository = 6;
|
|
167
|
-
*/
|
|
168
|
-
repository?: string;
|
|
169
|
-
/**
|
|
170
|
-
* 'bugs' is the URL or email for reporting bugs.
|
|
171
|
-
*
|
|
172
|
-
* Restrictions:
|
|
173
|
-
* - Must be a valid URL or email address.
|
|
174
|
-
* Security implications:
|
|
175
|
-
* - Should not contain sensitive information.
|
|
176
|
-
*
|
|
177
|
-
* @generated from protobuf field: optional string bugs = 7;
|
|
178
|
-
*/
|
|
179
|
-
bugs?: string;
|
|
180
|
-
/**
|
|
181
|
-
* 'author' is the name of the plugin's author.
|
|
182
|
-
*
|
|
183
|
-
* Restrictions:
|
|
184
|
-
* - Length must be less than 100 characters.
|
|
185
|
-
* Security implications:
|
|
186
|
-
* - Should not contain sensitive information.
|
|
187
|
-
*
|
|
188
|
-
* @generated from protobuf field: optional string author = 8;
|
|
189
|
-
*/
|
|
190
|
-
author?: string;
|
|
191
|
-
/**
|
|
192
|
-
* 'logo' is an optional path to the plugin logo.
|
|
193
|
-
* The logo will be resized to a maximum of 80x80 pixels.
|
|
194
|
-
*
|
|
195
|
-
* Restrictions:
|
|
196
|
-
* - Must be a valid Unix file path.
|
|
197
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
198
|
-
* - Length must be less than 4096 characters.
|
|
199
|
-
* - Supported file formats:
|
|
200
|
-
* - GIF: .gif
|
|
201
|
-
* - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
|
|
202
|
-
* - PNG: .png
|
|
203
|
-
* - SVG: .svg
|
|
204
|
-
* - WEBP: .webp
|
|
205
|
-
* - AVIF: .avif
|
|
206
|
-
* - Length must be less than 1024 characters.
|
|
207
|
-
*
|
|
208
|
-
* @generated from protobuf field: optional string logo = 9;
|
|
209
|
-
*/
|
|
210
|
-
logo?: string;
|
|
211
|
-
/**
|
|
212
|
-
* 'executor_esm' is the path to the executor ES module file.
|
|
213
|
-
*
|
|
214
|
-
* Restrictions:
|
|
215
|
-
* - Must be a valid Unix file path.
|
|
216
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
217
|
-
* - Length must be less than 4096 characters.
|
|
218
|
-
* - Supported file formats: .js, .mjs
|
|
219
|
-
*
|
|
220
|
-
* @generated from protobuf field: string executor_esm = 10;
|
|
221
|
-
*/
|
|
222
|
-
executorEsm: string;
|
|
223
|
-
/**
|
|
224
|
-
* 'configurator_esm' is an optional path to the configurator ES module file.
|
|
225
|
-
*
|
|
226
|
-
* Restrictions:
|
|
227
|
-
* - Must be a valid Unix file path.
|
|
228
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
229
|
-
* - Length must be less than 4096 characters.
|
|
230
|
-
* - Supported file formats: .js, .mjs
|
|
231
|
-
* - Required if the 'config' property is set for any global or vertex.
|
|
232
|
-
*
|
|
233
|
-
* @generated from protobuf field: optional string configurator_esm = 11;
|
|
234
|
-
*/
|
|
235
|
-
configuratorEsm?: string;
|
|
236
|
-
/**
|
|
237
|
-
* 'assets_dir' is an optional directory containing all static assets
|
|
238
|
-
* available to the plugin.
|
|
239
|
-
*
|
|
240
|
-
* Restrictions:
|
|
241
|
-
* - Must be a valid Unix directory path.
|
|
242
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]*)*\/?$
|
|
243
|
-
* - Length must be less than 4096 characters.
|
|
244
|
-
*
|
|
245
|
-
* @generated from protobuf field: optional string assets_dir = 12;
|
|
246
|
-
*/
|
|
247
|
-
assetsDir?: string;
|
|
248
|
-
/**
|
|
249
|
-
* 'default_config' is an field that contains
|
|
250
|
-
* a Unix file path.
|
|
251
|
-
*
|
|
252
|
-
* Security implications:
|
|
253
|
-
* - Ensure that the file path points to a trusted location.
|
|
254
|
-
* - Validate and sanitize the JSON string before using it in your
|
|
255
|
-
* application.
|
|
256
|
-
*
|
|
257
|
-
* Restrictions:
|
|
258
|
-
* 1. a Unix file path:
|
|
259
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
260
|
-
* - Length must be less than 4096 characters.
|
|
261
|
-
* - Allowed format: .json
|
|
262
|
-
* 2. We always require a default config
|
|
263
|
-
* 3. plugin.cue#PluginConfig must validate the config
|
|
264
|
-
* 4. This field is required if any Vertex is requiring a plugin config
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* @generated from protobuf field: optional string default_config = 13;
|
|
268
|
-
*/
|
|
269
|
-
defaultConfig?: string;
|
|
270
|
-
/**
|
|
271
|
-
* 'vertices' is a list of vertices that constitute the plugin.
|
|
272
|
-
*
|
|
273
|
-
* Restrictions:
|
|
274
|
-
* - The count must be greater than 0 and less than or equal to 100.
|
|
275
|
-
*
|
|
276
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.Vertex vertices = 14;
|
|
277
|
-
*/
|
|
278
|
-
vertices: Vertex[];
|
|
279
|
-
/**
|
|
280
|
-
* 'user_secrets' represents the user secrets required by the plugin.
|
|
281
|
-
* The platform ensures secure storage and transmission of secrets.
|
|
282
|
-
*
|
|
283
|
-
* Restrictions:
|
|
284
|
-
* - Must have between 0 and 10 user secrets, inclusive.
|
|
285
|
-
*
|
|
286
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.Secret user_secrets = 15;
|
|
287
|
-
*/
|
|
288
|
-
userSecrets: Secret[];
|
|
289
|
-
/**
|
|
290
|
-
* 'user_mtls' represents the user mTLS (mutual TLS) certificates required by
|
|
291
|
-
* the plugin. The platform ensures secure storage and transmission of
|
|
292
|
-
* certificates.
|
|
293
|
-
*
|
|
294
|
-
* Restrictions:
|
|
295
|
-
* - Must have between 0 and 5 user mTLS certificates, inclusive.
|
|
296
|
-
*
|
|
297
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.MTLSService user_mtls = 16;
|
|
298
|
-
*/
|
|
299
|
-
userMtls: MTLSService[];
|
|
300
|
-
/**
|
|
301
|
-
* 'plugin_mtls' represents the plugin mTLS (mutual TLS) certificates.
|
|
302
|
-
* The platform ensures secure storage and transmission of certificates.
|
|
303
|
-
*
|
|
304
|
-
* Restrictions:
|
|
305
|
-
* - Must have between 0 and 5 plugin mTLS certificates, inclusive.
|
|
306
|
-
*
|
|
307
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.MTLSService plugin_mtls = 17;
|
|
308
|
-
*/
|
|
309
|
-
pluginMtls: MTLSService[];
|
|
310
|
-
/**
|
|
311
|
-
* 'plugin_secrets' represents the secrets available to the plugin.
|
|
312
|
-
* The platform ensures secure storage and transmission of secrets.
|
|
313
|
-
* These variables are set by the owner of the plugin.
|
|
314
|
-
*
|
|
315
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.Secret plugin_secrets = 18;
|
|
316
|
-
*/
|
|
317
|
-
pluginSecrets: Secret[];
|
|
318
|
-
/**
|
|
319
|
-
* 'oauth2' represents the OAuth2 services required for the plugin.
|
|
320
|
-
* OAuth2 parameters are specified in the platform, and the service name is
|
|
321
|
-
* used as an identifier to fetch the access token from the API.
|
|
322
|
-
*
|
|
323
|
-
* @generated from protobuf field: repeated mochabug.adapt.plugins.v1.OAuth2Service oauth2 = 19;
|
|
324
|
-
*/
|
|
325
|
-
oauth2: OAuth2Service[];
|
|
326
|
-
}
|
|
327
|
-
/**
|
|
328
|
-
* MTLSService represents a mutual Transport Layer Security (mTLS) service
|
|
329
|
-
* configuration required by the plugin. mTLS provides secure communication
|
|
330
|
-
* between client and server by authenticating both parties and encrypting the
|
|
331
|
-
* communication.
|
|
332
|
-
*
|
|
333
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.MTLSService
|
|
334
|
-
*/
|
|
335
|
-
export interface MTLSService {
|
|
336
|
-
/**
|
|
337
|
-
* 'name' is the identifier of the mTLS service.
|
|
338
|
-
* It's used for referencing the specific mTLS configuration.
|
|
339
|
-
*
|
|
340
|
-
* Restrictions:
|
|
341
|
-
* - Must match the ECMA regex: ^[_$a-z][_$a-z0-9]*$
|
|
342
|
-
* - Length must be greater than 0 and less than 50 characters.
|
|
343
|
-
* Security implications:
|
|
344
|
-
* - Should not contain sensitive information.
|
|
345
|
-
*
|
|
346
|
-
* @generated from protobuf field: string name = 1;
|
|
347
|
-
*/
|
|
348
|
-
name: string;
|
|
349
|
-
/**
|
|
350
|
-
* 'optional' indicates whether the mTLS service is required to be configured.
|
|
351
|
-
* If set to true, the plugin can still be considered configured even if the
|
|
352
|
-
* mTLS is not configured. If set to false, the plugin is not considered
|
|
353
|
-
* configured unless the mTLS is also configured. A missing or improperly
|
|
354
|
-
* configured mTLS service can impact the security of the plugin's
|
|
355
|
-
* communication.
|
|
356
|
-
*
|
|
357
|
-
* @generated from protobuf field: bool optional = 2;
|
|
358
|
-
*/
|
|
359
|
-
optional: boolean;
|
|
360
|
-
/**
|
|
361
|
-
* 'trusted_ca' is a a path to the trusted server authority file
|
|
362
|
-
*
|
|
363
|
-
* Restrictions:
|
|
364
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
365
|
-
* - Length must be less than 4096 characters.
|
|
366
|
-
* - Allowed formats: .pem, .crt, .cer, ca-bundle
|
|
367
|
-
* - PEM format
|
|
368
|
-
*
|
|
369
|
-
* @generated from protobuf field: string trusted_ca = 3;
|
|
370
|
-
*/
|
|
371
|
-
trustedCa: string;
|
|
372
|
-
/**
|
|
373
|
-
* 'label' is an optional short label describing the purpose of the mTLS
|
|
374
|
-
* service.
|
|
375
|
-
*
|
|
376
|
-
* Restrictions:
|
|
377
|
-
* - Length must be greater than 0 and less than 25 characters.
|
|
378
|
-
* Security implications:
|
|
379
|
-
* - Should not contain sensitive information.
|
|
380
|
-
*
|
|
381
|
-
* @generated from protobuf field: optional string label = 4;
|
|
382
|
-
*/
|
|
383
|
-
label?: string;
|
|
384
|
-
/**
|
|
385
|
-
* 'description' is an optional detailed description of the mTLS service and
|
|
386
|
-
* its usage within the plugin.
|
|
387
|
-
*
|
|
388
|
-
* Restrictions:
|
|
389
|
-
* - Length must be less than 250 characters.
|
|
390
|
-
* Security implications:
|
|
391
|
-
* - Should not contain sensitive information.
|
|
392
|
-
*
|
|
393
|
-
* @generated from protobuf field: optional string description = 5;
|
|
394
|
-
*/
|
|
395
|
-
description?: string;
|
|
396
|
-
}
|
|
397
|
-
/**
|
|
398
|
-
* OAuth2Service defines the OAuth2 configuration required for a plugin.
|
|
399
|
-
*
|
|
400
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.OAuth2Service
|
|
401
|
-
*/
|
|
402
|
-
export interface OAuth2Service {
|
|
403
|
-
/**
|
|
404
|
-
* 'name' is the identifier for the OAuth2 service.
|
|
405
|
-
*
|
|
406
|
-
* Restrictions:
|
|
407
|
-
* - Must match the ECMA regex: ^[_$a-z][_$a-z0-9]*$
|
|
408
|
-
* - Length must be greater than 0 and less than 50 characters.
|
|
409
|
-
* Security implications:
|
|
410
|
-
* - Should not contain sensitive information.
|
|
411
|
-
*
|
|
412
|
-
* @generated from protobuf field: string name = 1;
|
|
413
|
-
*/
|
|
414
|
-
name: string;
|
|
415
|
-
/**
|
|
416
|
-
* 'optional' indicates whether the OAuth2 service configuration is required.
|
|
417
|
-
* When set to true, the plugin can be used without configuring the OAuth2
|
|
418
|
-
* service. When set to false, the plugin is considered invalid if the OAuth2
|
|
419
|
-
* service is not configured.
|
|
420
|
-
*
|
|
421
|
-
* @generated from protobuf field: bool optional = 2;
|
|
422
|
-
*/
|
|
423
|
-
optional: boolean;
|
|
424
|
-
/**
|
|
425
|
-
* 'grant_type' specifies the OAuth2 grant type to be used.
|
|
426
|
-
*
|
|
427
|
-
* @generated from protobuf field: mochabug.adapt.plugins.v1.OAuth2Service.GrantType grant_type = 3;
|
|
428
|
-
*/
|
|
429
|
-
grantType: OAuth2Service_GrantType;
|
|
430
|
-
/**
|
|
431
|
-
* 'label' is an optional short label describing the purpose of the OAuth2
|
|
432
|
-
* service.
|
|
433
|
-
*
|
|
434
|
-
* Restrictions:
|
|
435
|
-
* - Length must be greater than 0 and less than 25 characters.
|
|
436
|
-
* Security implications:
|
|
437
|
-
* - Should not contain sensitive information.
|
|
438
|
-
*
|
|
439
|
-
* @generated from protobuf field: optional string label = 4;
|
|
440
|
-
*/
|
|
441
|
-
label?: string;
|
|
442
|
-
/**
|
|
443
|
-
* 'description' is a full description about the oauth2 and what it's used for
|
|
444
|
-
*
|
|
445
|
-
* Restrictions:
|
|
446
|
-
* - Length must be greater than 0 and less than 250 characters.
|
|
447
|
-
* Security implications:
|
|
448
|
-
* - Should not contain sensitive information.
|
|
449
|
-
*
|
|
450
|
-
* @generated from protobuf field: optional string description = 5;
|
|
451
|
-
*/
|
|
452
|
-
description?: string;
|
|
453
|
-
}
|
|
454
|
-
/**
|
|
455
|
-
* GrantType represents the supported OAuth2 grant types.
|
|
456
|
-
*
|
|
457
|
-
* @generated from protobuf enum mochabug.adapt.plugins.v1.OAuth2Service.GrantType
|
|
458
|
-
*/
|
|
459
|
-
export declare enum OAuth2Service_GrantType {
|
|
460
|
-
/**
|
|
461
|
-
* GRANT_TYPE_UNSPECIFIED indicates an unspecified or invalid grant type.
|
|
462
|
-
*
|
|
463
|
-
* @generated from protobuf enum value: GRANT_TYPE_UNSPECIFIED = 0;
|
|
464
|
-
*/
|
|
465
|
-
UNSPECIFIED = 0,
|
|
466
|
-
/**
|
|
467
|
-
* GRANT_TYPE_CODE represents the authorization code grant type.
|
|
468
|
-
* Access tokens are issued on a per-user basis.
|
|
469
|
-
*
|
|
470
|
-
* @generated from protobuf enum value: GRANT_TYPE_CODE = 1;
|
|
471
|
-
*/
|
|
472
|
-
CODE = 1,
|
|
473
|
-
/**
|
|
474
|
-
* GRANT_TYPE_CLIENT_CREDENTIALS represents the client credentials grant
|
|
475
|
-
* type. Access tokens are issued globally for the plugin.
|
|
476
|
-
*
|
|
477
|
-
* @generated from protobuf enum value: GRANT_TYPE_CLIENT_CREDENTIALS = 2;
|
|
478
|
-
*/
|
|
479
|
-
CLIENT_CREDENTIALS = 2
|
|
480
|
-
}
|
|
481
|
-
/**
|
|
482
|
-
* Secret represents sensitive information that is stored and transmitted
|
|
483
|
-
* securely by the platform. Plugins should never require secrets themselves to
|
|
484
|
-
* ensure security.
|
|
485
|
-
*
|
|
486
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.Secret
|
|
487
|
-
*/
|
|
488
|
-
export interface Secret {
|
|
489
|
-
/**
|
|
490
|
-
* 'name' is the identifier of the secret, which is referenced where needed.
|
|
491
|
-
*
|
|
492
|
-
* Restrictions:
|
|
493
|
-
* - Must match the ECMA regex: ^[_$a-z][_$a-z0-9]*$
|
|
494
|
-
* - Length must be greater than 0 and less than 50 characters.
|
|
495
|
-
* Security implications:
|
|
496
|
-
* - Should not contain sensitive information.
|
|
497
|
-
*
|
|
498
|
-
* @generated from protobuf field: string name = 1;
|
|
499
|
-
*/
|
|
500
|
-
name: string;
|
|
501
|
-
/**
|
|
502
|
-
* 'optional' indicates whether the secret is optional or required.
|
|
503
|
-
*
|
|
504
|
-
* @generated from protobuf field: bool optional = 2;
|
|
505
|
-
*/
|
|
506
|
-
optional: boolean;
|
|
507
|
-
/**
|
|
508
|
-
* 'label' is a short, human-readable label describing the purpose of the
|
|
509
|
-
* secret.
|
|
510
|
-
*
|
|
511
|
-
* Restrictions:
|
|
512
|
-
* - Length must be greater than 0 and less than 25 characters.
|
|
513
|
-
* Security implications:
|
|
514
|
-
* - Avoid including sensitive information in the label.
|
|
515
|
-
*
|
|
516
|
-
* @generated from protobuf field: optional string label = 3;
|
|
517
|
-
*/
|
|
518
|
-
label?: string;
|
|
519
|
-
/**
|
|
520
|
-
* 'description' is a detailed description of the secret and its use.
|
|
521
|
-
*
|
|
522
|
-
* Restrictions:
|
|
523
|
-
* - Length must be less than 250 characters.
|
|
524
|
-
* Security implications:
|
|
525
|
-
* - Avoid including sensitive information in the description.
|
|
526
|
-
*
|
|
527
|
-
* @generated from protobuf field: optional string description = 4;
|
|
528
|
-
*/
|
|
529
|
-
description?: string;
|
|
530
|
-
}
|
|
531
|
-
/**
|
|
532
|
-
* Vertex represents a graph vertex that defines a plugin.
|
|
533
|
-
* The ES module names and entry points follow a convention for the executor_esm and
|
|
534
|
-
* configurator_esm files:
|
|
535
|
-
* - export {<vertex-name>InternalConfigurator} for the internal endpoint of the
|
|
536
|
-
* vertex configurator
|
|
537
|
-
* - export {<vertex-name>ExternalConfigurator} for the external endpoint of the
|
|
538
|
-
* vertex configurator
|
|
539
|
-
* - export {<vertex-name>InternalExecutor} for the internal endpoint of the
|
|
540
|
-
* vertex executor
|
|
541
|
-
* - export {<vertex-name>ExternalExecutor} for the external endpoint of the
|
|
542
|
-
* vertex executor
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
* Note: Be aware of potential security implications when dealing with
|
|
546
|
-
* user-provided data, such as file paths, and ensure proper input validation
|
|
547
|
-
* and sanitization.
|
|
548
|
-
*
|
|
549
|
-
* @generated from protobuf message mochabug.adapt.plugins.v1.Vertex
|
|
550
|
-
*/
|
|
551
|
-
export interface Vertex {
|
|
552
|
-
/**
|
|
553
|
-
* 'name' represents the vertex name.
|
|
554
|
-
*
|
|
555
|
-
* Restrictions:
|
|
556
|
-
* - Must match the ECMA regex: ^[_$a-z][_$a-z0-9]*$
|
|
557
|
-
* - Length must be greater than 0 and less than 50 characters.
|
|
558
|
-
* Security implications:
|
|
559
|
-
* - Should not contain sensitive information.
|
|
560
|
-
*
|
|
561
|
-
* @generated from protobuf field: string name = 1;
|
|
562
|
-
*/
|
|
563
|
-
name: string;
|
|
564
|
-
/**
|
|
565
|
-
* 'label' is a human-friendly label shown in the UI.
|
|
566
|
-
*
|
|
567
|
-
* Restrictions:
|
|
568
|
-
* - Length must be greater than 0 and less than 25 characters.
|
|
569
|
-
* Security implications:
|
|
570
|
-
* - Should not contain sensitive information.
|
|
571
|
-
*
|
|
572
|
-
* @generated from protobuf field: string label = 2;
|
|
573
|
-
*/
|
|
574
|
-
label: string;
|
|
575
|
-
/**
|
|
576
|
-
* 'description' is a human-friendly short description of the vertex displayed
|
|
577
|
-
* in UI.
|
|
578
|
-
*
|
|
579
|
-
* Restrictions:
|
|
580
|
-
* - Length must be greater than 0 and less than 250 characters.
|
|
581
|
-
* Security implications:
|
|
582
|
-
* - Should not contain sensitive information.
|
|
583
|
-
*
|
|
584
|
-
* @generated from protobuf field: optional string description = 3;
|
|
585
|
-
*/
|
|
586
|
-
description?: string;
|
|
587
|
-
/**
|
|
588
|
-
* 'logo' is the file path to the vertex logo, which will be resized to a
|
|
589
|
-
* maximum of 40x40 pixels. Ensure that the logo files are from trusted
|
|
590
|
-
* sources to avoid security risks.
|
|
591
|
-
*
|
|
592
|
-
* Restrictions:
|
|
593
|
-
* - Must be a valid Unix file path.
|
|
594
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
595
|
-
* - Length must be less than 4096 characters.
|
|
596
|
-
* - Supported formats: GIF (.gif), JPEG (.jpg, .jpeg, .jfif, .pjpeg, .pjp),
|
|
597
|
-
* PNG (.png),
|
|
598
|
-
* SVG (.svg), WEBP (.webp), and AVIF (.avif).
|
|
599
|
-
*
|
|
600
|
-
* @generated from protobuf field: optional string logo = 4;
|
|
601
|
-
*/
|
|
602
|
-
logo?: string;
|
|
603
|
-
/**
|
|
604
|
-
* 'type' specifies the type of the vertex.
|
|
605
|
-
*
|
|
606
|
-
* Restrictions:
|
|
607
|
-
* - Must not be VERTEX_TYPE_UNSPECIFIED.
|
|
608
|
-
*
|
|
609
|
-
* @generated from protobuf field: mochabug.adapt.plugins.v1.Vertex.VertexType type = 5;
|
|
610
|
-
*/
|
|
611
|
-
type: Vertex_VertexType;
|
|
612
|
-
/**
|
|
613
|
-
* 'default_config' is an field that contains
|
|
614
|
-
* a Unix file path.
|
|
615
|
-
*
|
|
616
|
-
* Security implications:
|
|
617
|
-
* - Ensure that the file path points to a trusted location.
|
|
618
|
-
* - Validate and sanitize the JSON string before using it in your
|
|
619
|
-
* application.
|
|
620
|
-
*
|
|
621
|
-
* Restrictions:
|
|
622
|
-
* 1. a Unix file path:
|
|
623
|
-
* - Must match the ECMA regex: ^/[^/\0]*(/[^/\0]+)*[^/]$
|
|
624
|
-
* - Length must be less than 4096 characters.
|
|
625
|
-
* - Allowed format: .json
|
|
626
|
-
* 2. We always require a default config
|
|
627
|
-
* 3. plugin.cue#VertexConfig must validate the config
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
* @generated from protobuf field: string default_config = 6;
|
|
631
|
-
*/
|
|
632
|
-
defaultConfig: string;
|
|
633
|
-
/**
|
|
634
|
-
* 'has_configurator' is a field to indicate whether or not
|
|
635
|
-
* the vertex has a configurator. That is: if it exports in the configurator_esm:
|
|
636
|
-
* - export {<vertex-name>InternalConfigurator} for the internal endpoint of the
|
|
637
|
-
* vertex configurator
|
|
638
|
-
* - export {<vertex-name>ExternalConfigurator} for the external endpoint of the
|
|
639
|
-
* vertex configurator
|
|
640
|
-
*
|
|
641
|
-
* @generated from protobuf field: bool has_configurator = 7;
|
|
642
|
-
*/
|
|
643
|
-
hasConfigurator: boolean;
|
|
644
|
-
/**
|
|
645
|
-
* 'cron_interval' defines the interval in milliseconds at which the cron
|
|
646
|
-
* trigger is fired.
|
|
647
|
-
*
|
|
648
|
-
* Restrictions:
|
|
649
|
-
* - Must be set for a VERTEX_TYPE_CRON_TRIGGER without a configurator ESM.
|
|
650
|
-
* - Must be greater than 10 ms.
|
|
651
|
-
* - The value is ignored for all other trigger types.
|
|
652
|
-
*
|
|
653
|
-
* Implications:
|
|
654
|
-
* - Setting an extremely low interval value may utilize a lot of resources
|
|
655
|
-
*
|
|
656
|
-
* @generated from protobuf field: optional uint32 cron_interval = 8;
|
|
657
|
-
*/
|
|
658
|
-
cronInterval?: number;
|
|
659
|
-
/**
|
|
660
|
-
* 'require_plugin_config' indicates whether the vertex requires plugin
|
|
661
|
-
* configuration. Defaults to false
|
|
662
|
-
*
|
|
663
|
-
* @generated from protobuf field: optional bool require_plugin_config = 9;
|
|
664
|
-
*/
|
|
665
|
-
requirePluginConfig?: boolean;
|
|
666
|
-
}
|
|
667
|
-
/**
|
|
668
|
-
* VertexType represents the type of a vertex.
|
|
669
|
-
*
|
|
670
|
-
* @generated from protobuf enum mochabug.adapt.plugins.v1.Vertex.VertexType
|
|
671
|
-
*/
|
|
672
|
-
export declare enum Vertex_VertexType {
|
|
673
|
-
/**
|
|
674
|
-
* Unspecified type (default value, should not be used).
|
|
675
|
-
*
|
|
676
|
-
* @generated from protobuf enum value: VERTEX_TYPE_UNSPECIFIED = 0;
|
|
677
|
-
*/
|
|
678
|
-
UNSPECIFIED = 0,
|
|
679
|
-
/**
|
|
680
|
-
* Action type, available in all contexts and not exposed to the outside
|
|
681
|
-
* world. This type has a lower security risk.
|
|
682
|
-
*
|
|
683
|
-
* @generated from protobuf enum value: VERTEX_TYPE_ACTION = 1;
|
|
684
|
-
*/
|
|
685
|
-
ACTION = 1,
|
|
686
|
-
/**
|
|
687
|
-
* Browser type, available only in a browser context.
|
|
688
|
-
* The configuration always runs inside a browser context.
|
|
689
|
-
* Security implications: be cautious about potentially sensitive data
|
|
690
|
-
* exposure.
|
|
691
|
-
*
|
|
692
|
-
* @generated from protobuf enum value: VERTEX_TYPE_BROWSER = 2;
|
|
693
|
-
*/
|
|
694
|
-
BROWSER = 2,
|
|
695
|
-
/**
|
|
696
|
-
* CronTrigger type, available only in a trigger context.
|
|
697
|
-
* Triggered at specific intervals.
|
|
698
|
-
*
|
|
699
|
-
* @generated from protobuf enum value: VERTEX_TYPE_CRON_TRIGGER = 3;
|
|
700
|
-
*/
|
|
701
|
-
CRON_TRIGGER = 3,
|
|
702
|
-
/**
|
|
703
|
-
* ExternalTrigger type, available only in a trigger context.
|
|
704
|
-
* Accessible via a publicly routable address.
|
|
705
|
-
* Security implications: be cautious about exposing sensitive data or
|
|
706
|
-
* functionality.
|
|
707
|
-
*
|
|
708
|
-
* @generated from protobuf enum value: VERTEX_TYPE_EXTERNAL_TRIGGER = 4;
|
|
709
|
-
*/
|
|
710
|
-
EXTERNAL_TRIGGER = 4
|
|
711
|
-
}
|
|
712
|
-
declare class UploadPluginRequest$Type extends MessageType<UploadPluginRequest> {
|
|
713
|
-
constructor();
|
|
714
|
-
create(value?: PartialMessage<UploadPluginRequest>): UploadPluginRequest;
|
|
715
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: UploadPluginRequest): UploadPluginRequest;
|
|
716
|
-
internalBinaryWrite(message: UploadPluginRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
717
|
-
}
|
|
718
|
-
/**
|
|
719
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.UploadPluginRequest
|
|
720
|
-
*/
|
|
721
|
-
export declare const UploadPluginRequest: UploadPluginRequest$Type;
|
|
722
|
-
declare class UploadPluginResponse$Type extends MessageType<UploadPluginResponse> {
|
|
723
|
-
constructor();
|
|
724
|
-
create(value?: PartialMessage<UploadPluginResponse>): UploadPluginResponse;
|
|
725
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: UploadPluginResponse): UploadPluginResponse;
|
|
726
|
-
internalBinaryWrite(message: UploadPluginResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
727
|
-
}
|
|
728
|
-
/**
|
|
729
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.UploadPluginResponse
|
|
730
|
-
*/
|
|
731
|
-
export declare const UploadPluginResponse: UploadPluginResponse$Type;
|
|
732
|
-
declare class File$Type extends MessageType<File> {
|
|
733
|
-
constructor();
|
|
734
|
-
create(value?: PartialMessage<File>): File;
|
|
735
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: File): File;
|
|
736
|
-
internalBinaryWrite(message: File, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
737
|
-
}
|
|
738
|
-
/**
|
|
739
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.File
|
|
740
|
-
*/
|
|
741
|
-
export declare const File: File$Type;
|
|
742
|
-
declare class Manifest$Type extends MessageType<Manifest> {
|
|
743
|
-
constructor();
|
|
744
|
-
create(value?: PartialMessage<Manifest>): Manifest;
|
|
745
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Manifest): Manifest;
|
|
746
|
-
internalBinaryWrite(message: Manifest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
747
|
-
}
|
|
748
|
-
/**
|
|
749
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.Manifest
|
|
750
|
-
*/
|
|
751
|
-
export declare const Manifest: Manifest$Type;
|
|
752
|
-
declare class MTLSService$Type extends MessageType<MTLSService> {
|
|
753
|
-
constructor();
|
|
754
|
-
create(value?: PartialMessage<MTLSService>): MTLSService;
|
|
755
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MTLSService): MTLSService;
|
|
756
|
-
internalBinaryWrite(message: MTLSService, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
757
|
-
}
|
|
758
|
-
/**
|
|
759
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.MTLSService
|
|
760
|
-
*/
|
|
761
|
-
export declare const MTLSService: MTLSService$Type;
|
|
762
|
-
declare class OAuth2Service$Type extends MessageType<OAuth2Service> {
|
|
763
|
-
constructor();
|
|
764
|
-
create(value?: PartialMessage<OAuth2Service>): OAuth2Service;
|
|
765
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: OAuth2Service): OAuth2Service;
|
|
766
|
-
internalBinaryWrite(message: OAuth2Service, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
767
|
-
}
|
|
768
|
-
/**
|
|
769
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.OAuth2Service
|
|
770
|
-
*/
|
|
771
|
-
export declare const OAuth2Service: OAuth2Service$Type;
|
|
772
|
-
declare class Secret$Type extends MessageType<Secret> {
|
|
773
|
-
constructor();
|
|
774
|
-
create(value?: PartialMessage<Secret>): Secret;
|
|
775
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Secret): Secret;
|
|
776
|
-
internalBinaryWrite(message: Secret, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
777
|
-
}
|
|
778
|
-
/**
|
|
779
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.Secret
|
|
780
|
-
*/
|
|
781
|
-
export declare const Secret: Secret$Type;
|
|
782
|
-
declare class Vertex$Type extends MessageType<Vertex> {
|
|
783
|
-
constructor();
|
|
784
|
-
create(value?: PartialMessage<Vertex>): Vertex;
|
|
785
|
-
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Vertex): Vertex;
|
|
786
|
-
internalBinaryWrite(message: Vertex, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
|
|
787
|
-
}
|
|
788
|
-
/**
|
|
789
|
-
* @generated MessageType for protobuf message mochabug.adapt.plugins.v1.Vertex
|
|
790
|
-
*/
|
|
791
|
-
export declare const Vertex: Vertex$Type;
|
|
792
|
-
/**
|
|
793
|
-
* @generated ServiceType for protobuf service mochabug.adapt.plugins.v1.PluginService
|
|
794
|
-
*/
|
|
795
|
-
export declare const PluginService: ServiceType;
|
|
796
|
-
export {};
|
|
797
|
-
//# sourceMappingURL=plugins.d.ts.map
|