@io-orkes/conductor-javascript 1.2.2 → 1.2.3
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/dist/browser.d.mts +2 -2
- package/dist/browser.d.ts +2 -2
- package/dist/browser.js +26 -8
- package/dist/browser.js.map +1 -1
- package/dist/browser.mjs +26 -8
- package/dist/browser.mjs.map +1 -1
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +26 -8
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +26 -8
- package/dist/index.mjs.map +1 -1
- package/dist/{types-1e3272c6.d.ts → types-f83aa26f.d.ts} +332 -331
- package/package.json +1 -1
|
@@ -1,29 +1,3 @@
|
|
|
1
|
-
interface ConductorLogger {
|
|
2
|
-
info(...args: any): void;
|
|
3
|
-
error(...args: any): void;
|
|
4
|
-
debug(...args: any): void;
|
|
5
|
-
}
|
|
6
|
-
declare type ConductorLogLevel = keyof typeof LOG_LEVELS;
|
|
7
|
-
interface DefaultLoggerConfig {
|
|
8
|
-
level?: ConductorLogLevel;
|
|
9
|
-
tags?: Object[];
|
|
10
|
-
}
|
|
11
|
-
declare const LOG_LEVELS: {
|
|
12
|
-
readonly DEBUG: 10;
|
|
13
|
-
readonly INFO: 30;
|
|
14
|
-
readonly ERROR: 60;
|
|
15
|
-
};
|
|
16
|
-
declare class DefaultLogger implements ConductorLogger {
|
|
17
|
-
private readonly tags;
|
|
18
|
-
private readonly level;
|
|
19
|
-
constructor(config?: DefaultLoggerConfig);
|
|
20
|
-
private log;
|
|
21
|
-
info: (...args: any) => void;
|
|
22
|
-
debug: (...args: any) => void;
|
|
23
|
-
error: (...args: any) => void;
|
|
24
|
-
}
|
|
25
|
-
declare const noopLogger: ConductorLogger;
|
|
26
|
-
|
|
27
1
|
declare type ApiRequestOptions = {
|
|
28
2
|
readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
|
|
29
3
|
readonly url: string;
|
|
@@ -79,299 +53,6 @@ declare type OpenAPIConfig = {
|
|
|
79
53
|
ENCODE_PATH?: (path: string) => string;
|
|
80
54
|
};
|
|
81
55
|
|
|
82
|
-
/**
|
|
83
|
-
* Request method
|
|
84
|
-
* @param config The OpenAPI configuration object
|
|
85
|
-
* @param options The request options from the service
|
|
86
|
-
* @returns CancelablePromise<T>
|
|
87
|
-
* @throws ApiError
|
|
88
|
-
*/
|
|
89
|
-
declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* A handler to modify requests made by ConductorClient. Useful for metrics/option transformation/etc.
|
|
93
|
-
*
|
|
94
|
-
* @remarks
|
|
95
|
-
* Example: Customizing the request URL
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* const requestCustomizer = (request, config, options) => {
|
|
99
|
-
* const url = options.url.replace(/^\/api/, '')
|
|
100
|
-
* return request(config, {...options, url });
|
|
101
|
-
* }
|
|
102
|
-
* const config = { BASE: "https://my-api.com"}
|
|
103
|
-
* const client = new ConductorClient(config, requestCustomizer)
|
|
104
|
-
* ```
|
|
105
|
-
*
|
|
106
|
-
* @param request the underlying node-fetch powered function
|
|
107
|
-
* @param config @see OpenAPIConfig
|
|
108
|
-
* @param options {see ApiRequestOptions}
|
|
109
|
-
*/
|
|
110
|
-
declare type RequestType = typeof request;
|
|
111
|
-
declare type ConductorHttpRequest = <T>(request: RequestType, config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
|
|
112
|
-
|
|
113
|
-
declare type SubWorkflowParams = {
|
|
114
|
-
name: string;
|
|
115
|
-
version?: number;
|
|
116
|
-
taskToDomain?: Record<string, string>;
|
|
117
|
-
workflowDefinition?: WorkflowDef$1;
|
|
118
|
-
};
|
|
119
|
-
|
|
120
|
-
declare type TaskDef = {
|
|
121
|
-
ownerApp?: string;
|
|
122
|
-
createTime?: number;
|
|
123
|
-
updateTime?: number;
|
|
124
|
-
createdBy?: string;
|
|
125
|
-
updatedBy?: string;
|
|
126
|
-
name: string;
|
|
127
|
-
description?: string;
|
|
128
|
-
retryCount?: number;
|
|
129
|
-
timeoutSeconds: number;
|
|
130
|
-
inputKeys?: Array<string>;
|
|
131
|
-
outputKeys?: Array<string>;
|
|
132
|
-
timeoutPolicy?: 'RETRY' | 'TIME_OUT_WF' | 'ALERT_ONLY';
|
|
133
|
-
retryLogic?: 'FIXED' | 'EXPONENTIAL_BACKOFF' | 'LINEAR_BACKOFF';
|
|
134
|
-
retryDelaySeconds?: number;
|
|
135
|
-
responseTimeoutSeconds?: number;
|
|
136
|
-
concurrentExecLimit?: number;
|
|
137
|
-
inputTemplate?: Record<string, any>;
|
|
138
|
-
rateLimitPerFrequency?: number;
|
|
139
|
-
rateLimitFrequencyInSeconds?: number;
|
|
140
|
-
isolationGroupId?: string;
|
|
141
|
-
executionNameSpace?: string;
|
|
142
|
-
ownerEmail?: string;
|
|
143
|
-
pollTimeoutSeconds?: number;
|
|
144
|
-
backoffScaleFactor?: number;
|
|
145
|
-
};
|
|
146
|
-
|
|
147
|
-
declare type WorkflowTask = {
|
|
148
|
-
name: string;
|
|
149
|
-
taskReferenceName: string;
|
|
150
|
-
description?: string;
|
|
151
|
-
inputParameters?: Record<string, any>;
|
|
152
|
-
type?: string;
|
|
153
|
-
dynamicTaskNameParam?: string;
|
|
154
|
-
/**
|
|
155
|
-
* @deprecated
|
|
156
|
-
*/
|
|
157
|
-
caseValueParam?: string;
|
|
158
|
-
/**
|
|
159
|
-
* @deprecated
|
|
160
|
-
*/
|
|
161
|
-
caseExpression?: string;
|
|
162
|
-
scriptExpression?: string;
|
|
163
|
-
decisionCases?: Record<string, Array<WorkflowTask>>;
|
|
164
|
-
/**
|
|
165
|
-
* @deprecated
|
|
166
|
-
*/
|
|
167
|
-
dynamicForkJoinTasksParam?: string;
|
|
168
|
-
dynamicForkTasksParam?: string;
|
|
169
|
-
dynamicForkTasksInputParamName?: string;
|
|
170
|
-
defaultCase?: Array<WorkflowTask>;
|
|
171
|
-
forkTasks?: Array<Array<WorkflowTask>>;
|
|
172
|
-
startDelay?: number;
|
|
173
|
-
subWorkflowParam?: SubWorkflowParams;
|
|
174
|
-
joinOn?: Array<string>;
|
|
175
|
-
sink?: string;
|
|
176
|
-
optional?: boolean;
|
|
177
|
-
taskDefinition?: TaskDef;
|
|
178
|
-
rateLimited?: boolean;
|
|
179
|
-
defaultExclusiveJoinTask?: Array<string>;
|
|
180
|
-
asyncComplete?: boolean;
|
|
181
|
-
loopCondition?: string;
|
|
182
|
-
loopOver?: Array<WorkflowTask>;
|
|
183
|
-
retryCount?: number;
|
|
184
|
-
evaluatorType?: string;
|
|
185
|
-
expression?: string;
|
|
186
|
-
workflowTaskType?: 'SIMPLE' | 'DYNAMIC' | 'FORK_JOIN' | 'FORK_JOIN_DYNAMIC' | 'DECISION' | 'SWITCH' | 'JOIN' | 'DO_WHILE' | 'SUB_WORKFLOW' | 'START_WORKFLOW' | 'EVENT' | 'WAIT' | 'HUMAN' | 'USER_DEFINED' | 'HTTP' | 'LAMBDA' | 'INLINE' | 'EXCLUSIVE_JOIN' | 'TERMINATE' | 'KAFKA_PUBLISH' | 'JSON_JQ_TRANSFORM' | 'SET_VARIABLE';
|
|
187
|
-
};
|
|
188
|
-
|
|
189
|
-
declare type WorkflowDef$1 = {
|
|
190
|
-
ownerApp?: string;
|
|
191
|
-
createTime?: number;
|
|
192
|
-
updateTime?: number;
|
|
193
|
-
createdBy?: string;
|
|
194
|
-
updatedBy?: string;
|
|
195
|
-
name: string;
|
|
196
|
-
description?: string;
|
|
197
|
-
version?: number;
|
|
198
|
-
tasks: Array<WorkflowTask>;
|
|
199
|
-
inputParameters?: Array<string>;
|
|
200
|
-
outputParameters?: Record<string, any>;
|
|
201
|
-
failureWorkflow?: string;
|
|
202
|
-
schemaVersion?: number;
|
|
203
|
-
restartable?: boolean;
|
|
204
|
-
workflowStatusListenerEnabled?: boolean;
|
|
205
|
-
ownerEmail?: string;
|
|
206
|
-
timeoutPolicy?: 'TIME_OUT_WF' | 'ALERT_ONLY';
|
|
207
|
-
timeoutSeconds: number;
|
|
208
|
-
variables?: Record<string, any>;
|
|
209
|
-
inputTemplate?: Record<string, any>;
|
|
210
|
-
};
|
|
211
|
-
|
|
212
|
-
interface CommonTaskDef {
|
|
213
|
-
name: string;
|
|
214
|
-
taskReferenceName: string;
|
|
215
|
-
}
|
|
216
|
-
declare enum TaskType {
|
|
217
|
-
START = "START",
|
|
218
|
-
SIMPLE = "SIMPLE",
|
|
219
|
-
DYNAMIC = "DYNAMIC",
|
|
220
|
-
FORK_JOIN = "FORK_JOIN",
|
|
221
|
-
FORK_JOIN_DYNAMIC = "FORK_JOIN_DYNAMIC",
|
|
222
|
-
DECISION = "DECISION",
|
|
223
|
-
SWITCH = "SWITCH",
|
|
224
|
-
JOIN = "JOIN",
|
|
225
|
-
DO_WHILE = "DO_WHILE",
|
|
226
|
-
SUB_WORKFLOW = "SUB_WORKFLOW",
|
|
227
|
-
EVENT = "EVENT",
|
|
228
|
-
WAIT = "WAIT",
|
|
229
|
-
USER_DEFINED = "USER_DEFINED",
|
|
230
|
-
HTTP = "HTTP",
|
|
231
|
-
LAMBDA = "LAMBDA",
|
|
232
|
-
INLINE = "INLINE",
|
|
233
|
-
EXCLUSIVE_JOIN = "EXCLUSIVE_JOIN",
|
|
234
|
-
TERMINAL = "TERMINAL",
|
|
235
|
-
TERMINATE = "TERMINATE",
|
|
236
|
-
KAFKA_PUBLISH = "KAFKA_PUBLISH",
|
|
237
|
-
JSON_JQ_TRANSFORM = "JSON_JQ_TRANSFORM",
|
|
238
|
-
SET_VARIABLE = "SET_VARIABLE"
|
|
239
|
-
}
|
|
240
|
-
declare type TaskDefTypes = SimpleTaskDef | DoWhileTaskDef | EventTaskDef | ForkJoinTaskDef | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDef | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDef | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
|
|
241
|
-
interface DoWhileTaskDef extends CommonTaskDef {
|
|
242
|
-
inputParameters: Record<string, unknown>;
|
|
243
|
-
type: TaskType.DO_WHILE;
|
|
244
|
-
startDelay?: number;
|
|
245
|
-
optional?: boolean;
|
|
246
|
-
asyncComplete?: boolean;
|
|
247
|
-
loopCondition: string;
|
|
248
|
-
loopOver: TaskDefTypes[];
|
|
249
|
-
}
|
|
250
|
-
interface EventTaskDef extends CommonTaskDef {
|
|
251
|
-
type: TaskType.EVENT;
|
|
252
|
-
sink: string;
|
|
253
|
-
asyncComplete?: boolean;
|
|
254
|
-
}
|
|
255
|
-
interface ForkJoinTaskDef extends CommonTaskDef {
|
|
256
|
-
type: TaskType.FORK_JOIN;
|
|
257
|
-
inputParameters?: Record<string, string>;
|
|
258
|
-
forkTasks: Array<Array<TaskDefTypes>>;
|
|
259
|
-
}
|
|
260
|
-
interface JoinTaskDef extends CommonTaskDef {
|
|
261
|
-
type: TaskType.JOIN;
|
|
262
|
-
inputParameters?: Record<string, string>;
|
|
263
|
-
joinOn: string[];
|
|
264
|
-
optional?: boolean;
|
|
265
|
-
asyncComplete?: boolean;
|
|
266
|
-
}
|
|
267
|
-
interface ForkJoinDynamicDef extends CommonTaskDef {
|
|
268
|
-
inputParameters: {
|
|
269
|
-
dynamicTasks: any;
|
|
270
|
-
dynamicTasksInput: any;
|
|
271
|
-
};
|
|
272
|
-
type: TaskType.FORK_JOIN_DYNAMIC;
|
|
273
|
-
dynamicForkTasksParam: string;
|
|
274
|
-
dynamicForkTasksInputParamName: string;
|
|
275
|
-
startDelay?: number;
|
|
276
|
-
optional?: boolean;
|
|
277
|
-
asyncComplete?: boolean;
|
|
278
|
-
}
|
|
279
|
-
interface HttpInputParameters {
|
|
280
|
-
uri: string;
|
|
281
|
-
method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD";
|
|
282
|
-
accept?: string;
|
|
283
|
-
contentType?: string;
|
|
284
|
-
headers?: Record<string, string>;
|
|
285
|
-
body?: unknown;
|
|
286
|
-
connectionTimeOut?: number;
|
|
287
|
-
readTimeOut?: string;
|
|
288
|
-
}
|
|
289
|
-
interface HttpTaskDef extends CommonTaskDef {
|
|
290
|
-
inputParameters: {
|
|
291
|
-
[x: string]: unknown;
|
|
292
|
-
http_request: HttpInputParameters;
|
|
293
|
-
};
|
|
294
|
-
type: TaskType.HTTP;
|
|
295
|
-
}
|
|
296
|
-
interface InlineTaskInputParameters {
|
|
297
|
-
evaluatorType: "javascript" | "graaljs";
|
|
298
|
-
expression: string;
|
|
299
|
-
[x: string]: unknown;
|
|
300
|
-
}
|
|
301
|
-
interface InlineTaskDef extends CommonTaskDef {
|
|
302
|
-
type: TaskType.INLINE;
|
|
303
|
-
inputParameters: InlineTaskInputParameters;
|
|
304
|
-
}
|
|
305
|
-
interface ContainingQueryExpression {
|
|
306
|
-
queryExpression: string;
|
|
307
|
-
[x: string | number | symbol]: unknown;
|
|
308
|
-
}
|
|
309
|
-
interface JsonJQTransformTaskDef extends CommonTaskDef {
|
|
310
|
-
type: TaskType.JSON_JQ_TRANSFORM;
|
|
311
|
-
inputParameters: ContainingQueryExpression;
|
|
312
|
-
}
|
|
313
|
-
interface KafkaPublishInputParameters {
|
|
314
|
-
topic: string;
|
|
315
|
-
value: string;
|
|
316
|
-
bootStrapServers: string;
|
|
317
|
-
headers: Record<string, string>;
|
|
318
|
-
key: string;
|
|
319
|
-
keySerializer: string;
|
|
320
|
-
}
|
|
321
|
-
interface KafkaPublishTaskDef extends CommonTaskDef {
|
|
322
|
-
inputParameters: {
|
|
323
|
-
kafka_request: KafkaPublishInputParameters;
|
|
324
|
-
};
|
|
325
|
-
type: TaskType.KAFKA_PUBLISH;
|
|
326
|
-
}
|
|
327
|
-
interface SetVariableTaskDef extends CommonTaskDef {
|
|
328
|
-
type: TaskType.SET_VARIABLE;
|
|
329
|
-
inputParameters: Record<string, unknown>;
|
|
330
|
-
}
|
|
331
|
-
interface SimpleTaskDef extends CommonTaskDef {
|
|
332
|
-
type: TaskType.SIMPLE;
|
|
333
|
-
inputParameters?: Record<string, unknown>;
|
|
334
|
-
}
|
|
335
|
-
interface SubWorkflowTaskDef extends CommonTaskDef {
|
|
336
|
-
type: TaskType.SUB_WORKFLOW;
|
|
337
|
-
inputParameters?: Record<string, unknown>;
|
|
338
|
-
subWorkflowParam: {
|
|
339
|
-
name: string;
|
|
340
|
-
version?: number;
|
|
341
|
-
taskToDomain?: Record<string, string>;
|
|
342
|
-
};
|
|
343
|
-
}
|
|
344
|
-
interface SwitchTaskDef extends CommonTaskDef {
|
|
345
|
-
inputParameters: Record<string, unknown>;
|
|
346
|
-
type: TaskType.SWITCH;
|
|
347
|
-
decisionCases: Record<string, TaskDefTypes[]>;
|
|
348
|
-
defaultCase: TaskDefTypes[];
|
|
349
|
-
evaluatorType: "value-param" | "javascript";
|
|
350
|
-
expression: string;
|
|
351
|
-
}
|
|
352
|
-
interface TerminateTaskDef extends CommonTaskDef {
|
|
353
|
-
inputParameters: {
|
|
354
|
-
terminationStatus: "COMPLETED" | "FAILED";
|
|
355
|
-
workflowOutput?: Record<string, string>;
|
|
356
|
-
terminationReason?: string;
|
|
357
|
-
};
|
|
358
|
-
type: TaskType.TERMINATE;
|
|
359
|
-
startDelay?: number;
|
|
360
|
-
optional?: boolean;
|
|
361
|
-
}
|
|
362
|
-
interface WaitTaskDef extends CommonTaskDef {
|
|
363
|
-
type: TaskType.WAIT;
|
|
364
|
-
inputParameters: {
|
|
365
|
-
duration?: string;
|
|
366
|
-
until?: string;
|
|
367
|
-
};
|
|
368
|
-
}
|
|
369
|
-
interface WorkflowDef extends Omit<WorkflowDef$1, "tasks" | "version" | "inputParameters"> {
|
|
370
|
-
inputParameters: string[];
|
|
371
|
-
version: number;
|
|
372
|
-
tasks: TaskDefTypes[];
|
|
373
|
-
}
|
|
374
|
-
|
|
375
56
|
declare abstract class BaseHttpRequest {
|
|
376
57
|
readonly config: OpenAPIConfig;
|
|
377
58
|
constructor(config: OpenAPIConfig);
|
|
@@ -481,15 +162,114 @@ declare class EventResourceService {
|
|
|
481
162
|
getEventHandlersForEvent(event: string, activeOnly?: boolean): CancelablePromise<Array<EventHandler>>;
|
|
482
163
|
}
|
|
483
164
|
|
|
484
|
-
declare class HealthCheckResourceService {
|
|
485
|
-
readonly httpRequest: BaseHttpRequest;
|
|
486
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
487
|
-
/**
|
|
488
|
-
* @returns any OK
|
|
489
|
-
* @throws ApiError
|
|
490
|
-
*/
|
|
491
|
-
doCheck(): CancelablePromise<Record<string, any>>;
|
|
492
|
-
}
|
|
165
|
+
declare class HealthCheckResourceService {
|
|
166
|
+
readonly httpRequest: BaseHttpRequest;
|
|
167
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
168
|
+
/**
|
|
169
|
+
* @returns any OK
|
|
170
|
+
* @throws ApiError
|
|
171
|
+
*/
|
|
172
|
+
doCheck(): CancelablePromise<Record<string, any>>;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
declare type TaskDef = {
|
|
176
|
+
ownerApp?: string;
|
|
177
|
+
createTime?: number;
|
|
178
|
+
updateTime?: number;
|
|
179
|
+
createdBy?: string;
|
|
180
|
+
updatedBy?: string;
|
|
181
|
+
name: string;
|
|
182
|
+
description?: string;
|
|
183
|
+
retryCount?: number;
|
|
184
|
+
timeoutSeconds: number;
|
|
185
|
+
inputKeys?: Array<string>;
|
|
186
|
+
outputKeys?: Array<string>;
|
|
187
|
+
timeoutPolicy?: 'RETRY' | 'TIME_OUT_WF' | 'ALERT_ONLY';
|
|
188
|
+
retryLogic?: 'FIXED' | 'EXPONENTIAL_BACKOFF' | 'LINEAR_BACKOFF';
|
|
189
|
+
retryDelaySeconds?: number;
|
|
190
|
+
responseTimeoutSeconds?: number;
|
|
191
|
+
concurrentExecLimit?: number;
|
|
192
|
+
inputTemplate?: Record<string, any>;
|
|
193
|
+
rateLimitPerFrequency?: number;
|
|
194
|
+
rateLimitFrequencyInSeconds?: number;
|
|
195
|
+
isolationGroupId?: string;
|
|
196
|
+
executionNameSpace?: string;
|
|
197
|
+
ownerEmail?: string;
|
|
198
|
+
pollTimeoutSeconds?: number;
|
|
199
|
+
backoffScaleFactor?: number;
|
|
200
|
+
};
|
|
201
|
+
|
|
202
|
+
declare type SubWorkflowParams = {
|
|
203
|
+
name: string;
|
|
204
|
+
version?: number;
|
|
205
|
+
taskToDomain?: Record<string, string>;
|
|
206
|
+
workflowDefinition?: WorkflowDef$1;
|
|
207
|
+
};
|
|
208
|
+
|
|
209
|
+
declare type WorkflowTask = {
|
|
210
|
+
name: string;
|
|
211
|
+
taskReferenceName: string;
|
|
212
|
+
description?: string;
|
|
213
|
+
inputParameters?: Record<string, any>;
|
|
214
|
+
type?: string;
|
|
215
|
+
dynamicTaskNameParam?: string;
|
|
216
|
+
/**
|
|
217
|
+
* @deprecated
|
|
218
|
+
*/
|
|
219
|
+
caseValueParam?: string;
|
|
220
|
+
/**
|
|
221
|
+
* @deprecated
|
|
222
|
+
*/
|
|
223
|
+
caseExpression?: string;
|
|
224
|
+
scriptExpression?: string;
|
|
225
|
+
decisionCases?: Record<string, Array<WorkflowTask>>;
|
|
226
|
+
/**
|
|
227
|
+
* @deprecated
|
|
228
|
+
*/
|
|
229
|
+
dynamicForkJoinTasksParam?: string;
|
|
230
|
+
dynamicForkTasksParam?: string;
|
|
231
|
+
dynamicForkTasksInputParamName?: string;
|
|
232
|
+
defaultCase?: Array<WorkflowTask>;
|
|
233
|
+
forkTasks?: Array<Array<WorkflowTask>>;
|
|
234
|
+
startDelay?: number;
|
|
235
|
+
subWorkflowParam?: SubWorkflowParams;
|
|
236
|
+
joinOn?: Array<string>;
|
|
237
|
+
sink?: string;
|
|
238
|
+
optional?: boolean;
|
|
239
|
+
taskDefinition?: TaskDef;
|
|
240
|
+
rateLimited?: boolean;
|
|
241
|
+
defaultExclusiveJoinTask?: Array<string>;
|
|
242
|
+
asyncComplete?: boolean;
|
|
243
|
+
loopCondition?: string;
|
|
244
|
+
loopOver?: Array<WorkflowTask>;
|
|
245
|
+
retryCount?: number;
|
|
246
|
+
evaluatorType?: string;
|
|
247
|
+
expression?: string;
|
|
248
|
+
workflowTaskType?: 'SIMPLE' | 'DYNAMIC' | 'FORK_JOIN' | 'FORK_JOIN_DYNAMIC' | 'DECISION' | 'SWITCH' | 'JOIN' | 'DO_WHILE' | 'SUB_WORKFLOW' | 'START_WORKFLOW' | 'EVENT' | 'WAIT' | 'HUMAN' | 'USER_DEFINED' | 'HTTP' | 'LAMBDA' | 'INLINE' | 'EXCLUSIVE_JOIN' | 'TERMINATE' | 'KAFKA_PUBLISH' | 'JSON_JQ_TRANSFORM' | 'SET_VARIABLE';
|
|
249
|
+
};
|
|
250
|
+
|
|
251
|
+
declare type WorkflowDef$1 = {
|
|
252
|
+
ownerApp?: string;
|
|
253
|
+
createTime?: number;
|
|
254
|
+
updateTime?: number;
|
|
255
|
+
createdBy?: string;
|
|
256
|
+
updatedBy?: string;
|
|
257
|
+
name: string;
|
|
258
|
+
description?: string;
|
|
259
|
+
version?: number;
|
|
260
|
+
tasks: Array<WorkflowTask>;
|
|
261
|
+
inputParameters?: Array<string>;
|
|
262
|
+
outputParameters?: Record<string, any>;
|
|
263
|
+
failureWorkflow?: string;
|
|
264
|
+
schemaVersion?: number;
|
|
265
|
+
restartable?: boolean;
|
|
266
|
+
workflowStatusListenerEnabled?: boolean;
|
|
267
|
+
ownerEmail?: string;
|
|
268
|
+
timeoutPolicy?: 'TIME_OUT_WF' | 'ALERT_ONLY';
|
|
269
|
+
timeoutSeconds: number;
|
|
270
|
+
variables?: Record<string, any>;
|
|
271
|
+
inputTemplate?: Record<string, any>;
|
|
272
|
+
};
|
|
493
273
|
|
|
494
274
|
declare class MetadataResourceService {
|
|
495
275
|
readonly httpRequest: BaseHttpRequest;
|
|
@@ -1366,6 +1146,37 @@ declare class WorkflowResourceService {
|
|
|
1366
1146
|
resetWorkflow(workflowId: string): CancelablePromise<void>;
|
|
1367
1147
|
}
|
|
1368
1148
|
|
|
1149
|
+
/**
|
|
1150
|
+
* Request method
|
|
1151
|
+
* @param config The OpenAPI configuration object
|
|
1152
|
+
* @param options The request options from the service
|
|
1153
|
+
* @returns CancelablePromise<T>
|
|
1154
|
+
* @throws ApiError
|
|
1155
|
+
*/
|
|
1156
|
+
declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
|
|
1157
|
+
|
|
1158
|
+
/**
|
|
1159
|
+
* A handler to modify requests made by ConductorClient. Useful for metrics/option transformation/etc.
|
|
1160
|
+
*
|
|
1161
|
+
* @remarks
|
|
1162
|
+
* Example: Customizing the request URL
|
|
1163
|
+
* ```
|
|
1164
|
+
*
|
|
1165
|
+
* const requestCustomizer = (request, config, options) => {
|
|
1166
|
+
* const url = options.url.replace(/^\/api/, '')
|
|
1167
|
+
* return request(config, {...options, url });
|
|
1168
|
+
* }
|
|
1169
|
+
* const config = { BASE: "https://my-api.com"}
|
|
1170
|
+
* const client = new ConductorClient(config, requestCustomizer)
|
|
1171
|
+
* ```
|
|
1172
|
+
*
|
|
1173
|
+
* @param request the underlying node-fetch powered function
|
|
1174
|
+
* @param config @see OpenAPIConfig
|
|
1175
|
+
* @param options {see ApiRequestOptions}
|
|
1176
|
+
*/
|
|
1177
|
+
declare type RequestType = typeof request;
|
|
1178
|
+
declare type ConductorHttpRequest = <T>(request: RequestType, config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;
|
|
1179
|
+
|
|
1369
1180
|
declare type AssignmentPolicy = {
|
|
1370
1181
|
type: string;
|
|
1371
1182
|
};
|
|
@@ -1693,6 +1504,195 @@ interface ConductorWorker {
|
|
|
1693
1504
|
pollInterval?: number;
|
|
1694
1505
|
}
|
|
1695
1506
|
|
|
1507
|
+
interface ConductorLogger {
|
|
1508
|
+
info(...args: any): void;
|
|
1509
|
+
error(...args: any): void;
|
|
1510
|
+
debug(...args: any): void;
|
|
1511
|
+
}
|
|
1512
|
+
declare type ConductorLogLevel = keyof typeof LOG_LEVELS;
|
|
1513
|
+
interface DefaultLoggerConfig {
|
|
1514
|
+
level?: ConductorLogLevel;
|
|
1515
|
+
tags?: Object[];
|
|
1516
|
+
}
|
|
1517
|
+
declare const LOG_LEVELS: {
|
|
1518
|
+
readonly DEBUG: 10;
|
|
1519
|
+
readonly INFO: 30;
|
|
1520
|
+
readonly ERROR: 60;
|
|
1521
|
+
};
|
|
1522
|
+
declare class DefaultLogger implements ConductorLogger {
|
|
1523
|
+
private readonly tags;
|
|
1524
|
+
private readonly level;
|
|
1525
|
+
constructor(config?: DefaultLoggerConfig);
|
|
1526
|
+
private log;
|
|
1527
|
+
info: (...args: any) => void;
|
|
1528
|
+
debug: (...args: any) => void;
|
|
1529
|
+
error: (...args: any) => void;
|
|
1530
|
+
}
|
|
1531
|
+
declare const noopLogger: ConductorLogger;
|
|
1532
|
+
|
|
1533
|
+
interface CommonTaskDef {
|
|
1534
|
+
name: string;
|
|
1535
|
+
taskReferenceName: string;
|
|
1536
|
+
}
|
|
1537
|
+
declare enum TaskType {
|
|
1538
|
+
START = "START",
|
|
1539
|
+
SIMPLE = "SIMPLE",
|
|
1540
|
+
DYNAMIC = "DYNAMIC",
|
|
1541
|
+
FORK_JOIN = "FORK_JOIN",
|
|
1542
|
+
FORK_JOIN_DYNAMIC = "FORK_JOIN_DYNAMIC",
|
|
1543
|
+
DECISION = "DECISION",
|
|
1544
|
+
SWITCH = "SWITCH",
|
|
1545
|
+
JOIN = "JOIN",
|
|
1546
|
+
DO_WHILE = "DO_WHILE",
|
|
1547
|
+
SUB_WORKFLOW = "SUB_WORKFLOW",
|
|
1548
|
+
EVENT = "EVENT",
|
|
1549
|
+
WAIT = "WAIT",
|
|
1550
|
+
USER_DEFINED = "USER_DEFINED",
|
|
1551
|
+
HTTP = "HTTP",
|
|
1552
|
+
LAMBDA = "LAMBDA",
|
|
1553
|
+
INLINE = "INLINE",
|
|
1554
|
+
EXCLUSIVE_JOIN = "EXCLUSIVE_JOIN",
|
|
1555
|
+
TERMINAL = "TERMINAL",
|
|
1556
|
+
TERMINATE = "TERMINATE",
|
|
1557
|
+
KAFKA_PUBLISH = "KAFKA_PUBLISH",
|
|
1558
|
+
JSON_JQ_TRANSFORM = "JSON_JQ_TRANSFORM",
|
|
1559
|
+
SET_VARIABLE = "SET_VARIABLE"
|
|
1560
|
+
}
|
|
1561
|
+
declare type TaskDefTypes = SimpleTaskDef | DoWhileTaskDef | EventTaskDef | ForkJoinTaskDef | ForkJoinDynamicDef | HttpTaskDef | InlineTaskDef | JsonJQTransformTaskDef | KafkaPublishTaskDef | SetVariableTaskDef | SubWorkflowTaskDef | SwitchTaskDef | TerminateTaskDef | JoinTaskDef | WaitTaskDef;
|
|
1562
|
+
interface DoWhileTaskDef extends CommonTaskDef {
|
|
1563
|
+
inputParameters: Record<string, unknown>;
|
|
1564
|
+
type: TaskType.DO_WHILE;
|
|
1565
|
+
startDelay?: number;
|
|
1566
|
+
optional?: boolean;
|
|
1567
|
+
asyncComplete?: boolean;
|
|
1568
|
+
loopCondition: string;
|
|
1569
|
+
loopOver: TaskDefTypes[];
|
|
1570
|
+
}
|
|
1571
|
+
interface EventTaskDef extends CommonTaskDef {
|
|
1572
|
+
type: TaskType.EVENT;
|
|
1573
|
+
sink: string;
|
|
1574
|
+
asyncComplete?: boolean;
|
|
1575
|
+
}
|
|
1576
|
+
interface ForkJoinTaskDef extends CommonTaskDef {
|
|
1577
|
+
type: TaskType.FORK_JOIN;
|
|
1578
|
+
inputParameters?: Record<string, string>;
|
|
1579
|
+
forkTasks: Array<Array<TaskDefTypes>>;
|
|
1580
|
+
}
|
|
1581
|
+
interface JoinTaskDef extends CommonTaskDef {
|
|
1582
|
+
type: TaskType.JOIN;
|
|
1583
|
+
inputParameters?: Record<string, string>;
|
|
1584
|
+
joinOn: string[];
|
|
1585
|
+
optional?: boolean;
|
|
1586
|
+
asyncComplete?: boolean;
|
|
1587
|
+
}
|
|
1588
|
+
interface ForkJoinDynamicDef extends CommonTaskDef {
|
|
1589
|
+
inputParameters: {
|
|
1590
|
+
dynamicTasks: any;
|
|
1591
|
+
dynamicTasksInput: any;
|
|
1592
|
+
};
|
|
1593
|
+
type: TaskType.FORK_JOIN_DYNAMIC;
|
|
1594
|
+
dynamicForkTasksParam: string;
|
|
1595
|
+
dynamicForkTasksInputParamName: string;
|
|
1596
|
+
startDelay?: number;
|
|
1597
|
+
optional?: boolean;
|
|
1598
|
+
asyncComplete?: boolean;
|
|
1599
|
+
}
|
|
1600
|
+
interface HttpInputParameters {
|
|
1601
|
+
uri: string;
|
|
1602
|
+
method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD";
|
|
1603
|
+
accept?: string;
|
|
1604
|
+
contentType?: string;
|
|
1605
|
+
headers?: Record<string, string>;
|
|
1606
|
+
body?: unknown;
|
|
1607
|
+
connectionTimeOut?: number;
|
|
1608
|
+
readTimeOut?: string;
|
|
1609
|
+
}
|
|
1610
|
+
interface HttpTaskDef extends CommonTaskDef {
|
|
1611
|
+
inputParameters: {
|
|
1612
|
+
[x: string]: unknown;
|
|
1613
|
+
http_request: HttpInputParameters;
|
|
1614
|
+
};
|
|
1615
|
+
type: TaskType.HTTP;
|
|
1616
|
+
}
|
|
1617
|
+
interface InlineTaskInputParameters {
|
|
1618
|
+
evaluatorType: "javascript" | "graaljs";
|
|
1619
|
+
expression: string;
|
|
1620
|
+
[x: string]: unknown;
|
|
1621
|
+
}
|
|
1622
|
+
interface InlineTaskDef extends CommonTaskDef {
|
|
1623
|
+
type: TaskType.INLINE;
|
|
1624
|
+
inputParameters: InlineTaskInputParameters;
|
|
1625
|
+
}
|
|
1626
|
+
interface ContainingQueryExpression {
|
|
1627
|
+
queryExpression: string;
|
|
1628
|
+
[x: string | number | symbol]: unknown;
|
|
1629
|
+
}
|
|
1630
|
+
interface JsonJQTransformTaskDef extends CommonTaskDef {
|
|
1631
|
+
type: TaskType.JSON_JQ_TRANSFORM;
|
|
1632
|
+
inputParameters: ContainingQueryExpression;
|
|
1633
|
+
}
|
|
1634
|
+
interface KafkaPublishInputParameters {
|
|
1635
|
+
topic: string;
|
|
1636
|
+
value: string;
|
|
1637
|
+
bootStrapServers: string;
|
|
1638
|
+
headers: Record<string, string>;
|
|
1639
|
+
key: string;
|
|
1640
|
+
keySerializer: string;
|
|
1641
|
+
}
|
|
1642
|
+
interface KafkaPublishTaskDef extends CommonTaskDef {
|
|
1643
|
+
inputParameters: {
|
|
1644
|
+
kafka_request: KafkaPublishInputParameters;
|
|
1645
|
+
};
|
|
1646
|
+
type: TaskType.KAFKA_PUBLISH;
|
|
1647
|
+
}
|
|
1648
|
+
interface SetVariableTaskDef extends CommonTaskDef {
|
|
1649
|
+
type: TaskType.SET_VARIABLE;
|
|
1650
|
+
inputParameters: Record<string, unknown>;
|
|
1651
|
+
}
|
|
1652
|
+
interface SimpleTaskDef extends CommonTaskDef {
|
|
1653
|
+
type: TaskType.SIMPLE;
|
|
1654
|
+
inputParameters?: Record<string, unknown>;
|
|
1655
|
+
}
|
|
1656
|
+
interface SubWorkflowTaskDef extends CommonTaskDef {
|
|
1657
|
+
type: TaskType.SUB_WORKFLOW;
|
|
1658
|
+
inputParameters?: Record<string, unknown>;
|
|
1659
|
+
subWorkflowParam: {
|
|
1660
|
+
name: string;
|
|
1661
|
+
version?: number;
|
|
1662
|
+
taskToDomain?: Record<string, string>;
|
|
1663
|
+
};
|
|
1664
|
+
}
|
|
1665
|
+
interface SwitchTaskDef extends CommonTaskDef {
|
|
1666
|
+
inputParameters: Record<string, unknown>;
|
|
1667
|
+
type: TaskType.SWITCH;
|
|
1668
|
+
decisionCases: Record<string, TaskDefTypes[]>;
|
|
1669
|
+
defaultCase: TaskDefTypes[];
|
|
1670
|
+
evaluatorType: "value-param" | "javascript";
|
|
1671
|
+
expression: string;
|
|
1672
|
+
}
|
|
1673
|
+
interface TerminateTaskDef extends CommonTaskDef {
|
|
1674
|
+
inputParameters: {
|
|
1675
|
+
terminationStatus: "COMPLETED" | "FAILED";
|
|
1676
|
+
workflowOutput?: Record<string, string>;
|
|
1677
|
+
terminationReason?: string;
|
|
1678
|
+
};
|
|
1679
|
+
type: TaskType.TERMINATE;
|
|
1680
|
+
startDelay?: number;
|
|
1681
|
+
optional?: boolean;
|
|
1682
|
+
}
|
|
1683
|
+
interface WaitTaskDef extends CommonTaskDef {
|
|
1684
|
+
type: TaskType.WAIT;
|
|
1685
|
+
inputParameters: {
|
|
1686
|
+
duration?: string;
|
|
1687
|
+
until?: string;
|
|
1688
|
+
};
|
|
1689
|
+
}
|
|
1690
|
+
interface WorkflowDef extends Omit<WorkflowDef$1, "tasks" | "version" | "inputParameters"> {
|
|
1691
|
+
inputParameters: string[];
|
|
1692
|
+
version: number;
|
|
1693
|
+
tasks: TaskDefTypes[];
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
1696
|
declare type TaskErrorHandler = (error: Error, task?: Task) => void;
|
|
1697
1697
|
interface TaskRunnerOptions {
|
|
1698
1698
|
workerID: string;
|
|
@@ -1709,6 +1709,7 @@ interface RunnerArgs {
|
|
|
1709
1709
|
onError?: TaskErrorHandler;
|
|
1710
1710
|
concurrency?: number;
|
|
1711
1711
|
}
|
|
1712
|
+
|
|
1712
1713
|
declare const noopErrorHandler: TaskErrorHandler;
|
|
1713
1714
|
/**
|
|
1714
1715
|
* Responsible for polling and executing tasks from a queue.
|
|
@@ -1830,7 +1831,7 @@ declare class WorkflowExecutor {
|
|
|
1830
1831
|
* @param includeVariables flag to include variable
|
|
1831
1832
|
* @returns Promise<WorkflowStatus>
|
|
1832
1833
|
*/
|
|
1833
|
-
getWorkflowStatus(workflowInstanceId: string, includeOutput: boolean, includeVariables: boolean):
|
|
1834
|
+
getWorkflowStatus(workflowInstanceId: string, includeOutput: boolean, includeVariables: boolean): Promise<WorkflowStatus>;
|
|
1834
1835
|
/**
|
|
1835
1836
|
* Pauses a running workflow
|
|
1836
1837
|
* @param workflowInstanceId current workflow execution
|
|
@@ -1844,7 +1845,7 @@ declare class WorkflowExecutor {
|
|
|
1844
1845
|
* @param rerunWorkflowRequest Rerun Workflow Execution Request
|
|
1845
1846
|
* @returns
|
|
1846
1847
|
*/
|
|
1847
|
-
reRun(workflowInstanceId: string, rerunWorkflowRequest?: Partial<RerunWorkflowRequest>):
|
|
1848
|
+
reRun(workflowInstanceId: string, rerunWorkflowRequest?: Partial<RerunWorkflowRequest>): Promise<string>;
|
|
1848
1849
|
/**
|
|
1849
1850
|
* Restarts workflow with workflowInstanceId, if useLatestDefinition uses last defintion
|
|
1850
1851
|
* @param workflowInstanceId
|
|
@@ -2182,4 +2183,4 @@ declare type FetchFn<T = RequestInit, R extends {
|
|
|
2182
2183
|
} = Response> = (input: RequestInfo, init?: T) => Promise<R>;
|
|
2183
2184
|
declare type OrkesApiConfig = ConductorClientAPIConfig & GenerateTokenRequest;
|
|
2184
2185
|
|
|
2185
|
-
export { HealthCheckResourceService as $, ApiRequestOptions as A, BaseHttpRequest as B, ConductorHttpRequest as C, StartWorkflow as D, EventHandler as E, FetchFn as F, GenerateTokenRequest as G, StartWorkflowRequest as H, SubWorkflowParams as I, Task as J, TaskDef as K, TaskDetails as L, TaskExecLog as M, TaskResult as N, OrkesApiConfig as O, PollData as P, TaskSummary as Q, RunnerArgs as R, SaveScheduleRequest as S,
|
|
2186
|
+
export { HealthCheckResourceService as $, ApiRequestOptions as A, BaseHttpRequest as B, ConductorHttpRequest as C, StartWorkflow as D, EventHandler as E, FetchFn as F, GenerateTokenRequest as G, StartWorkflowRequest as H, SubWorkflowParams as I, Task as J, TaskDef as K, TaskDetails as L, TaskExecLog as M, TaskResult as N, OrkesApiConfig as O, PollData as P, TaskSummary as Q, RunnerArgs as R, SaveScheduleRequest as S, TaskRunner as T, WorkflowSchedule as U, WorkflowScheduleExecutionModel as V, Workflow as W, WorkflowStatus as X, WorkflowSummary as Y, WorkflowTask as Z, EventResourceService as _, ConductorClient as a, forkTaskJoin as a$, MetadataResourceService as a0, SchedulerResourceService as a1, TaskResourceService as a2, TokenResourceService as a3, WorkflowBulkResourceService as a4, WorkflowResourceService as a5, AssignmentPolicy as a6, Fixed as a7, BackToAssigment as a8, ClearAssigment as a9, JoinTaskDef as aA, ForkJoinDynamicDef as aB, HttpInputParameters as aC, HttpTaskDef as aD, InlineTaskInputParameters as aE, InlineTaskDef as aF, JsonJQTransformTaskDef as aG, KafkaPublishInputParameters as aH, KafkaPublishTaskDef as aI, SetVariableTaskDef as aJ, SimpleTaskDef as aK, SubWorkflowTaskDef as aL, SwitchTaskDef as aM, TerminateTaskDef as aN, WaitTaskDef as aO, WorkflowDef as aP, WorkflowExecutor as aQ, ConductorError as aR, TaskResultStatus as aS, HumanExecutor as aT, doWhileTask as aU, newLoopTask as aV, dynamicForkTask as aW, eventTask as aX, sqsEventTask as aY, conductorEventTask as aZ, forkTask as a_, Escalate as aa, FFAAssignment as ab, HTScrollableSearchResultHumanTaskEntry as ac, HumanTaskActionLogEntry as ad, HumanTaskEntry as ae, HumanTaskLoad as af, HumanTaskStateLogEntry as ag, HumanTaskTemplate as ah, HumanTaskTemplateEntry as ai, LeastBusyGroupMemberAssignment as aj, Never as ak, SearchResultHumanTaskEntry as al, Terminate as am, TimeoutPolicy as an, ConductorLogger as ao, ConductorLogLevel as ap, DefaultLoggerConfig as aq, DefaultLogger as ar, noopLogger as as, RequestType as at, CommonTaskDef as au, TaskType as av, TaskDefTypes as aw, DoWhileTaskDef as ax, EventTaskDef as ay, ForkJoinTaskDef as az, ConductorClientAPIConfig as b, httpTask as b0, inlineTask as b1, joinTask as b2, jsonJqTask as b3, kafkaPublishTask as b4, setVariableTask as b5, simpleTask as b6, subWorkflowTask as b7, switchTask as b8, terminateTask as b9, waitTaskDuration as ba, waitTaskUntil as bb, workflow as bc, generateSimpleTask as bd, generateDoWhileTask as be, generateEventTask as bf, generateForkJoinTask as bg, generateJoinTask as bh, generateHTTPTask as bi, generateInlineTask as bj, generateJQTransformTask as bk, generateKafkaPublishTask as bl, generateSubWorkflowTask as bm, generateSetVariableTask as bn, generateTerminateTask as bo, generateWaitTask as bp, generateSwitchTask as bq, generate as br, taskGenMapper as bs, OpenAPIConfig as c, CancelablePromise as d, TaskManagerOptions as e, TaskManagerConfig as f, TaskManager as g, ConductorWorker as h, TaskErrorHandler as i, TaskRunnerOptions as j, ApiResult as k, OnCancel as l, ApiError as m, noopErrorHandler as n, CancelError as o, Action as p, ExternalStorageLocation as q, RerunWorkflowRequest as r, Response$1 as s, ScrollableSearchResultWorkflowSummary as t, SearchResultTask as u, SearchResultTaskSummary as v, SearchResultWorkflow as w, SearchResultWorkflowScheduleExecutionModel as x, SearchResultWorkflowSummary as y, SkipTaskRequest as z };
|