@io-orkes/conductor-javascript 2.1.3-alpha2 → 2.1.4

package/dist/index.d.mts

@@ -933,6 +933,29 @@ declare type WorkflowStatus = {
     status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
 };
 
+declare type TaskMock = {
+    executionTime?: number;
+    output: Record<string, any>;
+    queueWaitTime?: number;
+    status: "IN_PROGRESS" | "FAILED" | "FAILED_WITH_TERMINAL_ERROR" | "COMPLETED";
+};
+
+declare type WorkflowTestRequest = {
+    correlationId?: string;
+    createdBy?: string;
+    externalInputPayloadStoragePath?: string;
+    idempotencyKey?: string;
+    idempotencyStrategy?: "FAIL" | "RETURN_EXISTING";
+    input?: Record<string, Record<string, any>>;
+    name: string;
+    priority?: number;
+    subWorkflowTestRequest?: Record<string, WorkflowTestRequest>;
+    taskRefToMockOutput?: Record<string, Array<TaskMock>>;
+    taskToDomain?: Record<string, string>;
+    version?: number;
+    workflowDef?: WorkflowDef$1;
+};
+
 declare class WorkflowResourceService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -1149,6 +1172,13 @@ declare class WorkflowResourceService {
      * @throws ApiError
      */
     resetWorkflow(workflowId: string): CancelablePromise<void>;
+    /**
+     * Test workflow execution using mock data
+     * @param requestBody
+     * @returns Workflow OK
+     * @throws ApiError
+     */
+    testWorkflow(requestBody: WorkflowTestRequest): CancelablePromise<Workflow>;
 }
 
 /**
@@ -1192,17 +1222,6 @@ declare type HumanTaskAssignment = {
     slaMinutes?: number;
 };
 
-declare type HumanTaskTemplate = {
-    createdBy?: string;
-    createdOn?: number;
-    jsonSchema: Record<string, any>;
-    name: string;
-    templateUI: Record<string, any>;
-    updatedBy?: string;
-    updatedOn?: number;
-    version: number;
-};
-
 declare type HumanTaskTrigger = {
     startWorkflowRequest?: StartWorkflowRequest;
     triggerType?: 'ASSIGNEE_CHANGED' | 'PENDING' | 'IN_PROGRESS' | 'ASSIGNED' | 'COMPLETED' | 'TIMED_OUT';
@@ -1214,11 +1233,10 @@ declare type UserFormTemplate = {
 };
 
 declare type HumanTaskDefinition = {
-    assignmentCompletionStrategy?: "LEAVE_OPEN" | "TERMINATE";
+    assignmentCompletionStrategy?: 'LEAVE_OPEN' | 'TERMINATE';
     assignments?: Array<HumanTaskAssignment>;
     taskTriggers?: Array<HumanTaskTrigger>;
     userFormTemplate?: UserFormTemplate;
-    fullTemplate?: HumanTaskTemplate;
 };
 
 declare type HumanTaskEntry = {
@@ -1251,7 +1269,6 @@ declare type HumanTaskSearch = {
     start?: number;
     states?: Array<'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED'>;
     taskRefNames?: Array<string>;
-    workflowIds?: Array<string>;
     workflowNames?: Array<string>;
 };
 
@@ -1260,6 +1277,17 @@ declare type HumanTaskSearchResult = {
     totalHits?: number;
 };
 
+declare type HumanTaskTemplate = {
+    createdBy?: string;
+    createdOn?: number;
+    jsonSchema: Record<string, any>;
+    name: string;
+    templateUI: Record<string, any>;
+    updatedBy?: string;
+    updatedOn?: number;
+    version: number;
+};
+
 declare class HumanTaskService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -1301,7 +1329,7 @@ declare class HumanTaskService {
      * @returns HumanTaskEntry OK
      * @throws ApiError
      */
