@io-orkes/conductor-javascript 2.2.0 → 2.3.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 +112 -0
- package/dist/index.d.mts +434 -3
- package/dist/index.d.ts +434 -3
- package/dist/index.js +5453 -2786
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +5452 -2786
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -48,6 +48,14 @@ type Any = {
|
|
|
48
48
|
unknownFields?: UnknownFieldSet;
|
|
49
49
|
value?: ByteString;
|
|
50
50
|
};
|
|
51
|
+
type BulkResponse = {
|
|
52
|
+
bulkErrorResults?: {
|
|
53
|
+
[key: string]: string;
|
|
54
|
+
};
|
|
55
|
+
bulkSuccessfulResults?: Array<{
|
|
56
|
+
[key: string]: unknown;
|
|
57
|
+
}>;
|
|
58
|
+
};
|
|
51
59
|
type ByteString = {
|
|
52
60
|
empty?: boolean;
|
|
53
61
|
validUtf8?: boolean;
|
|
@@ -66,6 +74,17 @@ type CircuitBreakerTransitionResponse = {
|
|
|
66
74
|
type Config$2 = {
|
|
67
75
|
circuitBreakerConfig?: OrkesCircuitBreakerConfig;
|
|
68
76
|
};
|
|
77
|
+
type ConnectivityTestInput = {
|
|
78
|
+
input?: {
|
|
79
|
+
[key: string]: unknown;
|
|
80
|
+
};
|
|
81
|
+
sink: string;
|
|
82
|
+
};
|
|
83
|
+
type ConnectivityTestResult = {
|
|
84
|
+
reason?: string;
|
|
85
|
+
successful?: boolean;
|
|
86
|
+
workflowId?: string;
|
|
87
|
+
};
|
|
69
88
|
type Declaration = {
|
|
70
89
|
allFields?: {
|
|
71
90
|
[key: string]: unknown;
|
|
@@ -444,6 +463,41 @@ type EventHandler = {
|
|
|
444
463
|
orgId?: string;
|
|
445
464
|
tags?: Array<Tag>;
|
|
446
465
|
};
|
|
466
|
+
type EventMessage = {
|
|
467
|
+
createdAt?: number;
|
|
468
|
+
eventExecutions?: Array<ExtendedEventExecution>;
|
|
469
|
+
eventTarget?: string;
|
|
470
|
+
eventType?: 'WEBHOOK' | 'MESSAGE';
|
|
471
|
+
fullPayload?: {
|
|
472
|
+
[key: string]: unknown;
|
|
473
|
+
};
|
|
474
|
+
id?: string;
|
|
475
|
+
orgId?: string;
|
|
476
|
+
payload?: string;
|
|
477
|
+
status?: 'RECEIVED' | 'HANDLED' | 'REJECTED';
|
|
478
|
+
statusDescription?: string;
|
|
479
|
+
};
|
|
480
|
+
type ExtendedEventExecution = {
|
|
481
|
+
action?: 'start_workflow' | 'complete_task' | 'fail_task' | 'terminate_workflow' | 'update_workflow_variables';
|
|
482
|
+
created?: number;
|
|
483
|
+
event?: string;
|
|
484
|
+
eventHandler?: EventHandler;
|
|
485
|
+
fullMessagePayload?: {
|
|
486
|
+
[key: string]: unknown;
|
|
487
|
+
};
|
|
488
|
+
id?: string;
|
|
489
|
+
messageId?: string;
|
|
490
|
+
name?: string;
|
|
491
|
+
orgId?: string;
|
|
492
|
+
output?: {
|
|
493
|
+
[key: string]: unknown;
|
|
494
|
+
};
|
|
495
|
+
payload?: {
|
|
496
|
+
[key: string]: unknown;
|
|
497
|
+
};
|
|
498
|
+
status?: 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'SKIPPED';
|
|
499
|
+
statusDescription?: string;
|
|
500
|
+
};
|
|
447
501
|
type ExtendedTaskDef$1 = {
|
|
448
502
|
backoffScaleFactor?: number;
|
|
449
503
|
baseType?: string;
|
|
@@ -945,6 +999,13 @@ type GenerateTokenRequest = {
|
|
|
945
999
|
keyId: string;
|
|
946
1000
|
keySecret: string;
|
|
947
1001
|
};
|
|
1002
|
+
type HandledEventResponse = {
|
|
1003
|
+
active?: boolean;
|
|
1004
|
+
event?: string;
|
|
1005
|
+
name?: string;
|
|
1006
|
+
numberOfActions?: number;
|
|
1007
|
+
numberOfMessages?: number;
|
|
1008
|
+
};
|
|
948
1009
|
type HumanTaskAssignment = {
|
|
949
1010
|
assignee?: HumanTaskUser;
|
|
950
1011
|
slaMinutes?: number;
|
|
@@ -1545,6 +1606,10 @@ type ScrollableSearchResultWorkflowSummary = {
|
|
|
1545
1606
|
results?: Array<WorkflowSummary>;
|
|
1546
1607
|
totalHits?: number;
|
|
1547
1608
|
};
|
|
1609
|
+
type SearchResultHandledEventResponse = {
|
|
1610
|
+
results?: Array<HandledEventResponse>;
|
|
1611
|
+
totalHits?: number;
|
|
1612
|
+
};
|
|
1548
1613
|
type SearchResultTaskSummary = {
|
|
1549
1614
|
results?: Array<TaskSummary>;
|
|
1550
1615
|
totalHits?: number;
|
|
@@ -3600,6 +3665,172 @@ declare class MetadataClient {
|
|
|
3600
3665
|
unregisterWorkflow(workflowName: string, version?: number): Promise<void>;
|
|
3601
3666
|
}
|
|
3602
3667
|
|
|
3668
|
+
declare class EventClient {
|
|
3669
|
+
readonly _client: Client;
|
|
3670
|
+
constructor(client: Client);
|
|
3671
|
+
/**
|
|
3672
|
+
* Get all the event handlers
|
|
3673
|
+
* @returns {Promise<EventHandler[]>}
|
|
3674
|
+
* @throws {ConductorSdkError}
|
|
3675
|
+
*/
|
|
3676
|
+
getAllEventHandlers(): Promise<EventHandler[]>;
|
|
3677
|
+
/**
|
|
3678
|
+
* Add event handlers
|
|
3679
|
+
* @param {EventHandler[]} eventHandlers
|
|
3680
|
+
* @returns {Promise<void>}
|
|
3681
|
+
* @throws {ConductorSdkError}
|
|
3682
|
+
*/
|
|
3683
|
+
addEventHandlers(eventHandlers: EventHandler[]): Promise<void>;
|
|
3684
|
+
/**
|
|
3685
|
+
* Add an event handler
|
|
3686
|
+
* @param {EventHandler} eventHandler
|
|
3687
|
+
* @returns {Promise<void>}
|
|
3688
|
+
* @throws {ConductorSdkError}
|
|
3689
|
+
*/
|
|
3690
|
+
addEventHandler(eventHandler: EventHandler): Promise<void>;
|
|
3691
|
+
/**
|
|
3692
|
+
* Update an event handler
|
|
3693
|
+
* @param {EventHandler} eventHandler
|
|
3694
|
+
* @returns {Promise<void>}
|
|
3695
|
+
* @throws {ConductorSdkError}
|
|
3696
|
+
*/
|
|
3697
|
+
updateEventHandler(eventHandler: EventHandler): Promise<void>;
|
|
3698
|
+
/**
|
|
3699
|
+
* Handle an incoming event
|
|
3700
|
+
* @param {Record<string, string>} data
|
|
3701
|
+
* @returns {Promise<void>}
|
|
3702
|
+
* @throws {ConductorSdkError}
|
|
3703
|
+
*/
|
|
3704
|
+
handleIncomingEvent(data: Record<string, string>): Promise<void>;
|
|
3705
|
+
/**
|
|
3706
|
+
* Get an event handler by name
|
|
3707
|
+
* @param {string} eventHandlerName
|
|
3708
|
+
* @returns {Promise<EventHandler>}
|
|
3709
|
+
* @throws {ConductorSdkError}
|
|
3710
|
+
*/
|
|
3711
|
+
getEventHandlerByName(eventHandlerName: string): Promise<EventHandler>;
|
|
3712
|
+
/**
|
|
3713
|
+
* Get all queue configs
|
|
3714
|
+
* @returns {Promise<Record<string, string>>}
|
|
3715
|
+
* @throws {ConductorSdkError}
|
|
3716
|
+
*/
|
|
3717
|
+
getAllQueueConfigs(): Promise<Record<string, string>>;
|
|
3718
|
+
/**
|
|
3719
|
+
* Delete queue config
|
|
3720
|
+
* @param {string} queueType
|
|
3721
|
+
* @param {string} queueName
|
|
3722
|
+
* @returns {Promise<void>}
|
|
3723
|
+
* @throws {ConductorSdkError}
|
|
3724
|
+
*/
|
|
3725
|
+
deleteQueueConfig(queueType: string, queueName: string): Promise<void>;
|
|
3726
|
+
/**
|
|
3727
|
+
* Get queue config
|
|
3728
|
+
* @param {string} queueType
|
|
3729
|
+
* @param {string} queueName
|
|
3730
|
+
* @returns {Promise<Record<string, unknown>>}
|
|
3731
|
+
* @throws {ConductorSdkError}
|
|
3732
|
+
*/
|
|
3733
|
+
getQueueConfig(queueType: string, queueName: string): Promise<Record<string, unknown>>;
|
|
3734
|
+
/**
|
|
3735
|
+
* Get event handlers for a given event
|
|
3736
|
+
* @param {string} event
|
|
3737
|
+
* @param {boolean} [activeOnly=false] Only return active handlers.
|
|
3738
|
+
* @returns {Promise<EventHandler[]>}
|
|
3739
|
+
* @throws {ConductorSdkError}
|
|
3740
|
+
*/
|
|
3741
|
+
getEventHandlersForEvent(event: string, activeOnly?: boolean): Promise<EventHandler[]>;
|
|
3742
|
+
/**
|
|
3743
|
+
* Remove an event handler by name
|
|
3744
|
+
* @param {string} name
|
|
3745
|
+
* @returns {Promise<void>}
|
|
3746
|
+
* @throws {ConductorSdkError}
|
|
3747
|
+
*/
|
|
3748
|
+
removeEventHandler(name: string): Promise<void>;
|
|
3749
|
+
/**
|
|
3750
|
+
* Get tags for an event handler
|
|
3751
|
+
* @param {string} name
|
|
3752
|
+
* @returns {Promise<Tag[]>}
|
|
3753
|
+
* @throws {ConductorSdkError}
|
|
3754
|
+
*/
|
|
3755
|
+
getTagsForEventHandler(name: string): Promise<Tag[]>;
|
|
3756
|
+
/**
|
|
3757
|
+
* Put tags for an event handler
|
|
3758
|
+
* @param {string} name
|
|
3759
|
+
* @param {Tag[]} tags
|
|
3760
|
+
* @returns {Promise<void>}
|
|
3761
|
+
* @throws {ConductorSdkError}
|
|
3762
|
+
*/
|
|
3763
|
+
putTagForEventHandler(name: string, tags: Tag[]): Promise<void>;
|
|
3764
|
+
/**
|
|
3765
|
+
* Delete tags for an event handler
|
|
3766
|
+
* @param {string} name
|
|
3767
|
+
* @param {Tag[]} tags
|
|
3768
|
+
* @returns {Promise<void>}
|
|
3769
|
+
* @throws {ConductorSdkError}
|
|
3770
|
+
*/
|
|
3771
|
+
deleteTagsForEventHandler(name: string, tags: Tag[]): Promise<void>;
|
|
3772
|
+
/**
|
|
3773
|
+
* Delete a tag for an event handler
|
|
3774
|
+
* @param {string} name
|
|
3775
|
+
* @param {Tag} tag
|
|
3776
|
+
* @returns {Promise<void>}
|
|
3777
|
+
* @throws {ConductorSdkError}
|
|
3778
|
+
*/
|
|
3779
|
+
deleteTagForEventHandler(name: string, tag: Tag): Promise<void>;
|
|
3780
|
+
/**
|
|
3781
|
+
* Test connectivity for a given queue using a workflow with EVENT task and an EventHandler
|
|
3782
|
+
* @param {ConnectivityTestInput} input
|
|
3783
|
+
* @returns {Promise<ConnectivityTestResult>}
|
|
3784
|
+
* @throws {ConductorSdkError}
|
|
3785
|
+
*/
|
|
3786
|
+
testConnectivity(input: ConnectivityTestInput): Promise<ConnectivityTestResult>;
|
|
3787
|
+
/**
|
|
3788
|
+
* Create or update queue config by name
|
|
3789
|
+
* @deprecated Prefer server's newer endpoints if available
|
|
3790
|
+
* @param {string} queueType
|
|
3791
|
+
* @param {string} queueName
|
|
3792
|
+
* @param {string} config
|
|
3793
|
+
* @returns {Promise<void>}
|
|
3794
|
+
* @throws {ConductorSdkError}
|
|
3795
|
+
*/
|
|
3796
|
+
putQueueConfig(queueType: string, queueName: string, config: string): Promise<void>;
|
|
3797
|
+
/**
|
|
3798
|
+
* Test endpoint (as exposed by API)
|
|
3799
|
+
* @returns {Promise<EventHandler>}
|
|
3800
|
+
* @throws {ConductorSdkError}
|
|
3801
|
+
*/
|
|
3802
|
+
test(): Promise<EventHandler>;
|
|
3803
|
+
/**
|
|
3804
|
+
* Get all active event handlers (execution view)
|
|
3805
|
+
* @returns {Promise<SearchResultHandledEventResponse>}
|
|
3806
|
+
* @throws {ConductorSdkError}
|
|
3807
|
+
*/
|
|
3808
|
+
getAllActiveEventHandlers(): Promise<SearchResultHandledEventResponse>;
|
|
3809
|
+
/**
|
|
3810
|
+
* Get event executions for a specific handler
|
|
3811
|
+
* @param {string} eventHandlerName
|
|
3812
|
+
* @param {number} [from] Pagination cursor
|
|
3813
|
+
* @returns {Promise<ExtendedEventExecution[]>}
|
|
3814
|
+
* @throws {ConductorSdkError}
|
|
3815
|
+
*/
|
|
3816
|
+
getEventExecutions(eventHandlerName: string, from?: number): Promise<ExtendedEventExecution[]>;
|
|
3817
|
+
/**
|
|
3818
|
+
* Get all event handlers with statistics (messages view)
|
|
3819
|
+
* @param {number} [from] Pagination cursor
|
|
3820
|
+
* @returns {Promise<SearchResultHandledEventResponse>}
|
|
3821
|
+
* @throws {ConductorSdkError}
|
|
3822
|
+
*/
|
|
3823
|
+
getEventHandlersWithStats(from?: number): Promise<SearchResultHandledEventResponse>;
|
|
3824
|
+
/**
|
|
3825
|
+
* Get event messages for a given event
|
|
3826
|
+
* @param {string} event
|
|
3827
|
+
* @param {number} [from] Pagination cursor
|
|
3828
|
+
* @returns {Promise<EventMessage[]>}
|
|
3829
|
+
* @throws {ConductorSdkError}
|
|
3830
|
+
*/
|
|
3831
|
+
getEventMessages(event: string, from?: number): Promise<EventMessage[]>;
|
|
3832
|
+
}
|
|
3833
|
+
|
|
3603
3834
|
interface OrkesApiConfig {
|
|
3604
3835
|
serverUrl?: string;
|
|
3605
3836
|
keyId?: string;
|
|
@@ -3615,8 +3846,208 @@ interface OrkesApiConfig {
|
|
|
3615
3846
|
* @param config (optional) OrkesApiConfig with keyId and keySecret
|
|
3616
3847
|
* @param customFetch (optional) custom fetch function
|
|
3617
3848
|
* @param requestHandler DEPRECATED! (optional) ConductorHttpRequest handler, replaced with customFetch
|
|
3618
|
-
* @returns
|
|
3849
|
+
* @returns Client
|
|
3619
3850
|
*/
|
|
3620
|
-
declare const orkesConductorClient: (config?: OrkesApiConfig, customFetch?: typeof fetch) => Promise<
|
|
3851
|
+
declare const orkesConductorClient: (config?: OrkesApiConfig, customFetch?: typeof fetch) => Promise<{
|
|
3852
|
+
eventResource: {
|
|
3853
|
+
getQueueConfig: (queueType: string, queueName: string) => Promise<{
|
|
3854
|
+
[key: string]: unknown;
|
|
3855
|
+
}>;
|
|
3856
|
+
putQueueConfig: (queueType: string, queueName: string, body: string) => Promise<void>;
|
|
3857
|
+
deleteQueueConfig: (queueType: string, queueName: string) => Promise<void>;
|
|
3858
|
+
getEventHandlers: () => Promise<EventHandler[]>;
|
|
3859
|
+
updateEventHandler: (body: any) => Promise<void>;
|
|
3860
|
+
addEventHandler: (body: any) => Promise<void>;
|
|
3861
|
+
getQueueNames: () => Promise<{
|
|
3862
|
+
[key: string]: string;
|
|
3863
|
+
}>;
|
|
3864
|
+
removeEventHandlerStatus: (name: string) => Promise<void>;
|
|
3865
|
+
getEventHandlersForEvent: (event: string, activeOnly?: boolean) => Promise<EventHandler[]>;
|
|
3866
|
+
deleteTagForEventHandler: (name: string, body: any[]) => Promise<void>;
|
|
3867
|
+
getTagsForEventHandler: (name: string) => Promise<Tag[]>;
|
|
3868
|
+
putTagForEventHandler: (name: string, body: any[]) => Promise<void>;
|
|
3869
|
+
};
|
|
3870
|
+
healthCheckResource: {
|
|
3871
|
+
doCheck: () => Promise<{
|
|
3872
|
+
[key: string]: unknown;
|
|
3873
|
+
}>;
|
|
3874
|
+
};
|
|
3875
|
+
metadataResource: {
|
|
3876
|
+
getTaskDef: (tasktype: string, metadata?: boolean) => Promise<{
|
|
3877
|
+
[key: string]: unknown;
|
|
3878
|
+
}>;
|
|
3879
|
+
unregisterTaskDef: (tasktype: string) => Promise<void>;
|
|
3880
|
+
getAllWorkflows: (access?: string, metadata?: boolean, tagKey?: string, tagValue?: string) => Promise<WorkflowDef$1[]>;
|
|
3881
|
+
update: (requestBody: any[], overwrite?: boolean) => Promise<void>;
|
|
3882
|
+
create: (requestBody: any, overwrite?: boolean) => Promise<void>;
|
|
3883
|
+
getTaskDefs: (access?: string, metadata?: boolean, tagKey?: string, tagValue?: string) => Promise<TaskDef[]>;
|
|
3884
|
+
updateTaskDef: (requestBody: any) => Promise<void>;
|
|
3885
|
+
registerTaskDef: (requestBody: any[]) => Promise<void>;
|
|
3886
|
+
unregisterWorkflowDef: (name: string, version: number) => Promise<void>;
|
|
3887
|
+
get: (name: string, version?: number, metadata?: boolean) => Promise<WorkflowDef$1>;
|
|
3888
|
+
};
|
|
3889
|
+
schedulerResource: {
|
|
3890
|
+
getSchedule: (name: string) => Promise<WorkflowSchedule>;
|
|
3891
|
+
deleteSchedule: (name: string) => Promise<void>;
|
|
3892
|
+
getNextFewSchedules: (cronExpression: string, scheduleStartTime?: number, scheduleEndTime?: number, limit?: number) => Promise<number[]>;
|
|
3893
|
+
pauseSchedule: (name: string) => Promise<void>;
|
|
3894
|
+
pauseAllSchedules: () => Promise<{
|
|
3895
|
+
[key: string]: unknown;
|
|
3896
|
+
}>;
|
|
3897
|
+
resumeSchedule: (name: string) => Promise<void>;
|
|
3898
|
+
requeueAllExecutionRecords: () => Promise<{
|
|
3899
|
+
[key: string]: unknown;
|
|
3900
|
+
}>;
|
|
3901
|
+
resumeAllSchedules: () => Promise<{
|
|
3902
|
+
[key: string]: unknown;
|
|
3903
|
+
}>;
|
|
3904
|
+
getAllSchedules: (workflowName?: string) => Promise<WorkflowScheduleModel[]>;
|
|
3905
|
+
saveSchedule: (requestBody: any) => Promise<void>;
|
|
3906
|
+
searchV21: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<SearchResultWorkflowScheduleExecutionModel>;
|
|
3907
|
+
testTimeout: () => Promise<any>;
|
|
3908
|
+
};
|
|
3909
|
+
tokenResource: {
|
|
3910
|
+
generateToken: (requestBody: any) => Promise<Response$1>;
|
|
3911
|
+
getUserInfo: (claims?: boolean) => Promise<{
|
|
3912
|
+
[key: string]: unknown;
|
|
3913
|
+
}>;
|
|
3914
|
+
};
|
|
3915
|
+
workflowBulkResource: {
|
|
3916
|
+
retry: (requestBody: any[]) => Promise<BulkResponse>;
|
|
3917
|
+
restart: (requestBody: any[], useLatestDefinitions?: boolean) => Promise<BulkResponse>;
|
|
3918
|
+
terminate: (requestBody: any[], reason?: string) => Promise<BulkResponse>;
|
|
3919
|
+
resumeWorkflow: (requestBody: any[]) => Promise<BulkResponse>;
|
|
3920
|
+
pauseWorkflow1: (requestBody: any[]) => Promise<BulkResponse>;
|
|
3921
|
+
};
|
|
3922
|
+
workflowResource: {
|
|
3923
|
+
getRunningWorkflow: (name: string, version?: number, startTime?: number, endTime?: number) => Promise<string[]>;
|
|
3924
|
+
executeWorkflow: (body: any, name: string, version: number, requestId?: string, waitUntilTaskRef?: string, waitForSeconds?: number, consistency?: any, returnStrategy?: any) => Promise<SignalResponse$1>;
|
|
3925
|
+
startWorkflow: (requestBody: any) => Promise<string>;
|
|
3926
|
+
decide: (workflowId: string) => Promise<void>;
|
|
3927
|
+
rerun: (workflowId: string, requestBody: any) => Promise<string>;
|
|
3928
|
+
searchV21: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<any>;
|
|
3929
|
+
pauseWorkflow: (workflowId: string) => Promise<void>;
|
|
3930
|
+
skipTaskFromWorkflow: (workflowId: string, taskReferenceName: string, requestBody?: any) => Promise<void>;
|
|
3931
|
+
getWorkflows: (name: string, requestBody: any[], includeClosed?: boolean, includeTasks?: boolean) => Promise<{
|
|
3932
|
+
[key: string]: Workflow[];
|
|
3933
|
+
}>;
|
|
3934
|
+
getWorkflowStatusSummary: (workflowId: string, includeOutput?: boolean, includeVariables?: boolean) => Promise<WorkflowStatus>;
|
|
3935
|
+
getWorkflows1: (name: string, correlationId: string, includeClosed?: boolean, includeTasks?: boolean) => Promise<Workflow[]>;
|
|
3936
|
+
retry1: (workflowId: string, resumeSubworkflowTasks?: boolean) => Promise<void>;
|
|
3937
|
+
getExecutionStatus: (workflowId: string, includeTasks?: boolean) => Promise<Workflow>;
|
|
3938
|
+
terminate1: (workflowId: string, reason?: string) => Promise<void>;
|
|
3939
|
+
resumeWorkflow: (workflowId: string) => Promise<void>;
|
|
3940
|
+
delete: (workflowId: string, archiveWorkflow?: boolean) => Promise<void>;
|
|
3941
|
+
searchWorkflowsByTasks: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<any>;
|
|
3942
|
+
getExternalStorageLocation: (path: string, operation: string, payloadType: string) => Promise<any>;
|
|
3943
|
+
startWorkflow1: (name: string, requestBody: any, version?: number, correlationId?: string, priority?: number) => Promise<string>;
|
|
3944
|
+
restart1: (workflowId: string, useLatestDefinitions?: boolean) => Promise<void>;
|
|
3945
|
+
search1: (queryId?: string, start?: number, size?: number, sort?: string, freeText?: string, query?: string, skipCache?: boolean) => Promise<any>;
|
|
3946
|
+
searchWorkflowsByTasksV2: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<any>;
|
|
3947
|
+
resetWorkflow: (workflowId: string) => Promise<void>;
|
|
3948
|
+
testWorkflow: (requestBody: any) => Promise<Workflow>;
|
|
3949
|
+
};
|
|
3950
|
+
serviceRegistryResource: {
|
|
3951
|
+
getRegisteredServices: () => Promise<ServiceRegistry[]>;
|
|
3952
|
+
removeService: (name: string) => Promise<void>;
|
|
3953
|
+
getService: (name: string) => Promise<ServiceRegistry>;
|
|
3954
|
+
openCircuitBreaker: (name: string) => Promise<CircuitBreakerTransitionResponse>;
|
|
3955
|
+
closeCircuitBreaker: (name: string) => Promise<CircuitBreakerTransitionResponse>;
|
|
3956
|
+
getCircuitBreakerStatus: (name: string) => Promise<CircuitBreakerTransitionResponse>;
|
|
3957
|
+
addOrUpdateService: (serviceRegistry: any) => Promise<void>;
|
|
3958
|
+
addOrUpdateServiceMethod: (registryName: string, method: any) => Promise<void>;
|
|
3959
|
+
removeMethod: (registryName: string, serviceName: string, method: string, methodType: string) => Promise<void>;
|
|
3960
|
+
getProtoData: (registryName: string, filename: string) => Promise<string>;
|
|
3961
|
+
setProtoData: (registryName: string, filename: string, data: any) => Promise<void>;
|
|
3962
|
+
deleteProto: (registryName: string, filename: string) => Promise<void>;
|
|
3963
|
+
getAllProtos: (registryName: string) => Promise<ProtoRegistryEntry[]>;
|
|
3964
|
+
discover: (name: string, create?: boolean) => Promise<ServiceMethod[]>;
|
|
3965
|
+
};
|
|
3966
|
+
humanTaskResource: {
|
|
3967
|
+
getConductorTaskById: (taskId: string) => Promise<Task>;
|
|
3968
|
+
};
|
|
3969
|
+
humanTask: {
|
|
3970
|
+
deleteTaskFromHumanTaskRecords: (requestBody: any[]) => Promise<void>;
|
|
3971
|
+
deleteTaskFromHumanTaskRecords1: (taskId: string) => Promise<void>;
|
|
3972
|
+
search: (requestBody: any) => Promise<HumanTaskSearchResult>;
|
|
3973
|
+
updateTaskOutputByRef: (workflowId: string, taskRefName: string, requestBody: any, complete?: boolean, iteration?: any[]) => Promise<any>;
|
|
3974
|
+
getTask1: (taskId: string) => Promise<HumanTaskEntry>;
|
|
3975
|
+
claimTask: (taskId: string, overrideAssignment?: boolean, withTemplate?: boolean) => Promise<HumanTaskEntry>;
|
|
3976
|
+
assignAndClaim: (taskId: string, userId: string, overrideAssignment?: boolean, withTemplate?: boolean) => Promise<HumanTaskEntry>;
|
|
3977
|
+
reassignTask: (taskId: string, requestBody: any[]) => Promise<void>;
|
|
3978
|
+
releaseTask: (taskId: string) => Promise<void>;
|
|
3979
|
+
skipTask: (taskId: string, reason?: string) => Promise<void>;
|
|
3980
|
+
updateTaskOutput: (taskId: string, requestBody: any, complete?: boolean) => Promise<void>;
|
|
3981
|
+
getAllTemplates: (name?: string, version?: number) => Promise<HumanTaskTemplate[]>;
|
|
3982
|
+
saveTemplate: (requestBody: any, newVersion?: boolean) => Promise<HumanTaskTemplate>;
|
|
3983
|
+
saveTemplates: (requestBody: any[], newVersion?: boolean) => Promise<HumanTaskTemplate[]>;
|
|
3984
|
+
deleteTemplateByName: (name: string) => Promise<void>;
|
|
3985
|
+
deleteTemplatesByNameAndVersion: (name: string, version: number) => Promise<void>;
|
|
3986
|
+
getTemplateByNameAndVersion: (name: string, version: number) => Promise<HumanTaskTemplate>;
|
|
3987
|
+
};
|
|
3988
|
+
taskResource: {
|
|
3989
|
+
poll: (tasktype: string, workerid?: string, domain?: string) => Promise<Task>;
|
|
3990
|
+
allVerbose: () => Promise<{
|
|
3991
|
+
[key: string]: {
|
|
3992
|
+
[key: string]: {
|
|
3993
|
+
[key: string]: number;
|
|
3994
|
+
};
|
|
3995
|
+
};
|
|
3996
|
+
}>;
|
|
3997
|
+
updateTask: (workflowId: string, taskRefName: string, status: "IN_PROGRESS" | "FAILED" | "FAILED_WITH_TERMINAL_ERROR" | "COMPLETED", requestBody: any) => Promise<string>;
|
|
3998
|
+
getTask: (taskId: string) => Promise<Task>;
|
|
3999
|
+
all: () => Promise<{
|
|
4000
|
+
[key: string]: number;
|
|
4001
|
+
}>;
|
|
4002
|
+
requeuePendingTask: (taskType: string) => Promise<string>;
|
|
4003
|
+
search: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<SearchResultTaskSummary>;
|
|
4004
|
+
searchV22: (start?: number, size?: number, sort?: string, freeText?: string, query?: string) => Promise<any>;
|
|
4005
|
+
getPollData: (taskType: string) => Promise<PollData[]>;
|
|
4006
|
+
getTaskLogs: (taskId: string) => Promise<TaskExecLog[]>;
|
|
4007
|
+
log: (taskId: string, requestBody: string) => Promise<void>;
|
|
4008
|
+
getAllPollData: () => Promise<{
|
|
4009
|
+
[key: string]: unknown;
|
|
4010
|
+
}>;
|
|
4011
|
+
batchPoll: (tasktype: string, workerid?: string, domain?: string, count?: number, timeout?: number) => Promise<Task[]>;
|
|
4012
|
+
updateTask1: (requestBody: any) => Promise<string>;
|
|
4013
|
+
size1: (taskType?: string[]) => Promise<{
|
|
4014
|
+
[key: string]: number;
|
|
4015
|
+
}>;
|
|
4016
|
+
getExternalStorageLocation1: (path: string, operation: string, payloadType: string) => Promise<any>;
|
|
4017
|
+
updateTaskSync: (workflowId: string, taskRefName: string, status: any, output: any, workerId?: string) => Promise<Workflow>;
|
|
4018
|
+
signal: (workflowId: string, status: any, output: any, returnStrategy?: any) => Promise<SignalResponse$1>;
|
|
4019
|
+
signalAsync: (workflowId: string, status: any, output: any) => Promise<SignalResponse>;
|
|
4020
|
+
};
|
|
4021
|
+
buildUrl: <TData extends {
|
|
4022
|
+
body?: unknown;
|
|
4023
|
+
path?: Record<string, unknown>;
|
|
4024
|
+
query?: Record<string, unknown>;
|
|
4025
|
+
url: string;
|
|
4026
|
+
}>(options: Pick<TData, "url"> & Options<TData>) => string;
|
|
4027
|
+
getConfig: () => Config<ClientOptions>;
|
|
4028
|
+
request: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method"> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4029
|
+
setConfig: (config: Config<ClientOptions>) => Config<ClientOptions>;
|
|
4030
|
+
connect: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4031
|
+
delete: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4032
|
+
get: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4033
|
+
head: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4034
|
+
options: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4035
|
+
patch: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4036
|
+
post: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4037
|
+
put: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4038
|
+
trace: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
4039
|
+
sse: {
|
|
4040
|
+
connect: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4041
|
+
delete: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4042
|
+
get: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4043
|
+
head: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4044
|
+
options: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4045
|
+
patch: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4046
|
+
post: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4047
|
+
put: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4048
|
+
trace: <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
4049
|
+
};
|
|
4050
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
4051
|
+
}>;
|
|
3621
4052
|
|
|
3622
|
-
export { type Action, ApiError, type ApiRequestOptions, type ApiResult, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, type EventHandler, type EventTaskDef, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type RerunWorkflowRequest, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, 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, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
|
4053
|
+
export { type Action, ApiError, type ApiRequestOptions, type ApiResult, type Auth, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type ClientOptions, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, type Config, type ConnectivityTestInput, type ConnectivityTestResult, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, EventClient, type EventHandler, type EventMessage, type EventTaskDef, type ExtendedEventExecution, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type Middleware, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type QuerySerializerOptions, type RequestOptions, type RerunWorkflowRequest, type ResolvedRequestOptions, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultHandledEventResponse, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type StreamEvent, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Tag, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, 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, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|