@schemastore/workflows 0.0.6 → 0.0.7

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 (3) hide show
  1. package/README.md +1 -1
  2. package/index.d.ts +401 -546
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -24,5 +24,5 @@ The definitions were auto-generated by [schemastore-updater](https://github.com/
24
24
  ## Additional Details
25
25
 
26
26
  * [Schema source](https://github.com/SchemaStore/schemastore/tree/master/src/schemas/json/workflows)
27
- * Last updated: Fri, Jun 30, 2023, 21:04:05 GMT
27
+ * Last updated: Sat, Jul 19, 2025, 17:01:26 GMT
28
28
  * Dependencies: none
package/index.d.ts CHANGED
@@ -8,26 +8,15 @@
8
8
  /**
9
9
  * Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.
10
10
  */
11
- export type GoogleCloudWorkflows =
11
+ export type GoogleCloudWorkflowsConfigFile =
12
+ | StepArray
12
13
  | {
13
- main: {
14
- /**
15
- * The name of the parameter variable.
16
- *
17
- * @minItems 0
18
- * @maxItems 1
19
- */
20
- params?: [] | [string];
21
- steps?: StepArray;
22
- };
23
- [k: string]: SubworkflowUndefined;
24
- }
25
- | StepArray6;
14
+ [k: string]: Subworkflow;
15
+ };
26
16
  /**
27
- * An array of objects with a single step.
17
+ * A list of steps.
28
18
  *
29
19
  * @minItems 1
30
- * @maxItems 100000
31
20
  */
32
21
  export type StepArray = [
33
22
  {
@@ -38,46 +27,37 @@ export type StepArray = [
38
27
  }[]
39
28
  ];
40
29
  /**
41
- * A list of variable assignment maps.
30
+ * A list of steps to run in this switch statement.
42
31
  *
43
32
  * @minItems 1
44
- * @maxItems 50
45
33
  */
46
- export type Assign = [
34
+ export type StepArray1 = [
47
35
  {
48
- [k: string]: unknown | undefined;
36
+ [k: string]: Step;
49
37
  },
50
38
  ...{
51
- [k: string]: unknown | undefined;
39
+ [k: string]: Step;
52
40
  }[]
53
41
  ];
54
42
  /**
55
- * Run a function and return a result.
56
- */
57
- export type Call =
58
- | ("http.get" | "http.post" | "http.put" | "http.patch" | "http.delete" | "http.request")
59
- | ("sys.sleep" | "sys.sleep_until" | "sys.log")
60
- | ("events.await_callback" | "events.create_callback_endpoint")
61
- | string
62
- | string;
63
- /**
64
- * Define what step Workflows should execute next.
65
- */
66
- export type Next = string | "end" | "continue" | "break";
67
- /**
68
- * A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
43
+ * An array of objects with a single step.
69
44
  *
70
45
  * @minItems 1
71
- * @maxItems 50
72
46
  */
73
- export type Switch = [Condition, ...Condition[]];
47
+ export type StepArray2 = [
48
+ {
49
+ [k: string]: Step;
50
+ },
51
+ ...{
52
+ [k: string]: Step;
53
+ }[]
54
+ ];
74
55
  /**
75
56
  * An array of objects with a single step.
76
57
  *
77
58
  * @minItems 1
78
- * @maxItems 100000
79
59
  */
80
- export type StepArray1 = [
60
+ export type StepArray3 = [
81
61
  {
82
62
  [k: string]: Step;
83
63
  },
@@ -85,604 +65,479 @@ export type StepArray1 = [
85
65
  [k: string]: Step;
86
66
  }[]
87
67
  ];
68
+
88
69
  /**
89
- * Iterates over a sequence of numbers or through a collection of data, such as a list or map.
70
+ * A single workflow step.
71
+ *
72
+ * This interface was referenced by `undefined`'s JSON-Schema definition
73
+ * via the `patternProperty` "^.*$".
90
74
  */
91
- export type For = {
75
+ export interface Step {
92
76
  /**
93
- * A loop variable name. Contains the value of the currently iterated element.
77
+ * Required
94
78
  */
95
- value: string;
79
+ call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
96
80
  /**
97
- * An index variable name. Contains the value to the current offset of the iteration.
81
+ * Arguments to a workflow step.
98
82
  */
99
- index?: string;
83
+ args?: {
84
+ url?: string | string;
85
+ /**
86
+ * Required if using call type http.request. The type of HTTP request method to use.
87
+ */
88
+ method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
89
+ /**
90
+ * Request headers.
91
+ */
92
+ headers?: {
93
+ [k: string]: unknown | undefined;
94
+ };
95
+ /**
96
+ * Request body.
97
+ */
98
+ body?: {
99
+ [k: string]: unknown | undefined;
100
+ };
101
+ /**
102
+ * Request query parameters.
103
+ */
104
+ query?: {
105
+ [k: string]: unknown | undefined;
106
+ };
107
+ /**
108
+ * Required if the API being called requires authentication.
109
+ */
110
+ auth?: {
111
+ /**
112
+ * The type of authentication.
113
+ */
114
+ type?: "OIDC" | "OAuth2";
115
+ };
116
+ /**
117
+ * Time in seconds. How long a request is allowed to run before throwing an exception.
118
+ */
119
+ timeout?: number;
120
+ /**
121
+ * The number of seconds to sleep.
122
+ */
123
+ seconds?: number;
124
+ };
100
125
  /**
101
- * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
126
+ * Define a dictionary.
102
127
  */
103
- in?: unknown[] | string;
128
+ assign?: {
129
+ [k: string]: unknown | undefined;
130
+ }[];
104
131
  /**
105
- * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
132
+ * Variable name where the result of an HTTP invocation step is stored.
106
133
  */
107
- range?: [number, number] | string;
108
- steps: StepArray2;
109
- } & For1;
110
- /**
111
- * An array of objects with a single step.
112
- *
113
- * @minItems 1
114
- * @maxItems 100000
115
- */
116
- export type StepArray2 = [
117
- {
118
- [k: string]: Step;
119
- },
120
- ...{
121
- [k: string]: Step;
122
- }[]
123
- ];
124
- export type For1 =
125
- | {
126
- [k: string]: unknown | undefined;
127
- }
128
- | {
134
+ result?: string;
135
+ /**
136
+ * A switch block.
137
+ */
138
+ switch?: {
139
+ /**
140
+ * An expression to switch on.
141
+ */
142
+ condition: string;
143
+ /**
144
+ * The next step to jump to. "end" to terminate.
145
+ */
146
+ next?: string;
147
+ steps?: StepArray1;
148
+ /**
149
+ * Stop a workflow's execution and return a value, variable, or expression.
150
+ */
151
+ return?: {
129
152
  [k: string]: unknown | undefined;
130
153
  };
131
- /**
132
- * Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
133
- */
134
- export type Parallel = {
154
+ /**
155
+ * Raise an exception.
156
+ */
157
+ raise?:
158
+ | string
159
+ | {
160
+ [k: string]: unknown | undefined;
161
+ };
162
+ }[];
135
163
  /**
136
- * The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
164
+ * The next step to jump to. "end" to terminate.
137
165
  */
138
- exception_policy?: "continueAll";
166
+ next?: string;
139
167
  /**
140
- * A list of writable variables with parent scope that allow assignments within the 'parallel' step.
168
+ * Stop a workflow's execution and return a value, variable, or expression.
141
169
  */
142
- shared?: string[];
170
+ return?: {
171
+ [k: string]: unknown | undefined;
172
+ };
173
+ try?: Step1;
143
174
  /**
144
- * The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
175
+ * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
145
176
  */
146
- concurrency_limit?: number;
147
- branches?: Branches;
148
- for?: For2;
149
- } & Parallel1;
150
- /**
151
- * Branches that can run concurrently. Required, if not using 'for'.
152
- *
153
- * @minItems 2
154
- * @maxItems 10
155
- */
156
- export type Branches =
157
- | [
158
- {
159
- [k: string]: Step;
160
- },
161
- {
162
- [k: string]: Step;
163
- }
164
- ]
165
- | [
166
- {
167
- [k: string]: Step;
168
- },
169
- {
170
- [k: string]: Step;
171
- },
172
- {
173
- [k: string]: Step;
174
- }
175
- ]
176
- | [
177
- {
178
- [k: string]: Step;
179
- },
180
- {
181
- [k: string]: Step;
182
- },
183
- {
184
- [k: string]: Step;
185
- },
186
- {
187
- [k: string]: Step;
188
- }
189
- ]
190
- | [
191
- {
192
- [k: string]: Step;
193
- },
194
- {
195
- [k: string]: Step;
196
- },
197
- {
198
- [k: string]: Step;
199
- },
200
- {
201
- [k: string]: Step;
202
- },
203
- {
204
- [k: string]: Step;
205
- }
206
- ]
207
- | [
208
- {
209
- [k: string]: Step;
210
- },
211
- {
212
- [k: string]: Step;
213
- },
214
- {
215
- [k: string]: Step;
216
- },
217
- {
218
- [k: string]: Step;
219
- },
220
- {
221
- [k: string]: Step;
222
- },
223
- {
224
- [k: string]: Step;
225
- }
226
- ]
227
- | [
228
- {
229
- [k: string]: Step;
230
- },
231
- {
232
- [k: string]: Step;
233
- },
234
- {
235
- [k: string]: Step;
236
- },
237
- {
238
- [k: string]: Step;
239
- },
240
- {
241
- [k: string]: Step;
242
- },
243
- {
244
- [k: string]: Step;
245
- },
246
- {
247
- [k: string]: Step;
248
- }
249
- ]
250
- | [
251
- {
252
- [k: string]: Step;
253
- },
254
- {
255
- [k: string]: Step;
256
- },
257
- {
258
- [k: string]: Step;
259
- },
260
- {
261
- [k: string]: Step;
262
- },
263
- {
264
- [k: string]: Step;
265
- },
266
- {
267
- [k: string]: Step;
268
- },
269
- {
270
- [k: string]: Step;
271
- },
272
- {
273
- [k: string]: Step;
274
- }
275
- ]
276
- | [
277
- {
278
- [k: string]: Step;
279
- },
280
- {
281
- [k: string]: Step;
282
- },
283
- {
284
- [k: string]: Step;
285
- },
286
- {
287
- [k: string]: Step;
288
- },
289
- {
290
- [k: string]: Step;
291
- },
292
- {
293
- [k: string]: Step;
294
- },
295
- {
296
- [k: string]: Step;
297
- },
298
- {
299
- [k: string]: Step;
300
- },
301
- {
302
- [k: string]: Step;
303
- }
304
- ]
305
- | [
306
- {
307
- [k: string]: Step;
308
- },
309
- {
310
- [k: string]: Step;
311
- },
312
- {
313
- [k: string]: Step;
314
- },
315
- {
316
- [k: string]: Step;
317
- },
318
- {
319
- [k: string]: Step;
320
- },
321
- {
322
- [k: string]: Step;
323
- },
324
- {
325
- [k: string]: Step;
326
- },
327
- {
328
- [k: string]: Step;
329
- },
330
- {
331
- [k: string]: Step;
332
- },
333
- {
334
- [k: string]: Step;
335
- }
336
- ];
337
- /**
338
- * Iterates over a sequence of numbers or through a collection of data, such as a list or map.
339
- */
340
- export type For2 = {
177
+ retry?: {
178
+ /**
179
+ * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
180
+ */
181
+ predicate?: string;
182
+ /**
183
+ * Maximum number of times a step will be retried.
184
+ */
185
+ max_retries?: number;
186
+ /**
187
+ * Block that controls how retries occur.
188
+ */
189
+ backoff?: {
190
+ /**
191
+ * Delay in seconds between the initial failure and the first retry.
192
+ */
193
+ initial_delay?: number;
194
+ /**
195
+ * Maximum delay in seconds between retries.
196
+ */
197
+ max_delay?: number;
198
+ /**
199
+ * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
200
+ */
201
+ multiplier?: number;
202
+ };
203
+ };
341
204
  /**
342
- * A loop variable name. Contains the value of the currently iterated element.
205
+ * Except a try clause.
343
206
  */
344
- value: string;
207
+ except?:
208
+ | Step2
209
+ | {
210
+ /**
211
+ * Name of a dictionary variable that contains the error message.
212
+ */
213
+ as?: string;
214
+ steps?: StepArray2;
215
+ };
345
216
  /**
346
- * An index variable name. Contains the value to the current offset of the iteration.
217
+ * Raise an exception.
347
218
  */
348
- index?: string;
219
+ raise?:
220
+ | string
221
+ | {
222
+ [k: string]: unknown | undefined;
223
+ };
224
+ }
225
+ /**
226
+ * Try a single step or a list of steps.
227
+ */
228
+ export interface Step1 {
349
229
  /**
350
- * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
230
+ * Required
351
231
  */
352
- in?: unknown[] | string;
232
+ call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
353
233
  /**
354
- * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
234
+ * Arguments to a workflow step.
355
235
  */
356
- range?: [number, number] | string;
357
- steps: StepArray2;
358
- } & (
359
- | {
360
- [k: string]: unknown | undefined;
361
- }
362
- | {
236
+ args?: {
237
+ url?: string | string;
238
+ /**
239
+ * Required if using call type http.request. The type of HTTP request method to use.
240
+ */
241
+ method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
242
+ /**
243
+ * Request headers.
244
+ */
245
+ headers?: {
363
246
  [k: string]: unknown | undefined;
364
- }
365
- );
366
- export type Parallel1 =
367
- | {
247
+ };
248
+ /**
249
+ * Request body.
250
+ */
251
+ body?: {
368
252
  [k: string]: unknown | undefined;
369
- }
370
- | {
253
+ };
254
+ /**
255
+ * Request query parameters.
256
+ */
257
+ query?: {
371
258
  [k: string]: unknown | undefined;
372
259
  };
373
- /**
374
- * Raise an exception.
375
- */
376
- export type Raise =
377
- | string
378
- | {
379
- /**
380
- * Error code.
381
- */
382
- code?: number;
260
+ /**
261
+ * Required if the API being called requires authentication.
262
+ */
263
+ auth?: {
383
264
  /**
384
- * Error message string.
265
+ * The type of authentication.
385
266
  */
386
- message?: string;
267
+ type?: "OIDC" | "OAuth2";
268
+ };
269
+ /**
270
+ * Time in seconds. How long a request is allowed to run before throwing an exception.
271
+ */
272
+ timeout?: number;
273
+ /**
274
+ * The number of seconds to sleep.
275
+ */
276
+ seconds?: number;
277
+ };
278
+ /**
279
+ * Define a dictionary.
280
+ */
281
+ assign?: {
282
+ [k: string]: unknown | undefined;
283
+ }[];
284
+ /**
285
+ * Variable name where the result of an HTTP invocation step is stored.
286
+ */
287
+ result?: string;
288
+ /**
289
+ * A switch block.
290
+ */
291
+ switch?: {
292
+ /**
293
+ * An expression to switch on.
294
+ */
295
+ condition: string;
296
+ /**
297
+ * The next step to jump to. "end" to terminate.
298
+ */
299
+ next?: string;
300
+ steps?: StepArray1;
301
+ /**
302
+ * Stop a workflow's execution and return a value, variable, or expression.
303
+ */
304
+ return?: {
387
305
  [k: string]: unknown | undefined;
388
306
  };
389
- /**
390
- * A try/except structure for error handling.
391
- */
392
- export type Try = Step1 | StepArray4;
393
- /**
394
- * Define a retry policy to retry steps that return a specific error code.
395
- */
396
- export type Retry =
397
- | {
307
+ /**
308
+ * Raise an exception.
309
+ */
310
+ raise?:
311
+ | string
312
+ | {
313
+ [k: string]: unknown | undefined;
314
+ };
315
+ }[];
316
+ /**
317
+ * The next step to jump to. "end" to terminate.
318
+ */
319
+ next?: string;
320
+ /**
321
+ * Stop a workflow's execution and return a value, variable, or expression.
322
+ */
323
+ return?: {
324
+ [k: string]: unknown | undefined;
325
+ };
326
+ try?: Step1;
327
+ /**
328
+ * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
329
+ */
330
+ retry?: {
331
+ /**
332
+ * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
333
+ */
334
+ predicate?: string;
335
+ /**
336
+ * Maximum number of times a step will be retried.
337
+ */
338
+ max_retries?: number;
339
+ /**
340
+ * Block that controls how retries occur.
341
+ */
342
+ backoff?: {
398
343
  /**
399
- * Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
344
+ * Delay in seconds between the initial failure and the first retry.
400
345
  */
401
- predicate?: string;
346
+ initial_delay?: number;
402
347
  /**
403
- * Maximum number of times a step will be retried, not counting the initial step execution attempt.
348
+ * Maximum delay in seconds between retries.
404
349
  */
405
- max_retries?: number;
350
+ max_delay?: number;
406
351
  /**
407
- * Block that controls how retries occur.
352
+ * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
408
353
  */
409
- backoff?: {
410
- /**
411
- * Delay in seconds between the initial failure and the first retry.
412
- */
413
- initial_delay?: number;
414
- /**
415
- * Maximum delay in seconds between retries.
416
- */
417
- max_delay?: number;
354
+ multiplier?: number;
355
+ };
356
+ };
357
+ /**
358
+ * Except a try clause.
359
+ */
360
+ except?:
361
+ | Step2
362
+ | {
418
363
  /**
419
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
364
+ * Name of a dictionary variable that contains the error message.
420
365
  */
421
- multiplier?: number;
366
+ as?: string;
367
+ steps?: StepArray2;
368
+ };
369
+ /**
370
+ * Raise an exception.
371
+ */
372
+ raise?:
373
+ | string
374
+ | {
375
+ [k: string]: unknown | undefined;
422
376
  };
423
- }
424
- | string;
425
- /**
426
- * An array of objects with a single step.
427
- *
428
- * @minItems 1
429
- * @maxItems 100000
430
- */
431
- export type StepArray3 = [
432
- {
433
- [k: string]: Step;
434
- },
435
- ...{
436
- [k: string]: Step;
437
- }[]
438
- ];
439
- /**
440
- * An array of objects with a single step.
441
- *
442
- * @minItems 1
443
- * @maxItems 100000
444
- */
445
- export type StepArray4 = [
446
- {
447
- [k: string]: Step;
448
- },
449
- ...{
450
- [k: string]: Step;
451
- }[]
452
- ];
453
- /**
454
- * An array of objects with a single step.
455
- *
456
- * @minItems 1
457
- * @maxItems 100000
458
- */
459
- export type StepArray5 = [
460
- {
461
- [k: string]: Step;
462
- },
463
- ...{
464
- [k: string]: Step;
465
- }[]
466
- ];
467
- /**
468
- * An array of objects with a single step.
469
- *
470
- * @minItems 1
471
- * @maxItems 100000
472
- */
473
- export type StepArray6 = [
474
- {
475
- [k: string]: Step;
476
- },
477
- ...{
478
- [k: string]: Step;
479
- }[]
480
- ];
481
-
482
- /**
483
- * A single workflow step.
484
- *
485
- * This interface was referenced by `undefined`'s JSON-Schema definition
486
- * via the `patternProperty` "^.*$".
487
- */
488
- export interface Step {
489
- assign?: Assign;
490
- call?: Call;
491
- args?: Args;
492
- result?: Result;
493
- next?: Next;
494
- switch?: Switch;
495
- for?: For1;
496
- parallel?: Parallel1;
497
- raise?: Raise;
498
- try?: Try;
499
- retry?: Retry;
500
- except?: Except;
501
- return?: Return;
502
- steps?: StepArray1;
503
377
  }
504
378
  /**
505
- * Pass arguments and their values when calling a function that accepts parameters.
379
+ * A single workflow step.
506
380
  */
507
- export interface Args {
508
- url?: string | string;
381
+ export interface Step2 {
509
382
  /**
510
- * The type of HTTP request method to use. Required if using call type http.request.
383
+ * Required
511
384
  */
512
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
385
+ call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
513
386
  /**
514
- * Header fields to supply input to the API.
387
+ * Arguments to a workflow step.
515
388
  */
516
- headers?: {
517
- [k: string]: unknown | undefined;
389
+ args?: {
390
+ url?: string | string;
391
+ /**
392
+ * Required if using call type http.request. The type of HTTP request method to use.
393
+ */
394
+ method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
395
+ /**
396
+ * Request headers.
397
+ */
398
+ headers?: {
399
+ [k: string]: unknown | undefined;
400
+ };
401
+ /**
402
+ * Request body.
403
+ */
404
+ body?: {
405
+ [k: string]: unknown | undefined;
406
+ };
407
+ /**
408
+ * Request query parameters.
409
+ */
410
+ query?: {
411
+ [k: string]: unknown | undefined;
412
+ };
413
+ /**
414
+ * Required if the API being called requires authentication.
415
+ */
416
+ auth?: {
417
+ /**
418
+ * The type of authentication.
419
+ */
420
+ type?: "OIDC" | "OAuth2";
421
+ };
422
+ /**
423
+ * Time in seconds. How long a request is allowed to run before throwing an exception.
424
+ */
425
+ timeout?: number;
426
+ /**
427
+ * The number of seconds to sleep.
428
+ */
429
+ seconds?: number;
518
430
  };
519
431
  /**
520
- * Body fields to supply input to the API.
432
+ * Define a dictionary.
521
433
  */
522
- body?:
523
- | {
524
- [k: string]: unknown | undefined;
525
- }
526
- | null
527
- | string
528
- | string;
434
+ assign?: {
435
+ [k: string]: unknown | undefined;
436
+ }[];
529
437
  /**
530
- * Query fields to supply input to the API.
438
+ * Variable name where the result of an HTTP invocation step is stored.
531
439
  */
532
- query?:
533
- | {
534
- [k: string]: unknown | undefined;
535
- }
536
- | string;
440
+ result?: string;
537
441
  /**
538
- * Required if the API being called requires authentication.
442
+ * A switch block.
539
443
  */
540
- auth?: {
444
+ switch?: {
541
445
  /**
542
- * The type of authentication.
446
+ * An expression to switch on.
543
447
  */
544
- type?: "OIDC" | "OAuth2";
448
+ condition: string;
545
449
  /**
546
- * Specify token scope to limit an application's access to a user's account.
450
+ * The next step to jump to. "end" to terminate.
547
451
  */
548
- scope?: unknown[] | string;
452
+ next?: string;
453
+ steps?: StepArray1;
549
454
  /**
550
- * Specify token scope to limit an application's access to a user's account.
455
+ * Stop a workflow's execution and return a value, variable, or expression.
551
456
  */
552
- scopes?: unknown[] | string | string;
457
+ return?: {
458
+ [k: string]: unknown | undefined;
459
+ };
553
460
  /**
554
- * Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
461
+ * Raise an exception.
555
462
  */
556
- audience?: string | string;
557
- };
463
+ raise?:
464
+ | string
465
+ | {
466
+ [k: string]: unknown | undefined;
467
+ };
468
+ }[];
469
+ /**
470
+ * The next step to jump to. "end" to terminate.
471
+ */
472
+ next?: string;
558
473
  /**
559
- * Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
474
+ * Stop a workflow's execution and return a value, variable, or expression.
560
475
  */
561
- timeout?: number;
476
+ return?: {
477
+ [k: string]: unknown | undefined;
478
+ };
479
+ try?: Step1;
562
480
  /**
563
- * Connector-specific parameters.
481
+ * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
564
482
  */
565
- connector_params?: {
483
+ retry?: {
566
484
  /**
567
- * Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
485
+ * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
568
486
  */
569
- timeout?: number;
487
+ predicate?: string;
488
+ /**
489
+ * Maximum number of times a step will be retried.
490
+ */
491
+ max_retries?: number;
570
492
  /**
571
- * Polling policy.
493
+ * Block that controls how retries occur.
572
494
  */
573
- polling_policy?: {
495
+ backoff?: {
574
496
  /**
575
- * Time in seconds. Only applies to long-running operation calls.
497
+ * Delay in seconds between the initial failure and the first retry.
576
498
  */
577
499
  initial_delay?: number;
578
500
  /**
579
- * Time in seconds. Only applies to long-running operation calls.
501
+ * Maximum delay in seconds between retries.
580
502
  */
581
- multiplier?: number;
503
+ max_delay?: number;
582
504
  /**
583
- * Time in seconds. Only applies to long-running operation calls.
505
+ * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
584
506
  */
585
- max_delay?: number;
586
- [k: string]: unknown | undefined;
507
+ multiplier?: number;
587
508
  };
588
- /**
589
- * If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
590
- */
591
- skip_polling?: boolean;
592
- /**
593
- * OAuth2 scopes to pass to the Google API.
594
- */
595
- scopes?: unknown[] | string | string;
596
- [k: string]: unknown | undefined;
597
509
  };
598
- [k: string]: unknown | undefined;
599
- }
600
- /**
601
- * Assign the result from a call to this variable.
602
- */
603
- export interface Result {
604
- [k: string]: unknown | undefined;
605
- }
606
- /**
607
- * Define conditional expressions for a switch block.
608
- */
609
- export interface Condition {
610
510
  /**
611
- * An expression to switch on.
511
+ * Except a try clause.
612
512
  */
613
- condition: string | boolean;
614
- steps?: StepArray1;
615
- assign?: Assign;
616
- call?: Call;
617
- args?: Args;
618
- result?: Result;
619
- next?: Next;
620
- switch?: Switch;
621
- for?: For;
622
- parallel?: Parallel;
623
- raise?: Raise;
624
- try?: Try;
625
- retry?: Retry;
626
- except?: Except;
627
- return?: Return;
628
- [k: string]: unknown | undefined;
629
- }
630
- /**
631
- * A step.
632
- */
633
- export interface Step1 {
634
- assign?: Assign;
635
- call?: Call;
636
- args?: Args;
637
- result?: Result;
638
- next?: Next;
639
- switch?: Switch;
640
- for?: For1;
641
- parallel?: Parallel1;
642
- raise?: Raise;
643
- try?: Try;
644
- retry?: Retry;
645
- except?: Except;
646
- return?: Return;
647
- steps?: StepArray1;
648
- }
649
- /**
650
- * A try/except structure for error handling.
651
- */
652
- export interface Except {
513
+ except?:
514
+ | Step2
515
+ | {
516
+ /**
517
+ * Name of a dictionary variable that contains the error message.
518
+ */
519
+ as?: string;
520
+ steps?: StepArray2;
521
+ };
653
522
  /**
654
- * The name of a map variable that contains the error message.
523
+ * Raise an exception.
655
524
  */
656
- as?: string;
657
- steps?: StepArray3;
658
- }
659
- /**
660
- * Stop a workflow's execution and return a value, variable, or expression.
661
- */
662
- export interface Return {
663
- [k: string]: unknown | undefined;
525
+ raise?:
526
+ | string
527
+ | {
528
+ [k: string]: unknown | undefined;
529
+ };
664
530
  }
665
531
  /**
666
532
  * A subworkflow.
533
+ *
534
+ * This interface was referenced by `undefined`'s JSON-Schema definition
535
+ * via the `patternProperty` "^.*$".
667
536
  */
668
537
  export interface Subworkflow {
669
538
  /**
670
- * The name of the parameter variable.
671
- *
672
- * @minItems 0
673
- * @maxItems 10
539
+ * A list of parameters.
674
540
  */
675
- params?:
676
- | []
677
- | [unknown]
678
- | [unknown, unknown]
679
- | [unknown, unknown, unknown]
680
- | [unknown, unknown, unknown, unknown]
681
- | [unknown, unknown, unknown, unknown, unknown]
682
- | [unknown, unknown, unknown, unknown, unknown, unknown]
683
- | [unknown, unknown, unknown, unknown, unknown, unknown, unknown]
684
- | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
685
- | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
686
- | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown];
687
- steps?: StepArray5;
541
+ params?: string[];
542
+ steps?: StepArray3;
688
543
  }
package/package.json CHANGED
@@ -9,6 +9,6 @@
9
9
  "scripts": {},
10
10
  "typeScriptVersion": "2.2",
11
11
  "types": "index.d.ts",
12
- "typesPublisherContentHash": "7b43cba4e443b171d70f81acee415c7d35dec554ca7fc51febac7448b7052efa",
13
- "version": "0.0.6"
12
+ "typesPublisherContentHash": "c840e2bbe32f356c783e6f0347eb5e8497ecf3d1d7f903f6c7ae10f90aaf29d2",
13
+ "version": "0.0.7"
14
14
  }