-    getTask1(taskId: string, withTemplate?: boolean): CancelablePromise<HumanTaskEntry>;
+    getTask1(taskId: string): CancelablePromise<HumanTaskEntry>;
     /**
      * Claim a task by authenticated Conductor user
      * @param taskId
@@ -1414,6 +1442,7 @@ declare class HumanTaskResourceService {
 
 interface ConductorClientAPIConfig extends Omit<OpenAPIConfig, "BASE"> {
     serverUrl: string;
+    useEnvVars: boolean;
 }
 declare class ConductorClient {
     readonly eventResource: EventResourceService;
@@ -1918,10 +1947,6 @@ declare type PollIntervalOptions = {
     pollInterval: number;
     maxPollTimes: number;
 };
-declare type ClaimOptions = {
-    overrideAssignment: boolean;
-    withTemplate: boolean;
-};
 declare class HumanExecutor {
     readonly _client: ConductorClient;
     constructor(client: ConductorClient);
@@ -1967,20 +1992,20 @@ declare class HumanExecutor {
      * @param taskId
      * @returns
      */
-    getTaskById(taskId: string, withTemplate?: boolean): Promise<HumanTaskEntry>;
+    getTaskById(taskId: string): Promise<HumanTaskEntry>;
     /**
      * Assigns taskId to assignee. If the task is already assigned to another user, this will fail.
      * @param taskId
      * @param assignee
      * @returns
      */
-    claimTaskAsExternalUser(taskId: string, assignee: string, options?: ClaimOptions): Promise<HumanTaskEntry>;
+    claimTaskAsExternalUser(taskId: string, assignee: string, options?: Record<string, boolean>): Promise<HumanTaskEntry>;
     /**
      * Claim task as conductor user
      * @param taskId
      * @returns
      */
-    claimTaskAsConductorUser(taskId: string, options?: ClaimOptions): Promise<HumanTaskEntry>;
+    claimTaskAsConductorUser(taskId: string, options?: Record<string, boolean>): Promise<HumanTaskEntry>;
     /**
      * Claim task as conductor user
      * @param taskId
@@ -2362,6 +2387,14 @@ declare class MetadataClient {
      * @returns
      */
     updateTask(taskDef: TaskDef): Promise<void>;
