@5minds/processcube_engine_sdk 7.2.0-feature-2ec36f-mbqgwbs2 → 7.2.0-feature-7fb46c-mbrlc563

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 (59) hide show
  1. package/dist/DataModels/ApplicationInfo.d.ts +0 -3
  2. package/dist/DataModels/ProcessInstance/ProcessInstance.d.ts +0 -1
  3. package/dist/DataModels/index.d.ts +0 -1
  4. package/dist/Engine.d.ts +1 -22
  5. package/dist/EngineConfiguration.d.ts +0 -2
  6. package/dist/EngineEvents/EventPayloads/TerminateProcessInstance.d.ts +0 -1
  7. package/dist/EngineEvents/EventPayloads/index.d.ts +0 -1
  8. package/dist/EngineEvents/Subscription.d.ts +26 -0
  9. package/dist/EngineEvents/index.d.ts +1 -0
  10. package/dist/ExtensionAdapter/NotificationExtensionAdapter.d.ts +4 -4
  11. package/dist/ExtensionAdapter/index.d.ts +0 -3
  12. package/dist/ProcessModel/Model/Activities/CallActivity.d.ts +7 -0
  13. package/dist/ProcessModel/ViewModel/Activities/CallActivityViewModel.d.ts +4 -3
  14. package/dist/commonjs/DataModels/ProcessInstance/ProcessInstance.js.map +1 -1
  15. package/dist/commonjs/DataModels/index.js +0 -1
  16. package/dist/commonjs/DataModels/index.js.map +1 -1
  17. package/dist/commonjs/Engine.js.map +1 -1
  18. package/dist/commonjs/EngineEvents/EventPayloads/index.js +0 -1
  19. package/dist/commonjs/EngineEvents/EventPayloads/index.js.map +1 -1
  20. package/dist/commonjs/{DataModels/EngineMetadata.js → EngineEvents/Subscription.js} +1 -1
  21. package/dist/commonjs/EngineEvents/Subscription.js.map +1 -0
  22. package/dist/commonjs/EngineEvents/index.js +1 -0
  23. package/dist/commonjs/EngineEvents/index.js.map +1 -1
  24. package/dist/commonjs/ExtensionAdapter/index.js +0 -3
  25. package/dist/commonjs/ExtensionAdapter/index.js.map +1 -1
  26. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/CallActivityParser.js +4 -0
  27. package/dist/commonjs/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/CallActivityParser.js.map +1 -1
  28. package/dist/commonjs/ProcessModel/ViewModel/Activities/CallActivityViewModel.js +2 -0
  29. package/dist/commonjs/ProcessModel/ViewModel/Activities/CallActivityViewModel.js.map +1 -1
  30. package/dist/commonjs/index.js +0 -4
  31. package/dist/commonjs/index.js.map +1 -1
  32. package/dist/index.d.ts +0 -4
  33. package/package.json +1 -1
  34. package/dist/DataModels/EngineMetadata.d.ts +0 -13
  35. package/dist/EngineEventBus.d.ts +0 -87
  36. package/dist/EngineEventBusSettings.d.ts +0 -141
  37. package/dist/EngineEvents/EventPayloads/KillProcessInstanceMessageInternal.d.ts +0 -11
  38. package/dist/EngineRestApiSettings.d.ts +0 -2107
  39. package/dist/EngineSocketIoSettings.d.ts +0 -67
  40. package/dist/ExtensionAdapter/ClusterExtensionAdapter.d.ts +0 -14
  41. package/dist/ExtensionAdapter/MessageEventExtensionAdapter.d.ts +0 -4
  42. package/dist/ExtensionAdapter/SignalEventExtensionAdapter.d.ts +0 -4
  43. package/dist/commonjs/DataModels/EngineMetadata.js.map +0 -1
  44. package/dist/commonjs/EngineEventBus.js +0 -3
  45. package/dist/commonjs/EngineEventBus.js.map +0 -1
  46. package/dist/commonjs/EngineEventBusSettings.js +0 -99
  47. package/dist/commonjs/EngineEventBusSettings.js.map +0 -1
  48. package/dist/commonjs/EngineEvents/EventPayloads/KillProcessInstanceMessageInternal.js +0 -3
  49. package/dist/commonjs/EngineEvents/EventPayloads/KillProcessInstanceMessageInternal.js.map +0 -1
  50. package/dist/commonjs/EngineRestApiSettings.js +0 -2139
  51. package/dist/commonjs/EngineRestApiSettings.js.map +0 -1
  52. package/dist/commonjs/EngineSocketIoSettings.js +0 -76
  53. package/dist/commonjs/EngineSocketIoSettings.js.map +0 -1
  54. package/dist/commonjs/ExtensionAdapter/ClusterExtensionAdapter.js +0 -3
  55. package/dist/commonjs/ExtensionAdapter/ClusterExtensionAdapter.js.map +0 -1
  56. package/dist/commonjs/ExtensionAdapter/MessageEventExtensionAdapter.js +0 -3
  57. package/dist/commonjs/ExtensionAdapter/MessageEventExtensionAdapter.js.map +0 -1
  58. package/dist/commonjs/ExtensionAdapter/SignalEventExtensionAdapter.js +0 -3
  59. package/dist/commonjs/ExtensionAdapter/SignalEventExtensionAdapter.js.map +0 -1
