@5minds/processcube_engine_sdk 3.3.0

package/dist/DataModels/DataObjectInstance.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     DataObjectInstance:
+ *       description: Describes a data object instance.
+ *       type: object
+ *       required:
+ *         - dataObjectId
+ *         - processDefinitionId
+ *         - processModelId
+ *         - processInstanceId
+ *         - flowNodeInstanceId
+ *         - value
+ *         - createdAt
+ *         - updatedAt
+ *       properties:
+ *         dataObjectId:
+ *           description: The ID of the data object
+ *           type: string
+ *         processDefinitionId:
+ *           description: The ID of the process definition that contains the data object
+ *           type: string
+ *         processModelId:
+ *           description: The ID of the process model that contains the data object
+ *           type: string
+ *         processInstanceId:
+ *           description: The ID of the process instance that contains the data object
+ *           type: string
+ *         flowNodeInstanceId:
+ *           description: The ID of the FlowNodeInstance that contains the data object
+ *           type: string
+ *         value:
+ *           description: The value of the data object
+ *           type: object
+ *         createdAt:
+ *           description: The Date the data object instance was created
+ *           type: string
+ *         updatedAt:
+ *           description: The Date the data object instance was last updated
+ *           type: string
+ */
+export declare type DataObjectInstance<TValue extends object> = {
+    dataObjectId: string;
+    processDefinitionId: string;
+    processModelId: string;
+    processInstanceId: string;
+    flowNodeInstanceId: string;
+    value: TValue;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     DataObjectInstanceList:
+ *       description: A list of data object instances.
+ *       type: object
+ *       required:
+ *         - dataObjectInstances
+ *         - totalCount
+ *       properties:
+ *         dataObjectInstances:
+ *           description: The data object instances
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/DataObjectInstance'
+ *         totalCount:
+ *           description: The total number of data object instances
+ *           type: number
+ */
+export declare type DataObjectInstanceList = {
+    dataObjectInstances: Array<DataObjectInstance<object>>;
+    totalCount: number;
+};
+export declare type DataObjectInstanceQuery = {
+    dataObjectId?: Array<string> | string;
+    processDefinitionId?: Array<string> | string;
+    processModelId?: Array<string> | string;
+    processInstanceId?: Array<string> | string;
+    flowNodeInstanceId?: Array<string> | string;
+    createdAt?: Array<Date> | Date;
+};
+export declare enum DataObjectSortableColumns {
+    dataObjectId = "dataObjectId",
+    processDefinitionId = "processDefinitionId",
+    processModelId = "processModelId",
+    processInstanceId = "processInstanceId",
+    flowNodeInstanceId = "flowNodeInstanceId",
+    value = "value",
+    createdAt = "createdAt"
+}
+export declare type DataObjectSortSettings = {
+    sortBy: DataObjectSortableColumns;
+    sortDir?: 'ASC' | 'DESC';
+};

package/dist/DataModels/ExternalTask/ExternalTask.d.ts

@@ -0,0 +1,126 @@
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTask:
+ *       description: Describes an ExternalTask that the Engine has delegated to an ExternalTask worker for processing.
+ *       type: object
+ *       required:
+ *         - id
+ *         - workerId
+ *         - topic
+ *         - isSingleTry
+ *         - flowNodeInstanceId
+ *         - correlationId
+ *         - processDefinitionId
+ *         - processInstanceId
+ *         - ownerId
+ *         - payload
+ *         - lockExpirationTime
+ *         - state
+ *       properties:
+ *         id:
+ *           description: The ID of the ExternalTask.
+ *           type: string
+ *         workerId:
+ *           description: The ID of the worker that has most recently locked the ExternalTask for processing.
+ *           type: string
+ *         topic:
+ *           description: The topic of the ExternalTask.
+ *           type: string
+ *         isSingleTry:
+ *           description: A flag indicating whether or not the ExternalTask is a single try task.
+ *           type: boolean
+ *         flowNodeInstanceId:
+ *           description: The ID of the FlowNodeInstance that the ExternalTask belongs to.
+ *           type: string
+ *         correlationId:
+ *           description: The ID of the Correlation that the ExternalTask belongs to.
+ *           type: string
+ *         processDefinitionId:
+ *           description: The ID of the ProcessDefinition that contains the ExternalTask.
+ *           type: string
+ *         processModelId:
+ *           description: The ID of the ProcessModel that contains the ExternalTask.
+ *           type: string
+ *         processInstanceId:
+ *           description: The ID of the ProcessInstance the ExternalTask belongs to.
+ *           type: string
+ *         ownerId:
+ *           description: The ID of the user that owns the ExternalTask.
+ *           type: string
+ *         payload:
+ *           description: The payload containing all relevant data the worker needs to execute the ExternalTask.
+ *           type: object
+ *         lockExpirationTime:
+ *           description: The lock expiration time. On expiration, the task is released to be processed by other workers. If not set, the ExternalTask is not locked.
+ *           type: string
+ *         state:
+ *           description: The state of the ExternalTask.
+ *           $ref: '#/components/schemas/ExternalTaskState'
+ *         finishedAt:
+ *           description: The date when the ExternalTask was finished.
+ *           type: string
+ *         result:
+ *           description: The result of the ExternalTask.
+ *           type: object
+ *         error:
+ *           description: The error that occurred during processing of the ExternalTask (if any).
+ *           type: object
+ *         createdAt:
+ *           description: The date when the ExternalTask was created.
+ *           type: string
+ */
+/**
+ * Describes an ExternalTask that the Engine has delegated to an
+ * ExternalTask worker for processing.
+ */
+export declare type ExternalTask<TPayload> = {
+    id: string;
+    /**
+     * The ID of the worker that has most recently locked the ExternalTask
+     * for processing.
+     */
+    workerId: string;
+    topic: string;
+    isSingleTry: boolean;
+    flowNodeInstanceId: string;
+    correlationId: string;
+    processDefinitionId: string;
+    processModelId?: string;
+    processInstanceId: string;
+    ownerId: string;
+    /**
+     * The payload containing all relevant data the worker needs to execute the
+     * ExternalTask.
+     */
+    payload: TPayload;
+    /**
+     * The lock expiration time. On expiration, the task is released to
+     * be processed by other workers.
+     * If not set, the ExternalTask is not locked.
+     */
+    lockExpirationTime: Date;
+    state: ExternalTaskState;
+    finishedAt?: Date;
+    result?: any;
+    error?: any;
+    createdAt?: Date;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTaskState:
+ *       description: Describes the state of an ExternalTask.
+ *       type: string
+ *       enum:
+ *         - pending
+ *         - finished
+ *         - expired
+ */
+export declare enum ExternalTaskState {
+    pending = "pending",
+    finished = "finished",
+    expired = "expired"
+}

package/dist/DataModels/ExternalTask/ExternalTaskErrors.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTaskError:
+ *       description: Describes an error that occured while processing an External Task.
+ *       type: object
+ *       required:
+ *         - errorCode
+ *       properties:
+ *         errorCode:
+ *           type: string
+ *           description: The error code of the error.
+ *         errorMessage:
+ *           type: string
+ *           description: The error message of the error.
+ *         errorDetails:
+ *           type: object
+ *           description: Additional information about the error.
+ */
+/**
+ * Describes an error that occured while processing an External Task.
+ */
+export declare class ExternalTaskError {
+    errorCode: string;
+    errorMessage: string;
+    errorDetails: any;
+    constructor(errorCode: string, errorMessage?: string, errorDetails?: any);
+}
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTaskBpmnError:
+ *       description: Describes an error that occured while processing an External Task.
+ *       deprecated: true
+ *       allOf:
+ *         - $ref: '#/components/schemas/ExternalTaskError'
+ */
+/**
+ * @deprecated Use ExternalTaskError instead
+ */
+export declare class ExternalTaskBpmnError extends ExternalTaskError {
+}
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTaskServiceError:
+ *       description: Describes an error that occured while processing an External Task.
+ *       deprecated: true
+ *       allOf:
+ *         - $ref: '#/components/schemas/ExternalTaskError'
+ */
+/**
+ * @deprecated Use ExternalTaskError instead
+ */
+export declare class ExternalTaskServiceError extends ExternalTaskError {
+}
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExternalTaskReusableError:
+ *       description:  A formatted error object representing an ExternalTask error.
+ *       type: object
+ *       required:
+ *         - code
+ *       properties:
+ *         code:
+ *           description: The error code of the error.
+ *           oneOf:
+ *             - type: number
+ *             - type: string
+ *         name:
+ *           description: The name of the error.
+ *           type: string
+ *         message:
+ *           description: The error message of the error.
+ *           type: string
+ *         additionalInformation:
+ *           description: Additional information about the error.
+ *           type: object
+ */
+/**
+ * For internal use only - A formatted error object representing an ExternalTask error.
+ * Can be used by internal services who don't care if we're dealing with a Service- or BPMN error
+ */
+export declare class ExternalTaskReusableError {
+    code: number | string;
+    name?: string;
+    message?: string;
+    additionalInformation?: any;
+}

package/dist/DataModels/ExternalTask/ExternalTaskRequestPayloads.d.ts

@@ -0,0 +1,177 @@
+import { ExternalTaskBpmnError, ExternalTaskError, ExternalTaskServiceError } from './ExternalTaskErrors';
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ExtendLockRequestPayload:
+ *       description: Describes the payload that must be send with a extendLock HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - additionalDuration
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to extend the lock.
+ *           type: string
+ *         additionalDuration:
+ *           description: The additional duration in milliseconds that the lock should be extended.
+ *           type: number
+ */
+/**
+ * Describes the payload that must be send with a extendLock HTTP POST request.
+ */
+export declare type ExtendLockRequestPayload = {
+    workerId: string;
+    additionalDuration: number;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FetchAndLockRequestPayload:
+ *       description: Describes the payload that must be send with a fetchAndLock HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - topicName
+ *         - maxTasks
+ *         - longPollingTimeout
+ *         - lockDuration
+ *         - payloadFilter
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to fetch and lock tasks.
+ *           type: string
+ *         topicName:
+ *           description: The topic of the tasks to fetch and lock.
+ *           oneOf:
+ *             - type: string
+ *             - type: array
+ *               items:
+ *                 type: string
+ *         maxTasks:
+ *           description: The maximum number of tasks to fetch and lock.
+ *           type: number
+ *         longPollingTimeout:
+ *           description: The timeout for the long polling request.
+ *           type: number
+ *         lockDuration:
+ *           description: The duration for which the tasks should be locked.
+ *           type: number
+ *         payloadFilter:
+ *           description: A filter for the payload of the tasks.
+ *           type: string
+ */
+/**
+ * Describes the payload that must be send with a fetchAndLock HTTP POST request.
+ */
+export declare type FetchAndLockRequestPayload = {
+    workerId: string;
+    topicName: string | Array<string>;
+    maxTasks: number;
+    longPollingTimeout: number;
+    lockDuration: number;
+    payloadFilter: string;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FinishExternalTaskRequestPayload:
+ *       description: Describes the payload that must be send with a finishExternalTask HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - result
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to finish the task.
+ *           type: string
+ *         result:
+ *           description: The result of the task.
+ *           type: object
+ *           example:
+ *             foo: bar
+ */
+/**
+ * Describes the payload that must be send with a finishExternalTask HTTP POST request.
+ */
+export declare type FinishExternalTaskRequestPayload<TResult> = {
+    workerId: string;
+    result: TResult;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     HandleExternalTaskErrorRequestPayload:
+ *       description: Describes the payload that must be send with a handleExternalTaskError HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - bpmnError
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to handle the BPMN error.
+ *           type: string
+ *         error:
+ *           description: The error to handle.
+ *           $ref: '#/components/schemas/ExternalTaskError'
+ */
+/**
+ * Describes the payload that must be send with a handleExternalTaskError HTTP POST request.
+ */
+export declare type HandleExternalTaskErrorRequestPayload = {
+    workerId: string;
+    error: ExternalTaskError;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     HandleBpmnErrorRequestPayload:
+ *       description: Describes the payload that must be send with a handleBpmnError HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - bpmnError
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to handle the BPMN error.
+ *           type: string
+ *         bpmnError:
+ *           description: The BPMN error to handle.
+ *           $ref: '#/components/schemas/ExternalTaskBpmnError'
+ */
+/**
+ * Describes the payload that must be send with a handleBpmnError HTTP POST request.
+ */
+export declare type HandleBpmnErrorRequestPayload = {
+    workerId: string;
+    bpmnError: ExternalTaskBpmnError;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     HandleServiceErrorRequestPayload:
+ *       description: Describes the payload that must be send with a handleServiceError HTTP POST request.
+ *       type: object
+ *       required:
+ *         - workerId
+ *         - bpmnError
+ *       properties:
+ *         workerId:
+ *           description: The ID of the worker that wants to handle the BPMN error.
+ *           type: string
+ *         bpmnError:
+ *           description: The BPMN error to handle.
+ *           $ref: '#/components/schemas/ExternalTaskServiceError'
+ */
+/**
+ * Describes the payload that must be send with a handleServiceError HTTP POST request.
+ */
+export declare type HandleServiceErrorRequestPayload = {
+    workerId: string;
+    error: ExternalTaskServiceError;
+};

package/dist/DataModels/ExternalTask/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ExternalTask';
+export * from './ExternalTaskErrors';
+export * from './ExternalTaskRequestPayloads';

package/dist/DataModels/FlowNodeInstance/CallActivityInstance.d.ts

@@ -0,0 +1,16 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type CallActivityInstance = FlowNodeInstance & {
+    /**
+     * The ID of the Process Model that the Call Activity should start.
+     */
+    targetProcessModelId?: string;
+    /**
+     * The ID of the Start Event at which the Call Activity should start the target process.
+     */
+    startEventId?: string;
+    /**
+     * The ID of the Process Instance that the Call Activity started.
+     * Only available for CallActivites that have actually started a Process Instance.
+     */
+    childProcessInstanceId?: string;
+};

package/dist/DataModels/FlowNodeInstance/EmptyActivityInstance.d.ts

@@ -0,0 +1,9 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type EmptyActivityList = {
+    emptyActivities: Array<EmptyActivityInstance>;
+    totalCount: number;
+};
+/**
+ * Describes an Empty Activity.
+ */
+export type EmptyActivityInstance = FlowNodeInstance & {};

package/dist/DataModels/FlowNodeInstance/EventInstance.d.ts

@@ -0,0 +1,22 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type EventList = {
+    events: Array<EventInstance>;
+    totalCount: number;
+};
+export type EventInstance = FlowNodeInstance & {
+    /**
+     * The name of the event that this FlowNodeIntance is waiting for.
+     */
+    eventName: string;
+    /**
+     * Optional: The Correlation ID used by all Process Instances started by the Event.
+     * Throw- and End- Events only.
+     */
+    customCorrelationId?: string;
+    /**
+     * Optional: Contains the computed value of the triggerValueInToken expression from the model.
+     * If set, the Flow Node Instance will only continue, if the given value matches the triggerValue of the incoming message or signal.
+     * Start-, Boundary- and Catch- Events only.
+     */
+    triggerValue?: string;
+};