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

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
@@ -1918,10 +1946,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 +1991,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 +2386,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
@@ -1918,10 +1946,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 +1991,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 +2386,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.js

@@ -1589,6 +1589,20 @@ var WorkflowResourceService = class {
       }
     });
   }
+  /**
+   * Test workflow execution using mock data
+   * @param requestBody
+   * @returns Workflow OK
+   * @throws ApiError
+   */
+  testWorkflow(requestBody) {
+    return this.httpRequest.request({
+      method: "POST",
+      url: "/workflow/test",
+      body: requestBody,
+      mediaType: "application/json"
+    });
+  }
 };
 
 // src/common/open-api/core/ApiError.ts
@@ -1964,7 +1978,7 @@ var HumanTaskService = class {
       method: "DELETE",
       url: "/human/tasks/delete/{taskId}",
       path: {
-        taskId
+        "taskId": taskId
       }
     });
   }
@@ -1997,10 +2011,10 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/update/taskRef",
       query: {
-        workflowId,
-        taskRefName,
-        complete,
-        iteration
+        "workflowId": workflowId,
+        "taskRefName": taskRefName,
+        "complete": complete,
+        "iteration": iteration
       },
       body: requestBody,
       mediaType: "application/json"
@@ -2012,15 +2026,12 @@ var HumanTaskService = class {
    * @returns HumanTaskEntry OK
    * @throws ApiError
    */
-  getTask1(taskId, withTemplate = false) {
+  getTask1(taskId) {
     return this.httpRequest.request({
       method: "GET",
       url: "/human/tasks/{taskId}",
       path: {
-        taskId
-      },
-      query: {
-        withTemplate
+        "taskId": taskId
       }
     });
   }
@@ -2036,11 +2047,11 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/claim",
       path: {
-        taskId
+        "taskId": taskId
       },
       query: {
-        overrideAssignment,
-        withTemplate
+        "overrideAssignment": overrideAssignment,
+        "withTemplate": withTemplate
       }
     });
   }
@@ -2057,12 +2068,12 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/externalUser/{userId}",
       path: {
-        taskId,
-        userId
+        "taskId": taskId,
+        "userId": userId
       },
       query: {
-        overrideAssignment,
-        withTemplate
+        "overrideAssignment": overrideAssignment,
+        "withTemplate": withTemplate
       }
     });
   }
@@ -2078,7 +2089,7 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/reassign",
       path: {
-        taskId
+        "taskId": taskId
       },
       body: requestBody,
       mediaType: "application/json"
@@ -2095,7 +2106,7 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/release",
       path: {
-        taskId
+        "taskId": taskId
       }
     });
   }
@@ -2111,10 +2122,10 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/skip",
       path: {
-        taskId
+        "taskId": taskId
       },
       query: {
-        reason
+        "reason": reason
       }
     });
   }
@@ -2131,10 +2142,10 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/tasks/{taskId}/update",
       path: {
-        taskId
+        "taskId": taskId
       },
       query: {
-        complete
+        "complete": complete
       },
       body: requestBody,
       mediaType: "application/json"
@@ -2152,8 +2163,8 @@ var HumanTaskService = class {
       method: "GET",
       url: "/human/template",
       query: {
-        name,
-        version
+        "name": name,
+        "version": version
       }
     });
   }
@@ -2169,7 +2180,7 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/template",
       query: {
-        newVersion
+        "newVersion": newVersion
       },
       body: requestBody,
       mediaType: "application/json"
@@ -2187,7 +2198,7 @@ var HumanTaskService = class {
       method: "POST",
       url: "/human/template/bulk",
       query: {
-        newVersion
+        "newVersion": newVersion
       },
       body: requestBody,
       mediaType: "application/json"
@@ -2204,7 +2215,7 @@ var HumanTaskService = class {
       method: "DELETE",
       url: "/human/template/{name}",
       path: {
-        name
+        "name": name
       }
     });
   }
@@ -2220,8 +2231,8 @@ var HumanTaskService = class {
       method: "DELETE",
       url: "/human/template/{name}/{version}",
       path: {
-        name,
-        version
+        "name": name,
+        "version": version
       }
     });
   }
@@ -2237,8 +2248,8 @@ var HumanTaskService = class {
       method: "GET",
       url: "/human/template/{name}/{version}",
       path: {
-        name,
-        version
+        "name": name,
+        "version": version
       }
     });
   }
@@ -3131,10 +3142,8 @@ var HumanExecutor = class {
    * @param taskId
    * @returns
    */
-  getTaskById(taskId, withTemplate = false) {
-    return tryCatchReThrow(
-      () => this._client.humanTask.getTask1(taskId, withTemplate)
-    );
+  getTaskById(taskId) {
+    return tryCatchReThrow(() => this._client.humanTask.getTask1(taskId));
   }
   /**
    * Assigns taskId to assignee. If the task is already assigned to another user, this will fail.
@@ -3144,12 +3153,7 @@ var HumanExecutor = class {
    */
   async claimTaskAsExternalUser(taskId, assignee, options) {
     return tryCatchReThrow(
-      () => this._client.humanTask.assignAndClaim(
-        taskId,
-        assignee,
-        options?.overrideAssignment,
-        options?.withTemplate
-      )
+      () => this._client.humanTask.assignAndClaim(taskId, assignee, options?.overrideAssignment, options?.withTemplate)
     );
   }
   /**
@@ -3158,13 +3162,7 @@ var HumanExecutor = class {
    * @returns
    */
   async claimTaskAsConductorUser(taskId, options) {
-    return tryCatchReThrow(
-      () => this._client.humanTask.claimTask(
-        taskId,
-        options?.overrideAssignment,
-        options?.withTemplate
-      )
-    );
+    return tryCatchReThrow(() => this._client.humanTask.claimTask(taskId, options?.overrideAssignment, options?.withTemplate));
   }
   /**
    * Claim task as conductor user
@@ -4004,6 +4002,18 @@ var MetadataClient = class {
       () => this._client.metadataResource.updateTaskDef(taskDef)
     );
   }
+  /**
+   * Creates or updates (overwrite: true) a workflow definition
+   *
+   * @param workflowDef
+   * @param overwrite
+   * @returns
+   */
+  registerWorkflowDef(workflowDef, overwrite = false) {
+    return tryCatchReThrow(
+      () => this._client.metadataResource.create(workflowDef, overwrite)
+    );
+  }
 };
 
 // src/orkes/BaseOrkesConductorClient.ts