@camunda/task-testing 2.2.0 → 3.0.0-0

package/dist/types/types.d.ts

@@ -1,14 +1,14 @@
-import type { CamundaClient, CreateProcessInstanceResult, ElementInstanceResult, ElementInstanceSearchQueryResult, IncidentResult, IncidentSearchQueryResult, ProcessInstanceResult, ProcessInstanceSearchQueryResult, ProcessInstanceStateEnum, VariableSearchQueryResult, VariableSearchResult } from '@camunda8/orchestration-cluster-api';
-import type { ModdleElement } from "bpmn-js/lib/model/Types";
-type ExtendedDeploymentResult = Awaited<ReturnType<CamundaClient['createDeployment']>>;
-export type { CreateProcessInstanceResult, ElementInstanceSearchQueryResult, IncidentSearchQueryResult, ProcessInstanceSearchQueryResult, ProcessInstanceResult, VariableSearchQueryResult, ExtendedDeploymentResult, ProcessInstanceStateEnum, VariableSearchResult, ElementInstanceResult, IncidentResult };
+import type { CreateProcessInstanceResult, DeploymentResult, ElementInstanceSearchQueryResult, IncidentResult, IncidentSearchQueryResult, JobSearchQueryResult, MessageSubscriptionSearchQueryResult, ProcessInstanceSearchQueryResult, UserTaskSearchQueryResult, VariableSearchQueryResult } from '@camunda8/orchestration-cluster-api';
+import { ModdleElement } from 'bpmn-js/lib/model/Types';
+import { TASK_EXECUTION_EVENT, TASK_EXECUTION_FINISHED_REASON, TASK_EXECUTION_STATE } from './TaskExecution';
+import { EXECUTION_LOG_ENTRY_TYPE, EXECUTION_LOG_ENTRY_STATUS } from './ExecutionLog';
 export type Input = {
     [elementId: string]: string;
 };
 export type Output = {
     [elementId: string]: ElementOutput;
 };
