@5minds/processcube_engine_sdk 3.3.0

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

@@ -0,0 +1,215 @@
+import { BpmnType, EventType } from '../../ProcessModel/index';
+import { ProcessToken } from './ProcessToken';
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FlowNodeInstanceList:
+ *       description: A list of FlowNodeInstances.
+ *       type: object
+ *       required:
+ *         - flowNodeInstances
+ *         - totalCount
+ *       properties:
+ *         flowNodeInstances:
+ *           description: The FlowNodeInstances.
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/FlowNodeInstance'
+ *         totalCount:
+ *           description: The total number of FlowNodeInstances.
+ *           type: number
+ */
+export type FlowNodeInstanceList = {
+    flowNodeInstances: Array<FlowNodeInstance>;
+    totalCount: number;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FlowNodeInstance:
+ *       description: A FlowNodeInstance.
+ *       type: object
+ *       required:
+ *         - flowNodeInstanceId
+ *         - flowNodeId
+ *         - flowNodeType
+ *         - state
+ *         - processDefinitionId
+ *         - processModelId
+ *         - processInstanceId
+ *         - correlationId
+ *         - tokens
+ *         - ownerId
+ *       properties:
+ *         flowNodeInstanceId:
+ *           description: The ID of the FlowNodeInstance
+ *           type: string
+ *         flowNodeId:
+ *           description: The ID of the FlowNode
+ *           type: string
+ *         flowNodeName:
+ *           description: The name of the FlowNode
+ *           type: string
+ *         flowNodeLane:
+ *           description: The name of the FlowNode's lane that contains this FlowNodeInstance
+ *           type: string
+ *         flowNodeType:
+ *           description: The BPMN type of the FlowNode
+ *           $ref: '#/components/schemas/BpmnType'
+ *         eventType:
+ *           description: The type of the Event, if this FlowNodeInstance is an Event.
+ *           $ref: '#/components/schemas/EventType'
+ *         previousFlowNodeInstanceId:
+ *           description: The ID of the FlowNodeInstance that was executed before this one.
+ *           type: string
+ *         parentProcessInstanceId:
+ *           description: The ID of the parent ProcessInstance, if this FlowNodeInstance within is a sub process.
+ *           type: string
+ *         state:
+ *           description: The state of the FlowNodeInstance
+ *           $ref: '#/components/schemas/FlowNodeInstanceState'
+ *         processDefinitionId:
+ *           description: The ID of the ProcessDefinition that contains this FlowNodeInstance
+ *           type: string
+ *         processModelId:
+ *           description: The ID of the ProcessModel that contains this FlowNodeInstance
+ *           type: string
+ *         processInstanceId:
+ *           description: The ID of the ProcessInstance that contains this FlowNodeInstance
+ *           type: string
+ *         correlationId:
+ *           description: The ID of the Correlation that contains this FlowNodeInstance
+ *           type: string
+ *         tokens:
+ *           description: The ProcessToken of the FlowNodeInstance
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/ProcessToken'
+ *         ownerId:
+ *           description: The ID of the user that owns this FlowNodeInstance
+ *           type: string
+ *         error:
+ *           description: The error that occured during execution of the FlowNodeInstance (if any).
+ *           type: object
+ *         startedAt:
+ *           description: The date when the FlowNodeInstance was started.
+ *           type: string
+ *         finishedAt:
+ *           description: The date when the FlowNodeInstance was finished.
+ *           type: string
+ *         triggeredByFlowNodeInstance:
+ *           description: The FlowNodeInstance that triggered this FlowNodeInstance (if any).
+ *           $ref: '#/components/schemas/FlowNodeInstance'
+ */
+export type FlowNodeInstance = {
+    /**
+     * The instance ID of this FlowNodeInstance.
+     */
+    flowNodeInstanceId: string;
+    /**
+     * The unique ID of the FlowNode, as it is modelled in the diagram.
+     */
+    flowNodeId: string;
+    /**
+     * Optional: The name of the FlowNode, as it is modelled in the diagram.
+     */
+    flowNodeName?: string;
+    /**
+     * Optional: The lane that this FlowNodeInstance belongs to.
+     * The lane also serves as the IAM claim the user needs to have, in order to access this FlowNodeInstance.
+     */
+    flowNodeLane?: string;
+    /**
+     * Describes the BPMN type of the FlowNode that this instance is executing.
+     */
+    flowNodeType: BpmnType;
+    /**
+     * Optional: If the FlowNodeInstance is an Event, this will contain the type of Event (Message, Signal, Timer, etc).
+     *
+     * If the FlowNodeInstance is a regular Event, this will be undefined.
+     */
+    eventType?: EventType;
+    /**
+     * Optional: Contains the InstanceId of the FlowNodeInstance that was executed before this one.
+     *
+     * StartEvents never have a predecessor.
+     */
+    previousFlowNodeInstanceId?: string;
+    parentProcessInstanceId?: string;
+    state: FlowNodeInstanceState;
+    processDefinitionId: string;
+    processModelId: string;
+    processInstanceId: string;
+    correlationId: string;
+    /**
+     * @deprecated Tokens can now be referenced directly, by use of "startToken" and "endToken".
+     * Use these properties instead.
+     */
+    tokens: Array<ProcessToken>;
+    /**
+     * The token with which the Flow Node Instance was started.
+     */
+    startToken: Record<string, any>;
+    /**
+     * The token with which the Flow Node Instance was finished.
+     * Only available for Flow Node Instances with a "finished", "error" or "terminated" state.
+     */
+    endToken?: Record<string, any>;
+    ownerId: string;
+    error?: Error;
+    startedAt?: Date;
+    finishedAt?: Date;
+    triggeredByFlowNodeInstance?: FlowNodeInstance;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FlowNodeInstanceState:
+ *       description: The state of a FlowNodeInstance.
+ *       type: string
+ *       enum:
+ *         - running
+ *         - suspended
+ *         - finished
+ *         - terminated
+ *         - error
+ *         - canceled
+ */
+export declare enum FlowNodeInstanceState {
+    running = "running",
+    suspended = "suspended",
+    finished = "finished",
+    terminated = "terminated",
+    error = "error",
+    canceled = "canceled"
+}
+export type FlowNodeInstanceMetaInfo = {
+    key: string;
+    value: any;
+};
+export declare enum FlowNodeInstanceSortableColumns {
+    flowNodeInstanceId = "flowNodeInstanceId",
+    flowNodeId = "flowNodeId",
+    flowNodeName = "flowNodeName",
+    flowNodeLane = "flowNodeLane",
+    flowNodeType = "flowNodeType",
+    eventType = "eventType",
+    state = "state",
+    previousFlowNodeInstanceId = "previousFlowNodeInstanceId",
+    parentProcessInstanceId = "parentProcessInstanceId",
+    processDefinitionId = "processDefinitionId",
+    processModelId = "processModelId",
+    processInstanceId = "processInstanceId",
+    correlationId = "correlationId",
+    ownerId = "ownerId",
+    createdAt = "createdAt",
+    finishedAt = "finishedAt",
+    triggeredByFlowNodeInstance = "triggeredByFlowNodeInstance"
+}
+export type FlowNodeInstanceSortSettings = {
+    sortBy: FlowNodeInstanceSortableColumns;
+    sortDir?: 'ASC' | 'DESC';
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Contains information about a FlowNodeInstances result.
+ */
+export type FlowNodeInstanceResult = {
+    flowNodeInstanceId: string;
+    flowNodeId: string;
+    result: any;
+};

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

@@ -0,0 +1,12 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type ManualTaskInstance = FlowNodeInstance & {
+    /**
+     * The ID of the User that finished (aka 'resumed') the Manual Task.
+     * Only applies, if the Manual Task is actually finished.
+     */
+    finishedByUserId?: string;
+};
+export type ManualTaskList = {
+    manualTasks: Array<ManualTaskInstance>;
+    totalCount: number;
+};

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

@@ -0,0 +1,65 @@
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ProcessToken:
+ *       description: A process token describes the state of a FlowNode during a specific point in its life (i.e. onEnter, onExit, etc.).
+ *       deprecated: true
+ *       type: object
+ *       required:
+ *         - flowNodeInstanceId
+ *         - createdAt
+ *         - type
+ *         - payload
+ *       properties:
+ *         flowNodeInstanceId:
+ *           description: The ID of the FlowNodeInstance that this token belongs to.
+ *           type: string
+ *         createdAt:
+ *           description: The point in time at which this token was created.
+ *           type: string
+ *         type:
+ *           description: The type of token.
+ *           $ref: '#/components/schemas/ProcessTokenType'
+ *         payload:
+ *           description: The payload of the token.
+ *           type: object
+ */
+/**
+ * A process token describes the state of a FlowNode during a specific point in its life (i.e. onEnter, onExit, etc.).
+ * @deprecated This type was used in conjunction with the "FlowNodeInstance.tokens" property, which has become obsolete.
+ * To access a FlowNodeInstances tokens, use the new `startToken` and `endToken` properties.
+ */
+export type ProcessToken = {
+    flowNodeInstanceId: string;
+    createdAt: Date;
+    type: ProcessTokenType;
+    payload: any;
+};
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ProcessTokenType:
+ *       description: The type of a process token.
+ *       deprecated: true
+ *       type: string
+ *       enum:
+ *         - onEnter
+ *         - onSuspend
+ *         - onResume
+ *         - onExit
+ */
+/**
+ * Contains definitions for all currently supported types of process tokens.
+ * The type of token determines the point in time at which the token was recorded.
+ *
+ * @deprecated This enum was used in conjunction with the "FlowNodeInstnance.tokens" property, which has become obsolete.
+ * To access a FlowNodeInstances tokens, use the new `startToken` and `endToken` properties.
+ */
+export declare enum ProcessTokenType {
+    onEnter = "onEnter",
+    onSuspend = "onSuspend",
+    onResume = "onResume",
+    onExit = "onExit"
+}

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

@@ -0,0 +1,52 @@
+import { BpmnType, EventType } from '../../ProcessModel/index';
+import { FlowNodeInstanceState } from './FlowNodeInstance';
+type FlowNodeInstanceBaseQuery = {
+    flowNodeId?: Array<string> | string;
+    flowNodeName?: Array<string> | string;
+    flowNodeLane?: Array<string> | string;
+    flowNodeInstanceId?: Array<string> | string;
+    previousFlowNodeInstanceId?: Array<string> | string;
+    processDefinitionId?: Array<string> | string;
+    processModelId?: Array<string> | string;
+    processInstanceId?: Array<string> | string;
+    correlationId?: Array<string> | string;
+    parentProcessInstanceId?: Array<string> | string;
+    state?: Array<FlowNodeInstanceState> | FlowNodeInstanceState;
+    ownerId?: Array<string> | string;
+    triggeredByFlowNodeInstance?: Array<string> | string;
+};
+/**
+ * Query for retrieving all types of Flow Node Instances.
+ */
+export type GenericFlowNodeInstanceQuery = FlowNodeInstanceBaseQuery & {
+    /**
+     * By default, this will include EmptyActivities, ManualTasks and UserTasks.
+     */
+    flowNodeType?: Array<BpmnType> | BpmnType;
+    /**
+     * By default, this will include all types of events.
+     */
+    eventType?: Array<EventType> | EventType;
+};
+/**
+ * Query for retrieving EmptyActivities.
+ */
+export type EmptyActivityQuery = FlowNodeInstanceBaseQuery & {};
+/**
+ * Query for retrieving Events.
+ */
+export type EventQuery = FlowNodeInstanceBaseQuery & {
+    /**
+     * By default, this will include all types of events.
+     */
+    eventType?: Array<EventType> | EventType;
+};
+/**
+ * Query for retrieving ManualTasks.
+ */
+export type ManualTaskQuery = FlowNodeInstanceBaseQuery & {};
+/**
+ * Query for retrieving UserTasks.
+ */
+export type UserTaskQuery = FlowNodeInstanceBaseQuery & {};
+export {};

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

@@ -0,0 +1,12 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+/**
+ * @deprecated This type has been integrated into FlowNodeInstance. Use that type instead.
+ */
+export type ReceiveTaskInstance = FlowNodeInstance & {
+    /**
+     * @deprecated This property is only a stub. Use 'triggeredByFlowNodeInstance' instead.
+     *
+     * The ID of the Send Task that triggered the Receive Task.
+     */
+    sendTaskFlowNodeInstanceId?: string;
+};

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

@@ -0,0 +1,30 @@
+import { ExternalTaskState } from '../ExternalTask/ExternalTask';
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type ServiceTaskInstance = FlowNodeInstance & {
+    /**
+     * If the Service Task is an External Service Task, this will contain information about the corresponding External Task.
+     */
+    externalTaskData?: ExternalTaskData;
+    /**
+     * If the Service Task is an Http Service Task, this will contain information about the corresponding Http request.
+     */
+    httpServiceTaskData?: HttpServiceTaskData;
+};
+export type ExternalTaskData = {
+    externalTaskId: string;
+    topic: string;
+    state: ExternalTaskState;
+    isSingleTry: boolean;
+    payload: any;
+    workerId?: string;
+    lockExpirationTime?: Date;
+    result?: any;
+    error?: any;
+    finishedAt?: Date;
+};
+export type HttpServiceTaskData = {
+    url: string;
+    method: string;
+    body?: any;
+    headers?: Array<Record<string, string>>;
+};

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

@@ -0,0 +1,12 @@
+import { FlowNodeInstance } from './FlowNodeInstance';
+export type SubprocessInstance = FlowNodeInstance & {
+    /**
+     * The ID of the Start Event at which the Subprocess started.
+     */
+    startEventId?: string;
+    /**
+     * The ID of the Process Instance that the Subprocess started.
+     * Only available for Subprocesses that have actually started a Process Instance.
+     */
+    childProcessInstanceId?: string;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * Describes an aggregated TokenHistory.
+ */
+export type TokenHistory = {
+    current: object;
+    history: {
+        [flowNodeId: string]: object;
+    };
+};

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

@@ -0,0 +1,114 @@
+import { FlowNodeInstance } from '../FlowNodeInstance';
+/**
+ * Describes a suspended UserTask.
+ */
+export type UserTaskInstance = FlowNodeInstance & {
+    /**
+     * The ID of the User that reserved the User Task.
+     * Only applies, if the User Task is currently reserved by a user.
+     */
+    actualOwnerId?: string;
+    /**
+     * The ID of the User that finished (aka 'resumed') the User Task.
+     * Only applies, if the User Task is actually finished.
+     */
+    finishedByUserId?: string;
+    /**
+     * Contains the parsed configuration for the User Task, after all Flow Node Expressions have been evaluated.
+     */
+    userTaskConfig: UserTaskConfig;
+    /**
+     * Contains the configuration for the User Task, as it has been modeled on the Flow Node.
+     */
+    userTaskConfigModel: UserTaskConfigModel;
+    /**
+     * Optional: The IDs of the Users that are assigned to the UserTask.
+     */
+    assignedUserIds?: Array<string>;
+};
+/**
+ * Contains information about a UserTasks configuration.
+ */
+export type UserTaskConfig = {
+    /**
+     * Optional: The expression for determining the Users to assign to the User Task.
+     */
+    assignedUserIds?: Array<string>;
+    /**
+     * A list of accessible FormFields for the UserTask.
+     */
+    formFields: Array<UserTaskFormField>;
+    /**
+     * The type of UI control used for the UserTask.
+     */
+    customForm?: string;
+    description?: string;
+    finishedMessage?: string;
+};
+/**
+ * Contains information about a UserTasks configuration.
+ */
+export type UserTaskConfigModel = {
+    /**
+     * Optional: The IDs of the Users that are assigned to the UserTask.
+     */
+    assignedUserIds?: string;
+    /**
+     * A list of accessible FormFields for the UserTask.
+     */
+    formFields: Array<UserTaskFormField>;
+    /**
+     * The type of UI control used for the UserTask.
+     */
+    customForm?: string;
+    description?: string;
+    finishedMessage?: string;
+};
+export type UserTaskFormField = {
+    id: string;
+    type: UserTaskFormFieldType | string;
+    label: string;
+    defaultValue?: string | number | boolean | object;
+    /**
+     * The type of UI control used for the FormField.
+     */
+    customForm?: string;
+    /**
+     * Optional: If the FormField is an enumeration,
+     * this will contain the values for that enumeration.
+     */
+    enumValues?: Array<UserTaskEnumValue>;
+};
+/**
+ * Determines the type of a UserTasks FormField.
+ */
+export declare enum UserTaskFormFieldType {
+    boolean = "boolean",
+    date = "date",
+    enum = "enum",
+    long = "long",
+    number = "number",
+    string = "string"
+}
+/**
+ * If a UserTasks FormField is an enumeration, this will contain information
+ * about the values contained within that enumeration.
+ */
+export type UserTaskEnumValue = {
+    id: string;
+    name: string;
+};
+/**
+ * Describes the result set of a UserTask.
+ * Such a result set usually consists of a collection of FormFields and their assigend values.
+ */
+export type UserTaskResult = {
+    [formFieldId: string]: any;
+};
+/**
+ * Describes a list of UserTasks.
+ */
+export type UserTaskList = {
+    userTasks: Array<UserTaskInstance>;
+    totalCount: number;
+};

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

@@ -0,0 +1,13 @@
+export * from './FlowNodeInstance';
+export * from './FlowNodeInstanceResult';
+export * from './ProcessToken';
+export * from './Queries';
+export * from './TokenHistory';
+export * from './CallActivityInstance';
+export * from './EmptyActivityInstance';
+export * from './EventInstance';
+export * from './ManualTaskInstance';
+export * from './ReceiveTaskInstance';
+export * from './ServiceTaskInstance';
+export * from './SubprocessInstance';
+export * from './UserTaskInstance';

package/dist/DataModels/Iam/Claims.d.ts

@@ -0,0 +1,14 @@
+export declare const claims: {
+    canCreateAnonymousSession: string;
+    canAccessExternalTasks: string;
+    canDeleteProcessModel: string;
+    canManageProcessInstances: string;
+    canReadCronjobHistory: string;
+    canReadProcessModel: string;
+    canRetryProcessInstance: string;
+    canSubscribeToEvents: string;
+    canTerminateProcess: string;
+    canTriggerMessages: string;
+    canTriggerSignals: string;
+    canWriteProcessModel: string;
+};

package/dist/DataModels/Iam/IIamService.d.ts

@@ -0,0 +1,9 @@
+import { Identity } from './Identity';
+export interface IIamService {
+    getAuthorityAddress(): string;
+    ensureHasClaim(identity: Identity, claimName: string, claimValue?: string): Promise<void>;
+    generateDelegationToken(userToken: string): Promise<string>;
+    checkIfUserIsSuperAdmin(identity: Identity): Promise<boolean>;
+    checkIfTokenIsInternalToken(token: string): boolean;
+    checkIfTokenIsRootAccessToken(token: string): boolean;
+}

package/dist/DataModels/Iam/Identity.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Identity:
+ *       description: Contains information about an identity.
+ *       type: object
+ *       required:
+ *         - token
+ *         - userId
+ *       properties:
+ *         token:
+ *           description: The ID of the user to which this identiy belongs.
+ *           type: string
+ *         userId:
+ *           description: The ID of the auth token's owner.
+ *           type: string
+ *         anonymousSessionId:
+ *           description: The ID of an anonymous session.
+ *           type: string
+ */
+/**
+ * Contains information about an identity.
+ */
+export type Identity = {
+    /**
+     * The ID of the user to which this identiy belongs.
+     */
+    token: string;
+    /**
+     * The ID of the auth token's owner.
+     */
+    userId: string;
+    /**
+     * Optional: The ID of an anonymous session.
+     * Should be set, when the auth token belongs to an anonymous user.
+     */
+    anonymousSessionId?: string;
+};

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

@@ -0,0 +1,3 @@
+export * from './Claims';
+export * from './IIamService';
+export * from './Identity';