@mochabug/adapt-web 0.0.19 → 0.0.21

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.
Files changed (58) hide show
  1. package/dist/genproto/buf/validate/validate_pb.d.ts +99 -150
  2. package/dist/genproto/buf/validate/validate_pb.js +5 -20
  3. package/dist/genproto/buf/validate/validate_pb.js.map +1 -1
  4. package/dist/genproto/google/api/annotations_pb.js +1 -1
  5. package/dist/genproto/google/api/client_pb.d.ts +40 -0
  6. package/dist/genproto/google/api/client_pb.js +2 -2
  7. package/dist/genproto/google/api/client_pb.js.map +1 -1
  8. package/dist/genproto/google/api/http_pb.js +2 -2
  9. package/dist/genproto/google/api/http_pb.js.map +1 -1
  10. package/dist/genproto/google/api/launch_stage_pb.js +1 -1
  11. package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.d.ts +12 -0
  12. package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.js +1 -1
  13. package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.js.map +1 -1
  14. package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.d.ts +50 -7
  15. package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.js +38 -2
  16. package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.js.map +1 -1
  17. package/dist/genproto/mochabugapis/adapt/graph/{vertex_config_pb.d.ts → vertex_metadata_pb.d.ts} +15 -27
  18. package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.js +28 -0
  19. package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.js.map +1 -0
  20. package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.d.ts +61 -0
  21. package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.js +25 -0
  22. package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.js.map +1 -0
  23. package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.d.ts +222 -0
  24. package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.js +28 -0
  25. package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.js.map +1 -0
  26. package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.d.ts +714 -0
  27. package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.js +184 -0
  28. package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.js.map +1 -0
  29. package/dist/genproto/mochabugapis/adapt/plugins/v1/oneof_service_pb.d.ts +91 -0
  30. package/dist/genproto/mochabugapis/adapt/plugins/v1/oneof_service_pb.js +27 -0
  31. package/dist/genproto/mochabugapis/adapt/plugins/v1/oneof_service_pb.js.map +1 -0
  32. package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.d.ts +72 -1254
  33. package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.js +10 -249
  34. package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.js.map +1 -1
  35. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_binding_pb.d.ts +133 -0
  36. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_binding_pb.js +30 -0
  37. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_binding_pb.js.map +1 -0
  38. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.d.ts +115 -0
  39. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.js +28 -0
  40. package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.js.map +1 -0
  41. package/dist/genproto/mochabugapis/adapt/plugins/v1/tls_service_pb.d.ts +158 -0
  42. package/dist/genproto/mochabugapis/adapt/plugins/v1/tls_service_pb.js +61 -0
  43. package/dist/genproto/mochabugapis/adapt/plugins/v1/tls_service_pb.js.map +1 -0
  44. package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts +59 -0
  45. package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.js +27 -0
  46. package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.js.map +1 -0
  47. package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts +223 -0
  48. package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.js +77 -0
  49. package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.js.map +1 -0
  50. package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.d.ts +20 -108
  51. package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.js +7 -17
  52. package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.js.map +1 -1
  53. package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.d.ts +295 -301
  54. package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.js +76 -81
  55. package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.js.map +1 -1
  56. package/package.json +4 -4
  57. package/dist/genproto/mochabugapis/adapt/graph/vertex_config_pb.js +0 -28
  58. package/dist/genproto/mochabugapis/adapt/graph/vertex_config_pb.js.map +0 -1
@@ -1,4 +1,6 @@
1
- import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
1
+ import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
2
+ import type { File, FileJson } from "./file_pb";
3
+ import type { Manifest, ManifestJson } from "./manifest_pb";
2
4
  import type { Message } from "@bufbuild/protobuf";
3
5
  /**
4
6
  * Describes the file mochabugapis/adapt/plugins/v1/plugins.proto.
@@ -20,13 +22,12 @@ export type UploadPluginRequest = Message<"mochabugapis.adapt.plugins.v1.UploadP
20
22
  */
