@mochabug/adapt-sdk 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +873 -0
- package/dist/api.d.ts +1605 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.spec.d.ts +2 -0
- package/dist/api.spec.d.ts.map +1 -0
- package/dist/cjs/api.cjs +2 -0
- package/dist/cjs/api.cjs.map +7 -0
- package/dist/cjs/frontend.cjs +2 -0
- package/dist/cjs/frontend.cjs.map +7 -0
- package/dist/cjs/mime.cjs +2 -0
- package/dist/cjs/mime.cjs.map +7 -0
- package/dist/cjs/router.cjs +2 -0
- package/dist/cjs/router.cjs.map +7 -0
- package/dist/cjs/types.cjs +2 -0
- package/dist/cjs/types.cjs.map +7 -0
- package/dist/esm/api.mjs +2 -0
- package/dist/esm/api.mjs.map +7 -0
- package/dist/esm/frontend.mjs +2 -0
- package/dist/esm/frontend.mjs.map +7 -0
- package/dist/esm/mime.mjs +2 -0
- package/dist/esm/mime.mjs.map +7 -0
- package/dist/esm/router.mjs +2 -0
- package/dist/esm/router.mjs.map +7 -0
- package/dist/esm/types.mjs +1 -0
- package/dist/esm/types.mjs.map +7 -0
- package/dist/frontend.d.ts +10 -0
- package/dist/frontend.d.ts.map +1 -0
- package/dist/genproto/buf/validate/validate_pb.d.ts +8491 -0
- package/dist/genproto/buf/validate/validate_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/annotations_pb.d.ts +14 -0
- package/dist/genproto/google/api/annotations_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/client_pb.d.ts +1432 -0
- package/dist/genproto/google/api/client_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/http_pb.d.ts +843 -0
- package/dist/genproto/google/api/http_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/launch_stage_pb.d.ts +94 -0
- package/dist/genproto/google/api/launch_stage_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/automations/v1/automations_pb.d.ts +1006 -0
- package/dist/genproto/mochabugapis/adapt/automations/v1/automations_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/exchange_pb.d.ts +77 -0
- package/dist/genproto/mochabugapis/adapt/graph/exchange_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/jtd_schema_pb.d.ts +401 -0
- package/dist/genproto/mochabugapis/adapt/graph/jtd_schema_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/receiver_pb.d.ts +69 -0
- package/dist/genproto/mochabugapis/adapt/graph/receiver_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_binding_pb.d.ts +430 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_binding_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_data_pb.d.ts +198 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_data_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_descriptor_pb.d.ts +161 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_descriptor_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_format_pb.d.ts +305 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_format_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.d.ts +77 -0
- package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.d.ts +120 -0
- package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.d.ts +99 -0
- package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/compound_services_pb.d.ts +347 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/compound_services_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.d.ts +64 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/http_proxy_service_pb.d.ts +1282 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/http_proxy_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.d.ts +388 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.d.ts +805 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.d.ts +238 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.d.ts +241 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_settings_pb.d.ts +539 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_settings_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts +190 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts +269 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.d.ts +339 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.d.ts +2721 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/store_pb.d.ts +872 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/store_pb.d.ts.map +1 -0
- package/dist/grpcweb.d.ts +8 -0
- package/dist/grpcweb.d.ts.map +1 -0
- package/dist/mime.d.ts +11 -0
- package/dist/mime.d.ts.map +1 -0
- package/dist/router.d.ts +503 -0
- package/dist/router.d.ts.map +1 -0
- package/dist/router.spec.d.ts +2 -0
- package/dist/router.spec.d.ts.map +1 -0
- package/dist/signal-api.spec.d.ts +17 -0
- package/dist/signal-api.spec.d.ts.map +1 -0
- package/dist/types.d.ts +149 -0
- package/dist/types.d.ts.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"http_proxy_service_pb.d.ts","sourceRoot":"","sources":["../../../../../../src/genproto/mochabugapis/adapt/plugins/v1/http_proxy_service_pb.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGjF,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,qDAAqD,EAAE,OACytF,CAAC;AAE9xF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,mDAAmD,CAAC,GAAG;IAC/F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,EAAE,aAAa,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAC;CAClD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,EAAE,iBAAiB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAA;KAAE,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,UAAU,CAAC,mBAAmB,EAAE;IAAC,QAAQ,EAAE,uBAAuB,CAAA;CAAC,CACpC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,8CAA8C,CAAC,GAAG;IACrF;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;OASG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,UAAU,CAAC,cAAc,EAAE;IAAC,QAAQ,EAAE,kBAAkB,CAAA;CAAC,CACrB,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,6CAA6C,CAAC,GAAG;IACnF;;;;OAIG;IACH,IAAI,EAAE,kBAAkB,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,aAAa,EAAE;IAAC,QAAQ,EAAE,iBAAiB,CAAA;CAAC,CAClB,CAAC;AAExE;;;;GAIG;AACH,oBAAY,kBAAkB;IAC5B;;;;OAIG;IACH,WAAW,IAAI;IAEf;;;;;;;;;;;;;;OAcG;IACH,IAAI,IAAI;IAER;;;;;;;;;;;;;;;OAeG;IACH,WAAW,IAAI;CAChB;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG,WAAW,GAAG,kBAAkB,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,OAAO,CAAC,kBAAkB,EAAE,sBAAsB,CAClB,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,yCAAyC,CAAC,GAAG;IAC3E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC;IAEnB;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;IAEvB;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,SAAS,EAAE;IAAC,QAAQ,EAAE,aAAa,CAAA;CAAC,CACN,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,+CAA+C,CAAC,GAAG;IACvF;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+DG;IACH,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;CACrD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+DG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CAAA;KAAE,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,eAAe,EAAE;IAAC,QAAQ,EAAE,mBAAmB,CAAA;CAAC,CACxB,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,+CAA+C,CAAC,GAAG;IACvF;;;;;;;OAOG;IACH,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,eAAe,EAAE;IAAC,QAAQ,EAAE,mBAAmB,CAAA;CAAC,CACxB,CAAC"}
|
|
@@ -0,0 +1,388 @@
|
|
|
1
|
+
import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { ServiceDefinition, ServiceDefinitionJson } from "./service_definition_pb";
|
|
3
|
+
import type { Vertex, VertexJson } from "./vertex_pb";
|
|
4
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
5
|
+
/**
|
|
6
|
+
* Describes the file mochabugapis/adapt/plugins/v1/manifest.proto.
|
|
7
|
+
*/
|
|
8
|
+
export declare const file_mochabugapis_adapt_plugins_v1_manifest: GenFile;
|
|
9
|
+
/**
|
|
10
|
+
* Manifest describes a plugin and its properties.
|
|
11
|
+
*
|
|
12
|
+
* ## Architecture Overview
|
|
13
|
+
*
|
|
14
|
+
* A plugin consists of:
|
|
15
|
+
* 1. **Vertices**: The actual workflow nodes that users add to automation graphs
|
|
16
|
+
* 2. **Service Definitions**: Flat declarations of services (OAuth2, HTTP Proxy, Variables, Groups, OneOf)
|
|
17
|
+
* 3. **System Services**: String array referencing service definitions used at the plugin level
|
|
18
|
+
*
|
|
19
|
+
* ## Service Architecture
|
|
20
|
+
*
|
|
21
|
+
* **Service definitions are ALWAYS flat** - they exist at the top level of the manifest
|
|
22
|
+
* and are never nested within each other. This includes:
|
|
23
|
+
* - Oauth2Definition
|
|
24
|
+
* - HttpProxyDefinition
|
|
25
|
+
* - VariableDefinition
|
|
26
|
+
* - GroupedDefinition (references other flat definitions)
|
|
27
|
+
* - OneOfDefinition (references other flat definitions)
|
|
28
|
+
*
|
|
29
|
+
* **Services are referenced by name as strings**. Service lists are string arrays where each
|
|
30
|
+
* string must match a ServiceDefinition's `name`. Services exist at two levels:
|
|
31
|
+
* - `system_services`: Plugin-level services configured once for the entire plugin
|
|
32
|
+
* - `user_services` (in Vertex): Vertex-level services configured per vertex instance
|
|
33
|
+
*
|
|
34
|
+
* The `optional` field in ServiceDefinition controls whether a service must be configured:
|
|
35
|
+
* - `optional: false` (default): User MUST configure this service
|
|
36
|
+
* - `optional: true`: User MAY skip configuring this service
|
|
37
|
+
*
|
|
38
|
+
* ## Example Structure
|
|
39
|
+
*
|
|
40
|
+
* ```protobuf
|
|
41
|
+
* Manifest {
|
|
42
|
+
* name: "stripe_plugin"
|
|
43
|
+
* version: "1.0.0"
|
|
44
|
+
*
|
|
45
|
+
* // Flat service definitions at manifest level
|
|
46
|
+
* service_definitions: [
|
|
47
|
+
* { name: "stripe_oauth", oauth2: {...} },
|
|
48
|
+
* { name: "stripe_api", http_proxy: {...} },
|
|
49
|
+
* { name: "webhook_secret", variable: {...} }
|
|
50
|
+
* ]
|
|
51
|
+
*
|
|
52
|
+
* // System-level services (plugin-wide)
|
|
53
|
+
* // Each string references a service definition name
|
|
54
|
+
* system_services: ["stripe_oauth"]
|
|
55
|
+
*
|
|
56
|
+
* // Vertices with their own service references
|
|
57
|
+
* vertices: [
|
|
58
|
+
* {
|
|
59
|
+
* name: "CreatePayment",
|
|
60
|
+
* user_services: ["stripe_api", "webhook_secret"]
|
|
61
|
+
* }
|
|
62
|
+
* ]
|
|
63
|
+
* }
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* ## Security Considerations
|
|
67
|
+
*
|
|
68
|
+
* The platform ensures that secrets and certificates are stored and transmitted securely.
|
|
69
|
+
*
|
|
70
|
+
* *** Plugin authors must also ensure that their implementations
|
|
71
|
+
* handle sensitive data appropriately! ***
|
|
72
|
+
*
|
|
73
|
+
* @generated from message mochabugapis.adapt.plugins.v1.Manifest
|
|
74
|
+
*/
|
|
75
|
+
export type Manifest = Message<"mochabugapis.adapt.plugins.v1.Manifest"> & {
|
|
76
|
+
/**
|
|
77
|
+
* 'name' is the alpha-numeric identifier of the plugin. Must be conform to a ES variable name
|
|
78
|
+
*
|
|
79
|
+
* @generated from field: string name = 1;
|
|
80
|
+
*/
|
|
81
|
+
name: string;
|
|
82
|
+
/**
|
|
83
|
+
* 'version' is the plugin's version, following SemVer 2.0: https://semver.org/
|
|
84
|
+
*
|
|
85
|
+
* @generated from field: string version = 2;
|
|
86
|
+
*/
|
|
87
|
+
version: string;
|
|
88
|
+
/**
|
|
89
|
+
* 'label' is a human-friendly label displayed in the UI.
|
|
90
|
+
*
|
|
91
|
+
* @generated from field: string label = 3;
|
|
92
|
+
*/
|
|
93
|
+
label: string;
|
|
94
|
+
/**
|
|
95
|
+
* 'description' is a short, human-friendly description displayed in the UI.
|
|
96
|
+
*
|
|
97
|
+
* @generated from field: string description = 4;
|
|
98
|
+
*/
|
|
99
|
+
description: string;
|
|
100
|
+
/**
|
|
101
|
+
* 'organization' is the id of the organization the user belongs to.
|
|
102
|
+
*
|
|
103
|
+
* @generated from field: string organization = 5;
|
|
104
|
+
*/
|
|
105
|
+
organization: string;
|
|
106
|
+
/**
|
|
107
|
+
* 'homepage' is the plugin's homepage URL.
|
|
108
|
+
*
|
|
109
|
+
* @generated from field: optional string homepage = 6;
|
|
110
|
+
*/
|
|
111
|
+
homepage?: string;
|
|
112
|
+
/**
|
|
113
|
+
* 'repository' is the plugin's repository URL.
|
|
114
|
+
*
|
|
115
|
+
* @generated from field: optional string repository = 7;
|
|
116
|
+
*/
|
|
117
|
+
repository?: string;
|
|
118
|
+
/**
|
|
119
|
+
* 'bugs' is the URL or email for reporting bugs.
|
|
120
|
+
*
|
|
121
|
+
* @generated from field: optional string bugs = 8;
|
|
122
|
+
*/
|
|
123
|
+
bugs?: string;
|
|
124
|
+
/**
|
|
125
|
+
* 'author' is the name of the plugin's author.
|
|
126
|
+
*
|
|
127
|
+
* @generated from field: optional string author = 9;
|
|
128
|
+
*/
|
|
129
|
+
author?: string;
|
|
130
|
+
/**
|
|
131
|
+
* 'logo' is an optional path to the plugin logo.
|
|
132
|
+
* The logo will be resized to a maximum of 80x80 pixels.
|
|
133
|
+
* - Supported file formats:
|
|
134
|
+
* - GIF: .gif
|
|
135
|
+
* - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
|
|
136
|
+
* - PNG: .png
|
|
137
|
+
* - SVG: .svg
|
|
138
|
+
* - WEBP: .webp
|
|
139
|
+
* - AVIF: .avif
|
|
140
|
+
*
|
|
141
|
+
* @generated from field: optional string logo = 10;
|
|
142
|
+
*/
|
|
143
|
+
logo?: string;
|
|
144
|
+
/**
|
|
145
|
+
* 'vertices' is a list of vertices that constitute the plugin.
|
|
146
|
+
* this is filled in automatically when configurating a project on the filesystem
|
|
147
|
+
*
|
|
148
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.Vertex vertices = 11;
|
|
149
|
+
*/
|
|
150
|
+
vertices: Vertex[];
|
|
151
|
+
/**
|
|
152
|
+
* 'service_definitions' are flat service definitions that can be referenced by bindings.
|
|
153
|
+
*
|
|
154
|
+
* All service definitions exist at this top level - they are NEVER nested.
|
|
155
|
+
* Definitions can be referenced by:
|
|
156
|
+
* - system_services (plugin-level bindings)
|
|
157
|
+
* - user_services in vertices (vertex-level bindings)
|
|
158
|
+
*
|
|
159
|
+
* Each definition has a unique name used for referencing in bindings.
|
|
160
|
+
* Service types: OAuth2, HTTP Proxy, Variable, Group, OneOf.
|
|
161
|
+
*
|
|
162
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.ServiceDefinition service_definitions = 12;
|
|
163
|
+
*/
|
|
164
|
+
serviceDefinitions: ServiceDefinition[];
|
|
165
|
+
/**
|
|
166
|
+
* 'system_services' are plugin-level services configured once for the entire plugin.
|
|
167
|
+
*
|
|
168
|
+
* System services are:
|
|
169
|
+
* - Configured by plugin administrators (via PostPluginSettings API)
|
|
170
|
+
* - Shared across all vertices in the plugin
|
|
171
|
+
* - Required to be configured before the plugin can be used (status = ACTIVE), unless marked optional
|
|
172
|
+
*
|
|
173
|
+
* This is a string array where each string directly references a ServiceDefinition by its name.
|
|
174
|
+
* Plugin code accesses these services using the referenced service name.
|
|
175
|
+
*
|
|
176
|
+
* The `optional` field in the ServiceDefinition controls whether configuration is required:
|
|
177
|
+
* - If ServiceDefinition.optional = false (default): MUST be configured
|
|
178
|
+
* - If ServiceDefinition.optional = true: MAY be skipped
|
|
179
|
+
*
|
|
180
|
+
* Example:
|
|
181
|
+
* service_definitions: [
|
|
182
|
+
* { name: "github_oauth", oauth2: {...} },
|
|
183
|
+
* { name: "analytics", oauth2: {...}, optional: true }
|
|
184
|
+
* ]
|
|
185
|
+
* system_services: ["github_oauth", "analytics"]
|
|
186
|
+
* Plugin code references: "github_oauth", "analytics"
|
|
187
|
+
*
|
|
188
|
+
* IMPORTANT: For OAuth2 CODE grant type services, the service definition name is used
|
|
189
|
+
* for callback URL generation.
|
|
190
|
+
*
|
|
191
|
+
* @generated from field: repeated string system_services = 13;
|
|
192
|
+
*/
|
|
193
|
+
systemServices: string[];
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Manifest describes a plugin and its properties.
|
|
197
|
+
*
|
|
198
|
+
* ## Architecture Overview
|
|
199
|
+
*
|
|
200
|
+
* A plugin consists of:
|
|
201
|
+
* 1. **Vertices**: The actual workflow nodes that users add to automation graphs
|
|
202
|
+
* 2. **Service Definitions**: Flat declarations of services (OAuth2, HTTP Proxy, Variables, Groups, OneOf)
|
|
203
|
+
* 3. **System Services**: String array referencing service definitions used at the plugin level
|
|
204
|
+
*
|
|
205
|
+
* ## Service Architecture
|
|
206
|
+
*
|
|
207
|
+
* **Service definitions are ALWAYS flat** - they exist at the top level of the manifest
|
|
208
|
+
* and are never nested within each other. This includes:
|
|
209
|
+
* - Oauth2Definition
|
|
210
|
+
* - HttpProxyDefinition
|
|
211
|
+
* - VariableDefinition
|
|
212
|
+
* - GroupedDefinition (references other flat definitions)
|
|
213
|
+
* - OneOfDefinition (references other flat definitions)
|
|
214
|
+
*
|
|
215
|
+
* **Services are referenced by name as strings**. Service lists are string arrays where each
|
|
216
|
+
* string must match a ServiceDefinition's `name`. Services exist at two levels:
|
|
217
|
+
* - `system_services`: Plugin-level services configured once for the entire plugin
|
|
218
|
+
* - `user_services` (in Vertex): Vertex-level services configured per vertex instance
|
|
219
|
+
*
|
|
220
|
+
* The `optional` field in ServiceDefinition controls whether a service must be configured:
|
|
221
|
+
* - `optional: false` (default): User MUST configure this service
|
|
222
|
+
* - `optional: true`: User MAY skip configuring this service
|
|
223
|
+
*
|
|
224
|
+
* ## Example Structure
|
|
225
|
+
*
|
|
226
|
+
* ```protobuf
|
|
227
|
+
* Manifest {
|
|
228
|
+
* name: "stripe_plugin"
|
|
229
|
+
* version: "1.0.0"
|
|
230
|
+
*
|
|
231
|
+
* // Flat service definitions at manifest level
|
|
232
|
+
* service_definitions: [
|
|
233
|
+
* { name: "stripe_oauth", oauth2: {...} },
|
|
234
|
+
* { name: "stripe_api", http_proxy: {...} },
|
|
235
|
+
* { name: "webhook_secret", variable: {...} }
|
|
236
|
+
* ]
|
|
237
|
+
*
|
|
238
|
+
* // System-level services (plugin-wide)
|
|
239
|
+
* // Each string references a service definition name
|
|
240
|
+
* system_services: ["stripe_oauth"]
|
|
241
|
+
*
|
|
242
|
+
* // Vertices with their own service references
|
|
243
|
+
* vertices: [
|
|
244
|
+
* {
|
|
245
|
+
* name: "CreatePayment",
|
|
246
|
+
* user_services: ["stripe_api", "webhook_secret"]
|
|
247
|
+
* }
|
|
248
|
+
* ]
|
|
249
|
+
* }
|
|
250
|
+
* ```
|
|
251
|
+
*
|
|
252
|
+
* ## Security Considerations
|
|
253
|
+
*
|
|
254
|
+
* The platform ensures that secrets and certificates are stored and transmitted securely.
|
|
255
|
+
*
|
|
256
|
+
* *** Plugin authors must also ensure that their implementations
|
|
257
|
+
* handle sensitive data appropriately! ***
|
|
258
|
+
*
|
|
259
|
+
* @generated from message mochabugapis.adapt.plugins.v1.Manifest
|
|
260
|
+
*/
|
|
261
|
+
export type ManifestJson = {
|
|
262
|
+
/**
|
|
263
|
+
* 'name' is the alpha-numeric identifier of the plugin. Must be conform to a ES variable name
|
|
264
|
+
*
|
|
265
|
+
* @generated from field: string name = 1;
|
|
266
|
+
*/
|
|
267
|
+
name?: string;
|
|
268
|
+
/**
|
|
269
|
+
* 'version' is the plugin's version, following SemVer 2.0: https://semver.org/
|
|
270
|
+
*
|
|
271
|
+
* @generated from field: string version = 2;
|
|
272
|
+
*/
|
|
273
|
+
version?: string;
|
|
274
|
+
/**
|
|
275
|
+
* 'label' is a human-friendly label displayed in the UI.
|
|
276
|
+
*
|
|
277
|
+
* @generated from field: string label = 3;
|
|
278
|
+
*/
|
|
279
|
+
label?: string;
|
|
280
|
+
/**
|
|
281
|
+
* 'description' is a short, human-friendly description displayed in the UI.
|
|
282
|
+
*
|
|
283
|
+
* @generated from field: string description = 4;
|
|
284
|
+
*/
|
|
285
|
+
description?: string;
|
|
286
|
+
/**
|
|
287
|
+
* 'organization' is the id of the organization the user belongs to.
|
|
288
|
+
*
|
|
289
|
+
* @generated from field: string organization = 5;
|
|
290
|
+
*/
|
|
291
|
+
organization?: string;
|
|
292
|
+
/**
|
|
293
|
+
* 'homepage' is the plugin's homepage URL.
|
|
294
|
+
*
|
|
295
|
+
* @generated from field: optional string homepage = 6;
|
|
296
|
+
*/
|
|
297
|
+
homepage?: string;
|
|
298
|
+
/**
|
|
299
|
+
* 'repository' is the plugin's repository URL.
|
|
300
|
+
*
|
|
301
|
+
* @generated from field: optional string repository = 7;
|
|
302
|
+
*/
|
|
303
|
+
repository?: string;
|
|
304
|
+
/**
|
|
305
|
+
* 'bugs' is the URL or email for reporting bugs.
|
|
306
|
+
*
|
|
307
|
+
* @generated from field: optional string bugs = 8;
|
|
308
|
+
*/
|
|
309
|
+
bugs?: string;
|
|
310
|
+
/**
|
|
311
|
+
* 'author' is the name of the plugin's author.
|
|
312
|
+
*
|
|
313
|
+
* @generated from field: optional string author = 9;
|
|
314
|
+
*/
|
|
315
|
+
author?: string;
|
|
316
|
+
/**
|
|
317
|
+
* 'logo' is an optional path to the plugin logo.
|
|
318
|
+
* The logo will be resized to a maximum of 80x80 pixels.
|
|
319
|
+
* - Supported file formats:
|
|
320
|
+
* - GIF: .gif
|
|
321
|
+
* - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
|
|
322
|
+
* - PNG: .png
|
|
323
|
+
* - SVG: .svg
|
|
324
|
+
* - WEBP: .webp
|
|
325
|
+
* - AVIF: .avif
|
|
326
|
+
*
|
|
327
|
+
* @generated from field: optional string logo = 10;
|
|
328
|
+
*/
|
|
329
|
+
logo?: string;
|
|
330
|
+
/**
|
|
331
|
+
* 'vertices' is a list of vertices that constitute the plugin.
|
|
332
|
+
* this is filled in automatically when configurating a project on the filesystem
|
|
333
|
+
*
|
|
334
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.Vertex vertices = 11;
|
|
335
|
+
*/
|
|
336
|
+
vertices?: VertexJson[];
|
|
337
|
+
/**
|
|
338
|
+
* 'service_definitions' are flat service definitions that can be referenced by bindings.
|
|
339
|
+
*
|
|
340
|
+
* All service definitions exist at this top level - they are NEVER nested.
|
|
341
|
+
* Definitions can be referenced by:
|
|
342
|
+
* - system_services (plugin-level bindings)
|
|
343
|
+
* - user_services in vertices (vertex-level bindings)
|
|
344
|
+
*
|
|
345
|
+
* Each definition has a unique name used for referencing in bindings.
|
|
346
|
+
* Service types: OAuth2, HTTP Proxy, Variable, Group, OneOf.
|
|
347
|
+
*
|
|
348
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.ServiceDefinition service_definitions = 12;
|
|
349
|
+
*/
|
|
350
|
+
serviceDefinitions?: ServiceDefinitionJson[];
|
|
351
|
+
/**
|
|
352
|
+
* 'system_services' are plugin-level services configured once for the entire plugin.
|
|
353
|
+
*
|
|
354
|
+
* System services are:
|
|
355
|
+
* - Configured by plugin administrators (via PostPluginSettings API)
|
|
356
|
+
* - Shared across all vertices in the plugin
|
|
357
|
+
* - Required to be configured before the plugin can be used (status = ACTIVE), unless marked optional
|
|
358
|
+
*
|
|
359
|
+
* This is a string array where each string directly references a ServiceDefinition by its name.
|
|
360
|
+
* Plugin code accesses these services using the referenced service name.
|
|
361
|
+
*
|
|
362
|
+
* The `optional` field in the ServiceDefinition controls whether configuration is required:
|
|
363
|
+
* - If ServiceDefinition.optional = false (default): MUST be configured
|
|
364
|
+
* - If ServiceDefinition.optional = true: MAY be skipped
|
|
365
|
+
*
|
|
366
|
+
* Example:
|
|
367
|
+
* service_definitions: [
|
|
368
|
+
* { name: "github_oauth", oauth2: {...} },
|
|
369
|
+
* { name: "analytics", oauth2: {...}, optional: true }
|
|
370
|
+
* ]
|
|
371
|
+
* system_services: ["github_oauth", "analytics"]
|
|
372
|
+
* Plugin code references: "github_oauth", "analytics"
|
|
373
|
+
*
|
|
374
|
+
* IMPORTANT: For OAuth2 CODE grant type services, the service definition name is used
|
|
375
|
+
* for callback URL generation.
|
|
376
|
+
*
|
|
377
|
+
* @generated from field: repeated string system_services = 13;
|
|
378
|
+
*/
|
|
379
|
+
systemServices?: string[];
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* Describes the message mochabugapis.adapt.plugins.v1.Manifest.
|
|
383
|
+
* Use `create(ManifestSchema)` to create a new message.
|
|
384
|
+
*/
|
|
385
|
+
export declare const ManifestSchema: GenMessage<Manifest, {
|
|
386
|
+
jsonType: ManifestJson;
|
|
387
|
+
}>;
|
|
388
|
+
//# sourceMappingURL=manifest_pb.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"manifest_pb.d.ts","sourceRoot":"","sources":["../../../../../../src/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAExF,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,2CAA2C,EAAE,OACg+D,CAAC;AAE3hE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,wCAAwC,CAAC,GAAG;IACzE;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IAAC,QAAQ,EAAE,YAAY,CAAA;CAAC,CACb,CAAC"}
|