-export type VARIABLE_SCOPE = 'LOCAL' | 'PROCESS';
+export type VARIABLE_SCOPE = 'LOCAL' | 'PROCESS' | null;
 export type ElementOutputVariables = {
     [id: string]: {
         name: string;
@@ -20,7 +20,7 @@ export type ElementOutput = {
     success: boolean;
     variables?: ElementOutputVariables;
     error?: TaskExecutionError;
-    incident?: any;
+    incident?: IncidentResult;
     operateUrl?: string;
     [key: string]: any;
 } | undefined;
@@ -43,29 +43,183 @@ export type ApiResponse<T> = {
 } | {
     success: false;
     error: string;
+    errorType?: string;
+    status?: number | null;
+    detail?: string | null;
+    operationId?: string | null;
+};
+export type DeployResponse = ApiResponse<DeploymentResult>;
+export type GetProcessInstanceResponse = ApiResponse<ProcessInstanceSearchQueryResult>;
+export type GetProcessInstanceElementInstancesResponse = ApiResponse<ElementInstanceSearchQueryResult>;
+export type GetProcessInstanceIncidentsResponse = ApiResponse<IncidentSearchQueryResult>;
+export type GetProcessInstanceJobsResponse = ApiResponse<JobSearchQueryResult>;
+export type GetProcessInstanceMessageSubscriptionsResponse = ApiResponse<MessageSubscriptionSearchQueryResult>;
+export type GetProcessInstanceUserTasksResponse = ApiResponse<UserTaskSearchQueryResult>;
+export type GetProcessInstanceVariablesResponse = ApiResponse<VariableSearchQueryResult>;
+export type StartInstanceResponse = ApiResponse<CreateProcessInstanceResult>;
+export type TaskExecutionPolledResult = {
+    elementId: string;
+    elementInstancesResponse: GetProcessInstanceElementInstancesResponse;
+    jobsResponse: GetProcessInstanceJobsResponse;
+    messageSubscriptionsResponse: GetProcessInstanceMessageSubscriptionsResponse;
+    processInstanceKey: string;
+    processInstanceResponse: GetProcessInstanceResponse;
+    userTasksResponse: GetProcessInstanceUserTasksResponse;
+    variablesResponse: GetProcessInstanceVariablesResponse;
 };
 export type TaskExecutionApi = {
-    deploy: () => Promise<ApiResponse<ExtendedDeploymentResult>>;
+    deploy: () => Promise<DeployResponse>;
+    getProcessInstance: (processInstanceKey: string) => Promise<GetProcessInstanceResponse>;
+    getProcessInstanceElementInstances: (processInstanceKey: string) => Promise<GetProcessInstanceElementInstancesResponse>;
+    getProcessInstanceIncident: (processInstanceKey: string) => Promise<GetProcessInstanceIncidentsResponse>;
+    getProcessInstanceJobs: (processInstanceKey: string, elementId: string) => Promise<GetProcessInstanceJobsResponse>;
+    getProcessInstanceMessageSubscriptions: (processInstanceKey: string, elementId: string) => Promise<GetProcessInstanceMessageSubscriptionsResponse>;
+    getProcessInstanceUserTasks: (processInstanceKey: string, elementId: string) => Promise<GetProcessInstanceUserTasksResponse>;
+    getProcessInstanceVariables: (processInstanceKey: string) => Promise<GetProcessInstanceVariablesResponse>;
     startInstance: (processDefinitionKey: string, elementId: string, variables: {
         [key: string]: any;
-    }) => Promise<ApiResponse<CreateProcessInstanceResult>>;
-    getProcessInstance: (processInstanceKey: string) => Promise<ApiResponse<ProcessInstanceSearchQueryResult>>;
-    getProcessInstanceVariables: (processInstanceKey: string) => Promise<ApiResponse<VariableSearchQueryResult>>;
-    getProcessInstanceElementInstances: (processInstanceKey: string) => Promise<ApiResponse<ElementInstanceSearchQueryResult>>;
-    getProcessInstanceIncident: (processInstanceKey: string) => Promise<ApiResponse<IncidentSearchQueryResult>>;
-};
-export type TaskExecutionStatus = 'idle' | 'deploying' | 'starting-instance' | 'executing';
-export type TaskExecutionEvents = 'taskExecution.status.changed' | 'taskExecution.finished' | 'taskExecution.error' | 'taskExecution.interrupted';
-export type TaskExecutionResult = {
-    success: boolean;
-    variables?: ElementOutputVariables;
-    error?: TaskExecutionError;
-    incident?: any;
+    }) => Promise<StartInstanceResponse>;
+};
+export type TaskExecutionState = typeof TASK_EXECUTION_STATE[keyof typeof TASK_EXECUTION_STATE];
+export type TaskExecutionEventListeners = {
+    [TASK_EXECUTION_EVENT.STATE_CHANGED]: (state: TaskExecutionState) => void;
+    [TASK_EXECUTION_EVENT.DEPLOYED]: (response: DeployResponse) => void;
+    [TASK_EXECUTION_EVENT.INSTANCE_STARTED]: (response: StartInstanceResponse) => void;
+    [TASK_EXECUTION_EVENT.POLLED]: (result: TaskExecutionPolledResult) => void;
+    [TASK_EXECUTION_EVENT.FINISHED]: (result: TaskExecutionFinishedResult) => void;
+};
+export type TaskExecutionSuccessResult = {
+    lastPolledResult: TaskExecutionPolledResult;
+    processInstanceKey: string;
+    success: true;
+};
+export type TaskExecutionIncidentResult = {
+    incident: any;
+    lastPolledResult: TaskExecutionPolledResult;
+    processInstanceKey: string;
+    reason: typeof TASK_EXECUTION_FINISHED_REASON.INCIDENT;
+    success: false;
 };