@@ -56,8 +56,5 @@ export type ApplicationInfo = {
56
56
  name: string;
57
57
  version: string;
58
58
  }>;
59
- extensionInfo?: {
60
- [extensionName: string]: any;
61
- };
62
59
  extraInfo: any;
63
60
  };
@@ -161,7 +161,6 @@ export declare type ProcessInstance = {
161
161
  metadata?: ProcessInstanceMetadata;
162
162
  correlation?: Correlation;
163
163
  triggeredByFlowNodeInstance?: FlowNodeInstance;
164
- engineId?: string;
165
164
  };
166
165
  /**
167
166
  * @swagger
@@ -16,7 +16,6 @@ export * from './Constants';
16
16
  export * from './Correlation';
17
17
  export * from './Cronjob/index';
18
18
  export * from './DataObjectInstance';
19
- export * from './EngineMetadata';
20
19
  export * from './ExternalTask/index';
21
20
  export * from './FlowNodeInstance/index';
22
21
  export * from './Iam/index';
package/dist/Engine.d.ts CHANGED
@@ -1,9 +1,8 @@
1
1
  import * as express from 'express';
2
2
  import { UserTaskInstance } from './DataModels';
3
3
  import { Identity } from './DataModels/Iam/index';
4
- import { ExternalEventBus } from './EngineEventBus';
5
4
  import { EngineEventType, MiddlewareCallback } from './EngineEvents/index';
6
- import { IApplicationInfoExtensionAdapter, IClusterExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, IMessageEventExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, ISignalEventExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
5
+ import { IApplicationInfoExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
7
6
  import { EventViewModel, FlowNodeViewModel } from './ProcessModel/index';
8
7
  /**
9
8
  * Describes the onLoad function, which can be exported by an extension.
@@ -13,16 +12,8 @@ import { EventViewModel, FlowNodeViewModel } from './ProcessModel/index';
13
12
  * export const onLoad: onLoadFunction = (engine: Engine) => {}
14
13
  */
15
14
  export type OnLoad = (engine: Engine) => void | Promise<void>;
16
- export type GetStatusInfo = () => Object | Promise<Object>;
17
15
  export type EngineExtension = {
18
16
  onLoad: OnLoad;
19
- getStatusInfo?: GetStatusInfo;
20
- };
21
- export type Extension = {
22
- exports: EngineExtension;
23
- name: string;
24
- version: string;
25
- path: string;
26
17
  };