21
23
  data: {
22
24
  /**
23
- * 'manifest' is the Manifest describing the plugin.
24
- * It must be the first message in the stream.
25
+ * 'start' must be the first message of the stream
25
26
  *
26
- * @generated from field: mochabugapis.adapt.plugins.v1.Manifest manifest = 1;
27
+ * @generated from field: mochabugapis.adapt.plugins.v1.StartUpload start = 1;
27
28
  */
28
- value: Manifest;
29
- case: "manifest";
29
+ value: StartUpload;
30
+ case: "start";
30
31
  } | {
31
32
  /**
32
33
  * 'file' is a File contained within the plugin.
@@ -50,12 +51,11 @@ export type UploadPluginRequest = Message<"mochabugapis.adapt.plugins.v1.UploadP
50
51
  */
51
52
  export type UploadPluginRequestJson = {
52
53
  /**
53
- * 'manifest' is the Manifest describing the plugin.
54
- * It must be the first message in the stream.
54
+ * 'start' must be the first message of the stream
55
55
  *
56
- * @generated from field: mochabugapis.adapt.plugins.v1.Manifest manifest = 1;
56
+ * @generated from field: mochabugapis.adapt.plugins.v1.StartUpload start = 1;
57
57
  */
58
- manifest?: ManifestJson;
58
+ start?: StartUploadJson;
59
59
  /**
60
60
  * 'file' is a File contained within the plugin.
61
61
  * It follows the manifest in the stream.
@@ -70,1303 +70,121 @@ export type UploadPluginRequestJson = {
70
70
  */
71
71
  export declare const UploadPluginRequestSchema: GenMessage<UploadPluginRequest, UploadPluginRequestJson>;
72
72
  /**
73
- * UploadPluginResponse represents the response from the CreatePlugin streaming
74
- * RPC. The server sends a single CreatePluginResponse after successfully
75
- * processing all UploadPluginResponse messages from the client.
76
- *
77
- * @generated from message mochabugapis.adapt.plugins.v1.UploadPluginResponse
78
- */
79
- export type UploadPluginResponse = Message<"mochabugapis.adapt.plugins.v1.UploadPluginResponse"> & {};
80
- /**
81
- * UploadPluginResponse represents the response from the CreatePlugin streaming
82
- * RPC. The server sends a single CreatePluginResponse after successfully
83
- * processing all UploadPluginResponse messages from the client.
84
- *
85
- * @generated from message mochabugapis.adapt.plugins.v1.UploadPluginResponse
86
- */
87
- export type UploadPluginResponseJson = {};
88
- /**
89
- * Describes the message mochabugapis.adapt.plugins.v1.UploadPluginResponse.
90
- * Use `create(UploadPluginResponseSchema)` to create a new message.
91
- */
92
- export declare const UploadPluginResponseSchema: GenMessage<UploadPluginResponse, UploadPluginResponseJson>;
93
- /**
94
- * File represents a file within a plugin package.
95
- *
96
- * @generated from message mochabugapis.adapt.plugins.v1.File
97
- */
98
- export type File = Message<"mochabugapis.adapt.plugins.v1.File"> & {
99
- /**
100
- * 'path' is the local file path relative to the manifest.json folder.
101
- *
102
- * @generated from field: string path = 1;
103
- */
104
- path: string;
105
- /**
106
- * 'data' contains the actual binary file data.
107
- *
108
- * @generated from field: bytes data = 2;
109
- */
110
- data: Uint8Array;
111
- };
112
- /**
113
- * File represents a file within a plugin package.
114
- *
115
- * @generated from message mochabugapis.adapt.plugins.v1.File
116
- */
117
- export type FileJson = {
118
- /**
119
- * 'path' is the local file path relative to the manifest.json folder.
120
- *
121
- * @generated from field: string path = 1;
122
- */
123
- path?: string;
124
- /**
125
- * 'data' contains the actual binary file data.
126
- *
127
- * @generated from field: bytes data = 2;
128
- */
129
- data?: string;
130
- };
131
- /**
132
- * Describes the message mochabugapis.adapt.plugins.v1.File.
133
- * Use `create(FileSchema)` to create a new message.
134
- */
135
- export declare const FileSchema: GenMessage<File, FileJson>;
136
- /**
137
- * Manifest describes a plugin and its properties.
138
- *
139
- * Security considerations: The platform ensures that secrets and certificates
140
- * are stored and transmitted securely.
141
- *
142
- * *** Plugin authors must also ensure that their implementations
143
- * handle sensitive data appropriately! ***
144
- *
145
- * @generated from message mochabugapis.adapt.plugins.v1.Manifest
146
- */
147
- export type Manifest = Message<"mochabugapis.adapt.plugins.v1.Manifest"> & {
148
- /**
149
- * 'name' is the alpha-numeric identifier of the plugin. Must be conform to a ES variable name
150
- *
151
- * @generated from field: string name = 1;
152
- */
153
- name: string;
154
- /**
155
- * 'version' is the plugin's version, following SemVer 2.0: https://semver.org/
156
- *
157
- * @generated from field: string version = 2;
158
- */
159
- version: string;
160
- /**
161
- * 'label' is a human-friendly label displayed in the UI.
162
- *
163
- * @generated from field: string label = 3;
164
- */
165
- label: string;
166
- /**
167
- * 'description' is a short, human-friendly description displayed in the UI.
168
- *
169
- * @generated from field: string description = 4;
170
- */
171
- description: string;
172
- /**
173
- * 'organization' is the id of the organization the user belongs to.
174
- *
175
- * @generated from field: string organization = 5;
176
- */
177
- organization: string;
178
- /**
179
- * 'homepage' is the plugin's homepage URL.
180
- *
181
- * @generated from field: optional string homepage = 6;
182
- */
183
- homepage?: string;
184
- /**
185
- * 'repository' is the plugin's repository URL.
186
- *
187
- * @generated from field: optional string repository = 7;
188
- */
189
- repository?: string;
190
- /**
191
- * 'bugs' is the URL or email for reporting bugs.
192
- *
193
- * @generated from field: optional string bugs = 8;
194
- */
195
- bugs?: string;
196
- /**
197
- * 'author' is the name of the plugin's author.
198
- *
199
- * @generated from field: optional string author = 9;
200
- */
201
- author?: string;
202
- /**
203
- * 'logo' is an optional path to the plugin logo.
204
- * The logo will be resized to a maximum of 80x80 pixels.
205
- * - Supported file formats:
206
- * - GIF: .gif
207
- * - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
208
- * - PNG: .png
209
- * - SVG: .svg
210
- * - WEBP: .webp
211
- * - AVIF: .avif
212
- *
213
- * @generated from field: optional string logo = 10;
214
- */
215
- logo?: string;
216
- /**
217
- * 'executors' is the path to the executor ES module file.
218
- *
219
- * @generated from field: string executors = 11;
220
- */
221
- executors: string;
222
- /**
223
- * 'configurators' is an optional path to the configurator ES module file.
224
- *
225
- * @generated from field: optional string configurators = 12;
226
- */
227
- configurators?: string;
228
- /**
229
- * 'assets' is an optional directory containing all static assets
230
- * available to the plugin.
231
- *
232
- * @generated from field: optional string assets = 13;
233
- */
234
- assets?: string;
235
- /**
236
- * 'cdn' is the URL of the plugin's CDN (content delivery network).
237
- * The CDN is used to serve static assets, such as images, CSS, and JavaScript
238
- * files. The files will be located on https://cdn.mochabug.com/adapt/plugins/<owner>/<plugin>/<version>/
239
- *
240
- * @generated from field: optional string cdn = 14;
241
- */
242
- cdn?: string;
243
- /**
244
- * 'vertices' is a list of vertices that constitute the plugin.
245
- *
246
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Vertex vertices = 15;
247
- */
248
- vertices: Vertex[];
249
- /**
250
- * The plugin oauth2 services specifies oauth2 services that is required for the plugin.
251
- * The client_id must be set for ALL oauth services here
252
- *
253
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2Service plugin_oauth2 = 16;
254
- */
255
- pluginOauth2: Oauth2Service[];
256
- /**
257
- * 'plugin_variables' represents the variables required by the plugin.
258
- * The platform ensures secure storage and transmission of variables.
259
- * i.e. a plugin owner sets these variables and the plugin can use them
260
- *
261
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.VariableService plugin_variables = 17;
262
- */
263
- pluginVariables: VariableService[];
264
- /**
265
- * 'plugin_mtls' represents the mTLS (mutual TLS) certificates required by
266
- * the plugin. The platform ensures secure storage and transmission of
267
- * certificates.
268
- * i.e. a plugin owner sets these certificates and the plugin can use them
269
- *
270
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.MTLSService plugin_mtls = 18;
271
- */
272
- pluginMtls: MTLSService[];
273
- };
274
- /**
275
- * Manifest describes a plugin and its properties.
276
- *
277
- * Security considerations: The platform ensures that secrets and certificates
278
- * are stored and transmitted securely.
279
- *
280
- * *** Plugin authors must also ensure that their implementations
281
- * handle sensitive data appropriately! ***
282
- *
283
- * @generated from message mochabugapis.adapt.plugins.v1.Manifest
284
- */
285
- export type ManifestJson = {
286
- /**
287
- * 'name' is the alpha-numeric identifier of the plugin. Must be conform to a ES variable name
288
- *
289
- * @generated from field: string name = 1;
290
- */
291
- name?: string;
292
- /**
293
- * 'version' is the plugin's version, following SemVer 2.0: https://semver.org/
294
- *
295
- * @generated from field: string version = 2;
296
- */
297
- version?: string;
298
- /**
299
- * 'label' is a human-friendly label displayed in the UI.
300
- *
301
- * @generated from field: string label = 3;
302
- */
303
- label?: string;
304
- /**
305
- * 'description' is a short, human-friendly description displayed in the UI.
306
- *
307
- * @generated from field: string description = 4;
308
- */
309
- description?: string;
310
- /**
311
- * 'organization' is the id of the organization the user belongs to.
312
- *
313
- * @generated from field: string organization = 5;
314
- */
315
- organization?: string;
316
- /**
317
- * 'homepage' is the plugin's homepage URL.
318
- *
319
- * @generated from field: optional string homepage = 6;
320
- */
321
- homepage?: string;
322
- /**
323
- * 'repository' is the plugin's repository URL.
324
- *
325
- * @generated from field: optional string repository = 7;
326
- */
327
- repository?: string;
328
- /**
329
- * 'bugs' is the URL or email for reporting bugs.
330
- *
331
- * @generated from field: optional string bugs = 8;
332
- */
333
- bugs?: string;
334
- /**
335
- * 'author' is the name of the plugin's author.
336
- *
337
- * @generated from field: optional string author = 9;
338
- */
339
- author?: string;
340
- /**
341
- * 'logo' is an optional path to the plugin logo.
342
- * The logo will be resized to a maximum of 80x80 pixels.
343
- * - Supported file formats:
344
- * - GIF: .gif
345
- * - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
346
- * - PNG: .png
347
- * - SVG: .svg
348
- * - WEBP: .webp
349
- * - AVIF: .avif
350
- *
351
- * @generated from field: optional string logo = 10;
352
- */
353
- logo?: string;
354
- /**
355
- * 'executors' is the path to the executor ES module file.
356
- *
357
- * @generated from field: string executors = 11;
358
- */
359
- executors?: string;
360
- /**
361
- * 'configurators' is an optional path to the configurator ES module file.
362
- *
363
- * @generated from field: optional string configurators = 12;
364
- */
365
- configurators?: string;
366
- /**
367
- * 'assets' is an optional directory containing all static assets
368
- * available to the plugin.
369
- *
370
- * @generated from field: optional string assets = 13;
371
- */
372
- assets?: string;
373
- /**
374
- * 'cdn' is the URL of the plugin's CDN (content delivery network).
375
- * The CDN is used to serve static assets, such as images, CSS, and JavaScript
376
- * files. The files will be located on https://cdn.mochabug.com/adapt/plugins/<owner>/<plugin>/<version>/
377
- *
378
- * @generated from field: optional string cdn = 14;
379
- */
380
- cdn?: string;
381
- /**
382
- * 'vertices' is a list of vertices that constitute the plugin.
383
- *
384
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Vertex vertices = 15;
385
- */
386
- vertices?: VertexJson[];
387
- /**
388
- * The plugin oauth2 services specifies oauth2 services that is required for the plugin.
389
- * The client_id must be set for ALL oauth services here
390
- *
391
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2Service plugin_oauth2 = 16;
392
- */
393
- pluginOauth2?: Oauth2ServiceJson[];
394
- /**
395
- * 'plugin_variables' represents the variables required by the plugin.
396
- * The platform ensures secure storage and transmission of variables.
397
- * i.e. a plugin owner sets these variables and the plugin can use them
398
- *
399
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.VariableService plugin_variables = 17;
400
- */
401
- pluginVariables?: VariableServiceJson[];
402
- /**
403
- * 'plugin_mtls' represents the mTLS (mutual TLS) certificates required by
404
- * the plugin. The platform ensures secure storage and transmission of
405
- * certificates.
406
- * i.e. a plugin owner sets these certificates and the plugin can use them
407
- *
408
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.MTLSService plugin_mtls = 18;
409
- */
410
- pluginMtls?: MTLSServiceJson[];
411
- };
412
- /**
413
- * Describes the message mochabugapis.adapt.plugins.v1.Manifest.
414
- * Use `create(ManifestSchema)` to create a new message.
415
- */
416
- export declare const ManifestSchema: GenMessage<Manifest, ManifestJson>;
417
- /**
418
- * Vertex represents a graph vertex that defines a plugin.
419
- * Note: Be aware of potential security implications when dealing with
420
- * user-provided data, such as file paths, and ensure proper input validation
421
- * and sanitization.
73
+ * The start message containing information about the files to be uploaded.
422
74
  *
423
- * @generated from message mochabugapis.adapt.plugins.v1.Vertex
75
+ * @generated from message mochabugapis.adapt.plugins.v1.StartUpload
424
76
  */
425
- export type Vertex = Message<"mochabugapis.adapt.plugins.v1.Vertex"> & {
426
- /**
427
- * 'name' represents the vertex name.
428
- *
429
- * @generated from field: string name = 1;
430
- */
431
- name: string;
432
- /**
433
- * 'label' is a human-friendly label displayed in the UI.
434
- *
435
- * @generated from field: string label = 2;
436
- */
437
- label: string;
438
- /**
439
- * 'description' is a human-friendly short description of the vertex displayed
440
- * in UI.
441
- *
442
- * @generated from field: optional string description = 3;
443
- */
444
- description?: string;
445
- /**
446
- * 'logo' is the file path to the vertex logo, which will be resized to a
447
- * maximum of 40x40 pixels. Ensure that the logo files are from trusted
448
- * sources to avoid security risks.
449
- * - Supported file formats:
450
- * - GIF: .gif
451
- * - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
452
- * - PNG: .png
453
- * - SVG: .svg
454
- * - WEBP: .webp
455
- * - AVIF: .avif
456
- *
457
- * @generated from field: optional string logo = 4;
458
- */
459
- logo?: string;
460
- /**
461
- * 'type' specifies the type of the vertex.
462
- *
463
- * @generated from field: mochabugapis.adapt.plugins.v1.Vertex.VertexType type = 5;
464
- */
465
- type: Vertex_VertexType;
77
+ export type StartUpload = Message<"mochabugapis.adapt.plugins.v1.StartUpload"> & {
466
78
  /**
467
- * 'config' is an field that contains a Unix file path.
468
- * This can be any type of file, this is only intepreted for the vertex itself
469
- * Restrictions:
470
- *
471
- *
472
- * @generated from field: optional string config = 6;
473
- */
474
- config?: string;
475
- /**
476
- * 'metadata' is an field that contains a Unix file path.
477
- * This determines which receivers, transmitters etc... the vertex has to begin with
478
- * Restrictions:
479
- *
79
+ * 'manifest' is the Manifest describing the plugin.
80
+ * It must be the first message in the stream.
480
81
  *
481
- * @generated from field: string metadata = 7;
82
+ * @generated from field: mochabugapis.adapt.plugins.v1.Manifest manifest = 1;
482
83
  */
483
- metadata: string;
84
+ manifest?: Manifest;
484
85
  /**
485
- * 'configurator' is a field to indicate whether or not
486
- * the vertex has a configurator
86
+ * The 'cdn_prefix' path prefix for the plugin files.
487
87
  *
488
- * @generated from field: bool configurator = 8;
88
+ * @generated from field: optional string cdn_prefix = 2;
489
89
  */
490
- configurator: boolean;
90
+ cdnPrefix?: string;
491
91
  /**
492
- * The variables required by the vertex
92
+ * The 'assets_prefix' path prefix for the plugin files.
493
93
  *
494
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.VariableService variables = 9;
94
+ * @generated from field: optional string assets_prefix = 3;
495
95
  */
496
- variables: VariableService[];
96
+ assetsPrefix?: string;
497
97
  /**
498
- * The mtls field contains a list of MTLSService instances for user-defined mTLS services.
98
+ * The executor file path
499
99
  *
500
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.MTLSService mtls = 10;
100
+ * @generated from field: string executor_path = 4;
501
101
  */
502
- mtls: MTLSService[];
102
+ executorPath: string;
503
103
  /**
504
- * The code_oauth2 field stores a list of bindings to the actual code flow definitions.
104
+ * The configurator file path
505
105
  *
506
- * If any of the OAuth2 services referred to in these bindings are not configured and are not marked as 'optional'
507
- * in their respective ServiceBinding, the plugin might not be able to properly authenticate and authorize its operations.
508
- *
509
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2CodeBinding code_oauth2 = 11;
106
+ * @generated from field: optional string configurator_path = 5;
510
107
  */
511
- codeOauth2: Oauth2CodeBinding[];
108
+ configuratorPath?: string;
512
109
  /**
513
- * client_id must not be set, and code must not be set. It's only for user defined service accounts
110
+ * Whether we should copy-over previous system settings (if any) to the new
111
+ * plugin.
514
112
  *
515
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2Service oauth2 = 12;
113
+ * @generated from field: optional bool copy_system_settings = 6;
516
114
  */
517
- oauth2: Oauth2Service[];
115
+ copySystemSettings?: boolean;
518
116
  };
519
117
  /**
520
- * Vertex represents a graph vertex that defines a plugin.
521
- * Note: Be aware of potential security implications when dealing with
522
- * user-provided data, such as file paths, and ensure proper input validation
523
- * and sanitization.
118
+ * The start message containing information about the files to be uploaded.
524
119
  *
525
- * @generated from message mochabugapis.adapt.plugins.v1.Vertex
120
+ * @generated from message mochabugapis.adapt.plugins.v1.StartUpload
526
121
  */
527
- export type VertexJson = {
528
- /**
529
- * 'name' represents the vertex name.
530
- *
531
- * @generated from field: string name = 1;
532
- */
533
- name?: string;
534
- /**
535
- * 'label' is a human-friendly label displayed in the UI.
536
- *
537
- * @generated from field: string label = 2;
538
- */
539
- label?: string;
540
- /**
541
- * 'description' is a human-friendly short description of the vertex displayed
542
- * in UI.
543
- *
544
- * @generated from field: optional string description = 3;
545
- */
546
- description?: string;
547
- /**
548
- * 'logo' is the file path to the vertex logo, which will be resized to a
549
- * maximum of 40x40 pixels. Ensure that the logo files are from trusted
550
- * sources to avoid security risks.
551
- * - Supported file formats:
552
- * - GIF: .gif
553
- * - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
554
- * - PNG: .png
555
- * - SVG: .svg
556
- * - WEBP: .webp
557
- * - AVIF: .avif
558
- *
559
- * @generated from field: optional string logo = 4;
560
- */
561
- logo?: string;
562
- /**
563
- * 'type' specifies the type of the vertex.
564
- *
565
- * @generated from field: mochabugapis.adapt.plugins.v1.Vertex.VertexType type = 5;
566
- */
567
- type?: Vertex_VertexTypeJson;
568
- /**
569
- * 'config' is an field that contains a Unix file path.
570
- * This can be any type of file, this is only intepreted for the vertex itself
571
- * Restrictions:
572
- *
573
- *
574
- * @generated from field: optional string config = 6;
575
- */
576
- config?: string;
122
+ export type StartUploadJson = {
577
123
  /**
578
- * 'metadata' is an field that contains a Unix file path.
579
- * This determines which receivers, transmitters etc... the vertex has to begin with
580
- * Restrictions:
581
- *
124
+ * 'manifest' is the Manifest describing the plugin.
125
+ * It must be the first message in the stream.
582
126
  *
583
- * @generated from field: string metadata = 7;
127
+ * @generated from field: mochabugapis.adapt.plugins.v1.Manifest manifest = 1;
584
128
  */
585
- metadata?: string;
129
+ manifest?: ManifestJson;
586
130
  /**
587
- * 'configurator' is a field to indicate whether or not
588
- * the vertex has a configurator
131
+ * The 'cdn_prefix' path prefix for the plugin files.
589
132
  *
590
- * @generated from field: bool configurator = 8;
133
+ * @generated from field: optional string cdn_prefix = 2;
591
134
  */
592
- configurator?: boolean;
135
+ cdnPrefix?: string;
593
136
  /**
594
- * The variables required by the vertex
137
+ * The 'assets_prefix' path prefix for the plugin files.
595
138
  *
596
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.VariableService variables = 9;
139
+ * @generated from field: optional string assets_prefix = 3;
597
140
  */
598
- variables?: VariableServiceJson[];
141
+ assetsPrefix?: string;
599
142
  /**
600
- * The mtls field contains a list of MTLSService instances for user-defined mTLS services.
143
+ * The executor file path
601
144
  *
602
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.MTLSService mtls = 10;
145
+ * @generated from field: string executor_path = 4;
603
146
  */
604
- mtls?: MTLSServiceJson[];
147
+ executorPath?: string;
605
148
  /**
606
- * The code_oauth2 field stores a list of bindings to the actual code flow definitions.
149
+ * The configurator file path
607
150
  *
608
- * If any of the OAuth2 services referred to in these bindings are not configured and are not marked as 'optional'
609
- * in their respective ServiceBinding, the plugin might not be able to properly authenticate and authorize its operations.
610
- *
611
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2CodeBinding code_oauth2 = 11;
151
+ * @generated from field: optional string configurator_path = 5;
612
152
  */
613
- codeOauth2?: Oauth2CodeBindingJson[];
153
+ configuratorPath?: string;
614
154
  /**
615
- * client_id must not be set, and code must not be set. It's only for user defined service accounts
155
+ * Whether we should copy-over previous system settings (if any) to the new
156
+ * plugin.
616
157
  *
617
- * @generated from field: repeated mochabugapis.adapt.plugins.v1.Oauth2Service oauth2 = 12;
158
+ * @generated from field: optional bool copy_system_settings = 6;
618
159
  */
619
- oauth2?: Oauth2ServiceJson[];
160
+ copySystemSettings?: boolean;
620
161
  };
621
162
  /**
622
- * Describes the message mochabugapis.adapt.plugins.v1.Vertex.
623
- * Use `create(VertexSchema)` to create a new message.
163
+ * Describes the message mochabugapis.adapt.plugins.v1.StartUpload.
164
+ * Use `create(StartUploadSchema)` to create a new message.
624
165
  */
625
- export declare const VertexSchema: GenMessage<Vertex, VertexJson>;
166
+ export declare const StartUploadSchema: GenMessage<StartUpload, StartUploadJson>;
626
167
  /**
627
- * VertexType represents the type of a vertex.
168
+ * UploadPluginResponse represents the response from the CreatePlugin streaming
169
+ * RPC. The server sends a single CreatePluginResponse after successfully
170
+ * processing all UploadPluginResponse messages from the client.
628
171
  *
629
- * @generated from enum mochabugapis.adapt.plugins.v1.Vertex.VertexType
172
+ * @generated from message mochabugapis.adapt.plugins.v1.UploadPluginResponse
630
173
  */
631
- export declare enum Vertex_VertexType {
632
- /**
633
- * Unspecified type (default value, should not be used).
634
- *
635
- * @generated from enum value: VERTEX_TYPE_UNSPECIFIED = 0;
636
- */
637
- UNSPECIFIED = 0,
638
- /**
639
- * Action type, available in all contexts and not exposed to the outside
640
- * world. This type has a lower security risk.
641
- *
642
- * @generated from enum value: VERTEX_TYPE_ACTION = 1;
643
- */
644
- ACTION = 1,
645
- /**
646
- * Browser type, available only in a browser context.
647
- * The configuration always runs inside a browser context.
648
- * Security implications: be cautious about potentially sensitive data
649
- * exposure.
650
- *
651
- * @generated from enum value: VERTEX_TYPE_BROWSER = 2;
652
- */
653
- BROWSER = 2,
654
- /**
655
- * CronTrigger type, available only in a trigger context.
656
- * Triggered at specific intervals.
657
- *
658
- * @generated from enum value: VERTEX_TYPE_CRON_TRIGGER = 3;
659
- */
660
- CRON_TRIGGER = 3,
661
- /**
662
- * ExternalTrigger type, available only in a trigger context.
663
- * Accessible via a publicly routable address.
664
- * Security implications: be cautious about exposing sensitive data or
665
- * functionality.
666
- *
667
- * @generated from enum value: VERTEX_TYPE_EXTERNAL_TRIGGER = 4;
668
- */
669
- EXTERNAL_TRIGGER = 4
670
- }
174
+ export type UploadPluginResponse = Message<"mochabugapis.adapt.plugins.v1.UploadPluginResponse"> & {};
671
175
  /**
672
- * VertexType represents the type of a vertex.
176
+ * UploadPluginResponse represents the response from the CreatePlugin streaming
177
+ * RPC. The server sends a single CreatePluginResponse after successfully
178
+ * processing all UploadPluginResponse messages from the client.
673
179
  *
674
- * @generated from enum mochabugapis.adapt.plugins.v1.Vertex.VertexType
675
- */
676
- export type Vertex_VertexTypeJson = "VERTEX_TYPE_UNSPECIFIED" | "VERTEX_TYPE_ACTION" | "VERTEX_TYPE_BROWSER" | "VERTEX_TYPE_CRON_TRIGGER" | "VERTEX_TYPE_EXTERNAL_TRIGGER";
677
- /**
678
- * Describes the enum mochabugapis.adapt.plugins.v1.Vertex.VertexType.
180
+ * @generated from message mochabugapis.adapt.plugins.v1.UploadPluginResponse
679
181
  */
680
- export declare const Vertex_VertexTypeSchema: GenEnum<Vertex_VertexType, Vertex_VertexTypeJson>;
182
+ export type UploadPluginResponseJson = {};
681
183
  /**
682
- * MTLSService represents a mutual Transport Layer Security (mTLS) service
683
- * configuration required by the plugin. mTLS provides secure communication
684
- * between client and server by authenticating both parties and encrypting the
685
- * communication.
686
- *
687
- * @generated from message mochabugapis.adapt.plugins.v1.MTLSService
184
+ * Describes the message mochabugapis.adapt.plugins.v1.UploadPluginResponse.
185
+ * Use `create(UploadPluginResponseSchema)` to create a new message.
688
186
  */
689
- export type MTLSService = Message<"mochabugapis.adapt.plugins.v1.MTLSService"> & {
690
- /**
691
- * 'name' is the identifier of the mTLS service.
692
- * It's used for referencing the specific mTLS configuration.
693
- *
694
- * @generated from field: string name = 1;
695
- */
696
- name: string;
697
- /**
698
- * 'label' is an optional short label describing the purpose of the mTLS
699
- * service.
700
- *
701
- * Restrictions:
702
- * - Length must be greater than 0 and less than 25 characters.
703
- * Security implications:
704
- * - Should not contain sensitive information.
705
- *
706
- * @generated from field: optional string label = 2;
707
- */
708
- label?: string;
709
- /**
710
- * 'description' is an optional detailed description of the mTLS service and
711
- * its usage within the plugin.
712
- *
713
- * @generated from field: optional string description = 3;
714
- */
715
- description?: string;
716
- /**
717
- * Unset or false means the variable is required
718
- * true means the mtls service is optional
719
- *
720
- * @generated from field: optional bool optional = 4;
721
- */
722
- optional?: boolean;
723
- };
724
- /**
725
- * MTLSService represents a mutual Transport Layer Security (mTLS) service
726
- * configuration required by the plugin. mTLS provides secure communication
727
- * between client and server by authenticating both parties and encrypting the
728
- * communication.
729
- *
730
- * @generated from message mochabugapis.adapt.plugins.v1.MTLSService
731
- */
732
- export type MTLSServiceJson = {
733
- /**
734
- * 'name' is the identifier of the mTLS service.
735
- * It's used for referencing the specific mTLS configuration.
736
- *
737
- * @generated from field: string name = 1;
738
- */
739
- name?: string;
740
- /**
741
- * 'label' is an optional short label describing the purpose of the mTLS
742
- * service.
743
- *
744
- * Restrictions:
745
- * - Length must be greater than 0 and less than 25 characters.
746
- * Security implications:
747
- * - Should not contain sensitive information.
748
- *
749
- * @generated from field: optional string label = 2;
750
- */
751
- label?: string;
752
- /**
753
- * 'description' is an optional detailed description of the mTLS service and
754
- * its usage within the plugin.
755
- *
756
- * @generated from field: optional string description = 3;
757
- */
758
- description?: string;
759
- /**
760
- * Unset or false means the variable is required
761
- * true means the mtls service is optional
762
- *
763
- * @generated from field: optional bool optional = 4;
764
- */
765
- optional?: boolean;
766
- };
767
- /**
768
- * Describes the message mochabugapis.adapt.plugins.v1.MTLSService.
769
- * Use `create(MTLSServiceSchema)` to create a new message.
770
- */
771
- export declare const MTLSServiceSchema: GenMessage<MTLSService, MTLSServiceJson>;
772
- /**
773
- * A representation of a variable.
774
- *
775
- * This message represents a variable used within the hosting platform.
776
- * Variables are essential for configuring applications and services hosted on the platform.
777
- * They store values that can be accessed by the application or service during runtime.
778
- *
779
- * @generated from message mochabugapis.adapt.plugins.v1.VariableService
780
- */
781
- export type VariableService = Message<"mochabugapis.adapt.plugins.v1.VariableService"> & {
782
- /**
783
- * 'name' is the identifier of the variable, which is referenced where needed.
784
- *
785
- * @generated from field: string name = 1;
786
- */
787
- name: string;
788
- /**
789
- * 'label' is a short, human-readable label describing the purpose of the variable.
790
- *
791
- * @generated from field: optional string label = 2;
792
- */
793
- label?: string;
794
- /**
795
- * 'description' is a detailed description of the variable and its use.
796
- *
797
- * @generated from field: optional string description = 3;
798
- */
799
- description?: string;
800
- /**
801
- * The 'type' field specifies the data type of the environmental variable.
802
- *
803
- * @generated from field: mochabugapis.adapt.plugins.v1.VariableService.Type type = 4;
804
- */
805
- type: VariableService_Type;
806
- /**
807
- * Unset or false means the variable is required
808
- * true means the variable is optional
809
- *
810
- * @generated from field: optional bool optional = 5;
811
- */
812
- optional?: boolean;
813
- };
814
- /**
815
- * A representation of a variable.
816
- *
817
- * This message represents a variable used within the hosting platform.
818
- * Variables are essential for configuring applications and services hosted on the platform.
819
- * They store values that can be accessed by the application or service during runtime.
820
- *
821
- * @generated from message mochabugapis.adapt.plugins.v1.VariableService
822
- */
823
- export type VariableServiceJson = {
824
- /**
825
- * 'name' is the identifier of the variable, which is referenced where needed.
826
- *
827
- * @generated from field: string name = 1;
828
- */
829
- name?: string;
830
- /**
831
- * 'label' is a short, human-readable label describing the purpose of the variable.
832
- *
833
- * @generated from field: optional string label = 2;
834
- */
835
- label?: string;
836
- /**
837
- * 'description' is a detailed description of the variable and its use.
838
- *
839
- * @generated from field: optional string description = 3;
840
- */
841
- description?: string;
842
- /**
843
- * The 'type' field specifies the data type of the environmental variable.
844
- *
845
- * @generated from field: mochabugapis.adapt.plugins.v1.VariableService.Type type = 4;
846
- */
847
- type?: VariableService_TypeJson;
848
- /**
849
- * Unset or false means the variable is required
850
- * true means the variable is optional
851
- *
852
- * @generated from field: optional bool optional = 5;
853
- */
854
- optional?: boolean;
855
- };
856
- /**
857
- * Describes the message mochabugapis.adapt.plugins.v1.VariableService.
858
- * Use `create(VariableServiceSchema)` to create a new message.
859
- */
860
- export declare const VariableServiceSchema: GenMessage<VariableService, VariableServiceJson>;
861
- /**
862
- * The type of variable
863
- *
864
- * @generated from enum mochabugapis.adapt.plugins.v1.VariableService.Type
865
- */
866
- export declare enum VariableService_Type {
867
- /**
868
- * The type is not specified. Invalid value
869
- *
870
- * @generated from enum value: TYPE_UNSPECIFIED = 0;
871
- */
872
- UNSPECIFIED = 0,
873
- /**
874
- * The variable will hold a secret
875
- *
876
- * @generated from enum value: TYPE_SECRET = 1;
877
- */
878
- SECRET = 1,
879
- /**
880
- * The variable will hold a string
881
- *
882
- * @generated from enum value: TYPE_STRING = 2;
883
- */
884
- STRING = 2,
885
- /**
886
- * The variable is a boolean value (a string either "true" or "false")
887
- *
888
- * @generated from enum value: TYPE_SWITCH = 3;
889
- */
890
- SWITCH = 3
891
- }
892
- /**
893
- * The type of variable
894
- *
895
- * @generated from enum mochabugapis.adapt.plugins.v1.VariableService.Type
896
- */
897
- export type VariableService_TypeJson = "TYPE_UNSPECIFIED" | "TYPE_SECRET" | "TYPE_STRING" | "TYPE_SWITCH";
898
- /**
899
- * Describes the enum mochabugapis.adapt.plugins.v1.VariableService.Type.
900
- */
901
- export declare const VariableService_TypeSchema: GenEnum<VariableService_Type, VariableService_TypeJson>;
902
- /**
903
- * OAuth2 service configuration
904
- *
905
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2Service
906
- */
907
- export type Oauth2Service = Message<"mochabugapis.adapt.plugins.v1.Oauth2Service"> & {
908
- /**
909
- * 'name' is the identifier for the OAuth2 service.
910
- *
911
- * @generated from field: string name = 1;
912
- */
913
- name: string;
914
- /**
915
- * 'label' is an optional short label describing the OAuth2 service.
916
- *
917
- * @generated from field: optional string label = 2;
918
- */
919
- label?: string;
920
- /**
921
- * 'description' provides a full description of the OAuth2 service.
922
- *
923
- * @generated from field: optional string description = 3;
924
- */
925
- description?: string;
926
- /**
927
- * The OAuth2 grant type to be used.
928
- *
929
- * @generated from field: mochabugapis.adapt.plugins.v1.Oauth2GrantType grant_type = 4;
930
- */
931
- grantType: Oauth2GrantType;
932
- /**
933
- * The required scopes.
934
- *
935
- * @generated from field: repeated string scopes = 5;
936
- */
937
- scopes: string[];
938
- /**
939
- * The client authentication method.
940
- * REQUIRED when grant_type is:
941
- * - OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE
942
- * - OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS
943
- *
944
- * MUST NOT be set when grant_type is:
945
- * - OAUTH2_GRANT_TYPE_JWT_BEARER
946
- * - OAUTH2_GRANT_TYPE_SAML2_BEARER
947
- *
948
- * @generated from field: optional mochabugapis.adapt.plugins.v1.Oauth2AuthType auth_method = 6;
949
- */
950
- authMethod?: Oauth2AuthType;
951
- /**
952
- * Algorithm used for signing assertions.
953
- * REQUIRED when:
954
- * - grant_type is OAUTH2_GRANT_TYPE_JWT_BEARER
955
- * - grant_type is OAUTH2_GRANT_TYPE_SAML2_BEARER
956
- * - auth_method is OAUTH2_AUTH_TYPE_PRIVATE_KEY_JWT
957
- * - auth_method is OAUTH2_AUTH_TYPE_SAML2_BEARER
958
- *
959
- * MUST NOT be set otherwise.
960
- *
961
- * @generated from field: optional mochabugapis.adapt.plugins.v1.PrivateKeyAlg alg = 7;
962
- */
963
- alg?: PrivateKeyAlg;
964
- /**
965
- * Client ID.
966
- * This is required when used as plugin_oauth2, but not onto a vertex => oauth2
967
- *
968
- * @generated from field: optional string client_id = 8;
969
- */
970
- clientId?: string;
971
- /**
972
- * The token endpoint URL.
973
- *
974
- * @generated from field: string token_endpoint = 9;
975
- */
976
- tokenEndpoint: string;
977
- /**
978
- * Configuration specific to the Authorization Code grant type.
979
- * REQUIRED when grant_type is OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE.
980
- * MUST NOT be set otherwise.
981
- *
982
- * @generated from field: optional mochabugapis.adapt.plugins.v1.Oauth2Code code = 10;
983
- */
984
- code?: Oauth2Code;
985
- /**
986
- * Indicates if the OAuth2 service is optional.
987
- * This cannot be set to true in case of OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE
988
- *
989
- * @generated from field: optional bool optional = 11;
990
- */
991
- optional?: boolean;
992
- };
993
- /**
994
- * OAuth2 service configuration
995
- *
996
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2Service
997
- */
998
- export type Oauth2ServiceJson = {
999
- /**
1000
- * 'name' is the identifier for the OAuth2 service.
1001
- *
1002
- * @generated from field: string name = 1;
1003
- */
1004
- name?: string;
1005
- /**
1006
- * 'label' is an optional short label describing the OAuth2 service.
1007
- *
1008
- * @generated from field: optional string label = 2;
1009
- */
1010
- label?: string;
1011
- /**
1012
- * 'description' provides a full description of the OAuth2 service.
1013
- *
1014
- * @generated from field: optional string description = 3;
1015
- */
1016
- description?: string;
1017
- /**
1018
- * The OAuth2 grant type to be used.
1019
- *
1020
- * @generated from field: mochabugapis.adapt.plugins.v1.Oauth2GrantType grant_type = 4;
1021
- */
1022
- grantType?: Oauth2GrantTypeJson;
1023
- /**
1024
- * The required scopes.
1025
- *
1026
- * @generated from field: repeated string scopes = 5;
1027
- */
1028
- scopes?: string[];
1029
- /**
1030
- * The client authentication method.
1031
- * REQUIRED when grant_type is:
1032
- * - OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE
1033
- * - OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS
1034
- *
1035
- * MUST NOT be set when grant_type is:
1036
- * - OAUTH2_GRANT_TYPE_JWT_BEARER
1037
- * - OAUTH2_GRANT_TYPE_SAML2_BEARER
1038
- *
1039
- * @generated from field: optional mochabugapis.adapt.plugins.v1.Oauth2AuthType auth_method = 6;
1040
- */
1041
- authMethod?: Oauth2AuthTypeJson;
1042
- /**
1043
- * Algorithm used for signing assertions.
1044
- * REQUIRED when:
1045
- * - grant_type is OAUTH2_GRANT_TYPE_JWT_BEARER
1046
- * - grant_type is OAUTH2_GRANT_TYPE_SAML2_BEARER
1047
- * - auth_method is OAUTH2_AUTH_TYPE_PRIVATE_KEY_JWT
1048
- * - auth_method is OAUTH2_AUTH_TYPE_SAML2_BEARER
1049
- *
1050
- * MUST NOT be set otherwise.
1051
- *
1052
- * @generated from field: optional mochabugapis.adapt.plugins.v1.PrivateKeyAlg alg = 7;
1053
- */
1054
- alg?: PrivateKeyAlgJson;
1055
- /**
1056
- * Client ID.
1057
- * This is required when used as plugin_oauth2, but not onto a vertex => oauth2
1058
- *
1059
- * @generated from field: optional string client_id = 8;
1060
- */
1061
- clientId?: string;
1062
- /**
1063
- * The token endpoint URL.
1064
- *
1065
- * @generated from field: string token_endpoint = 9;
1066
- */
1067
- tokenEndpoint?: string;
1068
- /**
1069
- * Configuration specific to the Authorization Code grant type.
1070
- * REQUIRED when grant_type is OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE.
1071
- * MUST NOT be set otherwise.
1072
- *
1073
- * @generated from field: optional mochabugapis.adapt.plugins.v1.Oauth2Code code = 10;
1074
- */
1075
- code?: Oauth2CodeJson;
1076
- /**
1077
- * Indicates if the OAuth2 service is optional.
1078
- * This cannot be set to true in case of OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE
1079
- *
1080
- * @generated from field: optional bool optional = 11;
1081
- */
1082
- optional?: boolean;
1083
- };
1084
- /**
1085
- * Describes the message mochabugapis.adapt.plugins.v1.Oauth2Service.
1086
- * Use `create(Oauth2ServiceSchema)` to create a new message.
1087
- */
1088
- export declare const Oauth2ServiceSchema: GenMessage<Oauth2Service, Oauth2ServiceJson>;
1089
- /**
1090
- * Represents a binding to a code service
1091
- *
1092
- * The binding points to the required service by its 'name' and indicates whether the service is 'optional' or required.
1093
- *
1094
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2CodeBinding
1095
- */
1096
- export type Oauth2CodeBinding = Message<"mochabugapis.adapt.plugins.v1.Oauth2CodeBinding"> & {
1097
- /**
1098
- * The 'name' field specifies the name of the service to bind to. The name should match the 'name' field of
1099
- * the corresponding OAuth2Service.
1100
- *
1101
- * @generated from field: string name = 1;
1102
- */
1103
- name: string;
1104
- /**
1105
- * The 'optional' field indicates whether the service binding is optional or required. If 'optional' is
1106
- * set to true, the service is not strictly required and the plugin can function without it. If 'optional'
1107
- * is set to false, the service is required and the plugin might fail if it is not properly configured.
1108
- *
1109
- * @generated from field: optional bool optional = 2;
1110
- */
1111
- optional?: boolean;
1112
- };
1113
- /**
1114
- * Represents a binding to a code service
1115
- *
1116
- * The binding points to the required service by its 'name' and indicates whether the service is 'optional' or required.
1117
- *
1118
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2CodeBinding
1119
- */
1120
- export type Oauth2CodeBindingJson = {
1121
- /**
1122
- * The 'name' field specifies the name of the service to bind to. The name should match the 'name' field of
1123
- * the corresponding OAuth2Service.
1124
- *
1125
- * @generated from field: string name = 1;
1126
- */
1127
- name?: string;
1128
- /**
1129
- * The 'optional' field indicates whether the service binding is optional or required. If 'optional' is
1130
- * set to true, the service is not strictly required and the plugin can function without it. If 'optional'
1131
- * is set to false, the service is required and the plugin might fail if it is not properly configured.
1132
- *
1133
- * @generated from field: optional bool optional = 2;
1134
- */
1135
- optional?: boolean;
1136
- };
1137
- /**
1138
- * Describes the message mochabugapis.adapt.plugins.v1.Oauth2CodeBinding.
1139
- * Use `create(Oauth2CodeBindingSchema)` to create a new message.
1140
- */
1141
- export declare const Oauth2CodeBindingSchema: GenMessage<Oauth2CodeBinding, Oauth2CodeBindingJson>;
1142
- /**
1143
- * The code grant type
1144
- * IMPORTANT: it has to be configured with refresh token in order to work correctly
1145
- * this is not needed for client credentials of course since we are owning the client
1146
- * WE ONLY SUPPORT OIDC since we need the sub claim to distinguish between different users
1147
- *
1148
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2Code
1149
- */
1150
- export type Oauth2Code = Message<"mochabugapis.adapt.plugins.v1.Oauth2Code"> & {
1151
- /**
1152
- * The auth endpoint (i.e. where it gets redirected for login)
1153
- *
1154
- * @generated from field: string auth_endpoint = 1;
1155
- */
1156
- authEndpoint: string;
1157
- /**
1158
- * We need to know the issuer in order to validate the token
1159
- *
1160
- * @generated from field: string issuer = 2;
1161
- */
1162
- issuer: string;
1163
- /**
1164
- * We also need the JWKs endpoint to validate the token
1165
- *
1166
- * @generated from field: string jwks_uri = 3;
1167
- */
1168
- jwksUri: string;
1169
- /**
1170
- * Additional parameters used for the oauth2 login endpoint
1171
- * Do not include state or nonce here since we're generating them
1172
- * in the backend. All params will be encoded in the URL
1173
- *
1174
- * @generated from field: map<string, string> additional_params = 4;
1175
- */
1176
- additionalParams: {
1177
- [key: string]: string;
1178
- };
1179
- /**
1180
- * Whether or not to use the PKCE extension
1181
- *
1182
- * @generated from field: bool use_pkce = 5;
1183
- */
1184
- usePkce: boolean;
1185
- };
1186
- /**
1187
- * The code grant type
1188
- * IMPORTANT: it has to be configured with refresh token in order to work correctly
1189
- * this is not needed for client credentials of course since we are owning the client
1190
- * WE ONLY SUPPORT OIDC since we need the sub claim to distinguish between different users
1191
- *
1192
- * @generated from message mochabugapis.adapt.plugins.v1.Oauth2Code
1193
- */
1194
- export type Oauth2CodeJson = {
1195
- /**
1196
- * The auth endpoint (i.e. where it gets redirected for login)
1197
- *
1198
- * @generated from field: string auth_endpoint = 1;
1199
- */
1200
- authEndpoint?: string;
1201
- /**
1202
- * We need to know the issuer in order to validate the token
1203
- *
1204
- * @generated from field: string issuer = 2;
1205
- */
1206
- issuer?: string;
1207
- /**
1208
- * We also need the JWKs endpoint to validate the token
1209
- *
1210
- * @generated from field: string jwks_uri = 3;
1211
- */
1212
- jwksUri?: string;
1213
- /**
1214
- * Additional parameters used for the oauth2 login endpoint
1215
- * Do not include state or nonce here since we're generating them
1216
- * in the backend. All params will be encoded in the URL
1217
- *
1218
- * @generated from field: map<string, string> additional_params = 4;
1219
- */
1220
- additionalParams?: {
1221
- [key: string]: string;
1222
- };
1223
- /**
1224
- * Whether or not to use the PKCE extension
1225
- *
1226
- * @generated from field: bool use_pkce = 5;
1227
- */
1228
- usePkce?: boolean;
1229
- };
1230
- /**
1231
- * Describes the message mochabugapis.adapt.plugins.v1.Oauth2Code.
1232
- * Use `create(Oauth2CodeSchema)` to create a new message.
1233
- */
1234
- export declare const Oauth2CodeSchema: GenMessage<Oauth2Code, Oauth2CodeJson>;
1235
- /**
1236
- * The algorithm used for signing JWT or SAML assertions
1237
- *
1238
- * @generated from enum mochabugapis.adapt.plugins.v1.PrivateKeyAlg
1239
- */
1240
- export declare enum PrivateKeyAlg {
1241
- /**
1242
- * Unknown algorithm (invalid)
1243
- *
1244
- * @generated from enum value: PRIVATE_KEY_ALG_UNSPECIFIED = 0;
1245
- */
1246
- UNSPECIFIED = 0,
1247
- /**
1248
- * RS256 algorithm
1249
- *
1250
- * @generated from enum value: PRIVATE_KEY_ALG_RS256 = 1;
1251
- */
1252
- RS256 = 1
1253
- }
1254
- /**
1255
- * The algorithm used for signing JWT or SAML assertions
1256
- *
1257
- * @generated from enum mochabugapis.adapt.plugins.v1.PrivateKeyAlg
1258
- */
1259
- export type PrivateKeyAlgJson = "PRIVATE_KEY_ALG_UNSPECIFIED" | "PRIVATE_KEY_ALG_RS256";
1260
- /**
1261
- * Describes the enum mochabugapis.adapt.plugins.v1.PrivateKeyAlg.
1262
- */
1263
- export declare const PrivateKeyAlgSchema: GenEnum<PrivateKeyAlg, PrivateKeyAlgJson>;
1264
- /**
1265
- * The OAuth2 grant type
1266
- *
1267
- * @generated from enum mochabugapis.adapt.plugins.v1.Oauth2GrantType
1268
- */
1269
- export declare enum Oauth2GrantType {
1270
- /**
1271
- * Not specified (invalid)
1272
- *
1273
- * @generated from enum value: OAUTH2_GRANT_TYPE_UNSPECIFIED = 0;
1274
- */
1275
- UNSPECIFIED = 0,
1276
- /**
1277
- * Authorization Code Grant
1278
- * grant_type=authorization_code
1279
- *
1280
- * @generated from enum value: OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE = 1;
1281
- */
1282
- AUTHORIZATION_CODE = 1,
1283
- /**
1284
- * Client Credentials Grant
1285
- * grant_type=client_credentials
1286
- *
1287
- * @generated from enum value: OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS = 2;
1288
- */
1289
- CLIENT_CREDENTIALS = 2,
1290
- /**
1291
- * JWT Bearer Assertion Grant
1292
- * grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
1293
- *
1294
- * @generated from enum value: OAUTH2_GRANT_TYPE_JWT_BEARER = 3;
1295
- */
1296
- JWT_BEARER = 3,
1297
- /**
1298
- * SAML 2.0 Bearer Assertion Grant
1299
- * grant_type=urn:ietf:params:oauth:grant-type:saml2-bearer
1300
- *
1301
- * @generated from enum value: OAUTH2_GRANT_TYPE_SAML2_BEARER = 4;
1302
- */
1303
- SAML2_BEARER = 4
1304
- }
1305
- /**
1306
- * The OAuth2 grant type
1307
- *
1308
- * @generated from enum mochabugapis.adapt.plugins.v1.Oauth2GrantType
1309
- */
1310
- export type Oauth2GrantTypeJson = "OAUTH2_GRANT_TYPE_UNSPECIFIED" | "OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE" | "OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS" | "OAUTH2_GRANT_TYPE_JWT_BEARER" | "OAUTH2_GRANT_TYPE_SAML2_BEARER";
1311
- /**
1312
- * Describes the enum mochabugapis.adapt.plugins.v1.Oauth2GrantType.
1313
- */
1314
- export declare const Oauth2GrantTypeSchema: GenEnum<Oauth2GrantType, Oauth2GrantTypeJson>;
1315
- /**
1316
- * The OAuth2 client authentication method
1317
- *
1318
- * @generated from enum mochabugapis.adapt.plugins.v1.Oauth2AuthType
1319
- */
1320
- export declare enum Oauth2AuthType {
1321
- /**
1322
- * Not specified (invalid)
1323
- *
1324
- * @generated from enum value: OAUTH2_AUTH_TYPE_UNSPECIFIED = 0;
1325
- */
1326
- UNSPECIFIED = 0,
1327
- /**
1328
- * Basic Authentication (client ID and secret in Authorization header)
1329
- *
1330
- * @generated from enum value: OAUTH2_AUTH_TYPE_BASIC = 1;
1331
- */
1332
- BASIC = 1,
1333
- /**
1334
- * Form Authentication (client ID and secret in form body)
1335
- *
1336
- * @generated from enum value: OAUTH2_AUTH_TYPE_FORM = 2;
1337
- */
1338
- FORM = 2,
1339
- /**
1340
- * Private Key JWT Authentication
1341
- * client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
1342
- *
1343
- * @generated from enum value: OAUTH2_AUTH_TYPE_PRIVATE_KEY_JWT = 3;
1344
- */
1345
- PRIVATE_KEY_JWT = 3,
1346
- /**
1347
- * Mutual TLS Authentication
1348
- *
1349
- * @generated from enum value: OAUTH2_AUTH_TYPE_MTLS = 4;
1350
- */
1351
- MTLS = 4,
1352
- /**
1353
- * SAML 2.0 Bearer Assertion for Client Authentication
1354
- * client_assertion_type=urn:ietf:params:oauth:client-assertion-type:saml2-bearer
1355
- *
1356
- * @generated from enum value: OAUTH2_AUTH_TYPE_SAML2_BEARER = 5;
1357
- */
1358
- SAML2_BEARER = 5
1359
- }
1360
- /**
1361
- * The OAuth2 client authentication method
1362
- *
1363
- * @generated from enum mochabugapis.adapt.plugins.v1.Oauth2AuthType
1364
- */
1365
- export type Oauth2AuthTypeJson = "OAUTH2_AUTH_TYPE_UNSPECIFIED" | "OAUTH2_AUTH_TYPE_BASIC" | "OAUTH2_AUTH_TYPE_FORM" | "OAUTH2_AUTH_TYPE_PRIVATE_KEY_JWT" | "OAUTH2_AUTH_TYPE_MTLS" | "OAUTH2_AUTH_TYPE_SAML2_BEARER";
1366
- /**
1367
- * Describes the enum mochabugapis.adapt.plugins.v1.Oauth2AuthType.
1368
- */
1369
- export declare const Oauth2AuthTypeSchema: GenEnum<Oauth2AuthType, Oauth2AuthTypeJson>;
187
+ export declare const UploadPluginResponseSchema: GenMessage<UploadPluginResponse, UploadPluginResponseJson>;
1370
188
  /**
1371
189
  * PluginService provides a service for uploading a plugin.
1372
190
  *