+export type TaskExecutionUserCancelResult = {
+    lastPolledResult: TaskExecutionPolledResult | null;
+    processInstanceKey: string | null;
+    reason: typeof TASK_EXECUTION_FINISHED_REASON.USER_CANCEL;
+    success: false;
+};
+export type TaskExecutionUserSelectionChangedResult = {
+    lastPolledResult: TaskExecutionPolledResult | null;
+    processInstanceKey: string | null;
+    reason: typeof TASK_EXECUTION_FINISHED_REASON.USER_SELECTION_CHANGED;
+    success: false;
+};
+export type TaskExecutionErrorResult = {
+    error: TaskExecutionError;
+    lastPolledResult: TaskExecutionPolledResult | null;
+    processInstanceKey: string | null;
+    reason: typeof TASK_EXECUTION_FINISHED_REASON.ERROR;
+    success: false;
+};
+export type TaskExecutionTerminatedResult = {
+    lastPolledResult: TaskExecutionPolledResult;
+    processInstanceKey: string;
+    reason: typeof TASK_EXECUTION_FINISHED_REASON.TERMINATED;
+    success: false;
+};
+export type TaskExecutionFinishedResult = TaskExecutionSuccessResult | TaskExecutionIncidentResult | TaskExecutionTerminatedResult | TaskExecutionUserCancelResult | TaskExecutionUserSelectionChangedResult | TaskExecutionErrorResult;
 export type TaskExecutionError = {
     message: string;
-    response?: any;
+    response?: string;
+    errorType?: string;
+    status?: number | null;
+    detail?: string | null;
+    operationId?: string | null;
+};
+export type ExecutionLogEntryStatus = typeof EXECUTION_LOG_ENTRY_STATUS[keyof typeof EXECUTION_LOG_ENTRY_STATUS];
+export type DeployedStatusData = {
+    processDefinitionId?: string;
+    processDefinitionKey?: string;
+    processDefinitionVersion?: number;
+    deploymentKey?: string;
+};
+export type InstanceStartedStatusData = {
+    processInstanceKey: string;
+    processDefinitionId?: string;
+    processDefinitionKey?: string;
+};
+export type CompletedStatusData = {
+    processInstanceKey: string;
+};
+export type TerminatedStatusData = {
+    processInstanceKey: string;
+};
+export type IncidentStatusData = {
+    processInstanceKey: string;
+    errorType?: string;
+    errorMessage?: string;
+};
+export type CanceledStatusData = {
+    error?: TaskExecutionError;
+};
+export type ExecutionLogStatusEntryData = DeployedStatusData | InstanceStartedStatusData | CompletedStatusData | TerminatedStatusData | IncidentStatusData | CanceledStatusData;
+export type ExecutionLogJobData = {
+    state: string;
+    type?: string;
+    elementId?: string;
+    kind?: string;
+    listenerEventType?: string;
+    jobKey?: string;
+    creationTime?: string;
+    endTime?: string;
+};
+export type ExecutionLogUserTaskData = {
+    state: string;
+    name?: string;
+    userTaskKey?: string;
+    creationDate?: string;
+    completionDate?: string;
+};
+export type ExecutionLogElementInstanceData = {
+    type?: string;
+    state: string;
+    elementId?: string;
+    elementName?: string;
+    startDate?: string;
+    endDate?: string;
+    elementInstanceKey?: string;
+};
+export type ExecutionLogMessageSubscriptionData = {
+    messageName?: string;
+    elementId?: string;
+    messageSubscriptionState?: string;
+    messageSubscriptionKey?: string;
+};
+export type ExecutionLogStatusEntry = {
+    type: typeof EXECUTION_LOG_ENTRY_TYPE.STATUS;
+    status: ExecutionLogEntryStatus;
+    data?: ExecutionLogStatusEntryData;
+    timestamp: number;
+};
+export type ExecutionLogJobEntry = {
+    type: typeof EXECUTION_LOG_ENTRY_TYPE.JOB;
+    data: ExecutionLogJobData;
+    timestamp: number;
+};
+export type ExecutionLogUserTaskEntry = {
+    type: typeof EXECUTION_LOG_ENTRY_TYPE.USER_TASK;
+    data: ExecutionLogUserTaskData;
+    timestamp: number;
+};
+export type ExecutionLogMessageSubscriptionEntry = {
+    type: typeof EXECUTION_LOG_ENTRY_TYPE.MESSAGE_SUBSCRIPTION;
+    data: ExecutionLogMessageSubscriptionData;
+    timestamp: number;
+};
+export type ExecutionLogElementInstanceEntry = {
+    type: typeof EXECUTION_LOG_ENTRY_TYPE.ELEMENT_INSTANCE;
+    data: ExecutionLogElementInstanceData;
+    timestamp: number;
 };
