@5minds/processcube_engine_sdk 6.0.0-feature-914fda-m02hzed8 → 6.0.0-feature-38d53c-m0app9er

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/DataModels/Correlation.d.ts +1 -0
  2. package/dist/DataModels/ExternalTask/ExternalTask.d.ts +2 -1
  3. package/dist/DataModels/ExternalTask/ExternalTaskRequestPayloads.d.ts +1 -0
  4. package/dist/DataModels/FlowNodeInstance/FlowNodeInstance.d.ts +9 -15
  5. package/dist/DataModels/Iam/Identity.d.ts +6 -0
  6. package/dist/DataModels/ProcessInstance/ProcessInstance.d.ts +14 -12
  7. package/dist/DataModels/ProcessInstance/ProcessInstanceQuery.d.ts +2 -0
  8. package/dist/DataModels/ProcessInstance/ProcessStartOptions.d.ts +20 -13
  9. package/dist/Engine.d.ts +5 -2
  10. package/dist/EngineEvents/EngineEvent.d.ts +3 -1
  11. package/dist/EngineEvents/EventPayloads/BaseMessage.d.ts +7 -6
  12. package/dist/EngineEvents/EventPayloads/ExternalTaskMessages.d.ts +2 -3
  13. package/dist/ExtensionAdapter/EventExtensionAdapter.d.ts +2 -0
  14. package/dist/ProcessModel/Model/Activities/ReceiveTask.d.ts +2 -1
  15. package/dist/ProcessModel/Model/Activities/SendTask.d.ts +2 -1
  16. package/dist/ProcessModel/Model/Constants.d.ts +36 -0
  17. package/dist/ProcessModel/Model/Events/MessageEvents.d.ts +3 -1
  18. package/dist/ProcessModel/ViewModel/Activities/ReceiveTaskViewModel.d.ts +2 -0
  19. package/dist/ProcessModel/ViewModel/Activities/SendTaskViewModel.d.ts +2 -0
  20. package/dist/ProcessModel/ViewModel/Events/BoundaryEventViewModel.d.ts +2 -0
  21. package/dist/ProcessModel/ViewModel/Events/EndEventViewModel.d.ts +2 -0
  22. package/dist/ProcessModel/ViewModel/Events/IntermediateCatchEventViewModel.d.ts +2 -0
  23. package/dist/ProcessModel/ViewModel/Events/IntermediateThrowEventViewModel.d.ts +2 -0
  24. package/dist/ProcessModel/ViewModel/Events/StartEventViewModel.d.ts +2 -0
  25. package/dist/ProcessModel/ViewModel/FlowNodeViewModel.d.ts +3 -4
  26. package/dist/commonjs/DataModels/Correlation.js.map +1 -1
  27. package/dist/commonjs/DataModels/ExternalTask/ExternalTask.js +1 -1
  28. package/dist/commonjs/DataModels/ExternalTask/ExternalTask.js.map +1 -1
  29. package/dist/commonjs/DataModels/FlowNodeInstance/FlowNodeInstance.js.map +1 -1
  30. package/dist/commonjs/DataModels/ProcessInstance/ProcessInstance.js.map +1 -1
  31. package/dist/commonjs/DataModels/ProcessInstance/ProcessInstanceQuery.js +1 -0
  32. package/dist/commonjs/DataModels/ProcessInstance/ProcessInstanceQuery.js.map +1 -1
  33. package/dist/commonjs/DataModels/ProcessInstance/ProcessStartOptions.js +11 -4
  34. package/dist/commonjs/DataModels/ProcessInstance/ProcessStartOptions.js.map +1 -1
  35. package/dist/commonjs/Engine.js.map +1 -1
  36. package/dist/commonjs/EngineEvents/EngineEvent.js +1 -0
  37. package/dist/commonjs/EngineEvents/EngineEvent.js.map +1 -1
  38. package/dist/commonjs/ProcessModel/Model/Constants.js +39 -1
  39. package/dist/commonjs/ProcessModel/Model/Constants.js.map +1 -1
  40. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/ReceiveTaskParser.js +3 -0
  41. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/ReceiveTaskParser.js.map +1 -1
  42. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/SendTaskParser.js +2 -0
  43. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/SendTaskParser.js.map +1 -1
  44. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/EventParser.js +20 -3
  45. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/EventParser.js.map +1 -1
  46. package/dist/commonjs/ProcessModel/ViewModel/Activities/ReceiveTaskViewModel.js +2 -0
  47. package/dist/commonjs/ProcessModel/ViewModel/Activities/ReceiveTaskViewModel.js.map +1 -1
  48. package/dist/commonjs/ProcessModel/ViewModel/Activities/SendTaskViewModel.js +2 -0
  49. package/dist/commonjs/ProcessModel/ViewModel/Activities/SendTaskViewModel.js.map +1 -1
  50. package/dist/commonjs/ProcessModel/ViewModel/Events/BoundaryEventViewModel.js +2 -0
  51. package/dist/commonjs/ProcessModel/ViewModel/Events/BoundaryEventViewModel.js.map +1 -1
  52. package/dist/commonjs/ProcessModel/ViewModel/Events/EndEventViewModel.js +2 -0
  53. package/dist/commonjs/ProcessModel/ViewModel/Events/EndEventViewModel.js.map +1 -1
  54. package/dist/commonjs/ProcessModel/ViewModel/Events/IntermediateCatchEventViewModel.js +2 -0
  55. package/dist/commonjs/ProcessModel/ViewModel/Events/IntermediateCatchEventViewModel.js.map +1 -1
  56. package/dist/commonjs/ProcessModel/ViewModel/Events/IntermediateThrowEventViewModel.js +2 -0
  57. package/dist/commonjs/ProcessModel/ViewModel/Events/IntermediateThrowEventViewModel.js.map +1 -1
  58. package/dist/commonjs/ProcessModel/ViewModel/Events/StartEventViewModel.js +2 -0
  59. package/dist/commonjs/ProcessModel/ViewModel/Events/StartEventViewModel.js.map +1 -1
  60. package/dist/commonjs/ProcessModel/ViewModel/FlowNodeViewModel.js +2 -3
  61. package/dist/commonjs/ProcessModel/ViewModel/FlowNodeViewModel.js.map +1 -1
  62. package/dist/commonjs/ProcessModel/ViewModel/FlowNodeViewModelFactory.js +21 -21
  63. package/dist/commonjs/ProcessModel/ViewModel/FlowNodeViewModelFactory.js.map +1 -1
  64. package/dist/index.d.ts +1 -0
  65. package/package.json +1 -1
