@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,539 @@
|
|
|
1
|
+
import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { HttpProxyConfig, HttpProxyConfigJson } from "./http_proxy_service_pb";
|
|
3
|
+
import type { Oauth2Config, Oauth2ConfigJson } from "./oauth2_service_pb";
|
|
4
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
5
|
+
/**
|
|
6
|
+
* Describes the file mochabugapis/adapt/plugins/v1/service_settings.proto.
|
|
7
|
+
*/
|
|
8
|
+
export declare const file_mochabugapis_adapt_plugins_v1_service_settings: GenFile;
|
|
9
|
+
/**
|
|
10
|
+
* Configuration for a one-of service that records which option was selected
|
|
11
|
+
* and provides the configuration for that option.
|
|
12
|
+
*
|
|
13
|
+
* This message captures the user's choice and the corresponding configuration
|
|
14
|
+
* values for the selected option (either a service definition or group).
|
|
15
|
+
*
|
|
16
|
+
* ## Relationship to OneOfDefinition
|
|
17
|
+
*
|
|
18
|
+
* - OneOfDefinition: Defines the available options (part of the plugin definition)
|
|
19
|
+
* - OneOfConfig: Records the user's selection and configuration (runtime state)
|
|
20
|
+
*
|
|
21
|
+
* ## Examples
|
|
22
|
+
*
|
|
23
|
+
* Example 1: User selected OAuth2 service
|
|
24
|
+
* OneOfConfig {
|
|
25
|
+
* selected: "google_oauth",
|
|
26
|
+
* value: {
|
|
27
|
+
* name: "google_oauth",
|
|
28
|
+
* configured: true,
|
|
29
|
+
* oauth2: { /* Oauth2Config with tokens *\/ }
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
*
|
|
33
|
+
* Example 2: User selected HTTP proxy service
|
|
34
|
+
* OneOfConfig {
|
|
35
|
+
* selected: "stripe",
|
|
36
|
+
* value: {
|
|
37
|
+
* name: "stripe",
|
|
38
|
+
* configured: true,
|
|
39
|
+
* http_proxy: { /* HttpProxyConfig with TLS and headers *\/ }
|
|
40
|
+
* }
|
|
41
|
+
* }
|
|
42
|
+
*
|
|
43
|
+
* Example 3: User selected variable service
|
|
44
|
+
* OneOfConfig {
|
|
45
|
+
* selected: "api_key",
|
|
46
|
+
* value: {
|
|
47
|
+
* name: "api_key",
|
|
48
|
+
* configured: true,
|
|
49
|
+
* variable: "sk_live_abc123..."
|
|
50
|
+
* }
|
|
51
|
+
* }
|
|
52
|
+
*
|
|
53
|
+
* Example 4: User selected group service
|
|
54
|
+
* OneOfConfig {
|
|
55
|
+
* selected: "stripe_environments",
|
|
56
|
+
* value: {
|
|
57
|
+
* name: "stripe_environments",
|
|
58
|
+
* configured: true,
|
|
59
|
+
* group: { /* GroupConfig with multiple service configurations *\/ }
|
|
60
|
+
* }
|
|
61
|
+
* }
|
|
62
|
+
*
|
|
63
|
+
* @generated from message mochabugapis.adapt.plugins.v1.OneOfConfig
|
|
64
|
+
*/
|
|
65
|
+
export type OneOfConfig = Message<"mochabugapis.adapt.plugins.v1.OneOfConfig"> & {
|
|
66
|
+
/**
|
|
67
|
+
* The name of the selected service definition.
|
|
68
|
+
*
|
|
69
|
+
* This must match one of the service definition names from OneOfDefinition.options
|
|
70
|
+
* and should also match the value.name field of the ServiceSettings.
|
|
71
|
+
*
|
|
72
|
+
* If not set, the service has not been configured (only valid if the service definition is optional).
|
|
73
|
+
*
|
|
74
|
+
* @generated from field: optional string selected = 3;
|
|
75
|
+
*/
|
|
76
|
+
selected?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The ServiceSettings configuration for the selected option.
|
|
79
|
+
*
|
|
80
|
+
* This contains the actual configuration values for the selected service.
|
|
81
|
+
* The name field in this ServiceSettings should match the `selected` field above.
|
|
82
|
+
*
|
|
83
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.ServiceSettings value = 4;
|
|
84
|
+
*/
|
|
85
|
+
value?: ServiceSettings;
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* Configuration for a one-of service that records which option was selected
|
|
89
|
+
* and provides the configuration for that option.
|
|
90
|
+
*
|
|
91
|
+
* This message captures the user's choice and the corresponding configuration
|
|
92
|
+
* values for the selected option (either a service definition or group).
|
|
93
|
+
*
|
|
94
|
+
* ## Relationship to OneOfDefinition
|
|
95
|
+
*
|
|
96
|
+
* - OneOfDefinition: Defines the available options (part of the plugin definition)
|
|
97
|
+
* - OneOfConfig: Records the user's selection and configuration (runtime state)
|
|
98
|
+
*
|
|
99
|
+
* ## Examples
|
|
100
|
+
*
|
|
101
|
+
* Example 1: User selected OAuth2 service
|
|
102
|
+
* OneOfConfig {
|
|
103
|
+
* selected: "google_oauth",
|
|
104
|
+
* value: {
|
|
105
|
+
* name: "google_oauth",
|
|
106
|
+
* configured: true,
|
|
107
|
+
* oauth2: { /* Oauth2Config with tokens *\/ }
|
|
108
|
+
* }
|
|
109
|
+
* }
|
|
110
|
+
*
|
|
111
|
+
* Example 2: User selected HTTP proxy service
|
|
112
|
+
* OneOfConfig {
|
|
113
|
+
* selected: "stripe",
|
|
114
|
+
* value: {
|
|
115
|
+
* name: "stripe",
|
|
116
|
+
* configured: true,
|
|
117
|
+
* http_proxy: { /* HttpProxyConfig with TLS and headers *\/ }
|
|
118
|
+
* }
|
|
119
|
+
* }
|
|
120
|
+
*
|
|
121
|
+
* Example 3: User selected variable service
|
|
122
|
+
* OneOfConfig {
|
|
123
|
+
* selected: "api_key",
|
|
124
|
+
* value: {
|
|
125
|
+
* name: "api_key",
|
|
126
|
+
* configured: true,
|
|
127
|
+
* variable: "sk_live_abc123..."
|
|
128
|
+
* }
|
|
129
|
+
* }
|
|
130
|
+
*
|
|
131
|
+
* Example 4: User selected group service
|
|
132
|
+
* OneOfConfig {
|
|
133
|
+
* selected: "stripe_environments",
|
|
134
|
+
* value: {
|
|
135
|
+
* name: "stripe_environments",
|
|
136
|
+
* configured: true,
|
|
137
|
+
* group: { /* GroupConfig with multiple service configurations *\/ }
|
|
138
|
+
* }
|
|
139
|
+
* }
|
|
140
|
+
*
|
|
141
|
+
* @generated from message mochabugapis.adapt.plugins.v1.OneOfConfig
|
|
142
|
+
*/
|
|
143
|
+
export type OneOfConfigJson = {
|
|
144
|
+
/**
|
|
145
|
+
* The name of the selected service definition.
|
|
146
|
+
*
|
|
147
|
+
* This must match one of the service definition names from OneOfDefinition.options
|
|
148
|
+
* and should also match the value.name field of the ServiceSettings.
|
|
149
|
+
*
|
|
150
|
+
* If not set, the service has not been configured (only valid if the service definition is optional).
|
|
151
|
+
*
|
|
152
|
+
* @generated from field: optional string selected = 3;
|
|
153
|
+
*/
|
|
154
|
+
selected?: string;
|
|
155
|
+
/**
|
|
156
|
+
* The ServiceSettings configuration for the selected option.
|
|
157
|
+
*
|
|
158
|
+
* This contains the actual configuration values for the selected service.
|
|
159
|
+
* The name field in this ServiceSettings should match the `selected` field above.
|
|
160
|
+
*
|
|
161
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.ServiceSettings value = 4;
|
|
162
|
+
*/
|
|
163
|
+
value?: ServiceSettingsJson;
|
|
164
|
+
};
|
|
165
|
+
/**
|
|
166
|
+
* Describes the message mochabugapis.adapt.plugins.v1.OneOfConfig.
|
|
167
|
+
* Use `create(OneOfConfigSchema)` to create a new message.
|
|
168
|
+
*/
|
|
169
|
+
export declare const OneOfConfigSchema: GenMessage<OneOfConfig, {
|
|
170
|
+
jsonType: OneOfConfigJson;
|
|
171
|
+
}>;
|
|
172
|
+
/**
|
|
173
|
+
* Runtime configuration for a grouped service - contains the actual values for all members.
|
|
174
|
+
*
|
|
175
|
+
* ## Purpose
|
|
176
|
+
*
|
|
177
|
+
* GroupConfig holds the runtime configuration values for a GroupedDefinition.
|
|
178
|
+
* While GroupedDefinition declares which services belong to the group,
|
|
179
|
+
* GroupConfig contains the actual configured values for each member service.
|
|
180
|
+
*
|
|
181
|
+
* ## Relationship to GroupedDefinition
|
|
182
|
+
*
|
|
183
|
+
* - GroupedDefinition: Declares the group structure (in plugin manifest)
|
|
184
|
+
* - GroupConfig: Contains the runtime values for each member
|
|
185
|
+
*
|
|
186
|
+
* ## Examples
|
|
187
|
+
*
|
|
188
|
+
* Example: Stripe environments group with production and sandbox
|
|
189
|
+
* GroupedDefinition {
|
|
190
|
+
* name: "stripe_envs",
|
|
191
|
+
* services: ["stripe_prod", "stripe_sandbox"]
|
|
192
|
+
* }
|
|
193
|
+
*
|
|
194
|
+
* GroupConfig {
|
|
195
|
+
* members: [
|
|
196
|
+
* {
|
|
197
|
+
* name: "stripe_prod",
|
|
198
|
+
* configured: true,
|
|
199
|
+
* oauth2: { /* production OAuth2 tokens *\/ }
|
|
200
|
+
* },
|
|
201
|
+
* {
|
|
202
|
+
* name: "stripe_sandbox",
|
|
203
|
+
* configured: true,
|
|
204
|
+
* oauth2: { /* sandbox OAuth2 tokens *\/ }
|
|
205
|
+
* }
|
|
206
|
+
* ]
|
|
207
|
+
* }
|
|
208
|
+
*
|
|
209
|
+
* ## Accessing Members in Plugin Code
|
|
210
|
+
*
|
|
211
|
+
* Plugin code accesses group members using dot notation:
|
|
212
|
+
* - "stripe_envs.stripe_prod" for production environment
|
|
213
|
+
* - "stripe_envs.stripe_sandbox" for sandbox environment
|
|
214
|
+
*
|
|
215
|
+
* @generated from message mochabugapis.adapt.plugins.v1.GroupConfig
|
|
216
|
+
*/
|
|
217
|
+
export type GroupConfig = Message<"mochabugapis.adapt.plugins.v1.GroupConfig"> & {
|
|
218
|
+
/**
|
|
219
|
+
* The ServiceSettings for each member of the group.
|
|
220
|
+
*
|
|
221
|
+
* Each entry corresponds to a service definition referenced in GroupedDefinition.services.
|
|
222
|
+
* The order doesn't matter, but each member's name must match a service from the group definition.
|
|
223
|
+
*
|
|
224
|
+
* Requirements:
|
|
225
|
+
* - At least one member must be present
|
|
226
|
+
* - Each member name must be unique
|
|
227
|
+
* - Member names must match services declared in GroupedDefinition.services
|
|
228
|
+
*
|
|
229
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.ServiceSettings members = 3;
|
|
230
|
+
*/
|
|
231
|
+
members: ServiceSettings[];
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Runtime configuration for a grouped service - contains the actual values for all members.
|
|
235
|
+
*
|
|
236
|
+
* ## Purpose
|
|
237
|
+
*
|
|
238
|
+
* GroupConfig holds the runtime configuration values for a GroupedDefinition.
|
|
239
|
+
* While GroupedDefinition declares which services belong to the group,
|
|
240
|
+
* GroupConfig contains the actual configured values for each member service.
|
|
241
|
+
*
|
|
242
|
+
* ## Relationship to GroupedDefinition
|
|
243
|
+
*
|
|
244
|
+
* - GroupedDefinition: Declares the group structure (in plugin manifest)
|
|
245
|
+
* - GroupConfig: Contains the runtime values for each member
|
|
246
|
+
*
|
|
247
|
+
* ## Examples
|
|
248
|
+
*
|
|
249
|
+
* Example: Stripe environments group with production and sandbox
|
|
250
|
+
* GroupedDefinition {
|
|
251
|
+
* name: "stripe_envs",
|
|
252
|
+
* services: ["stripe_prod", "stripe_sandbox"]
|
|
253
|
+
* }
|
|
254
|
+
*
|
|
255
|
+
* GroupConfig {
|
|
256
|
+
* members: [
|
|
257
|
+
* {
|
|
258
|
+
* name: "stripe_prod",
|
|
259
|
+
* configured: true,
|
|
260
|
+
* oauth2: { /* production OAuth2 tokens *\/ }
|
|
261
|
+
* },
|
|
262
|
+
* {
|
|
263
|
+
* name: "stripe_sandbox",
|
|
264
|
+
* configured: true,
|
|
265
|
+
* oauth2: { /* sandbox OAuth2 tokens *\/ }
|
|
266
|
+
* }
|
|
267
|
+
* ]
|
|
268
|
+
* }
|
|
269
|
+
*
|
|
270
|
+
* ## Accessing Members in Plugin Code
|
|
271
|
+
*
|
|
272
|
+
* Plugin code accesses group members using dot notation:
|
|
273
|
+
* - "stripe_envs.stripe_prod" for production environment
|
|
274
|
+
* - "stripe_envs.stripe_sandbox" for sandbox environment
|
|
275
|
+
*
|
|
276
|
+
* @generated from message mochabugapis.adapt.plugins.v1.GroupConfig
|
|
277
|
+
*/
|
|
278
|
+
export type GroupConfigJson = {
|
|
279
|
+
/**
|
|
280
|
+
* The ServiceSettings for each member of the group.
|
|
281
|
+
*
|
|
282
|
+
* Each entry corresponds to a service definition referenced in GroupedDefinition.services.
|
|
283
|
+
* The order doesn't matter, but each member's name must match a service from the group definition.
|
|
284
|
+
*
|
|
285
|
+
* Requirements:
|
|
286
|
+
* - At least one member must be present
|
|
287
|
+
* - Each member name must be unique
|
|
288
|
+
* - Member names must match services declared in GroupedDefinition.services
|
|
289
|
+
*
|
|
290
|
+
* @generated from field: repeated mochabugapis.adapt.plugins.v1.ServiceSettings members = 3;
|
|
291
|
+
*/
|
|
292
|
+
members?: ServiceSettingsJson[];
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* Describes the message mochabugapis.adapt.plugins.v1.GroupConfig.
|
|
296
|
+
* Use `create(GroupConfigSchema)` to create a new message.
|
|
297
|
+
*/
|
|
298
|
+
export declare const GroupConfigSchema: GenMessage<GroupConfig, {
|
|
299
|
+
jsonType: GroupConfigJson;
|
|
300
|
+
}>;
|
|
301
|
+
/**
|
|
302
|
+
* Service settings - runtime configuration values for a service.
|
|
303
|
+
*
|
|
304
|
+
* ## Relationship to ServiceDefinition
|
|
305
|
+
*
|
|
306
|
+
* ServiceSettings is the direct runtime equivalent of a ServiceDefinition:
|
|
307
|
+
* - ServiceDefinition: Declares the schema/structure of a service (what it needs)
|
|
308
|
+
* - ServiceSettings: Contains the actual configured values for that service (what it has)
|
|
309
|
+
*
|
|
310
|
+
* The `name` field references the ServiceDefinition by its name from Manifest.service_definitions.
|
|
311
|
+
*
|
|
312
|
+
* ## Value Field Matching
|
|
313
|
+
*
|
|
314
|
+
* The `value` oneof must match the service type from the corresponding ServiceDefinition:
|
|
315
|
+
* - ServiceDefinition with `oauth2`: ServiceSettings must have `oauth2` config
|
|
316
|
+
* - ServiceDefinition with `http_proxy`: ServiceSettings must have `http_proxy` config
|
|
317
|
+
* - ServiceDefinition with `variable`: ServiceSettings must have `variable` data
|
|
318
|
+
* - ServiceDefinition with `group`: ServiceSettings must have `group` config
|
|
319
|
+
* - ServiceDefinition with `oneof`: ServiceSettings must have `oneof` config
|
|
320
|
+
*
|
|
321
|
+
* ## Optional Services and Empty Values
|
|
322
|
+
*
|
|
323
|
+
* IMPORTANT: The `value` field can be unset (empty) for optional services:
|
|
324
|
+
* - If ServiceDefinition.optional = true: The service MAY be left unconfigured
|
|
325
|
+
* - When unconfigured: `value` is unset AND `configured` = true
|
|
326
|
+
* - This allows optional services to be marked as "configured" without providing values
|
|
327
|
+
*
|
|
328
|
+
* Example: An optional analytics service
|
|
329
|
+
* ServiceDefinition { name: "analytics", oauth2: {...}, optional: true }
|
|
330
|
+
* ServiceSettings { name: "analytics", configured: true } // No value field set
|
|
331
|
+
*
|
|
332
|
+
* For required services (optional = false or not set), the value field MUST be populated.
|
|
333
|
+
*
|
|
334
|
+
* @generated from message mochabugapis.adapt.plugins.v1.ServiceSettings
|
|
335
|
+
*/
|
|
336
|
+
export type ServiceSettings = Message<"mochabugapis.adapt.plugins.v1.ServiceSettings"> & {
|
|
337
|
+
/**
|
|
338
|
+
* The name of the service this setting refers to.
|
|
339
|
+
*
|
|
340
|
+
* This must match a ServiceDefinition.name from Manifest.service_definitions.
|
|
341
|
+
* Since services are now referenced directly by name (as strings in system_services
|
|
342
|
+
* and user_services arrays), this field identifies which service definition these
|
|
343
|
+
* settings correspond to.
|
|
344
|
+
*
|
|
345
|
+
* @generated from field: string name = 1;
|
|
346
|
+
*/
|
|
347
|
+
name: string;
|
|
348
|
+
/**
|
|
349
|
+
* Whether or not the service is fully configured.
|
|
350
|
+
*
|
|
351
|
+
* This field indicates if the service has been successfully configured:
|
|
352
|
+
* - true: Service is configured and ready to use
|
|
353
|
+
* - false: Service requires additional configuration
|
|
354
|
+
*
|
|
355
|
+
* For optional services (ServiceDefinition.optional = true):
|
|
356
|
+
* - Can be true even when `value` is unset (user chose not to configure it)
|
|
357
|
+
* - This allows optional services to be marked as "handled" without providing values
|
|
358
|
+
*
|
|
359
|
+
* For required services (ServiceDefinition.optional = false):
|
|
360
|
+
* - Must be true only when `value` is properly populated
|
|
361
|
+
* - Indicates all required configuration values have been provided
|
|
362
|
+
*
|
|
363
|
+
* @generated from field: bool configured = 2;
|
|
364
|
+
*/
|
|
365
|
+
configured: boolean;
|
|
366
|
+
/**
|
|
367
|
+
* The actual configuration value for this service.
|
|
368
|
+
*
|
|
369
|
+
* The value type must match the corresponding ServiceDefinition's type:
|
|
370
|
+
* - oauth2: If ServiceDefinition has Oauth2Definition
|
|
371
|
+
* - http_proxy: If ServiceDefinition has HttpProxyDefinition
|
|
372
|
+
* - variable: If ServiceDefinition has VariableDefinition
|
|
373
|
+
* - oneof: If ServiceDefinition has OneOfDefinition
|
|
374
|
+
* - group: If ServiceDefinition has GroupedDefinition
|
|
375
|
+
*
|
|
376
|
+
* ## Optional Services
|
|
377
|
+
*
|
|
378
|
+
* This field CAN be unset (empty) when ServiceDefinition.optional = true:
|
|
379
|
+
* - User chooses not to configure the optional service
|
|
380
|
+
* - `configured` can still be true (indicating the choice to skip configuration)
|
|
381
|
+
* - Plugin code must handle the absence of this optional service
|
|
382
|
+
*
|
|
383
|
+
* ## Deletion
|
|
384
|
+
*
|
|
385
|
+
* Unsetting this field in an update request means "delete this service configuration".
|
|
386
|
+
*
|
|
387
|
+
* @generated from oneof mochabugapis.adapt.plugins.v1.ServiceSettings.value
|
|
388
|
+
*/
|
|
389
|
+
value: {
|
|
390
|
+
/**
|
|
391
|
+
* The oauth2 state
|
|
392
|
+
*
|
|
393
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.Oauth2Config oauth2 = 3;
|
|
394
|
+
*/
|
|
395
|
+
value: Oauth2Config;
|
|
396
|
+
case: "oauth2";
|
|
397
|
+
} | {
|
|
398
|
+
/**
|
|
399
|
+
* The http proxy state
|
|
400
|
+
*
|
|
401
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.HttpProxyConfig http_proxy = 4;
|
|
402
|
+
*/
|
|
403
|
+
value: HttpProxyConfig;
|
|
404
|
+
case: "httpProxy";
|
|
405
|
+
} | {
|
|
406
|
+
/**
|
|
407
|
+
* The variable state
|
|
408
|
+
* Raw JSON bytes, already validated against the variable's schema
|
|
409
|
+
*
|
|
410
|
+
* @generated from field: bytes variable = 5;
|
|
411
|
+
*/
|
|
412
|
+
value: Uint8Array;
|
|
413
|
+
case: "variable";
|
|
414
|
+
} | {
|
|
415
|
+
/**
|
|
416
|
+
* The oneof state
|
|
417
|
+
*
|
|
418
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.OneOfConfig oneof = 6;
|
|
419
|
+
*/
|
|
420
|
+
value: OneOfConfig;
|
|
421
|
+
case: "oneof";
|
|
422
|
+
} | {
|
|
423
|
+
/**
|
|
424
|
+
* The group state
|
|
425
|
+
*
|
|
426
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.GroupConfig group = 7;
|
|
427
|
+
*/
|
|
428
|
+
value: GroupConfig;
|
|
429
|
+
case: "group";
|
|
430
|
+
} | {
|
|
431
|
+
case: undefined;
|
|
432
|
+
value?: undefined;
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Service settings - runtime configuration values for a service.
|
|
437
|
+
*
|
|
438
|
+
* ## Relationship to ServiceDefinition
|
|
439
|
+
*
|
|
440
|
+
* ServiceSettings is the direct runtime equivalent of a ServiceDefinition:
|
|
441
|
+
* - ServiceDefinition: Declares the schema/structure of a service (what it needs)
|
|
442
|
+
* - ServiceSettings: Contains the actual configured values for that service (what it has)
|
|
443
|
+
*
|
|
444
|
+
* The `name` field references the ServiceDefinition by its name from Manifest.service_definitions.
|
|
445
|
+
*
|
|
446
|
+
* ## Value Field Matching
|
|
447
|
+
*
|
|
448
|
+
* The `value` oneof must match the service type from the corresponding ServiceDefinition:
|
|
449
|
+
* - ServiceDefinition with `oauth2`: ServiceSettings must have `oauth2` config
|
|
450
|
+
* - ServiceDefinition with `http_proxy`: ServiceSettings must have `http_proxy` config
|
|
451
|
+
* - ServiceDefinition with `variable`: ServiceSettings must have `variable` data
|
|
452
|
+
* - ServiceDefinition with `group`: ServiceSettings must have `group` config
|
|
453
|
+
* - ServiceDefinition with `oneof`: ServiceSettings must have `oneof` config
|
|
454
|
+
*
|
|
455
|
+
* ## Optional Services and Empty Values
|
|
456
|
+
*
|
|
457
|
+
* IMPORTANT: The `value` field can be unset (empty) for optional services:
|
|
458
|
+
* - If ServiceDefinition.optional = true: The service MAY be left unconfigured
|
|
459
|
+
* - When unconfigured: `value` is unset AND `configured` = true
|
|
460
|
+
* - This allows optional services to be marked as "configured" without providing values
|
|
461
|
+
*
|
|
462
|
+
* Example: An optional analytics service
|
|
463
|
+
* ServiceDefinition { name: "analytics", oauth2: {...}, optional: true }
|
|
464
|
+
* ServiceSettings { name: "analytics", configured: true } // No value field set
|
|
465
|
+
*
|
|
466
|
+
* For required services (optional = false or not set), the value field MUST be populated.
|
|
467
|
+
*
|
|
468
|
+
* @generated from message mochabugapis.adapt.plugins.v1.ServiceSettings
|
|
469
|
+
*/
|
|
470
|
+
export type ServiceSettingsJson = {
|
|
471
|
+
/**
|
|
472
|
+
* The name of the service this setting refers to.
|
|
473
|
+
*
|
|
474
|
+
* This must match a ServiceDefinition.name from Manifest.service_definitions.
|
|
475
|
+
* Since services are now referenced directly by name (as strings in system_services
|
|
476
|
+
* and user_services arrays), this field identifies which service definition these
|
|
477
|
+
* settings correspond to.
|
|
478
|
+
*
|
|
479
|
+
* @generated from field: string name = 1;
|
|
480
|
+
*/
|
|
481
|
+
name?: string;
|
|
482
|
+
/**
|
|
483
|
+
* Whether or not the service is fully configured.
|
|
484
|
+
*
|
|
485
|
+
* This field indicates if the service has been successfully configured:
|
|
486
|
+
* - true: Service is configured and ready to use
|
|
487
|
+
* - false: Service requires additional configuration
|
|
488
|
+
*
|
|
489
|
+
* For optional services (ServiceDefinition.optional = true):
|
|
490
|
+
* - Can be true even when `value` is unset (user chose not to configure it)
|
|
491
|
+
* - This allows optional services to be marked as "handled" without providing values
|
|
492
|
+
*
|
|
493
|
+
* For required services (ServiceDefinition.optional = false):
|
|
494
|
+
* - Must be true only when `value` is properly populated
|
|
495
|
+
* - Indicates all required configuration values have been provided
|
|
496
|
+
*
|
|
497
|
+
* @generated from field: bool configured = 2;
|
|
498
|
+
*/
|
|
499
|
+
configured?: boolean;
|
|
500
|
+
/**
|
|
501
|
+
* The oauth2 state
|
|
502
|
+
*
|
|
503
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.Oauth2Config oauth2 = 3;
|
|
504
|
+
*/
|
|
505
|
+
oauth2?: Oauth2ConfigJson;
|
|
506
|
+
/**
|
|
507
|
+
* The http proxy state
|
|
508
|
+
*
|
|
509
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.HttpProxyConfig http_proxy = 4;
|
|
510
|
+
*/
|
|
511
|
+
httpProxy?: HttpProxyConfigJson;
|
|
512
|
+
/**
|
|
513
|
+
* The variable state
|
|
514
|
+
* Raw JSON bytes, already validated against the variable's schema
|
|
515
|
+
*
|
|
516
|
+
* @generated from field: bytes variable = 5;
|
|
517
|
+
*/
|
|
518
|
+
variable?: string;
|
|
519
|
+
/**
|
|
520
|
+
* The oneof state
|
|
521
|
+
*
|
|
522
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.OneOfConfig oneof = 6;
|
|
523
|
+
*/
|
|
524
|
+
oneof?: OneOfConfigJson;
|
|
525
|
+
/**
|
|
526
|
+
* The group state
|
|
527
|
+
*
|
|
528
|
+
* @generated from field: mochabugapis.adapt.plugins.v1.GroupConfig group = 7;
|
|
529
|
+
*/
|
|
530
|
+
group?: GroupConfigJson;
|
|
531
|
+
};
|
|
532
|
+
/**
|
|
533
|
+
* Describes the message mochabugapis.adapt.plugins.v1.ServiceSettings.
|
|
534
|
+
* Use `create(ServiceSettingsSchema)` to create a new message.
|
|
535
|
+
*/
|
|
536
|
+
export declare const ServiceSettingsSchema: GenMessage<ServiceSettings, {
|
|
537
|
+
jsonType: ServiceSettingsJson;
|
|
538
|
+
}>;
|
|
539
|
+
//# sourceMappingURL=service_settings_pb.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service_settings_pb.d.ts","sourceRoot":"","sources":["../../../../../../src/genproto/mochabugapis/adapt/plugins/v1/service_settings_pb.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGxE,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEpF,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,mDAAmD,EAAE,OACg1C,CAAC;AAEn5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,2CAA2C,CAAC,GAAG;IAC/E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,UAAU,CAAC,WAAW,EAAE;IAAC,QAAQ,EAAE,eAAe,CAAA;CAAC,CACd,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,2CAA2C,CAAC,GAAG;IAC/E;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,UAAU,CAAC,WAAW,EAAE;IAAC,QAAQ,EAAE,eAAe,CAAA;CAAC,CACd,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,+CAA+C,CAAC,GAAG;IACvF;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE;QACL;;;;WAIG;QACH,KAAK,EAAE,YAAY,CAAC;QACpB,IAAI,EAAE,QAAQ,CAAC;KAChB,GAAG;QACF;;;;WAIG;QACH,KAAK,EAAE,eAAe,CAAC;QACvB,IAAI,EAAE,WAAW,CAAC;KACnB,GAAG;QACF;;;;;WAKG;QACH,KAAK,EAAE,UAAU,CAAC;QAClB,IAAI,EAAE,UAAU,CAAC;KAClB,GAAG;QACF;;;;WAIG;QACH,KAAK,EAAE,WAAW,CAAC;QACnB,IAAI,EAAE,OAAO,CAAC;KACf,GAAG;QACF;;;;WAIG;QACH,KAAK,EAAE,WAAW,CAAC;QACnB,IAAI,EAAE,OAAO,CAAC;KACf,GAAG;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IAExB;;;;OAIG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,eAAe,EAAE;IAAC,QAAQ,EAAE,mBAAmB,CAAA;CAAC,CAC1B,CAAC"}
|