@io-orkes/conductor-javascript 2.0.0 → 2.0.1-alpha
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 +2 -2
- package/dist/index.d.mts +83 -1
- package/dist/index.d.ts +83 -1
- package/dist/index.js +142 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +141 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Conductor OSS Javascript/Typescript SDK
|
|
2
2
|
|
|
3
3
|
The `conductor-javascript` repository provides the client SDKs to build task workers in javascript/typescript.
|
|
4
4
|
|
|
@@ -44,7 +44,7 @@ import { OrkesApiConfig, orkesConductorClient } from "@io-orkes/conductor-javasc
|
|
|
44
44
|
const config: Partial<OrkesApiConfig> = {
|
|
45
45
|
keyId: "XXX", // optional
|
|
46
46
|
keySecret: "XXXX", // optional
|
|
47
|
-
refreshTokenInterval: 0 // optional (in milliseconds) defaults to 30 minutes (30 * 60 * 1000). 0 no refresh
|
|
47
|
+
refreshTokenInterval: 0, // optional (in milliseconds) defaults to 30 minutes (30 * 60 * 1000). 0 no refresh
|
|
48
48
|
serverUrl: "https://play.orkes.io/api",
|
|
49
49
|
};
|
|
50
50
|
|
package/dist/index.d.mts
CHANGED
|
@@ -2192,6 +2192,88 @@ declare const generateDoWhileTask: (overrides?: Partial<DoWhileTaskDefGen>, nest
|
|
|
2192
2192
|
*/
|
|
2193
2193
|
declare const generateForkJoinTask: (overrides?: Partial<ForkJoinTaskDefGen>, nestedMapper?: NestedTaskMapper) => ForkJoinTaskDef;
|
|
2194
2194
|
|
|
2195
|
+
declare class SchedulerClient {
|
|
2196
|
+
readonly _client: ConductorClient;
|
|
2197
|
+
constructor(client: ConductorClient);
|
|
2198
|
+
/**
|
|
2199
|
+
* Create or update a schedule for a specified workflow with a corresponding start workflow request
|
|
2200
|
+
* @param requestBody
|
|
2201
|
+
* @returns
|
|
2202
|
+
*/
|
|
2203
|
+
saveSchedule(param: SaveScheduleRequest): Promise<void>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Searches for existing scheduler execution based on below parameters
|
|
2206
|
+
*
|
|
2207
|
+
* @param start
|
|
2208
|
+
* @param size
|
|
2209
|
+
* @param sort
|
|
2210
|
+
* @param freeText
|
|
2211
|
+
* @param query
|
|
2212
|
+
* @returns SearchResultWorkflowScheduleExecutionModel
|
|
2213
|
+
*/
|
|
2214
|
+
search(start: number, size: number, sort: string | undefined, freeText: string, query: string): Promise<SearchResultWorkflowScheduleExecutionModel>;
|
|
2215
|
+
/**
|
|
2216
|
+
* Get an existing schedule by name
|
|
2217
|
+
* @param name
|
|
2218
|
+
* @returns SaveScheduleRequest
|
|
2219
|
+
*/
|
|
2220
|
+
getSchedule(name: string): Promise<SaveScheduleRequest>;
|
|
2221
|
+
/**
|
|
2222
|
+
* Pauses an existing schedule by name
|
|
2223
|
+
* @param name
|
|
2224
|
+
* @returns
|
|
2225
|
+
*/
|
|
2226
|
+
pauseSchedule(name: string): Promise<void>;
|
|
2227
|
+
/**
|
|
2228
|
+
* Resume a paused schedule by name
|
|
2229
|
+
*
|
|
2230
|
+
* @param name
|
|
2231
|
+
* @returns
|
|
2232
|
+
*/
|
|
2233
|
+
resumeSchedule(name: string): Promise<void>;
|
|
2234
|
+
/**
|
|
2235
|
+
* Deletes an existing scheduler execution by name
|
|
2236
|
+
*
|
|
2237
|
+
* @param name
|
|
2238
|
+
* @returns
|
|
2239
|
+
*/
|
|
2240
|
+
deleteSchedule(name: string): Promise<void>;
|
|
2241
|
+
/**
|
|
2242
|
+
* Get all existing workflow schedules and optionally filter by workflow name
|
|
2243
|
+
* @param workflowName
|
|
2244
|
+
* @returns Array<WorkflowSchedule>
|
|
2245
|
+
*/
|
|
2246
|
+
getAllSchedules(workflowName?: string): Promise<Array<WorkflowSchedule>>;
|
|
2247
|
+
/**
|
|
2248
|
+
* Get list of the next x (default 3, max 5) execution times for a scheduler
|
|
2249
|
+
* @param cronExpression
|
|
2250
|
+
* @param scheduleStartTime
|
|
2251
|
+
* @param scheduleEndTime
|
|
2252
|
+
* @param limit
|
|
2253
|
+
* @returns number OK
|
|
2254
|
+
* @throws ApiError
|
|
2255
|
+
*/
|
|
2256
|
+
getNextFewSchedules(cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number): Promise<Array<number[]>>;
|
|
2257
|
+
/**
|
|
2258
|
+
* Pause all scheduling in a single conductor server instance (for debugging only)
|
|
2259
|
+
* @returns any OK
|
|
2260
|
+
* @throws ApiError
|
|
2261
|
+
*/
|
|
2262
|
+
pauseAllSchedules(): Promise<void>;
|
|
2263
|
+
/**
|
|
2264
|
+
* Requeue all execution records
|
|
2265
|
+
* @returns any OK
|
|
2266
|
+
* @throws ApiError
|
|
2267
|
+
*/
|
|
2268
|
+
requeueAllExecutionRecords(): Promise<void>;
|
|
2269
|
+
/**
|
|
2270
|
+
* Resume all scheduling
|
|
2271
|
+
* @returns any OK
|
|
2272
|
+
* @throws ApiError
|
|
2273
|
+
*/
|
|
2274
|
+
resumeAllSchedules(): Promise<void>;
|
|
2275
|
+
}
|
|
2276
|
+
|
|
2195
2277
|
declare type FetchFn<T = RequestInit, R extends {
|
|
2196
2278
|
json: () => Promise<any>;
|
|
2197
2279
|
} = Response> = (input: RequestInfo, init?: T) => Promise<R>;
|
|
@@ -2227,4 +2309,4 @@ declare const baseOrkesConductorClient: <T = RequestInit, R extends {
|
|
|
2227
2309
|
*/
|
|
2228
2310
|
declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions, fetchFn?: FetchFn) => CancelablePromise<T>;
|
|
2229
2311
|
|
|
2230
|
-
export { Action, ApiError, ApiRequestOptions, ApiResult, AuthConductorClient, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorClientAPIConfig, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FetchFn, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskAssignment, HumanTaskDefinition, HumanTaskEntry, HumanTaskSearch, HumanTaskSearchResult, HumanTaskTemplate, HumanTaskTrigger, HumanTaskUser, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response$1 as Response, RunnerArgs, SaveScheduleRequest, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskFinderPredicate, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, UserFormTemplate, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, baseOrkesConductorClient, completedTaskMatchingType, 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, noopLogger, orkesConductorClient, request, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
|
2312
|
+
export { Action, ApiError, ApiRequestOptions, ApiResult, AuthConductorClient, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorClientAPIConfig, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FetchFn, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskAssignment, HumanTaskDefinition, HumanTaskEntry, HumanTaskSearch, HumanTaskSearchResult, HumanTaskTemplate, HumanTaskTrigger, HumanTaskUser, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response$1 as Response, RunnerArgs, SaveScheduleRequest, SchedulerClient, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskFinderPredicate, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, UserFormTemplate, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, baseOrkesConductorClient, completedTaskMatchingType, 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, noopLogger, orkesConductorClient, request, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
package/dist/index.d.ts
CHANGED
|
@@ -2192,6 +2192,88 @@ declare const generateDoWhileTask: (overrides?: Partial<DoWhileTaskDefGen>, nest
|
|
|
2192
2192
|
*/
|
|
2193
2193
|
declare const generateForkJoinTask: (overrides?: Partial<ForkJoinTaskDefGen>, nestedMapper?: NestedTaskMapper) => ForkJoinTaskDef;
|
|
2194
2194
|
|
|
2195
|
+
declare class SchedulerClient {
|
|
2196
|
+
readonly _client: ConductorClient;
|
|
2197
|
+
constructor(client: ConductorClient);
|
|
2198
|
+
/**
|
|
2199
|
+
* Create or update a schedule for a specified workflow with a corresponding start workflow request
|
|
2200
|
+
* @param requestBody
|
|
2201
|
+
* @returns
|
|
2202
|
+
*/
|
|
2203
|
+
saveSchedule(param: SaveScheduleRequest): Promise<void>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Searches for existing scheduler execution based on below parameters
|
|
2206
|
+
*
|
|
2207
|
+
* @param start
|
|
2208
|
+
* @param size
|
|
2209
|
+
* @param sort
|
|
2210
|
+
* @param freeText
|
|
2211
|
+
* @param query
|
|
2212
|
+
* @returns SearchResultWorkflowScheduleExecutionModel
|
|
2213
|
+
*/
|
|
2214
|
+
search(start: number, size: number, sort: string | undefined, freeText: string, query: string): Promise<SearchResultWorkflowScheduleExecutionModel>;
|
|
2215
|
+
/**
|
|
2216
|
+
* Get an existing schedule by name
|
|
2217
|
+
* @param name
|
|
2218
|
+
* @returns SaveScheduleRequest
|
|
2219
|
+
*/
|
|
2220
|
+
getSchedule(name: string): Promise<SaveScheduleRequest>;
|
|
2221
|
+
/**
|
|
2222
|
+
* Pauses an existing schedule by name
|
|
2223
|
+
* @param name
|
|
2224
|
+
* @returns
|
|
2225
|
+
*/
|
|
2226
|
+
pauseSchedule(name: string): Promise<void>;
|
|
2227
|
+
/**
|
|
2228
|
+
* Resume a paused schedule by name
|
|
2229
|
+
*
|
|
2230
|
+
* @param name
|
|
2231
|
+
* @returns
|
|
2232
|
+
*/
|
|
2233
|
+
resumeSchedule(name: string): Promise<void>;
|
|
2234
|
+
/**
|
|
2235
|
+
* Deletes an existing scheduler execution by name
|
|
2236
|
+
*
|
|
2237
|
+
* @param name
|
|
2238
|
+
* @returns
|
|
2239
|
+
*/
|
|
2240
|
+
deleteSchedule(name: string): Promise<void>;
|
|
2241
|
+
/**
|
|
2242
|
+
* Get all existing workflow schedules and optionally filter by workflow name
|
|
2243
|
+
* @param workflowName
|
|
2244
|
+
* @returns Array<WorkflowSchedule>
|
|
2245
|
+
*/
|
|
2246
|
+
getAllSchedules(workflowName?: string): Promise<Array<WorkflowSchedule>>;
|
|
2247
|
+
/**
|
|
2248
|
+
* Get list of the next x (default 3, max 5) execution times for a scheduler
|
|
2249
|
+
* @param cronExpression
|
|
2250
|
+
* @param scheduleStartTime
|
|
2251
|
+
* @param scheduleEndTime
|
|
2252
|
+
* @param limit
|
|
2253
|
+
* @returns number OK
|
|
2254
|
+
* @throws ApiError
|
|
2255
|
+
*/
|
|
2256
|
+
getNextFewSchedules(cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number): Promise<Array<number[]>>;
|
|
2257
|
+
/**
|
|
2258
|
+
* Pause all scheduling in a single conductor server instance (for debugging only)
|
|
2259
|
+
* @returns any OK
|
|
2260
|
+
* @throws ApiError
|
|
2261
|
+
*/
|
|
2262
|
+
pauseAllSchedules(): Promise<void>;
|
|
2263
|
+
/**
|
|
2264
|
+
* Requeue all execution records
|
|
2265
|
+
* @returns any OK
|
|
2266
|
+
* @throws ApiError
|
|
2267
|
+
*/
|
|
2268
|
+
requeueAllExecutionRecords(): Promise<void>;
|
|
2269
|
+
/**
|
|
2270
|
+
* Resume all scheduling
|
|
2271
|
+
* @returns any OK
|
|
2272
|
+
* @throws ApiError
|
|
2273
|
+
*/
|
|
2274
|
+
resumeAllSchedules(): Promise<void>;
|
|
2275
|
+
}
|
|
2276
|
+
|
|
2195
2277
|
declare type FetchFn<T = RequestInit, R extends {
|
|
2196
2278
|
json: () => Promise<any>;
|
|
2197
2279
|
} = Response> = (input: RequestInfo, init?: T) => Promise<R>;
|
|
@@ -2227,4 +2309,4 @@ declare const baseOrkesConductorClient: <T = RequestInit, R extends {
|
|
|
2227
2309
|
*/
|
|
2228
2310
|
declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions, fetchFn?: FetchFn) => CancelablePromise<T>;
|
|
2229
2311
|
|
|
2230
|
-
export { Action, ApiError, ApiRequestOptions, ApiResult, AuthConductorClient, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorClientAPIConfig, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FetchFn, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskAssignment, HumanTaskDefinition, HumanTaskEntry, HumanTaskSearch, HumanTaskSearchResult, HumanTaskTemplate, HumanTaskTrigger, HumanTaskUser, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response$1 as Response, RunnerArgs, SaveScheduleRequest, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskFinderPredicate, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, UserFormTemplate, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, baseOrkesConductorClient, completedTaskMatchingType, 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, noopLogger, orkesConductorClient, request, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
|
2312
|
+
export { Action, ApiError, ApiRequestOptions, ApiResult, AuthConductorClient, BaseHttpRequest, CancelError, CancelablePromise, CommonTaskDef, ConductorClient, ConductorClientAPIConfig, ConductorError, ConductorHttpRequest, ConductorLogLevel, ConductorLogger, ConductorWorker, DefaultLogger, DefaultLoggerConfig, DoWhileTaskDef, EventHandler, EventResourceService, EventTaskDef, ExternalStorageLocation, FetchFn, ForkJoinDynamicDef, ForkJoinTaskDef, GenerateTokenRequest, HTScrollableSearchResultHumanTaskEntry, HealthCheckResourceService, HttpInputParameters, HttpTaskDef, HumanExecutor, HumanTaskAssignment, HumanTaskDefinition, HumanTaskEntry, HumanTaskSearch, HumanTaskSearchResult, HumanTaskTemplate, HumanTaskTrigger, HumanTaskUser, InlineTaskDef, InlineTaskInputParameters, JoinTaskDef, JsonJQTransformTaskDef, KafkaPublishInputParameters, KafkaPublishTaskDef, MetadataResourceService, OnCancel, OpenAPIConfig, OrkesApiConfig, PollData, RequestType, RerunWorkflowRequest, Response$1 as Response, RunnerArgs, SaveScheduleRequest, SchedulerClient, SchedulerResourceService, ScrollableSearchResultWorkflowSummary, SearchResultTask, SearchResultTaskSummary, SearchResultWorkflow, SearchResultWorkflowScheduleExecutionModel, SearchResultWorkflowSummary, SetVariableTaskDef, SimpleTaskDef, SkipTaskRequest, StartWorkflow, StartWorkflowRequest, SubWorkflowParams, SubWorkflowTaskDef, SwitchTaskDef, Task, TaskDef, TaskDefTypes, TaskDetails, TaskErrorHandler, TaskExecLog, TaskFinderPredicate, TaskManager, TaskManagerConfig, TaskManagerOptions, TaskResourceService, TaskResult, TaskResultStatus, TaskRunner, TaskRunnerOptions, TaskSummary, TaskType, Terminate, TerminateTaskDef, TimeoutPolicy, TokenResourceService, UserFormTemplate, WaitTaskDef, Workflow, WorkflowBulkResourceService, WorkflowDef, WorkflowExecutor, WorkflowResourceService, WorkflowSchedule, WorkflowScheduleExecutionModel, WorkflowStatus, WorkflowSummary, WorkflowTask, baseOrkesConductorClient, completedTaskMatchingType, 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, noopLogger, orkesConductorClient, request, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
package/dist/index.js
CHANGED
|
@@ -42,6 +42,7 @@ __export(conductor_javascript_exports, {
|
|
|
42
42
|
HealthCheckResourceService: () => HealthCheckResourceService,
|
|
43
43
|
HumanExecutor: () => HumanExecutor,
|
|
44
44
|
MetadataResourceService: () => MetadataResourceService,
|
|
45
|
+
SchedulerClient: () => SchedulerClient,
|
|
45
46
|
SchedulerResourceService: () => SchedulerResourceService,
|
|
46
47
|
TaskManager: () => TaskManager,
|
|
47
48
|
TaskResourceService: () => TaskResourceService,
|
|
@@ -3676,6 +3677,146 @@ var workflow = (name, tasks) => ({
|
|
|
3676
3677
|
timeoutSeconds: 0
|
|
3677
3678
|
});
|
|
3678
3679
|
|
|
3680
|
+
// src/core/schedulerClient.ts
|
|
3681
|
+
var SchedulerClient = class {
|
|
3682
|
+
_client;
|
|
3683
|
+
constructor(client) {
|
|
3684
|
+
this._client = client;
|
|
3685
|
+
}
|
|
3686
|
+
/**
|
|
3687
|
+
* Create or update a schedule for a specified workflow with a corresponding start workflow request
|
|
3688
|
+
* @param requestBody
|
|
3689
|
+
* @returns
|
|
3690
|
+
*/
|
|
3691
|
+
saveSchedule(param) {
|
|
3692
|
+
return tryCatchReThrow(
|
|
3693
|
+
() => this._client.schedulerResource.saveSchedule(param)
|
|
3694
|
+
);
|
|
3695
|
+
}
|
|
3696
|
+
/**
|
|
3697
|
+
* Searches for existing scheduler execution based on below parameters
|
|
3698
|
+
*
|
|
3699
|
+
* @param start
|
|
3700
|
+
* @param size
|
|
3701
|
+
* @param sort
|
|
3702
|
+
* @param freeText
|
|
3703
|
+
* @param query
|
|
3704
|
+
* @returns SearchResultWorkflowScheduleExecutionModel
|
|
3705
|
+
*/
|
|
3706
|
+
search(start, size, sort = "", freeText, query) {
|
|
3707
|
+
return tryCatchReThrow(
|
|
3708
|
+
() => this._client.schedulerResource.searchV21(
|
|
3709
|
+
start,
|
|
3710
|
+
size,
|
|
3711
|
+
sort,
|
|
3712
|
+
freeText,
|
|
3713
|
+
query
|
|
3714
|
+
)
|
|
3715
|
+
);
|
|
3716
|
+
}
|
|
3717
|
+
/**
|
|
3718
|
+
* Get an existing schedule by name
|
|
3719
|
+
* @param name
|
|
3720
|
+
* @returns SaveScheduleRequest
|
|
3721
|
+
*/
|
|
3722
|
+
getSchedule(name) {
|
|
3723
|
+
return tryCatchReThrow(
|
|
3724
|
+
() => this._client.schedulerResource.getSchedule(name)
|
|
3725
|
+
);
|
|
3726
|
+
}
|
|
3727
|
+
/**
|
|
3728
|
+
* Pauses an existing schedule by name
|
|
3729
|
+
* @param name
|
|
3730
|
+
* @returns
|
|
3731
|
+
*/
|
|
3732
|
+
pauseSchedule(name) {
|
|
3733
|
+
return tryCatchReThrow(
|
|
3734
|
+
() => this._client.schedulerResource.pauseSchedule(name)
|
|
3735
|
+
);
|
|
3736
|
+
}
|
|
3737
|
+
/**
|
|
3738
|
+
* Resume a paused schedule by name
|
|
3739
|
+
*
|
|
3740
|
+
* @param name
|
|
3741
|
+
* @returns
|
|
3742
|
+
*/
|
|
3743
|
+
resumeSchedule(name) {
|
|
3744
|
+
return tryCatchReThrow(
|
|
3745
|
+
() => this._client.schedulerResource.resumeSchedule(name)
|
|
3746
|
+
);
|
|
3747
|
+
}
|
|
3748
|
+
/**
|
|
3749
|
+
* Deletes an existing scheduler execution by name
|
|
3750
|
+
*
|
|
3751
|
+
* @param name
|
|
3752
|
+
* @returns
|
|
3753
|
+
*/
|
|
3754
|
+
deleteSchedule(name) {
|
|
3755
|
+
return tryCatchReThrow(
|
|
3756
|
+
() => this._client.schedulerResource.deleteSchedule(name)
|
|
3757
|
+
);
|
|
3758
|
+
}
|
|
3759
|
+
/**
|
|
3760
|
+
* Get all existing workflow schedules and optionally filter by workflow name
|
|
3761
|
+
* @param workflowName
|
|
3762
|
+
* @returns Array<WorkflowSchedule>
|
|
3763
|
+
*/
|
|
3764
|
+
getAllSchedules(workflowName) {
|
|
3765
|
+
return tryCatchReThrow(
|
|
3766
|
+
() => this._client.schedulerResource.getAllSchedules(workflowName)
|
|
3767
|
+
);
|
|
3768
|
+
}
|
|
3769
|
+
/**
|
|
3770
|
+
* Get list of the next x (default 3, max 5) execution times for a scheduler
|
|
3771
|
+
* @param cronExpression
|
|
3772
|
+
* @param scheduleStartTime
|
|
3773
|
+
* @param scheduleEndTime
|
|
3774
|
+
* @param limit
|
|
3775
|
+
* @returns number OK
|
|
3776
|
+
* @throws ApiError
|
|
3777
|
+
*/
|
|
3778
|
+
getNextFewSchedules(cronExpression, scheduleStartTime, scheduleEndTime, limit = 3) {
|
|
3779
|
+
return tryCatchReThrow(
|
|
3780
|
+
() => this._client.schedulerResource.getNextFewSchedules(
|
|
3781
|
+
cronExpression,
|
|
3782
|
+
scheduleStartTime,
|
|
3783
|
+
scheduleEndTime,
|
|
3784
|
+
limit
|
|
3785
|
+
)
|
|
3786
|
+
);
|
|
3787
|
+
}
|
|
3788
|
+
/**
|
|
3789
|
+
* Pause all scheduling in a single conductor server instance (for debugging only)
|
|
3790
|
+
* @returns any OK
|
|
3791
|
+
* @throws ApiError
|
|
3792
|
+
*/
|
|
3793
|
+
pauseAllSchedules() {
|
|
3794
|
+
return tryCatchReThrow(
|
|
3795
|
+
() => this._client.schedulerResource.pauseAllSchedules()
|
|
3796
|
+
);
|
|
3797
|
+
}
|
|
3798
|
+
/**
|
|
3799
|
+
* Requeue all execution records
|
|
3800
|
+
* @returns any OK
|
|
3801
|
+
* @throws ApiError
|
|
3802
|
+
*/
|
|
3803
|
+
requeueAllExecutionRecords() {
|
|
3804
|
+
return tryCatchReThrow(
|
|
3805
|
+
() => this._client.schedulerResource.requeueAllExecutionRecords()
|
|
3806
|
+
);
|
|
3807
|
+
}
|
|
3808
|
+
/**
|
|
3809
|
+
* Resume all scheduling
|
|
3810
|
+
* @returns any OK
|
|
3811
|
+
* @throws ApiError
|
|
3812
|
+
*/
|
|
3813
|
+
resumeAllSchedules() {
|
|
3814
|
+
return tryCatchReThrow(
|
|
3815
|
+
() => this._client.schedulerResource.resumeAllSchedules()
|
|
3816
|
+
);
|
|
3817
|
+
}
|
|
3818
|
+
};
|
|
3819
|
+
|
|
3679
3820
|
// src/orkes/BaseOrkesConductorClient.ts
|
|
3680
3821
|
var defaultRequestHandler2 = (request3, config, options) => request3(config, options);
|
|
3681
3822
|
var REFRESH_TOKEN_IN_MILLISECONDS = 30 * 60 * 1e3;
|
|
@@ -3991,6 +4132,7 @@ var request2 = (config, options, fetchFn = fetch) => {
|
|
|
3991
4132
|
HealthCheckResourceService,
|
|
3992
4133
|
HumanExecutor,
|
|
3993
4134
|
MetadataResourceService,
|
|
4135
|
+
SchedulerClient,
|
|
3994
4136
|
SchedulerResourceService,
|
|
3995
4137
|
TaskManager,
|
|
3996
4138
|
TaskResourceService,
|