27
18
  export type CustomServiceTaskHandlerContext = {
28
19
  token: {
@@ -76,7 +67,6 @@ export type CustomHttpRouteRequest = {
76
67
  stale: boolean;
77
68
  subdomains: Array<string>;
78
69
  xhr: boolean;
79
- nonce?: string;
80
70
  };
81
71
  export declare enum HttpResponseActionType {
82
72
  Send = "send",
@@ -223,14 +213,6 @@ export type Engine = {
223
213
  * @param callback The callback to call after the Engine has finished starting up.
224
214
  */
225
215
  onReady(callback: () => void | Promise<void>): void;
226
- /**
227
- * Registers a custom Event Bus, which will replace the Engine's own internal Event Bus.
228
- *
229
- * **NOTE:** Can only be used BEFORE the {@link Engine.onReady} Event was fired!
230
- *
231
- * @param eventBus A custom {@link ExternalEventBus}.
232
- */
233
- registerCustomEventBus(eventBus: ExternalEventBus): void;
234
216
  /**
235
217
  * Registers the given callback as an Event Middleware.
236
218
  * This middleware gets called whenever a Log Event occurs at the Engine.
@@ -375,7 +357,6 @@ export type Engine = {
375
357
  registerHttpRoute(path: string, method: 'get' | 'post' | 'put' | 'delete', routeHandler: CustomHttpRouteHandler, options?: CustomHttpRouteOptions): void;
376
358
  executeRuntimeExpression<TExpectedResult>(expression: string, params: RuntimeExpressionParameters): Promise<TExpectedResult>;
377
359
  applicationInfo: IApplicationInfoExtensionAdapter;
378
- cluster: IClusterExtensionAdapter;
379
360
  correlations: ICorrelationExtensionAdapter;
380
361
  cronjobs: ICronjobExtensionAdapter;
381
362
  dataObjectInstances: IDataObjectInstanceExtensionAdapter;
@@ -385,11 +366,9 @@ export type Engine = {
385
366
  flowNodeInstances: IFlowNodeInstanceExtensionAdapter;
386
367
  iam: IIamExtensionAdapter;
387
368
  manualTasks: IManualTaskExtensionAdapter;
388
- messageEvents: IMessageEventExtensionAdapter;
389
369
  notification: INotificationExtensionAdapter;
390
370
  processDefinitions: IProcessDefinitionExtensionAdapter;
391
371
  processInstances: IProcessInstanceExtensionAdapter;
392
372
  processModels: IProcessModelExtensionAdapter;
393
- signalEvents: ISignalEventExtensionAdapter;
394
373
  userTasks: IUserTaskExtensionAdapter;
395
374
  };
@@ -30,7 +30,6 @@ export declare type ExtensionsConfig = {
30
30
  exclude?: string[];
31
31
  };
32
32
  export declare type RuntimeExpressionConfig = {
33
- disableTimeout?: boolean;
34
33
  timeoutInMiliseconds?: number;
35
34
  workerPoolSize?: number;
36
35
  };
@@ -93,7 +92,6 @@ export declare type HttpServerConfig = {
93
92
  };
94
93
  export declare type IAMConfiguration = {
95
94
  baseUrl: string;
96
- internalUrl?: string;
97
95
  allowAnonymousRootAccess?: boolean;
98
96
  rootAccessToken?: string;
99
97
  };
@@ -3,7 +3,6 @@ import { Identity } from '../../DataModels/Iam/index';
3
3
  * Encapsulates a message for when a Process Instance gets terminated.
4
4
  */
5
5
  export type TerminateProcessInstanceMessage = {
6
- processInstanceId: string;
7
6
  /**
8
7
  * If the Process Instance is terminated by a user, this will contain the users identity.
9
8
  */
@@ -5,7 +5,6 @@ export * from './ErrorEndEventReached';
5
5
  export * from './ExternalTaskMessages';
6
6
  export * from './FinishManualTask';
7
7
  export * from './FinishUserTask';
8
- export * from './KillProcessInstanceMessageInternal';
9
8
  export * from './MessageEventReached';
10
9
  export * from './MetadataChangedMessage';
11
10
  export * from './ProcessDeploymentMessage';
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Defines the signature for the Callback that an EventSubscription should have.
3
+ *
4
+ * @param eventPayload Optional: The payload received with the event.
5
+ * @param eventName Optional: The name of the received event.
6
+ */
7
+ export declare type EventReceivedCallback = (eventPayload?: any, eventName?: string) => void | Promise<void>;
8
+ /**
9
+ * Contains information about a subscription on the EventAggregator.
10
+ * External services can use this information to manage their own subscriptions.
11
+ */
12
+ export declare type Subscription = {
13
+ /**
14
+ * The Id under which the EventAggregator has stored the Subscription.
15
+ */
16
+ readonly id: string;
17
+ /**
18
+ * The name of the event for which the Subscription was created.
19
+ */
20
+ readonly eventName: string;
21
+ /**
22
+ * If set to true, the Subscription will be destroyed after first receiving
23
+ * the event.
24
+ */
25
+ readonly onlyReceiveOnce: boolean;
26
+ };
@@ -8,6 +8,7 @@ export * from './EventCallbackTypes';
8
8
  export * from './EngineEvent';
9
9
  export * from './EngineEventMiddlewares';
10
10
  export * from './EventPayloads/index';
11
+ export * from './Subscription';
11
12
  export declare namespace Messages {
12
13
  export import EventMessage = eventPayloads.EventMessage;
13
14
  export import BpmnEvents = eventPayloads;
@@ -77,10 +77,6 @@ export interface INotificationExtensionAdapter {
77
77
  subscribeOnce?: boolean;
78
78
  identity?: Identity;
79
79
  }): Promise<Subscription>;
80
- onActivityError(callback: Messages.CallbackTypes.OnActivityErrorCallback, options?: {
81
- subscribeOnce?: boolean;
82
- identity?: Identity;
83
- }): Promise<Subscription>;
84
80
  onUntypedTaskWaiting(callback: Messages.CallbackTypes.OnUntypedTaskWaitingCallback, options?: {
85
81
  subscribeOnce?: boolean;
86
82
  identity?: Identity;
@@ -141,6 +137,10 @@ export interface INotificationExtensionAdapter {
141
137
  subscribeOnce?: boolean;
142
138
  identity?: Identity;
143
139
  }): Promise<Subscription>;
140
+ onFlowNodeEventRetrySending(callback: Messages.CallbackTypes.OnFlowNodeEventRetrySendingCallback, options?: {
141
+ subscribeOnce?: boolean;
142
+ identity?: Identity;
143
+ }): Promise<Subscription>;
144
144
  onMessageTriggered(callback: Messages.CallbackTypes.OnMessageTriggeredCallback, options?: {
145
145
  subscribeOnce?: boolean;
146
146
  identity?: Identity;
@@ -1,5 +1,4 @@
1
1
  export * from './ApplicationInfoExtensionAdapter';
2
- export * from './ClusterExtensionAdapter';
3
2
  export * from './CorrelationExtensionAdapter';
4
3
  export * from './CronjobExtensionAdapter';
5
4
  export * from './DataObjectInstanceExtensionAdapter';
@@ -8,11 +7,9 @@ export * from './ExternalTaskExtensionAdapter';
8
7
  export * from './FlowNodeInstanceExtensionAdapter';
9
8
  export * from './IIamExtensionAdapter';
10
9
  export * from './ManualTaskExtensionAdapter';
11
- export * from './MessageEventExtensionAdapter';
12
10
  export * from './NotificationExtensionAdapter';
13
11
  export * from './ProcessDefinitionExtensionAdapter';
14
12
  export * from './ProcessModelExtensionAdapter';
15
13
  export * from './ProcessInstanceExtensionAdapter';
16
- export * from './SignalEventExtensionAdapter';
17
14
  export * from './UntypedTaskExtensionAdapter';
18
15
  export * from './UserTaskExtensionAdapter';
@@ -26,5 +26,12 @@ export type CallActivity = Activity & {
26
26
  * The DataContract to validate the payload.
27
27
  */
28
28
  dataContract?: string;
29
+ /**
30
+ * If set, the child process instance will use this correlation ID, instead of the of the one used by the parent process.
31
+ */
32
+ customCorrelationId?: string;
33
+ /**
34
+ * @deprecated
35
+ */
29
36
  calledElementVersion?: string;
30
37
  };
@@ -2,8 +2,9 @@ import { CallActivity } from '../../Model/Activities/index';
2
2
  import { ProcessModelLike } from '../BaseElementViewModel';
3
3
  import { ActivityViewModel } from './ActivityViewModel';
4
4
  export declare class CallActivityViewModel extends ActivityViewModel {
5
- processId?: string;
6
- startEvent?: string;
7
- payload?: any;
5
+ readonly processId?: string;
6
+ readonly startEvent?: string;
7
+ readonly customCorrelationId?: string;
8
+ readonly payload?: any;
8
9
  constructor(callActivity: CallActivity, processModel: ProcessModelLike);
9
10
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ProcessInstance.js","sourceRoot":"","sources":["../../../../src/DataModels/ProcessInstance/ProcessInstance.ts"],"names":[],"mappings":";;;AAwKA;;;;;;;;;;;;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":";;;AAuKA;;;;;;;;;;;;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"}
@@ -50,7 +50,6 @@ __exportStar(require("./Constants"), exports);
50
50
  __exportStar(require("./Correlation"), exports);
51
51
  __exportStar(require("./Cronjob/index"), exports);
52
52
  __exportStar(require("./DataObjectInstance"), exports);
53
- __exportStar(require("./EngineMetadata"), exports);
54
53
  __exportStar(require("./ExternalTask/index"), exports);
55
54
  __exportStar(require("./FlowNodeInstance/index"), exports);
56
55
  __exportStar(require("./Iam/index"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/DataModels/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,2DAA6C;AAC7C,yDAA2C;AAC3C,iEAAmD;AACnD,oEAAsD;AACtD,4EAA8D;AAC9D,iDAAmC;AACnC,wEAA0D;AAC1D,0EAA4D;AAE5D,oDAAkC;AAClC,8CAA4B;AAC5B,gDAA8B;AAC9B,kDAAgC;AAChC,uDAAqC;AACrC,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,8CAA4B;AAC5B,sDAAoC;AACpC,0DAAwC;AAExC,IAAiB,UAAU,CAU1B;AAVD,WAAiB,UAAU;IAEX,sBAAW,GAAG,WAAW,CAAC;IAC1B,kBAAO,GAAG,OAAO,CAAC;IAClB,sBAAW,GAAG,UAAU,CAAC;IACzB,wBAAa,GAAG,aAAa,CAAC;IAC9B,4BAAiB,GAAG,iBAAiB,CAAC;IACtC,cAAG,GAAG,GAAG,CAAC;IACV,6BAAkB,GAAG,kBAAkB,CAAC;IACxC,2BAAgB,GAAG,gBAAgB,CAAC;AACpD,CAAC,EAVgB,UAAU,0BAAV,UAAU,QAU1B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/DataModels/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,2DAA6C;AAC7C,yDAA2C;AAC3C,iEAAmD;AACnD,oEAAsD;AACtD,4EAA8D;AAC9D,iDAAmC;AACnC,wEAA0D;AAC1D,0EAA4D;AAE5D,oDAAkC;AAClC,8CAA4B;AAC5B,gDAA8B;AAC9B,kDAAgC;AAChC,uDAAqC;AACrC,uDAAqC;AACrC,2DAAyC;AACzC,8CAA4B;AAC5B,sDAAoC;AACpC,0DAAwC;AAExC,IAAiB,UAAU,CAU1B;AAVD,WAAiB,UAAU;IAEX,sBAAW,GAAG,WAAW,CAAC;IAC1B,kBAAO,GAAG,OAAO,CAAC;IAClB,sBAAW,GAAG,UAAU,CAAC;IACzB,wBAAa,GAAG,aAAa,CAAC;IAC9B,4BAAiB,GAAG,iBAAiB,CAAC;IACtC,cAAG,GAAG,GAAG,CAAC;IACV,6BAAkB,GAAG,kBAAkB,CAAC;IACxC,2BAAgB,GAAG,gBAAgB,CAAC;AACpD,CAAC,EAVgB,UAAU,0BAAV,UAAU,QAU1B"}
@@ -1 +1 @@
1
- {"version":3,"file":"Engine.js","sourceRoot":"","sources":["../../src/Engine.ts"],"names":[],"mappings":";;;AAoGA,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,uCAAa,CAAA;IACb,uCAAa,CAAA;IACb,yCAAe,CAAA;IACf,+CAAqB,CAAA;IACrB,+CAAqB,CAAA;IACrB,qCAAW,CAAA;IACX,mDAAyB,CAAA;IACzB,+CAAqB,CAAA;AACvB,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAoCY,QAAA,6BAA6B,GAAG,+BAA+B,CAAC"}
1
+ {"version":3,"file":"Engine.js","sourceRoot":"","sources":["../../src/Engine.ts"],"names":[],"mappings":";;;AAsFA,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,uCAAa,CAAA;IACb,uCAAa,CAAA;IACb,yCAAe,CAAA;IACf,+CAAqB,CAAA;IACrB,+CAAqB,CAAA;IACrB,qCAAW,CAAA;IACX,mDAAyB,CAAA;IACzB,+CAAqB,CAAA;AACvB,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAoCY,QAAA,6BAA6B,GAAG,+BAA+B,CAAC"}
@@ -21,7 +21,6 @@ __exportStar(require("./ErrorEndEventReached"), exports);
21
21
  __exportStar(require("./ExternalTaskMessages"), exports);
22
22
  __exportStar(require("./FinishManualTask"), exports);
23
23
  __exportStar(require("./FinishUserTask"), exports);
24
- __exportStar(require("./KillProcessInstanceMessageInternal"), exports);
25
24
  __exportStar(require("./MessageEventReached"), exports);
26
25
  __exportStar(require("./MetadataChangedMessage"), exports);
27
26
  __exportStar(require("./ProcessDeploymentMessage"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/EngineEvents/EventPayloads/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAE9B,iDAA+B;AAC/B,iEAA+C;AAC/C,yDAAuC;AACvC,yDAAuC;AACvC,qDAAmC;AACnC,mDAAiC;AACjC,uEAAqD;AACrD,wDAAsC;AACtC,2DAAyC;AACzC,6DAA2C;AAC3C,mEAAiD;AACjD,sEAAoD;AACpD,uDAAqC;AACrC,qDAAmC;AACnC,6DAA2C;AAC3C,uDAAqC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/EngineEvents/EventPayloads/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAE9B,iDAA+B;AAC/B,iEAA+C;AAC/C,yDAAuC;AACvC,yDAAuC;AACvC,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,6DAA2C;AAC3C,mEAAiD;AACjD,sEAAoD;AACpD,uDAAqC;AACrC,qDAAmC;AACnC,6DAA2C;AAC3C,uDAAqC"}
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=EngineMetadata.js.map
3
+ //# sourceMappingURL=Subscription.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Subscription.js","sourceRoot":"","sources":["../../../src/EngineEvents/Subscription.ts"],"names":[],"mappings":""}
@@ -47,6 +47,7 @@ __exportStar(require("./EventCallbackTypes"), exports);
47
47
  __exportStar(require("./EngineEvent"), exports);
48
48
  __exportStar(require("./EngineEventMiddlewares"), exports);
49
49
  __exportStar(require("./EventPayloads/index"), exports);
50
+ __exportStar(require("./Subscription"), exports);
50
51
  var Messages;
51
52
  (function (Messages) {
52
53
  Messages.BpmnEvents = eventPayloads;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/EngineEvents/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,oEAAsD;AACtD,qEAAuD;AAEvD,kDAAgC;AAChC,uDAAqC;AACrC,gDAA8B;AAC9B,2DAAyC;AAEzC,wDAAsC;AAEtC,IAAiB,QAAQ,CAKxB;AALD,WAAiB,QAAQ;IAET,mBAAU,GAAG,aAAa,CAAC;IAC3B,qBAAY,GAAG,aAAa,CAAC;IAC7B,sBAAa,GAAG,aAAa,CAAC;AAC9C,CAAC,EALgB,QAAQ,wBAAR,QAAQ,QAKxB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/EngineEvents/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,oEAAsD;AACtD,qEAAuD;AAEvD,kDAAgC;AAChC,uDAAqC;AACrC,gDAA8B;AAC9B,2DAAyC;AAEzC,wDAAsC;AACtC,iDAA+B;AAE/B,IAAiB,QAAQ,CAKxB;AALD,WAAiB,QAAQ;IAET,mBAAU,GAAG,aAAa,CAAC;IAC3B,qBAAY,GAAG,aAAa,CAAC;IAC7B,sBAAa,GAAG,aAAa,CAAC;AAC9C,CAAC,EALgB,QAAQ,wBAAR,QAAQ,QAKxB"}
@@ -15,7 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./ApplicationInfoExtensionAdapter"), exports);
18
- __exportStar(require("./ClusterExtensionAdapter"), exports);
19
18
  __exportStar(require("./CorrelationExtensionAdapter"), exports);
20
19
  __exportStar(require("./CronjobExtensionAdapter"), exports);
21
20
  __exportStar(require("./DataObjectInstanceExtensionAdapter"), exports);
@@ -24,12 +23,10 @@ __exportStar(require("./ExternalTaskExtensionAdapter"), exports);
24
23
  __exportStar(require("./FlowNodeInstanceExtensionAdapter"), exports);
25
24
  __exportStar(require("./IIamExtensionAdapter"), exports);
26
25
  __exportStar(require("./ManualTaskExtensionAdapter"), exports);
27
- __exportStar(require("./MessageEventExtensionAdapter"), exports);
28
26
  __exportStar(require("./NotificationExtensionAdapter"), exports);
29
27
  __exportStar(require("./ProcessDefinitionExtensionAdapter"), exports);
30
28
  __exportStar(require("./ProcessModelExtensionAdapter"), exports);
31
29
  __exportStar(require("./ProcessInstanceExtensionAdapter"), exports);
32
- __exportStar(require("./SignalEventExtensionAdapter"), exports);
33
30
  __exportStar(require("./UntypedTaskExtensionAdapter"), exports);
34
31
  __exportStar(require("./UserTaskExtensionAdapter"), exports);
35
32
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ExtensionAdapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oEAAkD;AAClD,4DAA0C;AAC1C,gEAA8C;AAC9C,4DAA0C;AAC1C,uEAAqD;AACrD,0DAAwC;AACxC,iEAA+C;AAC/C,qEAAmD;AACnD,yDAAuC;AACvC,+DAA6C;AAC7C,iEAA+C;AAC/C,iEAA+C;AAC/C,sEAAoD;AACpD,iEAA+C;AAC/C,oEAAkD;AAClD,gEAA8C;AAC9C,gEAA8C;AAC9C,6DAA2C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ExtensionAdapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oEAAkD;AAClD,gEAA8C;AAC9C,4DAA0C;AAC1C,uEAAqD;AACrD,0DAAwC;AACxC,iEAA+C;AAC/C,qEAAmD;AACnD,yDAAuC;AACvC,+DAA6C;AAC7C,iEAA+C;AAC/C,sEAAoD;AACpD,iEAA+C;AAC/C,oEAAkD;AAClD,gEAA8C;AAC9C,6DAA2C"}
@@ -35,6 +35,7 @@ function parseCallActivity(callActivityRaw) {
35
35
  callActivity.targetProcessModelId = callActivityRaw.calledElement;
36
36
  setStartEventId(callActivity);
37
37
  setPayload(callActivity);
38
+ setCustomCorrelationId(callActivity);
38
39
  setDataContract(callActivity);
39
40
  }
40
41
  return callActivity;
@@ -45,6 +46,9 @@ function setStartEventId(callActivity) {
45
46
  function setPayload(callActivity) {
46
47
  callActivity.payload = (0, ExtensionPropertyParser_1.findCamundaExtensionPropertyByName)('payload', callActivity.extensionElements.camundaExtensionProperties)?.value;
47
48
  }
49
+ function setCustomCorrelationId(callActivity) {
50
+ callActivity.customCorrelationId = (0, ExtensionPropertyParser_1.findCamundaExtensionPropertyByName)('engine.customCorrelationId', callActivity.extensionElements.camundaExtensionProperties)?.value;
51
+ }
48
52
  function setDataContract(callActivity) {
49
53
  callActivity.dataContract = (0, ExtensionPropertyParser_1.findCamundaExtensionPropertyByName)('engine.dataContract', callActivity.extensionElements.camundaExtensionProperties)?.value;
50
54
  }
@@ -1 +1 @@
1
- {"version":3,"file":"CallActivityParser.js","sourceRoot":"","sources":["../../../../../../../src/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/CallActivityParser.ts"],"names":[],"mappings":";;AAKA,kDA0BC;AA/BD,mDAAoE;AACpE,sDAA+D;AAC/D,uDAA2D;AAC3D,uEAA+E;AAE/E,SAAgB,mBAAmB,CAAC,WAAgB;IAClD,MAAM,iBAAiB,GAAG,IAAA,qCAAuB,EAAC,WAAW,EAAE,gBAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAElG,MAAM,qBAAqB,GAAG,CAAC,CAAC,iBAAiB,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/D,IAAI,qBAAqB,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAyC,EAAE,CAAC;IAEhE,KAAK,MAAM,eAAe,IAAI,iBAAiB,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,eAAe,CAAC,EAAE,CAAC;QAEtC,IAAI,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,qBAAqB,GAAG;gBAC5B,GAAG,KAAK,CAAC,qBAAqB;gBAC9B,UAAU,EAAE,UAAU;aACvB,CAAC;YAEF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,iBAAiB,CAAC,eAAoB;IAC7C,IAAI,YAAY,GAAG;QACjB,GAAG,IAAA,wCAAsB,EAAgC,eAAe,EAAE,gBAAQ,CAAC,YAAY,CAAC;KACjG,CAAC;IAEF,IAAI,eAAe,CAAC,aAAa,EAAE,CAAC;QAClC,YAAY,CAAC,oBAAoB,GAAG,eAAe,CAAC,aAAa,CAAC;QAClE,eAAe,CAAC,YAAY,CAAC,CAAC;QAC9B,UAAU,CAAC,YAAY,CAAC,CAAC;QACzB,eAAe,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,eAAe,CAAC,YAA2C;IAClE,YAAY,CAAC,YAAY,GAAG,IAAA,4DAAkC,EAAC,cAAc,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AACnJ,CAAC;AAED,SAAS,UAAU,CAAC,YAA2C;IAC7D,YAAY,CAAC,OAAO,GAAG,IAAA,4DAAkC,EAAC,SAAS,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AACzI,CAAC;AAED,SAAS,eAAe,CAAC,YAA2C;IAClE,YAAY,CAAC,YAAY,GAAG,IAAA,4DAAkC,EAAC,qBAAqB,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AAC1J,CAAC"}
1
+ {"version":3,"file":"CallActivityParser.js","sourceRoot":"","sources":["../../../../../../../src/ProcessModel/ProcessModelParser/Parser/FlowNodeParsers/ActivityParsers/CallActivityParser.ts"],"names":[],"mappings":";;AAKA,kDA0BC;AA/BD,mDAAoE;AACpE,sDAA+D;AAC/D,uDAA2D;AAC3D,uEAA+E;AAE/E,SAAgB,mBAAmB,CAAC,WAAgB;IAClD,MAAM,iBAAiB,GAAG,IAAA,qCAAuB,EAAC,WAAW,EAAE,gBAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAElG,MAAM,qBAAqB,GAAG,CAAC,CAAC,iBAAiB,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/D,IAAI,qBAAqB,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAyC,EAAE,CAAC;IAEhE,KAAK,MAAM,eAAe,IAAI,iBAAiB,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,eAAe,CAAC,EAAE,CAAC;QAEtC,IAAI,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,qBAAqB,GAAG;gBAC5B,GAAG,KAAK,CAAC,qBAAqB;gBAC9B,UAAU,EAAE,UAAU;aACvB,CAAC;YAEF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,iBAAiB,CAAC,eAAoB;IAC7C,IAAI,YAAY,GAAG;QACjB,GAAG,IAAA,wCAAsB,EAAgC,eAAe,EAAE,gBAAQ,CAAC,YAAY,CAAC;KACjG,CAAC;IAEF,IAAI,eAAe,CAAC,aAAa,EAAE,CAAC;QAClC,YAAY,CAAC,oBAAoB,GAAG,eAAe,CAAC,aAAa,CAAC;QAClE,eAAe,CAAC,YAAY,CAAC,CAAC;QAC9B,UAAU,CAAC,YAAY,CAAC,CAAC;QACzB,sBAAsB,CAAC,YAAY,CAAC,CAAC;QACrC,eAAe,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,eAAe,CAAC,YAA2C;IAClE,YAAY,CAAC,YAAY,GAAG,IAAA,4DAAkC,EAAC,cAAc,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AACnJ,CAAC;AAED,SAAS,UAAU,CAAC,YAA2C;IAC7D,YAAY,CAAC,OAAO,GAAG,IAAA,4DAAkC,EAAC,SAAS,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AACzI,CAAC;AAED,SAAS,sBAAsB,CAAC,YAA2C;IACzE,YAAY,CAAC,mBAAmB,GAAG,IAAA,4DAAkC,EAAC,4BAA4B,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AACxK,CAAC;AAED,SAAS,eAAe,CAAC,YAA2C;IAClE,YAAY,CAAC,YAAY,GAAG,IAAA,4DAAkC,EAAC,qBAAqB,EAAE,YAAY,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC;AAC1J,CAAC"}
@@ -5,11 +5,13 @@ const ActivityViewModel_1 = require("./ActivityViewModel");
5
5
  class CallActivityViewModel extends ActivityViewModel_1.ActivityViewModel {
6
6
  processId;
7
7
  startEvent;
8
+ customCorrelationId;
8
9
  payload;
9
10
  constructor(callActivity, processModel) {
10
11
  super(callActivity, processModel);
11
12
  this.processId = callActivity.targetProcessModelId;
12
13
  this.startEvent = callActivity.startEventId;
14
+ this.customCorrelationId = callActivity.customCorrelationId;
13
15
  this.payload = callActivity.payload;
14
16
  }
15
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"CallActivityViewModel.js","sourceRoot":"","sources":["../../../../../src/ProcessModel/ViewModel/Activities/CallActivityViewModel.ts"],"names":[],"mappings":";;;AAEA,2DAAwD;AAExD,MAAa,qBAAsB,SAAQ,qCAAiB;IACnD,SAAS,CAAU;IACnB,UAAU,CAAU;IACpB,OAAO,CAAO;IAErB,YAAY,YAA0B,EAAE,YAA8B;QACpE,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;IACtC,CAAC;CACF;AAXD,sDAWC"}
1
+ {"version":3,"file":"CallActivityViewModel.js","sourceRoot":"","sources":["../../../../../src/ProcessModel/ViewModel/Activities/CallActivityViewModel.ts"],"names":[],"mappings":";;;AAEA,2DAAwD;AAExD,MAAa,qBAAsB,SAAQ,qCAAiB;IAC1C,SAAS,CAAU;IACnB,UAAU,CAAU;IACpB,mBAAmB,CAAU;IAC7B,OAAO,CAAO;IAE9B,YAAY,YAA0B,EAAE,YAA8B;QACpE,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,CAAC;QAC5D,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;IACtC,CAAC;CACF;AAbD,sDAaC"}
@@ -22,11 +22,7 @@ __exportStar(require("./Errors/index"), exports);
22
22
  __exportStar(require("./ExtensionAdapter/index"), exports);
23
23
  __exportStar(require("./ProcessModel/index"), exports);
24
24
  __exportStar(require("./Engine"), exports);
25
- __exportStar(require("./EngineEventBus"), exports);
26
25
  __exportStar(require("./EngineConfiguration"), exports);
27
- __exportStar(require("./EngineEventBusSettings"), exports);
28
- __exportStar(require("./EngineRestApiSettings"), exports);
29
- __exportStar(require("./EngineSocketIoSettings"), exports);
30
26
  __exportStar(require("./Logger"), exports);
31
27
  __exportStar(require("./Serializer"), exports);
32
28
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAAuD;AAEvD,qDAAmC;AACnC,uDAAqC;AACrC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AAErC,2CAAyB;AACzB,mDAAiC;AACjC,wDAAsC;AAEtC,2DAAyC;AACzC,0DAAwC;AACxC,2DAAyC;AAEzC,2CAAyB;AACzB,+CAA6B;AAE7B;;GAEG;AACU,QAAA,YAAY,GAAG;IAC1B,GAAG,uBAAe;CACnB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAAuD;AAEvD,qDAAmC;AACnC,uDAAqC;AACrC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AAErC,2CAAyB;AACzB,wDAAsC;AAEtC,2CAAyB;AACzB,+CAA6B;AAE7B;;GAEG;AACU,QAAA,YAAY,GAAG;IAC1B,GAAG,uBAAe;CACnB,CAAC"}
package/dist/index.d.ts CHANGED
@@ -5,11 +5,7 @@ export * from './Errors/index';
5
5
  export * from './ExtensionAdapter/index';
6
6
  export * from './ProcessModel/index';
7
7
  export * from './Engine';
8
- export * from './EngineEventBus';
9
8
  export * from './EngineConfiguration';
10
- export * from './EngineEventBusSettings';
11
- export * from './EngineRestApiSettings';
12
- export * from './EngineSocketIoSettings';
13
9
  export * from './Logger';
14
10
  export * from './Serializer';
15
11
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@5minds/processcube_engine_sdk",
3
- "version": "7.2.0-feature-2ec36f-mbqgwbs2",
3
+ "version": "7.2.0-feature-7fb46c-mbrlc563",
4
4
  "description": "Software development kit for the Engine.",
5
5
  "main": "dist/commonjs/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -1,13 +0,0 @@
1
- export type EngineMetadata = {
2
- engineId: string;
3
- hostname: string;
4
- lastSeen: number;
5
- alive?: boolean;
6
- leader?: boolean;
7
- current?: boolean;
8
- allProcesses?: number;
9
- runningProcesses?: number;
10
- finishedProcesses?: number;
11
- erroredProcesses?: number;
12
- terminatedProcesses?: number;
13
- };
@@ -1,87 +0,0 @@
1
- /**
2
- * Defines the signature for the Callback that an EventSubscription should have.
3
- *
4
- * @param eventPayload Optional: The payload received with the event.
5
- * @param eventName Optional: The name of the received event.
6
- */
7
- export type EventReceivedCallback = (eventPayload?: any, eventName?: string) => void | Promise<void>;
8
- /**
9
- * Contains information about a subscription on the EngineEventBus.
10
- * External services can use this information to manage their own subscriptions.
11
- */
12
- export type Subscription = {
13
- /**
14
- * The Id under which the EngineEventBus has stored the Subscription.
15
- */
16
- readonly id: string;
17
- /**
18
- * The name of the event for which the Subscription was created.
19
- */
20
- readonly eventName: string;
21
- /**
22
- * If set to true, the Subscription will be destroyed after first receiving
23
- * the event.
24
- */
25
- readonly onlyReceiveOnce: boolean;
26
- };
27
- export type ExternalSubscription = {
28
- remove: () => Promise<void>;
29
- };
30
- /**
31
- * The Event Bus is used by the Engine to manage communications between the individual engine services, as well as all Flow Node Instances and Process Instances.
32
- *
33
- * By default, the Engine uses its own EventAggregator.
34
- *
35
- * You can replace it with your own, if you want to connect the engine to an external messagebus.
36
- */
37
- export type EngineEventBus = {
38
- /**
39
- * Creates a new {@link Subscription} on the EventBus for the event with the given name.
40
- * The {@link Subscription} will remain active, until manually disposed through the {@link EngineEventBus.unsubscribe} method.
41
- *
42
- * @param eventName The name of the Event to subscribe to.
43
- * @param callback The callback to execute, when the event is received.
44
- * @returns A {@link Subscription} object.
45
- */
46
- subscribe: (eventName: string, callback: EventReceivedCallback) => Subscription;
47
- /**
48
- * Creates a new {@link Subscription} on the EventBus for the event with the given name.
49
- * The {@link Subscription} is automatically disposed, after the event was received once.
50
- *
51
- * @param eventName The name of the Event to subscribe to.
52
- * @param callback The callback to execute, when the event is received.
53
- * @returns A {@link Subscription} object.
54
- */
55
- subscribeOnce: (eventName: string, callback: EventReceivedCallback) => Subscription;
56
- /**
57
- * Publishes a given event on the EventBus.
58
- * Usually, this function returns as soon as the Event was published.
59
- * However, it is possible to wait for all Subscribers to acknowledge receiving the Event, by providing an "onAcknowledgement" Callback function.
60
- *
61
- * @param eventName The name of the Event to publish.
62
- * @param payload The payload to send with the Event.
63
- * @param onAcknowledgement Optional: The callback to call, after all Subscribers have acknowledged receiving the Event.
64
- * @param eventId Optional: The Event ID to use.
65
- */
66
- publish: (eventName: string, payload?: Record<string, any>, onAcknowledgement?: () => void, eventId?: string) => void;
67
- /**
68
- * Allows a Subscriber to acknowledge the receit of an Event with the given ID.
69
- *
70
- * @param eventId The ID of the Event to acknowledge.
71
- */
72
- acknowledgeEvent: (eventId: string) => void;
73
- /**
74
- * Disposes the given Event Subscription.
75
- *
76
- * @param subscription The Subscription to dispose.
77
- */
78
- unsubscribe: (subscription: Subscription) => void;
79
- };
80
- export type ExternalEventBus = {
81
- subscribeToWorkQueue: (queueName: string, callback: Function) => Promise<ExternalSubscription>;
82
- subscribeToTopicWithRoutingKey: (topic: string, routingKey: string, callback: Function, oneTimeSubscription?: boolean) => Promise<ExternalSubscription>;
83
- subscribeToBroadcast: (topic: string, callback: Function, oneTimeSubscription?: boolean) => Promise<ExternalSubscription>;
84
- publishToWorkQueue: (queueName: string, payload: Record<string, any>) => Promise<void>;
85
- publishToTopicWithRoutingKey: (topic: string, routingKey: string, payload: Record<string, any>) => Promise<void>;
86
- publishToBroadcast: (topic: string, payload: Record<string, any>) => Promise<void>;
87
- };