+export type ExecutionLogEntry = ExecutionLogStatusEntry | ExecutionLogJobEntry | ExecutionLogUserTaskEntry | ExecutionLogMessageSubscriptionEntry | ExecutionLogElementInstanceEntry;
 export type { Element, ModdleElement } from 'bpmn-js/lib/model/Types';
 export type Plugin = {
     priority?: number;
@@ -79,3 +233,4 @@ export type PluginContextValue = {
     unregisterPlugin: (plugin: Plugin) => void;
     getPlugins: (pluginPoint: string) => Plugin[];
 };
+export { CreateProcessInstanceResult, DeploymentResult, ElementInstanceResult, ElementInstanceSearchQueryResult, IncidentResult, IncidentSearchQueryResult, JobSearchQueryResult, JobSearchResult, MessageSubscriptionResult, MessageSubscriptionSearchQueryResult, ProcessInstanceResult, ProcessInstanceSearchQueryResult, SearchQueryResponse, UserTaskResult, UserTaskSearchQueryResult, VariableSearchResult, VariableSearchQueryResult } from '@camunda8/orchestration-cluster-api';

package/dist/types/utils/autocompletion.d.ts

@@ -1,12 +1,12 @@
 /**
- * @typedef {import('@codemirror/autocomplete').Completion} Completion
- * @typedef {import('@codemirror/autocomplete').CompletionContext} CompletionContext
- * @typedef {import('@codemirror/autocomplete').CompletionResult} CompletionResult
+ * @import {
+ *  Completion,
+ *  CompletionContext,
+ *  CompletionResult
+ * } from '@codemirror/autocomplete';
  */
 /**
  * @param {Completion[]} variables
  */
 export function getAutocompletionExtensions(variables: Completion[]): import("@codemirror/state").Extension[];
-export type Completion = import("@codemirror/autocomplete").Completion;
-export type CompletionContext = import("@codemirror/autocomplete").CompletionContext;
-export type CompletionResult = import("@codemirror/autocomplete").CompletionResult;
+import type { Completion } from '@codemirror/autocomplete';

package/dist/types/utils/element.d.ts

@@ -1,11 +1,20 @@
 export function getName(element: any): string;
 export function getType(element: any, injector: any): any;
 export function getConcreteType(element: any): any;
+/**
+ * Check if an element is a child of an ad-hoc subprocess.
+ *
+ * @param {Element} element
+ *
+ * @returns {boolean}
+ */
+export function isInsideAdHocSubProcess(element: Element): boolean;
 /**
  * Get parent process of an element.
  *
- * @param {import('../types').Element} element
+ * @param {Element} element
  *
  * @returns {string|null}
  */
-export function getProcessId(element: import("../types").Element): string | null;
+export function getProcessId(element: Element): string | null;
+import type { Element } from '../types';

package/dist/types/utils/getOperateUrl.d.ts

@@ -1,6 +1,9 @@
 /**
+ * Get Operate URL for a given process instance.
+ *
  * @param {string} operateBaseUrl
  * @param {string} processInstanceKey
- * @returns {string}
+ *
+ * @returns {string|null}
  */
-export function getOperateUrl(operateBaseUrl: string, processInstanceKey: string): string;
+export function getOperateUrl(operateBaseUrl: string, processInstanceKey: string): string | null;

package/dist/types/utils/getTasklistUrl.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get Tasklist URL for a given user task.
+ *
+ * @param {string} tasklistBaseUrl
+ * @param {string} userTaskKey
+ *
+ * @returns {string|null}
+ */
+export function getTasklistUrl(tasklistBaseUrl: string, userTaskKey: string): string | null;

package/dist/types/utils/trimTrailingSlashes.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Trim trailing slashes from a string.
+ *
+ * @example
+ * trimTrailingSlashes('http://example.com/') // => 'http://example.com'
+ * trimTrailingSlashes('http://example.com///') // => 'http://example.com'
+ *
+ * @param {string} string
+ *
+ * @returns {string}
+ */
+export function trimTrailingSlashes(string: string): string;

package/dist/types/utils/variables.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Get scoped variables from raw API response items.
+ *
+ * @param {Array} variableItems
+ * @param {Array} elementInstanceItems
+ * @param {string} processInstanceKey
+ * @param {string} elementId
+ *
+ * @returns {ElementOutputVariables}
+ */
+export function getVariables(variableItems: any[], elementInstanceItems: any[], processInstanceKey: string, elementId: string): ElementOutputVariables;
+/**
+ * Pick variables for a given scope. Variables in legacy format are ignored.
+ *
+ * @param {ElementOutputVariables} variables
+ * @param {string} scope
+ *
+ * @returns {Object}
+ */
+export function pickVariables(variables: ElementOutputVariables, scope: string): any;
+/**
+ * @type {{ LOCAL: 'LOCAL', PROCESS: 'PROCESS' }}
+ */
+export const SCOPES: {
+    LOCAL: "LOCAL";
+    PROCESS: "PROCESS";
+};
+import type { ElementOutputVariables } from '../types';

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@camunda/task-testing",
-  "version": "2.2.0",
+  "version": "3.0.0-0",
   "files": [
     "dist"
   ],
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/camunda/task-testing"
+  },
   "scripts": {
     "all": "run-s lint types test build",
     "open": "open-cli http://localhost:3000",
@@ -34,15 +38,14 @@
     "classnames": "^2.5.1",
     "codemirror": "^6.0.2",
     "events": "^3.3.0",
-    "min-dash": "^4.2.3"
+    "min-dash": "^5.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.28.0",
     "@babel/preset-env": "^7.28.0",
     "@babel/preset-react": "^7.27.1",
-    "@bpmn-io/variable-resolver": "^1.3.6",
+    "@bpmn-io/variable-resolver": "^2.0.0",
     "@camunda8/orchestration-cluster-api": "^8.8.4",
-    "@camunda8/sdk": "^8.8.3",
     "@carbon/icons-react": "^11.62.0",
     "@carbon/react": "^1.76.0",
     "@eslint/js": "^9.31.0",
@@ -50,22 +53,20 @@
     "@testing-library/user-event": "^14.6.1",
     "@types/codemirror": "^5.60.16",
     "@types/react": "^19.1.12",
-    "babel-loader": "^10.0.0",
-    "bpmn-js-element-templates": "^2.15.1",
+    "babel-loader": "^10.1.1",
+    "bpmn-js-element-templates": "^2.22.0",
     "bpmn-js-headless": "^0.1.0",
-    "bpmn-js-properties-panel": "^5.42.3",
-    "camunda-bpmn-js": "^5.14.2",
+    "bpmn-js-properties-panel": "^5.53.0",
+    "camunda-bpmn-js": "^5.24.2",
     "chai": "^4.5.0",
-    "css-loader": "^7.1.2",
+    "css-loader": "^7.1.4",
     "dotenv": "^17.2.1",
     "eslint": "^9.31.0",
     "eslint-plugin-bpmn-io": "^2.2.0",
-    "eslint-plugin-react-hooks": "^5.2.0",
-    "eslint-plugin-react-refresh": "^0.4.20",
     "express": "^5.1.0",
-    "html-webpack-plugin": "^5.6.3",
+    "html-webpack-plugin": "^5.6.6",
     "karma": "^6.4.4",
-    "karma-chrome-launcher": "^3.2.0",
+    "karma-chrome-launcher-2": "^3.3.0",
     "karma-env-preprocessor": "^0.1.1",
     "karma-mocha": "^2.0.1",
     "karma-sinon-chai": "^2.0.2",
@@ -74,18 +75,19 @@
     "npm-run-all2": "^8.0.4",
     "open": "^10.2.0",
     "open-cli": "^8.0.0",
+    "puppeteer": "^24.38.0",
     "raw-loader": "^4.0.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "sass": "^1.89.2",
-    "sass-loader": "^16.0.5",
+    "sass": "^1.97.3",
+    "sass-loader": "^16.0.7",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
     "style-loader": "^4.0.0",
     "typescript": "^5.9.2",
-    "webpack": "^5.100.1",
+    "webpack": "^5.105.4",
     "webpack-cli": "^6.0.1",
-    "webpack-dev-server": "^5.2.2",
+    "webpack-dev-server": "^5.2.3",
     "zeebe-bpmn-moddle": "^1.11.0"
   },
   "peerDependencies": {

package/dist/types/components/Output/OutputVariables.d.ts

@@ -1,20 +0,0 @@
-export function OutputVariables({ isTaskExecuting, output, element }: {
-    isTaskExecuting: any;
-    output: any;
-    element: any;
-}): import("react/jsx-runtime").JSX.Element;
-/**
- * Pick variables for a given scope. Variables in legacy format are ignored.
- *
- * @param {import('../../types').ElementOutputVariables} variables
- * @param {string} scope
- *
- * @returns {Object}
- */
-export function pickVariables(variables: import("../../types").ElementOutputVariables, scope: string): any;
-export function OutputTab({ children, render, label, priority }: {
-    label: string;
-    render?: Function | undefined;
-    children?: React.ReactNode;
-    priority?: number | undefined;
-}): null;