@@ -50,6 +50,7 @@ export declare type CorrelationMetadata = {
50
50
  * description: The id of the correlation.
51
51
  * type: string
52
52
  * metadata:
53
+ * description: Metadata for the correlation.
53
54
  * $ref: '#/components/schemas/CorrelationMetadata'
54
55
  * processInstances:
55
56
  * description: The process instances that run in the context of this correlation.
@@ -56,6 +56,7 @@
56
56
  * 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.
57
57
  * type: string
58
58
  * state:
59
+ * description: The state of the ExternalTask.
59
60
  * $ref: '#/components/schemas/ExternalTaskState'
60
61
  * finishedAt:
61
62
  * description: The date when the ExternalTask was finished.
@@ -111,7 +112,7 @@ export declare type ExternalTask<TPayload> = {
111
112
  * components:
112
113
  * schemas:
113
114
  * ExternalTaskState:
114
- * description: The state of the ExternalTask.
115
+ * description: Describes the state of an ExternalTask.
115
116
  * type: string
116
117
  * enum:
117
118
  * - pending
@@ -115,6 +115,7 @@ export declare type FinishExternalTaskRequestPayload<TResult> = {
115
115
  * description: The ID of the worker that wants to handle the BPMN error.
116
116
  * type: string
117
117
  * error:
118
+ * description: The error to handle.
118
119
  * $ref: '#/components/schemas/ExternalTaskError'
119
120
  */
120
121
  /**
@@ -55,13 +55,11 @@ export type FlowNodeInstanceList = {
55
55
  * description: The name of the FlowNode's lane that contains this FlowNodeInstance
56
56
  * type: string
57
57
  * flowNodeType:
58
- * allOf:
59
- * - $ref: '#/components/schemas/BpmnType'
60
- * - description: The BPMN type of the FlowNode
58
+ * description: The BPMN type of the FlowNode
59
+ * $ref: '#/components/schemas/BpmnType'
61
60
  * eventType:
62
- * allOf:
63
- * - $ref: '#/components/schemas/EventType'
64
- * - description: The type of the Event, if this FlowNodeInstance is an Event
61
+ * description: The type of the Event, if this FlowNodeInstance is an Event
62
+ * $ref: '#/components/schemas/EventType'
65
63
  * previousFlowNodeInstanceId:
66
64
  * description: The ID of the FlowNodeInstance that was executed before this one
67
65
  * type: string
@@ -69,6 +67,7 @@ export type FlowNodeInstanceList = {
69
67
  * description: The ID of the parent ProcessInstance, if this FlowNodeInstance within is a sub process
70
68
  * type: string
71
69
  * state:
70
+ * description: The state of the FlowNodeInstance
72
71
  * $ref: '#/components/schemas/FlowNodeInstanceState'
73
72
  * processDefinitionId:
74
73
  * description: The ID of the ProcessDefinition that contains this FlowNodeInstance
@@ -84,14 +83,10 @@ export type FlowNodeInstanceList = {
84
83
  * type: string
85
84
  * startToken:
86
85
  * description: The token with which the Flow Node Instance started
87
- * type: object
88
- * additionalProperties:
89
- * type: any
86
+ * type: Record<string, any>
90
87
  * endToken:
91
88
  * description: The token with which the Flow Node Instance finished
92
- * type: object
93
- * additionalProperties:
94
- * type: any
89
+ * type: Record<string, any>
95
90
  * ownerId:
96
91
  * description: The ID of the user that owns this FlowNodeInstance
97
92
  * type: string
@@ -105,9 +100,8 @@ export type FlowNodeInstanceList = {
105
100
  * description: The date when the FlowNodeInstance was finished
106
101
  * type: string
107
102
  * triggeredByFlowNodeInstance:
108
- * allOf:
109
- * - $ref: '#/components/schemas/FlowNodeInstance'
110
- * - description: The FlowNodeInstance that triggered this FlowNodeInstance (if any)
103
+ * description: The FlowNodeInstance that triggered this FlowNodeInstance (if any)
104
+ * $ref: '#/components/schemas/FlowNodeInstance'
111
105
  */
112
106
  export type FlowNodeInstance = {
113
107
  /**
@@ -36,4 +36,10 @@ export type Identity = {
36
36
  * Should be set, when the auth token belongs to an anonymous user.
37
37
  */
38
38
  anonymousSessionId?: string;
39
+ /**
40
+ * Lists the claims contained with the identity.
41
+ */
42
+ claims: {
43
+ [key: string]: boolean;
44
+ };
39
45
  };
@@ -58,6 +58,9 @@ export declare type ProcessInstanceList = {
58
58
  * processModelName:
59
59
  * description: The name of the executed process model.
60
60
  * type: string
61
+ * processModelVersion:
62
+ * description: The version of the executed process model.
63
+ * type: string
61
64
  * parentProcessInstanceId:
62
65
  * description: The id of the parent process instance, if this process instance is a sub process.
63
66
  * type: string
@@ -68,6 +71,7 @@ export declare type ProcessInstanceList = {
68
71
  * description: The xml of the used process model.
69
72
  * type: string
70
73
  * state:
74
+ * description: The state of the process instance.
71
75
  * $ref: '#/components/schemas/ProcessInstanceState'
72
76
  * error:
73
77
  * description: The error that occured during execution of the process instance (if any).
@@ -100,9 +104,8 @@ export declare type ProcessInstanceList = {
100
104
  * description: The id of the start event that started the process instance.
101
105
  * type: string
102
106
  * startEventType:
103
- * allOf:
104
- * - $ref: '#/components/schemas/EventType'
105
- * - description: The type of the start event that started the process instance.
107
+ * description: The type of the start event that started the process instance.
108
+ * $ref: '#/components/schemas/EventType'
106
109
  * startToken:
107
110
  * description: The token that was used to start the process instance
108
111
  * type: object
@@ -110,22 +113,20 @@ export declare type ProcessInstanceList = {
110
113
  * description: The id of the end event that ended the process instance (if ended).
111
114
  * type: string
112
115
  * endEventType:
113
- * allOf:
114
- * - $ref: '#/components/schemas/EventType'
115
- * - description: The type of the end event that ended the process instance (if ended).
116
+ * description: The type of the end event that ended the process instance (if ended).
117
+ * $ref: '#/components/schemas/EventType'
116
118
  * endToken:
117
119
  * description: The token that reached the end event (if ended).
118
120
  * type: object
119
121
  * metadata:
122
+ * description: The metadata of the process instance.
120
123
  * $ref: '#/components/schemas/ProcessInstanceMetadata'
121
124
  * correlation:
122
- * allOf:
123
- * - $ref: '#/components/schemas/Correlation'
124
- * - description: The correlation in whichs context the process instance runs.
125
+ * description: The correlation in whichs context the process instance runs.
126
+ * $ref: '#/components/schemas/Correlation'
125
127
  * triggeredByFlowNodeInstance:
126
- * allOf:
127
- * - $ref: '#/components/schemas/FlowNodeInstance'
128
- * - description: The FlowNodeInstance that triggered the process instance (if any).
128
+ * description: The FlowNodeInstance that triggered the process instance (if any).
129
+ * $ref: '#/components/schemas/FlowNodeInstance'
129
130
  */
130
131
  export declare type ProcessInstance = {
131
132
  correlationId: string;
@@ -133,6 +134,7 @@ export declare type ProcessInstance = {
133
134
  processDefinitionId: string;
134
135
  processModelId: string;
135
136
  processModelName?: string;
137
+ processModelVersion?: string;
136
138
  parentProcessInstanceId?: string;
137
139
  hash: string;
138
140
  xml?: string;
@@ -63,6 +63,7 @@ export type ProcessInstanceQuery = {
63
63
  processModelId?: Array<string> | string | SearchQuery;
64
64
  processModelName?: Array<string> | string | SearchQuery;
65
65
  processModelHash?: Array<string> | string | SearchQuery;
66
+ processModelVersion?: Array<string> | string | SearchQuery;
66
67
  ownerId?: Array<string> | string | SearchQuery;
67
68
  startedByRootAccessToken?: boolean;
68
69
  anonymousSessionId?: Array<string> | string | SearchQuery;
@@ -96,6 +97,7 @@ export declare enum ProcessInstanceSortableColumns {
96
97
  processDefinitionId = "processDefinitionId",
97
98
  processModelId = "processModelId",
98
99
  processModelName = "processModelName",
100
+ processModelVersion = "processModelVersion",
99
101
  processModelHash = "processModelHash",
100
102
  ownerId = "ownerId",
101
103
  startedByRootAccessToken = "startedByRootAccessToken",
@@ -3,11 +3,18 @@
3
3
  * components:
4
4
  * schemas:
5
5
  * StartCallbackType:
6
+ * description: The type of callback to use for a ProcessInstance start.
6
7
  * type: integer
7
- * enum:
8
- * - 1
9
- * - 2
10
- * - 3
8
+ * oneOf:
9
+ * - title: CallbackOnProcessInstanceCreated
10
+ * const: 1
11
+ * description: The Engine will resolve immediately after the ProcessInstance was started.
12
+ * - title: CallbackOnProcessInstanceFinished
13
+ * const: 2
14
+ * description: The Engine will resolve after the first EndEvent was reached.
15
+ * - title: CallbackOnEndEventReached
16
+ * const: 3
17
+ * description: The Engine will resolve after a specific EndEvent was reached.
11
18
  */
12
19
  /**
13
20
  * Determines when the Engine will resolve after a new ProcessInstance was started.
@@ -33,7 +40,12 @@ export declare enum StartCallbackType {
33
40
  * ProcessStartOptions:
34
41
  * description: The options to use for starting a ProcessInstance.
35
42
  * type: object
43
+ * required:
44
+ * - processModelId
36
45
  * properties:
46
+ * processModelId:
47
+ * description: The ID of the ProcessModel to start.
48
+ * type: string
37
49
  * startEventId:
38
50
  * description: The ID of a StartEvent at which the ProcessInstance should start.
39
51
  * type: string
@@ -79,15 +91,10 @@ export declare type ProcessStartOptions<TToken extends Record<string, any>> = {
79
91
  * - type: object
80
92
  * properties:
81
93
  * returnOn:
82
- * allOf:
83
- * - $ref: '#/components/schemas/StartCallbackType'
84
- * - description: |
85
- * Determines when the Engine will resolve, after a new request for starting a ProcessInstance was made.
86
- * **Note**: If "CallbackOnEndEventReached" is selected, "endEventId" is no longer optional!
87
- *
88
- * - **CallbackOnProcessInstanceCreated (1):** The Engine will resolve immediately after the ProcessInstance was started.
89
- * - **CallbackOnProcessInstanceFinished (2):** The Engine will resolve after the first EndEvent was reached.
90
- * - **CallbackOnEndEventReached (3):** The Engine will resolve after a specific EndEvent was reached.
94
+ * description: |
95
+ * Determines when the Engine will resolve, after a new request for starting a ProcessInstance was made.
96
+ * Note: If "CallbackOnEndEventReached" is selected, "endEventId" is no longer optional!
97
+ * $ref: '#/components/schemas/StartCallbackType'
91
98
  * endEventId:
92
99
  * description: The ID of an EndEvent that should be awaited. Must be provided, of "returnOn" is set to "CallbackOnEndEventReached".
93
100
  * type: string
package/dist/Engine.d.ts CHANGED
@@ -4,6 +4,7 @@ import { Identity } from './DataModels/Iam/index';
4
4
  import { EngineEventType, MiddlewareCallback } from './EngineEvents/index';
5
5
  import { IApplicationInfoExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
6
6
  import { EventViewModel, FlowNodeViewModel } from './ProcessModel/index';
7
+ import { TargetSystemType } from './ProcessModel/index';
7
8
  /**
8
9
  * Describes the onLoad function, which can be exported by an extension.
9
10
  * It will be called by the Engine on startup.
@@ -269,9 +270,10 @@ export type Engine = {
269
270
  * @param processInstanceId Optional: The ID of the ProcessInstance on which to trigger the message event.
270
271
  * @param identity Optional: The requesting users identity.
271
272
  * @param correlationId Optional: The ID of a correlation to which the message should belong.
273
+ * @param targetSystemType Optional: The targetsystem type to which the message is being sent.
272
274
  * @returns A guid to identify the corresponding acknowledgement event.
273
275
  */
274
- triggerMessageEvent: <TPayload extends object>(messageName: string, payload?: TPayload, processInstanceId?: string, identity?: Identity, correlationId?: string) => Promise<string>;
276
+ triggerMessageEvent: <TPayload extends object>(messageName: string, payload?: TPayload, processInstanceId?: string, identity?: Identity, correlationId?: string, targetSystemType?: TargetSystemType) => Promise<string>;
275
277
  /**
276
278
  * Triggers a message start event.
277
279
  *
@@ -280,9 +282,10 @@ export type Engine = {
280
282
  * @param payload Optional: The payload with which to trigger the message.
281
283
  * @param identity Optional: The requesting users identity.
282
284
  * @param correlationId Optional: The ID of a correlation to which the message should belong.
285
+ * @param targetSystemType Optional: The targetsystem type to which the message is being sent.
283
286
  * @returns A guid to identify the corresponding acknowledgement event.
284
287
  */
285
- triggerMessageStartEvent: <TPayload extends object>(messageName: string, payload?: TPayload, identity?: Identity, correlationId?: string) => Promise<string>;
288
+ triggerMessageStartEvent: <TPayload extends object>(messageName: string, payload?: TPayload, identity?: Identity, correlationId?: string, targetSystemType?: TargetSystemType) => Promise<string>;
286
289
  /**
287
290
  * Triggers a signal event.
288
291
  *
@@ -1,4 +1,4 @@
1
- import { RuntimeExpressionParameters } from '..';
1
+ import { RuntimeExpressionParameters, TargetSystemType } from '..';
2
2
  import { BaseElementViewModel, BpmnType } from '../ProcessModel/index';
3
3
  export declare enum LogLevel {
4
4
  trace = "trace",
@@ -35,6 +35,7 @@ export declare type EngineEvent = {
35
35
  logLevel: LogLevel;
36
36
  tokenPayload?: object;
37
37
  eventId?: string;
38
+ targetSystemType?: TargetSystemType;
38
39
  };
39
40
  export declare type EngineEventContext = FlowNodeExpressionEngineEventContext | undefined;
40
41
  export declare type FlowNodeExpressionEngineEventContext = {
@@ -47,6 +48,7 @@ export declare type FlowNodeExpressionEngineEventContext = {
47
48
  export declare enum EngineEventType {
48
49
  OnActivityError = "OnActivityError",
49
50
  OnEventProcessed = "OnEventProcessed",
51
+ OnMessageTriggered = "OnMessageTriggered",
50
52
  OnProcessDeployed = "OnProcessDeployed",
51
53
  OnProcessUndeployed = "OnProcessUndeployed",
52
54
  OnProcessStarting = "OnProcessStarting",
@@ -26,6 +26,9 @@ import { BpmnType, EventType } from '../../ProcessModel/index';
26
26
  * processModelName:
27
27
  * description: The name of the ProcessModel that the event belongs to.
28
28
  * type: string
29
+ * processModelVersion:
30
+ * description: The version of the ProcessModel that the event belongs to.
31
+ * type: string
29
32
  * processInstanceId:
30
33
  * description: The ID of the ProcessInstance that the event belongs to.
31
34
  * type: string
@@ -39,9 +42,8 @@ import { BpmnType, EventType } from '../../ProcessModel/index';
39
42
  * description: The name of the FlowNode that the event belongs to.
40
43
  * type: string
41
44
  * flowNodeType:
42
- * allOf:
43
- * - $ref: '#/components/schemas/BpmnType'
44
- * - description: The BPMN type of the FlowNode that the event belongs to.
45
+ * description: The BPMN type of the FlowNode that the event belongs to.
46
+ * $ref: '#/components/schemas/BpmnType'
45
47
  * flowNodeInstanceId:
46
48
  * description: The ID of the FlowNodeInstance that the event belongs to.
47
49
  * type: string
@@ -56,9 +58,7 @@ import { BpmnType, EventType } from '../../ProcessModel/index';
56
58
  * type: object
57
59
  * eventType:
58
60
  * description: The type of the event.
59
- * allOf:
60
- * - $ref: '#/components/schemas/EventType'
61
- * - description: The type of the event.
61
+ * $ref: '#/components/schemas/EventType'
62
62
  * eventName:
63
63
  * description: The name of the event.
64
64
  * type: string
@@ -74,6 +74,7 @@ export type EventMessage = {
74
74
  processDefinitionId: string;
75
75
  processModelId: string;
76
76
  processModelName?: string;
77
+ processModelVersion?: string;
77
78
  processInstanceId: string;
78
79
  parentProcessInstanceId?: string;
79
80
  flowNodeId?: string;
@@ -127,9 +127,8 @@ export type ExternalTaskExpiredMessage = ExternalTaskCreatedMessage & {
127
127
  * - error
128
128
  * properties:
129
129
  * error:
130
- * allOf:
131
- * - $ref: '#/components/schemas/ExternalTaskReusableError'
132
- * - description: The error that occurred.
130
+ * description: The error that occurred.
131
+ * $ref: '#/components/schemas/ExternalTaskReusableError'
133
132
  */
134
133
  /**
135
134
  * Encapsulates a payload that is used when sending an event for finishing an External Task with an error result.
@@ -1,3 +1,4 @@
1
+ import { TargetSystemType } from '../ProcessModel/Model';
1
2
  import { DataModels, Identity, Messages, Subscription } from '../index';
2
3
  type EventList = DataModels.FlowNodeInstances.EventList;
3
4
  export interface IEventExtensionAdapter {
@@ -11,6 +12,7 @@ export interface IEventExtensionAdapter {
11
12
  processInstanceId?: string;
12
13
  payload?: TPayload;
13
14
  identity?: Identity;
15
+ targetSystemType?: TargetSystemType;
14
16
  }): Promise<void>;
15
17
  triggerSignalEvent<TPayload>(signalName: string, options?: {
16
18
  processInstanceId?: string;
@@ -1,4 +1,4 @@
1
- import { BpmnType, EventType } from '../Constants';
1
+ import { BpmnType, EventType, SourceSystemType } from '../Constants';
2
2
  import { MessageEventDefinition } from '../Events/index';
3
3
  import { Activity } from './ActivityBase';
4
4
  /**
@@ -10,6 +10,7 @@ import { Activity } from './ActivityBase';
10
10
  export type ReceiveTask = Activity & {
11
11
  readonly bpmnType: BpmnType.receiveTask;
12
12
  readonly eventType: EventType;
13
+ sourceSystemType: SourceSystemType;
13
14
  /**
14
15
  * This is the user defined Message which is expected by this ReceiveTask.
15
16
  */
@@ -1,4 +1,4 @@
1
- import { BpmnType, EventType } from '../Constants';
1
+ import { BpmnType, EventType, TargetSystemType } from '../Constants';
2
2
  import { MessageEventDefinition } from '../Events/index';
3
3
  import { Activity } from './ActivityBase';
4
4
  /**
@@ -10,6 +10,7 @@ import { Activity } from './ActivityBase';
10
10
  export type SendTask = Activity & {
11
11
  readonly bpmnType: BpmnType.sendTask;
12
12
  readonly eventType: EventType;
13
+ targetSystemType: TargetSystemType;
13
14
  /**
14
15
  * The message that should be send.
15
16
  ‚ */
@@ -82,3 +82,39 @@ export declare enum EventType {
82
82
  terminateEvent = "terminateEvent",
83
83
  timerEvent = "timerEvent"
84
84
  }
85
+ /**
86
+ * @swagger
87
+ * components:
88
+ * schemas:
89
+ * TargetSystemType:
90
+ * description: The desired target system type of a message.
91
+ * type: string
92
+ * enum:
93
+ * - internal
94
+ * - external
95
+ */
96
+ /**
97
+ * Contains a list of all target system types for messages.
98
+ */
99
+ export declare enum TargetSystemType {
100
+ internal = "internal",
101
+ external = "external"
102
+ }
103
+ /**
104
+ * @swagger
105
+ * components:
106
+ * schemas:
107
+ * SourceSystemType:
108
+ * description: The desired source system type of a message.
109
+ * type: string
110
+ * enum:
111
+ * - internal
112
+ * - external
113
+ */
114
+ /**
115
+ * Contains a list of all source system types for messages.
116
+ */
117
+ export declare enum SourceSystemType {
118
+ internal = "internal",
119
+ external = "external"
120
+ }
@@ -1,4 +1,4 @@
1
- import { EventType } from '../Constants';
1
+ import { EventType, SourceSystemType, TargetSystemType } from '../Constants';
2
2
  import { BoundaryEvent, EndEvent, Event, EventDefinition, IntermediateCatchEvent, IntermediateThrowEvent, StartEvent } from './EventBase';
3
3
  /**
4
4
  * Describes a global BPMN Message object.
@@ -20,6 +20,8 @@ export type MessageEventDefinition = EventDefinition & {
20
20
  export type MessageEvent = Event & {
21
21
  readonly eventType: EventType.messageEvent;
22
22
  messageEventDefinition: MessageEventDefinition;
23
+ sourceSystemType?: SourceSystemType;
24
+ targetSystemType?: TargetSystemType;
23
25
  };
24
26
  export type MessageBoundaryEvent = BoundaryEvent & MessageEvent;
25
27
  export type MessageStartEvent = StartEvent & MessageEvent;
@@ -1,8 +1,10 @@
1
+ import { SourceSystemType } from '../../Model';
1
2
  import { ReceiveTask } from '../../Model/Activities/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { ActivityViewModel } from './ActivityViewModel';
4
5
  export declare class ReceiveTaskViewModel extends ActivityViewModel {
5
6
  messageName?: string;
6
7
  messageId?: string;
8
+ sourceSystemType?: SourceSystemType;
7
9
  constructor(receiveTask: ReceiveTask, processModel: ProcessModelLike);
8
10
  }
@@ -1,8 +1,10 @@
1
+ import { TargetSystemType } from '../../Model';
1
2
  import { SendTask } from '../../Model/Activities/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { ActivityViewModel } from './ActivityViewModel';
4
5
  export declare class SendTaskViewModel extends ActivityViewModel {
5
6
  messageName?: string;
6
7
  messageId?: string;
8
+ targetSystemType?: TargetSystemType;
7
9
  constructor(sendTask: SendTask, processModel: ProcessModelLike);
8
10
  }
@@ -1,3 +1,4 @@
1
+ import { SourceSystemType } from '../../Model';
1
2
  import { BoundaryEvent } from '../../Model/Events/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { EventViewModel } from './EventBaseViewModel';
@@ -8,5 +9,6 @@ export declare class BoundaryEventViewModel extends EventViewModel {
8
9
  timerType?: string;
9
10
  timerValue?: string;
10
11
  condition?: string;
12
+ sourceSystemType?: SourceSystemType;
11
13
  constructor(boundaryEvent: BoundaryEvent, processModel: ProcessModelLike);
12
14
  }
@@ -1,3 +1,4 @@
1
+ import { TargetSystemType } from '../../Model';
1
2
  import { EndEvent } from '../../Model/Events/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { EventViewModel } from './EventBaseViewModel';
@@ -25,5 +26,6 @@ export declare class EndEventViewModel extends EventViewModel {
25
26
  errorName?: string;
26
27
  errorCode?: string;
27
28
  errorMessage?: string;
29
+ targetSystemType?: TargetSystemType;
28
30
  constructor(endEvent: EndEvent, processModel: ProcessModelLike);
29
31
  }
@@ -1,3 +1,4 @@
1
+ import { SourceSystemType } from '../../Model';
1
2
  import { IntermediateCatchEvent } from '../../Model/Events/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { EventViewModel } from './EventBaseViewModel';
@@ -6,5 +7,6 @@ export declare class IntermediateCatchEventViewModel extends EventViewModel {
6
7
  timerType?: string;
7
8
  timerValue?: string;
8
9
  condition?: string;
10
+ sourceSystemType?: SourceSystemType;
9
11
  constructor(intermediateCatchEvent: IntermediateCatchEvent, processModel: ProcessModelLike);
10
12
  }
@@ -1,7 +1,9 @@
1
+ import { TargetSystemType } from '../../Model';
1
2
  import { IntermediateThrowEvent } from '../../Model/Events/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { EventViewModel } from './EventBaseViewModel';
4
5
  export declare class IntermediateThrowEventViewModel extends EventViewModel {
5
6
  linkName?: string;
7
+ targetSystemType?: TargetSystemType;
6
8
  constructor(intermediateThrowEvent: IntermediateThrowEvent, processModel: ProcessModelLike);
7
9
  }
@@ -1,3 +1,4 @@
1
+ import { SourceSystemType } from '../../Model';
1
2
  import { StartEvent } from '../../Model/Events/index';
2
3
  import { ProcessModelLike } from '../BaseElementViewModel';
3
4
  import { EventViewModel } from './EventBaseViewModel';
@@ -21,5 +22,6 @@ import { EventViewModel } from './EventBaseViewModel';
21
22
  export declare class StartEventViewModel extends EventViewModel {
22
23
  timerType?: string;
23
24
  timerValue?: string;
25
+ sourceSystemType?: SourceSystemType;
24
26
  constructor(startEvent: StartEvent, processModel: ProcessModelLike);
25
27
  }
@@ -1,5 +1,5 @@
1
+ import { BpmnType } from '../Model';
1
2
  import { FlowNode } from '../Model/Base';
2
- import { BpmnType } from '../Model/Constants';
3
3
  import { BaseElementViewModel, ProcessModelLike } from './BaseElementViewModel';
4
4
  /**
5
5
  * @swagger
@@ -15,9 +15,8 @@ import { BaseElementViewModel, ProcessModelLike } from './BaseElementViewModel';
15
15
  * description: The name of the FlowNode.
16
16
  * type: string
17
17
  * flowNodeType:
18
- * allOf:
19
- * - $ref: '#/components/schemas/BpmnType'
20
- * - description: The type of the FlowNode.
18
+ * description: The type of the FlowNode.
19
+ * $ref: '#/components/schemas/BpmnType'
21
20
  */
22
21
  export declare class FlowNodeViewModel extends BaseElementViewModel {
23
22
  name: string;
@@ -1 +1 @@
1
- {"version":3,"file":"Correlation.js","sourceRoot":"","sources":["../../../src/DataModels/Correlation.ts"],"names":[],"mappings":";;;AA4EA,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,6DAA+B,CAAA;IAC/B,qDAAuB,CAAA;AACzB,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC"}
1
+ {"version":3,"file":"Correlation.js","sourceRoot":"","sources":["../../../src/DataModels/Correlation.ts"],"names":[],"mappings":";;;AA6EA,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,6DAA+B,CAAA;IAC/B,qDAAuB,CAAA;AACzB,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC"}
@@ -6,7 +6,7 @@ exports.ExternalTaskState = void 0;
6
6
  * components:
7
7
  * schemas:
8
8
  * ExternalTaskState:
9
- * description: The state of the ExternalTask.
9
+ * description: Describes the state of an ExternalTask.
10
10
  * type: string
11
11
  * enum:
12
12
  * - pending
@@ -1 +1 @@
1
- {"version":3,"file":"ExternalTask.js","sourceRoot":"","sources":["../../../../src/DataModels/ExternalTask/ExternalTask.ts"],"names":[],"mappings":";;;AA6GA;;;;;;;;;;;GAWG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;AACrB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}
1
+ {"version":3,"file":"ExternalTask.js","sourceRoot":"","sources":["../../../../src/DataModels/ExternalTask/ExternalTask.ts"],"names":[],"mappings":";;;AA8GA;;;;;;;;;;;GAWG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;AACrB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}
@@ -1 +1 @@
1
- {"version":3,"file":"FlowNodeInstance.js","sourceRoot":"","sources":["../../../../src/DataModels/FlowNodeInstance/FlowNodeInstance.ts"],"names":[],"mappings":";;;AA6KA;;;;;;;;;;;;;;GAcG;AACH,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,gDAAuB,CAAA;IACvB,8CAAqB,CAAA;IACrB,kDAAyB,CAAA;IACzB,wCAAe,CAAA;IACf,8CAAqB,CAAA;AACvB,CAAC,EAPW,qBAAqB,qCAArB,qBAAqB,QAOhC;AAOD,IAAY,+BAkBX;AAlBD,WAAY,+BAA+B;IACzC,4EAAyC,CAAA;IACzC,4DAAyB,CAAA;IACzB,gEAA6B,CAAA;IAC7B,gEAA6B,CAAA;IAC7B,gEAA6B,CAAA;IAC7B,0DAAuB,CAAA;IACvB,kDAAe,CAAA;IACf,4FAAyD,CAAA;IACzD,sFAAmD,CAAA;IACnD,8EAA2C,CAAA;IAC3C,oEAAiC,CAAA;IACjC,0EAAuC,CAAA;IACvC,kEAA+B,CAAA;IAC/B,sDAAmB,CAAA;IACnB,0DAAuB,CAAA;IACvB,4DAAyB,CAAA;IACzB,8FAA2D,CAAA;AAC7D,CAAC,EAlBW,+BAA+B,+CAA/B,+BAA+B,QAkB1C"}
1
+ {"version":3,"file":"FlowNodeInstance.js","sourceRoot":"","sources":["../../../../src/DataModels/FlowNodeInstance/FlowNodeInstance.ts"],"names":[],"mappings":";;;AAuKA;;;;;;;;;;;;;;GAcG;AACH,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,gDAAuB,CAAA;IACvB,8CAAqB,CAAA;IACrB,kDAAyB,CAAA;IACzB,wCAAe,CAAA;IACf,8CAAqB,CAAA;AACvB,CAAC,EAPW,qBAAqB,qCAArB,qBAAqB,QAOhC;AAOD,IAAY,+BAkBX;AAlBD,WAAY,+BAA+B;IACzC,4EAAyC,CAAA;IACzC,4DAAyB,CAAA;IACzB,gEAA6B,CAAA;IAC7B,gEAA6B,CAAA;IAC7B,gEAA6B,CAAA;IAC7B,0DAAuB,CAAA;IACvB,kDAAe,CAAA;IACf,4FAAyD,CAAA;IACzD,sFAAmD,CAAA;IACnD,8EAA2C,CAAA;IAC3C,oEAAiC,CAAA;IACjC,0EAAuC,CAAA;IACvC,kEAA+B,CAAA;IAC/B,sDAAmB,CAAA;IACnB,0DAAuB,CAAA;IACvB,4DAAyB,CAAA;IACzB,8FAA2D,CAAA;AAC7D,CAAC,EAlBW,+BAA+B,+CAA/B,+BAA+B,QAkB1C"}
@@ -1 +1 @@
1
- {"version":3,"file":"ProcessInstance.js","sourceRoot":"","sources":["../../../../src/DataModels/ProcessInstance/ProcessInstance.ts"],"names":[],"mappings":";;;AAiKA;;;;;;;;;;;;GAYG;AACH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,6CAAqB,CAAA;IACrB,uCAAe,CAAA;IACf,iDAAyB,CAAA;AAC3B,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B"}
1
+ {"version":3,"file":"ProcessInstance.js","sourceRoot":"","sources":["../../../../src/DataModels/ProcessInstance/ProcessInstance.ts"],"names":[],"mappings":";;;AAmKA;;;;;;;;;;;;GAYG;AACH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,6CAAqB,CAAA;IACrB,uCAAe,CAAA;IACf,iDAAyB,CAAA;AAC3B,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B"}
@@ -8,6 +8,7 @@ var ProcessInstanceSortableColumns;
8
8
  ProcessInstanceSortableColumns["processDefinitionId"] = "processDefinitionId";
9
9
  ProcessInstanceSortableColumns["processModelId"] = "processModelId";
10
10
  ProcessInstanceSortableColumns["processModelName"] = "processModelName";
11
+ ProcessInstanceSortableColumns["processModelVersion"] = "processModelVersion";
11
12
  ProcessInstanceSortableColumns["processModelHash"] = "processModelHash";
12
13
  ProcessInstanceSortableColumns["ownerId"] = "ownerId";
13
14
  ProcessInstanceSortableColumns["startedByRootAccessToken"] = "startedByRootAccessToken";
@@ -1 +1 @@
1
- {"version":3,"file":"ProcessInstanceQuery.js","sourceRoot":"","sources":["../../../../src/DataModels/ProcessInstance/ProcessInstanceQuery.ts"],"names":[],"mappings":";;;AAgGA,IAAY,8BA0BX;AA1BD,WAAY,8BAA8B;IACxC,iEAA+B,CAAA;IAC/B,yEAAuC,CAAA;IACvC,6EAA2C,CAAA;IAC3C,mEAAiC,CAAA;IACjC,uEAAqC,CAAA;IACrC,uEAAqC,CAAA;IACrC,qDAAmB,CAAA;IACnB,uFAAqD,CAAA;IACrD,iDAAe,CAAA;IACf,iDAAe,CAAA;IACf,qFAAmD,CAAA;IACnD,2DAAyB,CAAA;IACzB,2EAAyC,CAAA;IACzC,yDAAuB,CAAA;IACvB,yDAAuB,CAAA;IACvB,mFAAiD,CAAA;IACjD,2DAAyB,CAAA;IACzB,+DAA6B,CAAA;IAC7B,mEAAiC,CAAA;IACjC,uDAAqB,CAAA;IACrB,2DAAyB,CAAA;IACzB,+DAA6B,CAAA;IAC7B,6EAA2C,CAAA;IAC3C,qFAAmD,CAAA;IACnD,6FAA2D,CAAA;AAC7D,CAAC,EA1BW,8BAA8B,8CAA9B,8BAA8B,QA0BzC"}
1
+ {"version":3,"file":"ProcessInstanceQuery.js","sourceRoot":"","sources":["../../../../src/DataModels/ProcessInstance/ProcessInstanceQuery.ts"],"names":[],"mappings":";;;AAiGA,IAAY,8BA2BX;AA3BD,WAAY,8BAA8B;IACxC,iEAA+B,CAAA;IAC/B,yEAAuC,CAAA;IACvC,6EAA2C,CAAA;IAC3C,mEAAiC,CAAA;IACjC,uEAAqC,CAAA;IACrC,6EAA2C,CAAA;IAC3C,uEAAqC,CAAA;IACrC,qDAAmB,CAAA;IACnB,uFAAqD,CAAA;IACrD,iDAAe,CAAA;IACf,iDAAe,CAAA;IACf,qFAAmD,CAAA;IACnD,2DAAyB,CAAA;IACzB,2EAAyC,CAAA;IACzC,yDAAuB,CAAA;IACvB,yDAAuB,CAAA;IACvB,mFAAiD,CAAA;IACjD,2DAAyB,CAAA;IACzB,+DAA6B,CAAA;IAC7B,mEAAiC,CAAA;IACjC,uDAAqB,CAAA;IACrB,2DAAyB,CAAA;IACzB,+DAA6B,CAAA;IAC7B,6EAA2C,CAAA;IAC3C,qFAAmD,CAAA;IACnD,6FAA2D,CAAA;AAC7D,CAAC,EA3BW,8BAA8B,8CAA9B,8BAA8B,QA2BzC"}
@@ -6,11 +6,18 @@ exports.StartCallbackType = void 0;
6
6
  * components:
7
7
  * schemas:
8
8
  * StartCallbackType:
9
+ * description: The type of callback to use for a ProcessInstance start.
9
10
  * type: integer
10
- * enum:
11
- * - 1
12
- * - 2
13
- * - 3
11
+ * oneOf:
12
+ * - title: CallbackOnProcessInstanceCreated
13
+ * const: 1
14
+ * description: The Engine will resolve immediately after the ProcessInstance was started.
15
+ * - title: CallbackOnProcessInstanceFinished
16
+ * const: 2
17
+ * description: The Engine will resolve after the first EndEvent was reached.
18
+ * - title: CallbackOnEndEventReached
19
+ * const: 3
20
+ * description: The Engine will resolve after a specific EndEvent was reached.
14
21
  */
15
22
  /**
16
23
  * Determines when the Engine will resolve after a new ProcessInstance was started.