@io-orkes/conductor-javascript 0.9.0 → 1.0.0
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/README.md +27 -51
- package/dist/index.d.ts +85 -42
- package/dist/index.js +58 -16
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +48 -15
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -5
package/README.md
CHANGED
|
@@ -1,66 +1,40 @@
|
|
|
1
|
-
# Conductor Javascript SDK
|
|
1
|
+
# Netflix Conductor Javascript SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `conductor-javascript` repository provides the client SDKs to build task workers in javascript/typescript.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Building the task workers in javascript mainly consists of the following steps:
|
|
6
6
|
|
|
7
|
-
1.
|
|
8
|
-
2. [Create and run
|
|
9
|
-
3. [Create workflows using
|
|
7
|
+
1. Setup conductor-javascript package
|
|
8
|
+
2. [Create and run task workers](workers_sdk.md)
|
|
9
|
+
3. [Create workflows using code](workflow_sdk.md)
|
|
10
10
|
4. [Api Docs](docs/api/README.md)
|
|
11
|
+
|
|
12
|
+
### Setup Conductor Javascript Package
|
|
11
13
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
Simple connection to conductor
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
const client = new ConductorClient({
|
|
18
|
-
serverUrl: "https://play.orkes.io/api",
|
|
19
|
-
});
|
|
14
|
+
* Get the package from npm
|
|
20
15
|
|
|
16
|
+
```shell
|
|
17
|
+
npm i @io-orkes/conductor-javascript
|
|
21
18
|
```
|
|
19
|
+
or
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
import { OrkesApiConfig, orkesConductorClient, TaskRunner } from "@io-orkes/conductor-javascript";
|
|
28
|
-
|
|
29
|
-
const clientPromise = orkesConductorClient({
|
|
30
|
-
serverUrl: 'https://play.orkes.io/api',
|
|
31
|
-
})
|
|
32
|
-
|
|
33
|
-
const client = await clientPromise;
|
|
21
|
+
```shell
|
|
22
|
+
yarn add @io-orkes/conductor-javascript
|
|
23
|
+
```
|
|
34
24
|
|
|
35
|
-
|
|
36
|
-
taskResource: client.taskResource,
|
|
37
|
-
worker: {
|
|
38
|
-
taskDefName: "MyCustomWorker",
|
|
39
|
-
execute: async ({ inputData, taskId }) => {
|
|
40
|
-
return {
|
|
41
|
-
outputData: {
|
|
42
|
-
greeting: "Hello World",
|
|
43
|
-
},
|
|
44
|
-
status: "COMPLETED",
|
|
45
|
-
};
|
|
46
|
-
},
|
|
47
|
-
},
|
|
48
|
-
options: {
|
|
49
|
-
pollInterval: 10,
|
|
50
|
-
domain: undefined,
|
|
51
|
-
concurrency: 1,
|
|
52
|
-
workerID: "",
|
|
53
|
-
},
|
|
54
|
-
});
|
|
25
|
+
## Configurations
|
|
55
26
|
|
|
56
|
-
|
|
27
|
+
### Authentication Settings (Optional)
|
|
28
|
+
Configure the authentication settings if your Conductor server requires authentication.
|
|
29
|
+
* keyId: Key for authentication.
|
|
30
|
+
* keySecret: Secret for the key.
|
|
57
31
|
|
|
58
|
-
|
|
32
|
+
### Access Control Setup
|
|
33
|
+
See [Access Control](https://orkes.io/content/docs/getting-started/concepts/access-control) for more details on role-based access control with Conductor and generating API keys for your environment.
|
|
59
34
|
|
|
60
|
-
|
|
35
|
+
### Configure API Client
|
|
61
36
|
|
|
62
37
|
```typescript
|
|
63
|
-
|
|
64
38
|
/**
|
|
65
39
|
* Application keys generated from the Application menu > Create Application
|
|
66
40
|
* then edit and create Access Keys
|
|
@@ -69,11 +43,13 @@ taskManager.startPolling();
|
|
|
69
43
|
import { OrkesApiConfig, orkesConductorClient } from "@io-orkes/conductor-javascript";
|
|
70
44
|
|
|
71
45
|
const config: Partial<OrkesApiConfig> = {
|
|
72
|
-
keyId: "XXX",
|
|
73
|
-
keySecret: "XXXX",
|
|
46
|
+
keyId: "XXX", // optional
|
|
47
|
+
keySecret: "XXXX", // optional
|
|
74
48
|
serverUrl: "https://play.orkes.io/api",
|
|
75
49
|
};
|
|
76
50
|
|
|
77
51
|
orkesConductorClient(config).then(client => ..... );
|
|
78
52
|
|
|
79
53
|
```
|
|
54
|
+
|
|
55
|
+
### Next: [Create and run task workers](workers_sdk.md)
|
package/dist/index.d.ts
CHANGED
|
@@ -414,7 +414,7 @@ declare class MetadataResourceService {
|
|
|
414
414
|
get(name: string, version?: number, metadata?: boolean): CancelablePromise<WorkflowDef$1>;
|
|
415
415
|
}
|
|
416
416
|
|
|
417
|
-
declare type StartWorkflowRequest
|
|
417
|
+
declare type StartWorkflowRequest = {
|
|
418
418
|
name: string;
|
|
419
419
|
version?: number;
|
|
420
420
|
correlationId?: string;
|
|
@@ -431,7 +431,7 @@ declare type SaveScheduleRequest = {
|
|
|
431
431
|
cronExpression: string;
|
|
432
432
|
runCatchupScheduleInstances?: boolean;
|
|
433
433
|
paused?: boolean;
|
|
434
|
-
startWorkflowRequest?: StartWorkflowRequest
|
|
434
|
+
startWorkflowRequest?: StartWorkflowRequest;
|
|
435
435
|
createdBy?: string;
|
|
436
436
|
updatedBy?: string;
|
|
437
437
|
scheduleStartTime?: number;
|
|
@@ -447,7 +447,7 @@ declare type WorkflowScheduleExecutionModel = {
|
|
|
447
447
|
workflowId?: string;
|
|
448
448
|
reason?: string;
|
|
449
449
|
stackTrace?: string;
|
|
450
|
-
startWorkflowRequest?: StartWorkflowRequest
|
|
450
|
+
startWorkflowRequest?: StartWorkflowRequest;
|
|
451
451
|
state?: 'POLLED' | 'FAILED' | 'EXECUTED';
|
|
452
452
|
};
|
|
453
453
|
|
|
@@ -461,7 +461,7 @@ declare type WorkflowSchedule = {
|
|
|
461
461
|
cronExpression?: string;
|
|
462
462
|
runCatchupScheduleInstances?: boolean;
|
|
463
463
|
paused?: boolean;
|
|
464
|
-
startWorkflowRequest?: StartWorkflowRequest
|
|
464
|
+
startWorkflowRequest?: StartWorkflowRequest;
|
|
465
465
|
scheduleStartTime?: number;
|
|
466
466
|
scheduleEndTime?: number;
|
|
467
467
|
createTime?: number;
|
|
@@ -657,7 +657,7 @@ declare type TaskExecLog = {
|
|
|
657
657
|
createdTime?: number;
|
|
658
658
|
};
|
|
659
659
|
|
|
660
|
-
declare type TaskResult
|
|
660
|
+
declare type TaskResult = {
|
|
661
661
|
workflowInstanceId: string;
|
|
662
662
|
taskId: string;
|
|
663
663
|
reasonForIncompletion?: string;
|
|
@@ -787,7 +787,7 @@ declare class TaskResourceService {
|
|
|
787
787
|
* @returns string OK
|
|
788
788
|
* @throws ApiError
|
|
789
789
|
*/
|
|
790
|
-
updateTask1(requestBody: TaskResult
|
|
790
|
+
updateTask1(requestBody: TaskResult): CancelablePromise<string>;
|
|
791
791
|
/**
|
|
792
792
|
* Get Task type queue sizes
|
|
793
793
|
* @param taskType
|
|
@@ -878,7 +878,7 @@ declare class WorkflowBulkResourceService {
|
|
|
878
878
|
pauseWorkflow1(requestBody: Array<string>): CancelablePromise<BulkResponse>;
|
|
879
879
|
}
|
|
880
880
|
|
|
881
|
-
declare type RerunWorkflowRequest
|
|
881
|
+
declare type RerunWorkflowRequest = {
|
|
882
882
|
reRunFromWorkflowId?: string;
|
|
883
883
|
workflowInput?: Record<string, any>;
|
|
884
884
|
reRunFromTaskId?: string;
|
|
@@ -955,11 +955,26 @@ declare type SearchResultWorkflowSummary = {
|
|
|
955
955
|
results?: Array<WorkflowSummary>;
|
|
956
956
|
};
|
|
957
957
|
|
|
958
|
-
declare type SkipTaskRequest
|
|
958
|
+
declare type SkipTaskRequest = {
|
|
959
959
|
taskInput?: Record<string, any>;
|
|
960
960
|
taskOutput?: Record<string, any>;
|
|
961
961
|
};
|
|
962
962
|
|
|
963
|
+
declare type WorkflowRun = {
|
|
964
|
+
correlationId?: string;
|
|
965
|
+
createTime?: number;
|
|
966
|
+
createdBy?: string;
|
|
967
|
+
priority?: number;
|
|
968
|
+
requestId?: string;
|
|
969
|
+
status?: string;
|
|
970
|
+
tasks?: Array<Task>;
|
|
971
|
+
updateTime?: number;
|
|
972
|
+
workflowId?: string;
|
|
973
|
+
variables?: Record<string, object>;
|
|
974
|
+
input?: Record<string, object>;
|
|
975
|
+
output?: Record<string, object>;
|
|
976
|
+
};
|
|
977
|
+
|
|
963
978
|
declare type WorkflowStatus = {
|
|
964
979
|
workflowId?: string;
|
|
965
980
|
correlationId?: string;
|
|
@@ -981,13 +996,25 @@ declare class WorkflowResourceService {
|
|
|
981
996
|
* @throws ApiError
|
|
982
997
|
*/
|
|
983
998
|
getRunningWorkflow(name: string, version?: number, startTime?: number, endTime?: number): CancelablePromise<Array<string>>;
|
|
999
|
+
/**
|
|
1000
|
+
* Execute a workflow synchronously
|
|
1001
|
+
* @param body
|
|
1002
|
+
* @param name
|
|
1003
|
+
* @param version
|
|
1004
|
+
* @param requestId
|
|
1005
|
+
* @param waitUntilTaskRef
|
|
1006
|
+
* @param callback
|
|
1007
|
+
* @returns workflowRun
|
|
1008
|
+
* @throws ApiError
|
|
1009
|
+
*/
|
|
1010
|
+
executeWorkflow(body: StartWorkflowRequest, name: string, version: number, requestId: string, waitUntilTaskRef: string): CancelablePromise<WorkflowRun>;
|
|
984
1011
|
/**
|
|
985
1012
|
* Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain
|
|
986
1013
|
* @param requestBody
|
|
987
1014
|
* @returns string OK
|
|
988
1015
|
* @throws ApiError
|
|
989
1016
|
*/
|
|
990
|
-
startWorkflow(requestBody: StartWorkflowRequest
|
|
1017
|
+
startWorkflow(requestBody: StartWorkflowRequest): CancelablePromise<string>;
|
|
991
1018
|
/**
|
|
992
1019
|
* Starts the decision task for a workflow
|
|
993
1020
|
* @param workflowId
|
|
@@ -1002,7 +1029,7 @@ declare class WorkflowResourceService {
|
|
|
1002
1029
|
* @returns string OK
|
|
1003
1030
|
* @throws ApiError
|
|
1004
1031
|
*/
|
|
1005
|
-
rerun(workflowId: string, requestBody: RerunWorkflowRequest
|
|
1032
|
+
rerun(workflowId: string, requestBody: RerunWorkflowRequest): CancelablePromise<string>;
|
|
1006
1033
|
/**
|
|
1007
1034
|
* Search for workflows based on payload and other parameters
|
|
1008
1035
|
* use sort options as sort=<field>:ASC|DESC e.g. sort=name&sort=workflowId:DESC. If order is not specified, defaults to ASC.
|
|
@@ -1030,7 +1057,7 @@ declare class WorkflowResourceService {
|
|
|
1030
1057
|
* @returns any OK
|
|
1031
1058
|
* @throws ApiError
|
|
1032
1059
|
*/
|
|
1033
|
-
skipTaskFromWorkflow(workflowId: string, taskReferenceName: string, requestBody?: SkipTaskRequest
|
|
1060
|
+
skipTaskFromWorkflow(workflowId: string, taskReferenceName: string, requestBody?: SkipTaskRequest): CancelablePromise<any>;
|
|
1034
1061
|
/**
|
|
1035
1062
|
* Lists workflows for the given correlation id list
|
|
1036
1063
|
* @param name
|
|
@@ -1191,6 +1218,23 @@ declare class ConductorClient {
|
|
|
1191
1218
|
constructor(config?: Partial<ConductorClientAPIConfig>, requestHandler?: ConductorHttpRequest);
|
|
1192
1219
|
}
|
|
1193
1220
|
|
|
1221
|
+
declare type ApiResult = {
|
|
1222
|
+
readonly url: string;
|
|
1223
|
+
readonly ok: boolean;
|
|
1224
|
+
readonly status: number;
|
|
1225
|
+
readonly statusText: string;
|
|
1226
|
+
readonly body: any;
|
|
1227
|
+
};
|
|
1228
|
+
|
|
1229
|
+
declare class ApiError extends Error {
|
|
1230
|
+
readonly url: string;
|
|
1231
|
+
readonly status: number;
|
|
1232
|
+
readonly statusText: string;
|
|
1233
|
+
readonly body: any;
|
|
1234
|
+
readonly request: ApiRequestOptions;
|
|
1235
|
+
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
1236
|
+
}
|
|
1237
|
+
|
|
1194
1238
|
declare type OrkesApiConfig = ConductorClientAPIConfig & GenerateTokenRequest;
|
|
1195
1239
|
/**
|
|
1196
1240
|
* Takes a config with keyId and keySecret returns a promise with an instance of ConductorClient
|
|
@@ -1574,7 +1618,7 @@ declare const workflow: (name: string, tasks: TaskDefTypes[]) => WorkflowDef;
|
|
|
1574
1618
|
*/
|
|
1575
1619
|
interface ConductorWorker {
|
|
1576
1620
|
taskDefName: string;
|
|
1577
|
-
execute: (task: Task) => Promise<Omit<TaskResult
|
|
1621
|
+
execute: (task: Task) => Promise<Omit<TaskResult, "workflowInstanceId" | "taskId">>;
|
|
1578
1622
|
domain?: string;
|
|
1579
1623
|
concurrency?: number;
|
|
1580
1624
|
}
|
|
@@ -1601,7 +1645,13 @@ declare class TaskManager {
|
|
|
1601
1645
|
private workers;
|
|
1602
1646
|
private readonly taskManageOptions;
|
|
1603
1647
|
constructor(client: ConductorClient, workers: Array<ConductorWorker>, config?: TaskManagerConfig);
|
|
1648
|
+
/**
|
|
1649
|
+
* Start polling for tasks
|
|
1650
|
+
*/
|
|
1604
1651
|
startPolling: () => void;
|
|
1652
|
+
/**
|
|
1653
|
+
* Stops polling for tasks
|
|
1654
|
+
*/
|
|
1605
1655
|
stopPolling: () => void;
|
|
1606
1656
|
}
|
|
1607
1657
|
|
|
@@ -1631,45 +1681,26 @@ declare class TaskRunner {
|
|
|
1631
1681
|
options: Required<TaskManagerOptions>;
|
|
1632
1682
|
errorHandler: TaskErrorHandler;
|
|
1633
1683
|
constructor({ worker, taskResource, options, logger, onError: errorHandler, }: RunnerArgs);
|
|
1684
|
+
/**
|
|
1685
|
+
* Starts polling for work
|
|
1686
|
+
*/
|
|
1634
1687
|
startPolling: () => Promise<void>;
|
|
1688
|
+
/**
|
|
1689
|
+
* Stops Polling for work
|
|
1690
|
+
*/
|
|
1635
1691
|
stopPolling: () => void;
|
|
1636
1692
|
poll: () => Promise<void>;
|
|
1637
|
-
updateTaskWithRetry: (task: Task, taskResult: TaskResult
|
|
1693
|
+
updateTaskWithRetry: (task: Task, taskResult: TaskResult) => Promise<void>;
|
|
1638
1694
|
executeTask: (task: Task) => Promise<void>;
|
|
1639
1695
|
handleUnknownError: (unknownError: unknown) => void;
|
|
1640
1696
|
}
|
|
1641
1697
|
|
|
1642
|
-
interface StartWorkflowRequest<I = Record<string, any>> {
|
|
1643
|
-
name: string;
|
|
1644
|
-
version: number;
|
|
1645
|
-
correlationId?: string;
|
|
1646
|
-
input?: I;
|
|
1647
|
-
taskToDomain?: Record<string, string>;
|
|
1648
|
-
workflowDef?: WorkflowDef;
|
|
1649
|
-
externalInputPayloadStoragePath?: string;
|
|
1650
|
-
priority?: number;
|
|
1651
|
-
}
|
|
1652
|
-
interface RerunWorkflowRequest<I = Record<string, any>> {
|
|
1653
|
-
workflowInput: I;
|
|
1654
|
-
rerunFromTaskId?: string;
|
|
1655
|
-
taskInput: Record<string, any>;
|
|
1656
|
-
correlationId: string;
|
|
1657
|
-
}
|
|
1658
|
-
interface SkipTaskRequest {
|
|
1659
|
-
taskInput: Record<string, any>;
|
|
1660
|
-
taskOutput: Record<string, any>;
|
|
1661
|
-
}
|
|
1662
1698
|
declare class ConductorError extends Error {
|
|
1663
1699
|
private _trace;
|
|
1664
1700
|
private __proto__;
|
|
1665
1701
|
constructor(message?: string, innerError?: Error);
|
|
1666
1702
|
}
|
|
1667
|
-
declare
|
|
1668
|
-
IN_PROGRESS = "IN_PROGRESS",
|
|
1669
|
-
FAILED = "FAILED",
|
|
1670
|
-
FAILED_WITH_TERMINAL_ERROR = "FAILED_WITH_TERMINAL_ERROR",
|
|
1671
|
-
COMPLETED = "COMPLETED"
|
|
1672
|
-
}
|
|
1703
|
+
declare type TaskResultStatus = NonNullable<TaskResult['status']>;
|
|
1673
1704
|
|
|
1674
1705
|
declare class WorkflowExecutor {
|
|
1675
1706
|
readonly _client: ConductorClient;
|
|
@@ -1687,6 +1718,12 @@ declare class WorkflowExecutor {
|
|
|
1687
1718
|
* @returns
|
|
1688
1719
|
*/
|
|
1689
1720
|
startWorkflow(workflowRequest: StartWorkflowRequest): Promise<string>;
|
|
1721
|
+
/**
|
|
1722
|
+
* Execute a workflow synchronously. returns a Promise<WorkflowRun> with details of the running workflow
|
|
1723
|
+
* @param workflowRequest
|
|
1724
|
+
* @returns
|
|
1725
|
+
*/
|
|
1726
|
+
executeWorkflow(workflowRequest: StartWorkflowRequest, name: string, version: number, requestId: string, waitUntilTaskRef?: string): Promise<WorkflowRun>;
|
|
1690
1727
|
startWorkflows(workflowsRequest: StartWorkflowRequest[]): Promise<string>[];
|
|
1691
1728
|
/**
|
|
1692
1729
|
* Takes an workflowInstanceId and an includeTasks and an optional retry parameter returns the whole execution status.
|
|
@@ -1781,7 +1818,7 @@ declare class WorkflowExecutor {
|
|
|
1781
1818
|
* @param taskOutput
|
|
1782
1819
|
* @returns
|
|
1783
1820
|
*/
|
|
1784
|
-
updateTask(taskId: string, workflowInstanceId: string, taskStatus:
|
|
1821
|
+
updateTask(taskId: string, workflowInstanceId: string, taskStatus: TaskResultStatus, outputData: Record<string, any>): any;
|
|
1785
1822
|
/**
|
|
1786
1823
|
* Updates a task by reference Name
|
|
1787
1824
|
* @param taskReferenceName
|
|
@@ -1790,7 +1827,13 @@ declare class WorkflowExecutor {
|
|
|
1790
1827
|
* @param taskOutput
|
|
1791
1828
|
* @returns
|
|
1792
1829
|
*/
|
|
1793
|
-
updateTaskByRefName(taskReferenceName: string, workflowInstanceId: string, status:
|
|
1830
|
+
updateTaskByRefName(taskReferenceName: string, workflowInstanceId: string, status: TaskResultStatus, taskOutput: Record<string, any>): any;
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
* @param taskId
|
|
1834
|
+
* @returns
|
|
1835
|
+
*/
|
|
1836
|
+
getTask(taskId: string): Promise<Task>;
|
|
1794
1837
|
}
|
|
1795
1838
|
|
|
1796
|
-
export { CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventTaskDef, ForkJoinDynamicDef, ForkJoinTaskDef, HttpInputParameters, HttpTaskDef, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, OnCancel, OpenAPIConfig, OrkesApiConfig, RequestType, RerunWorkflowRequest, RunnerArgs, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflowRequest, SubWorkflowTaskDef, SwitchTaskDef, TaskDefTypes, TaskErrorHandler, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResult, TaskRunner, TaskType, TerminateTaskDef, WaitTaskDef, WorkflowDef, WorkflowExecutor, WorkflowInputParameters, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
|
1839
|
+
export { Action, ApiError, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response, RunnerArgs, SaveScheduleRequest, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskSummary, TaskType, TerminateTaskDef, TokenResourceService, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowInputParameters, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
package/dist/index.js
CHANGED
|
@@ -39,16 +39,25 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
39
39
|
// index.ts
|
|
40
40
|
var conductor_javascript_exports = {};
|
|
41
41
|
__export(conductor_javascript_exports, {
|
|
42
|
+
ApiError: () => ApiError,
|
|
43
|
+
BaseHttpRequest: () => BaseHttpRequest,
|
|
42
44
|
CancelError: () => CancelError,
|
|
43
45
|
CancelablePromise: () => CancelablePromise,
|
|
44
46
|
ConductorClient: () => ConductorClient,
|
|
45
47
|
ConductorError: () => ConductorError,
|
|
46
48
|
DefaultLogger: () => DefaultLogger,
|
|
49
|
+
EventResourceService: () => EventResourceService,
|
|
50
|
+
HealthCheckResourceService: () => HealthCheckResourceService,
|
|
51
|
+
MetadataResourceService: () => MetadataResourceService,
|
|
52
|
+
SchedulerResourceService: () => SchedulerResourceService,
|
|
47
53
|
TaskManager: () => TaskManager,
|
|
48
|
-
|
|
54
|
+
TaskResourceService: () => TaskResourceService,
|
|
49
55
|
TaskRunner: () => TaskRunner,
|
|
50
56
|
TaskType: () => TaskType,
|
|
57
|
+
TokenResourceService: () => TokenResourceService,
|
|
58
|
+
WorkflowBulkResourceService: () => WorkflowBulkResourceService,
|
|
51
59
|
WorkflowExecutor: () => WorkflowExecutor,
|
|
60
|
+
WorkflowResourceService: () => WorkflowResourceService,
|
|
52
61
|
conductorEventTask: () => conductorEventTask,
|
|
53
62
|
doWhileTask: () => doWhileTask,
|
|
54
63
|
dynamicForkTask: () => dynamicForkTask,
|
|
@@ -904,6 +913,22 @@ var WorkflowResourceService = class {
|
|
|
904
913
|
}
|
|
905
914
|
});
|
|
906
915
|
}
|
|
916
|
+
executeWorkflow(body, name, version, requestId, waitUntilTaskRef) {
|
|
917
|
+
return this.httpRequest.request({
|
|
918
|
+
method: "POST",
|
|
919
|
+
url: "/workflow/execute/{name}/{version}",
|
|
920
|
+
path: {
|
|
921
|
+
"name": name,
|
|
922
|
+
"version": version
|
|
923
|
+
},
|
|
924
|
+
query: {
|
|
925
|
+
"requestId": requestId,
|
|
926
|
+
"waitUntilTaskRef": waitUntilTaskRef
|
|
927
|
+
},
|
|
928
|
+
body,
|
|
929
|
+
mediaType: "application/json"
|
|
930
|
+
});
|
|
931
|
+
}
|
|
907
932
|
startWorkflow(requestBody) {
|
|
908
933
|
return this.httpRequest.request({
|
|
909
934
|
method: "POST",
|
|
@@ -1543,7 +1568,7 @@ var generateHTTPTask = (overrides = {}) => __spreadProps(__spreadValues(__spread
|
|
|
1543
1568
|
// src/common/generators/InlineTask.ts
|
|
1544
1569
|
var defaultInputParams = {
|
|
1545
1570
|
value: "${workflow.input.value}",
|
|
1546
|
-
evaluatorType: "
|
|
1571
|
+
evaluatorType: "graaljs",
|
|
1547
1572
|
expression: "true"
|
|
1548
1573
|
};
|
|
1549
1574
|
var generateEvaluationCode = (inputParametersPartial = {}) => {
|
|
@@ -1553,15 +1578,15 @@ var generateEvaluationCode = (inputParametersPartial = {}) => {
|
|
|
1553
1578
|
const resultingFunction = inlineExpression();
|
|
1554
1579
|
const resultingFunctionAsString = resultingFunction.toString();
|
|
1555
1580
|
const toReturn = __spreadProps(__spreadValues({
|
|
1556
|
-
evaluatorType: "
|
|
1581
|
+
evaluatorType: "graaljs"
|
|
1557
1582
|
}, inputParametersPartial || { value: "true" }), {
|
|
1558
1583
|
expression: `(${resultingFunctionAsString})();`
|
|
1559
1584
|
});
|
|
1560
1585
|
return toReturn;
|
|
1561
1586
|
}
|
|
1562
|
-
return __spreadProps(__spreadValues(
|
|
1563
|
-
evaluatorType: "
|
|
1564
|
-
});
|
|
1587
|
+
return __spreadValues(__spreadProps(__spreadValues({}, defaultInputParams), {
|
|
1588
|
+
evaluatorType: "graaljs"
|
|
1589
|
+
}), inputParametersPartial);
|
|
1565
1590
|
};
|
|
1566
1591
|
var generateInlineTask = (override = {}) => __spreadProps(__spreadValues(__spreadValues({}, nameTaskNameGenerator("inline", override)), override), {
|
|
1567
1592
|
inputParameters: generateEvaluationCode(override?.inputParameters || {}),
|
|
@@ -1926,6 +1951,13 @@ var workflow = (name, tasks) => ({
|
|
|
1926
1951
|
timeoutSeconds: 0
|
|
1927
1952
|
});
|
|
1928
1953
|
|
|
1954
|
+
// src/common/open-api/core/BaseHttpRequest.ts
|
|
1955
|
+
var BaseHttpRequest = class {
|
|
1956
|
+
constructor(config) {
|
|
1957
|
+
this.config = config;
|
|
1958
|
+
}
|
|
1959
|
+
};
|
|
1960
|
+
|
|
1929
1961
|
// src/task/TaskManager.ts
|
|
1930
1962
|
var defaultManagerOptions = {
|
|
1931
1963
|
workerID: "",
|
|
@@ -1993,13 +2025,6 @@ var ConductorError = class extends Error {
|
|
|
1993
2025
|
}
|
|
1994
2026
|
}
|
|
1995
2027
|
};
|
|
1996
|
-
var TaskResult = /* @__PURE__ */ ((TaskResult3) => {
|
|
1997
|
-
TaskResult3["IN_PROGRESS"] = "IN_PROGRESS";
|
|
1998
|
-
TaskResult3["FAILED"] = "FAILED";
|
|
1999
|
-
TaskResult3["FAILED_WITH_TERMINAL_ERROR"] = "FAILED_WITH_TERMINAL_ERROR";
|
|
2000
|
-
TaskResult3["COMPLETED"] = "COMPLETED";
|
|
2001
|
-
return TaskResult3;
|
|
2002
|
-
})(TaskResult || {});
|
|
2003
2028
|
|
|
2004
2029
|
// src/core/executor.ts
|
|
2005
2030
|
var RETRY_TIME_IN_MILLISECONDS = 1e4;
|
|
@@ -2021,6 +2046,9 @@ var WorkflowExecutor = class {
|
|
|
2021
2046
|
startWorkflow(workflowRequest) {
|
|
2022
2047
|
return tryCatchReThrow(() => this._client.workflowResource.startWorkflow(workflowRequest));
|
|
2023
2048
|
}
|
|
2049
|
+
executeWorkflow(workflowRequest, name, version, requestId, waitUntilTaskRef = "") {
|
|
2050
|
+
return tryCatchReThrow(() => this._client.workflowResource.executeWorkflow(workflowRequest, name, version, requestId, waitUntilTaskRef));
|
|
2051
|
+
}
|
|
2024
2052
|
startWorkflows(workflowsRequest) {
|
|
2025
2053
|
return tryCatchReThrow(() => workflowsRequest.map(this.startWorkflow));
|
|
2026
2054
|
}
|
|
@@ -2064,30 +2092,44 @@ var WorkflowExecutor = class {
|
|
|
2064
2092
|
terminate(workflowInstanceId, reason) {
|
|
2065
2093
|
return tryCatchReThrow(() => this._client.workflowResource.terminate1(workflowInstanceId, reason));
|
|
2066
2094
|
}
|
|
2067
|
-
updateTask(taskId, workflowInstanceId, taskStatus,
|
|
2095
|
+
updateTask(taskId, workflowInstanceId, taskStatus, outputData) {
|
|
2068
2096
|
const taskUpdates = {
|
|
2069
2097
|
status: taskStatus,
|
|
2070
2098
|
taskId,
|
|
2071
2099
|
workflowInstanceId
|
|
2072
2100
|
};
|
|
2073
|
-
return tryCatchReThrow(() => this._client.taskResource.updateTask1(__spreadValues(
|
|
2101
|
+
return tryCatchReThrow(() => this._client.taskResource.updateTask1(__spreadValues({
|
|
2102
|
+
outputData
|
|
2103
|
+
}, taskUpdates)));
|
|
2074
2104
|
}
|
|
2075
2105
|
updateTaskByRefName(taskReferenceName, workflowInstanceId, status, taskOutput) {
|
|
2076
2106
|
return tryCatchReThrow(() => this._client.taskResource.updateTask(workflowInstanceId, taskReferenceName, status, taskOutput));
|
|
2077
2107
|
}
|
|
2108
|
+
getTask(taskId) {
|
|
2109
|
+
return tryCatchReThrow(() => this._client.taskResource.getTask(taskId));
|
|
2110
|
+
}
|
|
2078
2111
|
};
|
|
2079
2112
|
// Annotate the CommonJS export names for ESM import in node:
|
|
2080
2113
|
0 && (module.exports = {
|
|
2114
|
+
ApiError,
|
|
2115
|
+
BaseHttpRequest,
|
|
2081
2116
|
CancelError,
|
|
2082
2117
|
CancelablePromise,
|
|
2083
2118
|
ConductorClient,
|
|
2084
2119
|
ConductorError,
|
|
2085
2120
|
DefaultLogger,
|
|
2121
|
+
EventResourceService,
|
|
2122
|
+
HealthCheckResourceService,
|
|
2123
|
+
MetadataResourceService,
|
|
2124
|
+
SchedulerResourceService,
|
|
2086
2125
|
TaskManager,
|
|
2087
|
-
|
|
2126
|
+
TaskResourceService,
|
|
2088
2127
|
TaskRunner,
|
|
2089
2128
|
TaskType,
|
|
2129
|
+
TokenResourceService,
|
|
2130
|
+
WorkflowBulkResourceService,
|
|
2090
2131
|
WorkflowExecutor,
|
|
2132
|
+
WorkflowResourceService,
|
|
2091
2133
|
conductorEventTask,
|
|
2092
2134
|
doWhileTask,
|
|
2093
2135
|
dynamicForkTask,
|