+    /**
+     * Creates or updates (overwrite: true) a workflow definition
+     *
+     * @param workflowDef
+     * @param overwrite
+     * @returns
+     */
+    registerWorkflowDef(workflowDef: WorkflowDef$1, overwrite?: boolean): any;
 }
 
 declare type FetchFn<T = RequestInit, R extends {

package/dist/index.d.ts

@@ -933,6 +933,29 @@ declare type WorkflowStatus = {
     status?: 'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'TERMINATED' | 'PAUSED';
 };
 
+declare type TaskMock = {
+    executionTime?: number;
+    output: Record<string, any>;
+    queueWaitTime?: number;
+    status: "IN_PROGRESS" | "FAILED" | "FAILED_WITH_TERMINAL_ERROR" | "COMPLETED";
+};
+
+declare type WorkflowTestRequest = {
+    correlationId?: string;
+    createdBy?: string;
+    externalInputPayloadStoragePath?: string;
+    idempotencyKey?: string;
+    idempotencyStrategy?: "FAIL" | "RETURN_EXISTING";
+    input?: Record<string, Record<string, any>>;
+    name: string;
+    priority?: number;
+    subWorkflowTestRequest?: Record<string, WorkflowTestRequest>;
+    taskRefToMockOutput?: Record<string, Array<TaskMock>>;
+    taskToDomain?: Record<string, string>;
+    version?: number;
+    workflowDef?: WorkflowDef$1;
+};
+
 declare class WorkflowResourceService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -1149,6 +1172,13 @@ declare class WorkflowResourceService {
      * @throws ApiError
      */
     resetWorkflow(workflowId: string): CancelablePromise<void>;
+    /**
+     * Test workflow execution using mock data
+     * @param requestBody
+     * @returns Workflow OK
+     * @throws ApiError
+     */
+    testWorkflow(requestBody: WorkflowTestRequest): CancelablePromise<Workflow>;
 }
 
 /**
@@ -1192,17 +1222,6 @@ declare type HumanTaskAssignment = {
     slaMinutes?: number;
 };
 
-declare type HumanTaskTemplate = {
-    createdBy?: string;
-    createdOn?: number;
-    jsonSchema: Record<string, any>;
-    name: string;
-    templateUI: Record<string, any>;
-    updatedBy?: string;
-    updatedOn?: number;
-    version: number;
-};
-
 declare type HumanTaskTrigger = {
     startWorkflowRequest?: StartWorkflowRequest;
     triggerType?: 'ASSIGNEE_CHANGED' | 'PENDING' | 'IN_PROGRESS' | 'ASSIGNED' | 'COMPLETED' | 'TIMED_OUT';
@@ -1214,11 +1233,10 @@ declare type UserFormTemplate = {
 };
 
 declare type HumanTaskDefinition = {
-    assignmentCompletionStrategy?: "LEAVE_OPEN" | "TERMINATE";
+    assignmentCompletionStrategy?: 'LEAVE_OPEN' | 'TERMINATE';
     assignments?: Array<HumanTaskAssignment>;
     taskTriggers?: Array<HumanTaskTrigger>;
     userFormTemplate?: UserFormTemplate;
-    fullTemplate?: HumanTaskTemplate;
 };
 
 declare type HumanTaskEntry = {
@@ -1251,7 +1269,6 @@ declare type HumanTaskSearch = {
     start?: number;
     states?: Array<'PENDING' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'TIMED_OUT' | 'DELETED'>;
     taskRefNames?: Array<string>;
-    workflowIds?: Array<string>;
     workflowNames?: Array<string>;
 };
 
@@ -1260,6 +1277,17 @@ declare type HumanTaskSearchResult = {
     totalHits?: number;
 };
 
+declare type HumanTaskTemplate = {
+    createdBy?: string;
+    createdOn?: number;
+    jsonSchema: Record<string, any>;
+    name: string;
+    templateUI: Record<string, any>;
+    updatedBy?: string;
+    updatedOn?: number;
+    version: number;
+};
+
 declare class HumanTaskService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -1301,7 +1329,7 @@ declare class HumanTaskService {
      * @returns HumanTaskEntry OK
      * @throws ApiError
      */
-    getTask1(taskId: string, withTemplate?: boolean): CancelablePromise<HumanTaskEntry>;
+    getTask1(taskId: string): CancelablePromise<HumanTaskEntry>;
     /**
      * Claim a task by authenticated Conductor user
      * @param taskId
@@ -1414,6 +1442,7 @@ declare class HumanTaskResourceService {
 
 interface ConductorClientAPIConfig extends Omit<OpenAPIConfig, "BASE"> {
     serverUrl: string;
+    useEnvVars: boolean;
 }
 declare class ConductorClient {
     readonly eventResource: EventResourceService;
@@ -1918,10 +1947,6 @@ declare type PollIntervalOptions = {
     pollInterval: number;
     maxPollTimes: number;
 };
-declare type ClaimOptions = {
-    overrideAssignment: boolean;
-    withTemplate: boolean;
-};
 declare class HumanExecutor {
     readonly _client: ConductorClient;
     constructor(client: ConductorClient);
@@ -1967,20 +1992,20 @@ declare class HumanExecutor {
      * @param taskId
      * @returns
      */
-    getTaskById(taskId: string, withTemplate?: boolean): Promise<HumanTaskEntry>;
+    getTaskById(taskId: string): Promise<HumanTaskEntry>;
     /**
      * Assigns taskId to assignee. If the task is already assigned to another user, this will fail.
      * @param taskId
      * @param assignee
      * @returns
      */
-    claimTaskAsExternalUser(taskId: string, assignee: string, options?: ClaimOptions): Promise<HumanTaskEntry>;
+    claimTaskAsExternalUser(taskId: string, assignee: string, options?: Record<string, boolean>): Promise<HumanTaskEntry>;
     /**
      * Claim task as conductor user
      * @param taskId
      * @returns
      */
-    claimTaskAsConductorUser(taskId: string, options?: ClaimOptions): Promise<HumanTaskEntry>;
+    claimTaskAsConductorUser(taskId: string, options?: Record<string, boolean>): Promise<HumanTaskEntry>;
     /**
      * Claim task as conductor user
      * @param taskId
@@ -2362,6 +2387,14 @@ declare class MetadataClient {
      * @returns
      */
     updateTask(taskDef: TaskDef): Promise<void>;
+    /**
+     * Creates or updates (overwrite: true) a workflow definition
+     *
+     * @param workflowDef
+     * @param overwrite
+     * @returns
+     */
+    registerWorkflowDef(workflowDef: WorkflowDef$1, overwrite?: boolean): any;
 }
 
 declare type FetchFn<T = RequestInit, R extends {