bpmn-elements 17.2.2 → 18.0.0

package/dist/events/EndEvent.js

@@ -3,27 +3,41 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.EndEvent = EndEvent;
 exports.EndEventBehaviour = EndEventBehaviour;
-exports.default = EndEvent;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
-var _EventDefinitionExecution = _interopRequireDefault(require("../eventDefinitions/EventDefinitionExecution.js"));
+var _Activity = require("../activity/Activity.js");
+var _EventDefinitionExecution = require("../eventDefinitions/EventDefinitionExecution.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kExecution = Symbol.for('execution');
+var _constants = require("../constants.js");
+/**
+ * End event
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function EndEvent(activityDef, context) {
-  return new _Activity.default(EndEventBehaviour, {
+  return new _Activity.Activity(EndEventBehaviour, {
     ...activityDef,
     isThrowing: true
   }, context);
 }
+
+/**
+ * End event behaviour
+ * @param {import('#types').Activity} activity
+ */
 function EndEventBehaviour(activity) {
   this.id = activity.id;
   this.type = activity.type;
   this.broker = activity.broker;
-  this[kExecution] = activity.eventDefinitions && new _EventDefinitionExecution.default(activity, activity.eventDefinitions);
+  this[_constants.K_EXECUTION] = activity.eventDefinitions && new _EventDefinitionExecution.EventDefinitionExecution(activity, activity.eventDefinitions);
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 EndEventBehaviour.prototype.execute = function execute(executeMessage) {
-  const execution = this[kExecution];
+  const execution = this[_constants.K_EXECUTION];
   if (execution) {
     return execution.execute(executeMessage);
   }

package/dist/events/IntermediateCatchEvent.js

@@ -3,24 +3,42 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.IntermediateCatchEvent = IntermediateCatchEvent;
 exports.IntermediateCatchEventBehaviour = IntermediateCatchEventBehaviour;
-exports.default = IntermediateCatchEvent;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
-var _EventDefinitionExecution = _interopRequireDefault(require("../eventDefinitions/EventDefinitionExecution.js"));
+var _Activity = require("../activity/Activity.js");
+var _EventDefinitionExecution = require("../eventDefinitions/EventDefinitionExecution.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kExecution = Symbol.for('execution');
+var _constants = require("../constants.js");
+/**
+ * Intermediate catch event
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function IntermediateCatchEvent(activityDef, context) {
-  return new _Activity.default(IntermediateCatchEventBehaviour, activityDef, context);
+  return new _Activity.Activity(IntermediateCatchEventBehaviour, {
+    ...activityDef,
+    isCatching: true,
+    ...context.getLinkEventDefinitionInfo(activityDef)
+  }, context);
 }
+
+/**
+ * Intermediate catch event behaviour
+ * @param {import('#types').Activity} activity
+ */
 function IntermediateCatchEventBehaviour(activity) {
   this.id = activity.id;
   this.type = activity.type;
   this.broker = activity.broker;
-  this[kExecution] = activity.eventDefinitions && new _EventDefinitionExecution.default(activity, activity.eventDefinitions);
+  this[_constants.K_EXECUTION] = activity.eventDefinitions && new _EventDefinitionExecution.EventDefinitionExecution(activity, activity.eventDefinitions);
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 IntermediateCatchEventBehaviour.prototype.execute = function execute(executeMessage) {
-  const execution = this[kExecution];
+  const execution = this[_constants.K_EXECUTION];
   if (execution) {
     return execution.execute(executeMessage);
   }

package/dist/events/IntermediateThrowEvent.js

@@ -3,27 +3,42 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.IntermediateThrowEvent = IntermediateThrowEvent;
 exports.IntermediateThrowEventBehaviour = IntermediateThrowEventBehaviour;
-exports.default = IntermediateThrowEvent;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
-var _EventDefinitionExecution = _interopRequireDefault(require("../eventDefinitions/EventDefinitionExecution.js"));
+var _Activity = require("../activity/Activity.js");
+var _EventDefinitionExecution = require("../eventDefinitions/EventDefinitionExecution.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kExecution = Symbol.for('execution');
+var _constants = require("../constants.js");
+/**
+ * Intermediate throw event
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function IntermediateThrowEvent(activityDef, context) {
-  return new _Activity.default(IntermediateThrowEventBehaviour, {
+  return new _Activity.Activity(IntermediateThrowEventBehaviour, {
     ...activityDef,
-    isThrowing: true
+    isThrowing: true,
+    ...context.getLinkEventDefinitionInfo(activityDef)
   }, context);
 }
+
+/**
+ * Intermediate throw event behaviour
+ * @param {import('#types').Activity} activity
+ */
 function IntermediateThrowEventBehaviour(activity) {
   this.id = activity.id;
   this.type = activity.type;
   this.broker = activity.broker;
-  this[kExecution] = activity.eventDefinitions && new _EventDefinitionExecution.default(activity, activity.eventDefinitions);
+  this[_constants.K_EXECUTION] = activity.eventDefinitions && new _EventDefinitionExecution.EventDefinitionExecution(activity, activity.eventDefinitions);
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 IntermediateThrowEventBehaviour.prototype.execute = function execute(executeMessage) {
-  const execution = this[kExecution];
+  const execution = this[_constants.K_EXECUTION];
   if (execution) {
     return execution.execute(executeMessage);
   }

package/dist/events/StartEvent.js

@@ -3,31 +3,47 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.StartEvent = StartEvent;
 exports.StartEventBehaviour = StartEventBehaviour;
-exports.default = StartEvent;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
-var _EventDefinitionExecution = _interopRequireDefault(require("../eventDefinitions/EventDefinitionExecution.js"));
+var _Activity = require("../activity/Activity.js");
+var _EventDefinitionExecution = require("../eventDefinitions/EventDefinitionExecution.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kExecuteMessage = Symbol.for('executeMessage');
-const kExecution = Symbol.for('execution');
+var _constants = require("../constants.js");
+/**
+ * Start event
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function StartEvent(activityDef, context) {
-  return new _Activity.default(StartEventBehaviour, activityDef, context);
+  return new _Activity.Activity(StartEventBehaviour, {
+    ...activityDef,
+    isStartEvent: true
+  }, context);
 }
+
+/**
+ * Start event behaviour
+ * @param {import('#types').Activity} activity
+ */
 function StartEventBehaviour(activity) {
   this.id = activity.id;
   this.type = activity.type;
   this.activity = activity;
   this.broker = activity.broker;
-  this[kExecution] = activity.eventDefinitions && new _EventDefinitionExecution.default(activity, activity.eventDefinitions);
+  this[_constants.K_EXECUTION] = activity.eventDefinitions && new _EventDefinitionExecution.EventDefinitionExecution(activity, activity.eventDefinitions);
 }
 Object.defineProperty(StartEventBehaviour.prototype, 'executionId', {
   get() {
-    return this[kExecuteMessage]?.content.executionId;
+    return this[_constants.K_EXECUTE_MESSAGE]?.content.executionId;
   }
 });
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 StartEventBehaviour.prototype.execute = function execute(executeMessage) {
-  const execution = this[kExecution];
+  const execution = this[_constants.K_EXECUTION];
   if (execution) {
     return execution.execute(executeMessage);
   }
@@ -37,7 +53,7 @@ StartEventBehaviour.prototype.execute = function execute(executeMessage) {
     return broker.publish('execution', 'execute.completed', content);
   }
   const executionId = content.executionId;
-  this[kExecuteMessage] = executeMessage;
+  this[_constants.K_EXECUTE_MESSAGE] = executeMessage;
   broker.subscribeTmp('api', `activity.#.${executionId}`, (...args) => this._onApiMessage(...args), {
     noAck: true,
     consumerTag: `_api-${executionId}`,
@@ -64,7 +80,7 @@ StartEventBehaviour.prototype._onApiMessage = function onApiMessage(routingKey,
     case 'signal':
       {
         this._stop();
-        const content = this[kExecuteMessage].content;
+        const content = this[_constants.K_EXECUTE_MESSAGE].content;
         return this.broker.publish('execution', 'execute.completed', (0, _messageHelper.cloneContent)(content, {
           output: message.content.message,
           state: 'signal'
@@ -75,7 +91,7 @@ StartEventBehaviour.prototype._onApiMessage = function onApiMessage(routingKey,
     case 'discard':
       {
         this._stop();
-        const content = this[kExecuteMessage].content;
+        const content = this[_constants.K_EXECUTE_MESSAGE].content;
         return this.broker.publish('execution', 'execute.discard', (0, _messageHelper.cloneContent)(content), {
           correlationId
         });
@@ -95,7 +111,7 @@ StartEventBehaviour.prototype._onDelegatedApiMessage = function onDelegatedApiMe
     type,
     correlationId
   } = message.properties;
-  const executeContent = this[kExecuteMessage].content;
+  const executeContent = this[_constants.K_EXECUTE_MESSAGE].content;
   this.broker.publish('event', 'activity.consumed', (0, _messageHelper.cloneContent)(executeContent, {
     message: {
       ...content.message

package/dist/events/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "BoundaryEvent", {
   enumerable: true,
   get: function () {
-    return _BoundaryEvent.default;
+    return _BoundaryEvent.BoundaryEvent;
   }
 });
 Object.defineProperty(exports, "BoundaryEventBehaviour", {
@@ -18,7 +18,7 @@ Object.defineProperty(exports, "BoundaryEventBehaviour", {
 Object.defineProperty(exports, "EndEvent", {
   enumerable: true,
   get: function () {
-    return _EndEvent.default;
+    return _EndEvent.EndEvent;
   }
 });
 Object.defineProperty(exports, "EndEventBehaviour", {
@@ -30,7 +30,7 @@ Object.defineProperty(exports, "EndEventBehaviour", {
 Object.defineProperty(exports, "IntermediateCatchEvent", {
   enumerable: true,
   get: function () {
-    return _IntermediateCatchEvent.default;
+    return _IntermediateCatchEvent.IntermediateCatchEvent;
   }
 });
 Object.defineProperty(exports, "IntermediateCatchEventBehaviour", {
@@ -42,7 +42,7 @@ Object.defineProperty(exports, "IntermediateCatchEventBehaviour", {
 Object.defineProperty(exports, "IntermediateThrowEvent", {
   enumerable: true,
   get: function () {
-    return _IntermediateThrowEvent.default;
+    return _IntermediateThrowEvent.IntermediateThrowEvent;
   }
 });
 Object.defineProperty(exports, "IntermediateThrowEventBehaviour", {
@@ -54,7 +54,7 @@ Object.defineProperty(exports, "IntermediateThrowEventBehaviour", {
 Object.defineProperty(exports, "StartEvent", {
   enumerable: true,
   get: function () {
-    return _StartEvent.default;
+    return _StartEvent.StartEvent;
   }
 });
 Object.defineProperty(exports, "StartEventBehaviour", {
@@ -63,9 +63,8 @@ Object.defineProperty(exports, "StartEventBehaviour", {
     return _StartEvent.StartEventBehaviour;
   }
 });
-var _BoundaryEvent = _interopRequireWildcard(require("./BoundaryEvent.js"));
-var _EndEvent = _interopRequireWildcard(require("./EndEvent.js"));
-var _IntermediateCatchEvent = _interopRequireWildcard(require("./IntermediateCatchEvent.js"));
-var _IntermediateThrowEvent = _interopRequireWildcard(require("./IntermediateThrowEvent.js"));
-var _StartEvent = _interopRequireWildcard(require("./StartEvent.js"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+var _BoundaryEvent = require("./BoundaryEvent.js");
+var _EndEvent = require("./EndEvent.js");
+var _IntermediateCatchEvent = require("./IntermediateCatchEvent.js");
+var _IntermediateThrowEvent = require("./IntermediateThrowEvent.js");
+var _StartEvent = require("./StartEvent.js");

package/dist/flows/Association.js

@@ -3,12 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = Association;
+exports.Association = Association;
 var _messageHelper = require("../messageHelper.js");
 var _EventBroker = require("../EventBroker.js");
 var _Api = require("../Api.js");
 var _shared = require("../shared.js");
-const kCounters = Symbol.for('counters');
+var _constants = require("../constants.js");
+/**
+ * Association connecting a source and target activity. Used to drive compensation —
+ * activities marked `isForCompensation` subscribe to inbound association events.
+ * @param {import('moddle-context-serializer').Association} associationDef
+ * @param {import('#types').ContextInstance} context
+ */
 function Association(associationDef, {
   environment
 }) {
@@ -25,13 +31,14 @@ function Association(associationDef, {
   this.type = type;
   this.name = name;
   this.parent = (0, _messageHelper.cloneParent)(parent);
+  /** @type {Record<string, any>} */
   this.behaviour = behaviour;
   this.sourceId = sourceId;
   this.targetId = targetId;
   this.isAssociation = true;
   this.environment = environment;
   const logger = this.logger = environment.Logger(type.toLowerCase());
-  this[kCounters] = {
+  this[_constants.K_COUNTERS] = {
     take: 0,
     discard: 0
   };
@@ -52,24 +59,41 @@ function Association(associationDef, {
   logger.debug(`<${id}> init, <${sourceId}> -> <${targetId}>`);
 }
 Object.defineProperty(Association.prototype, 'counters', {
+  /** @returns {{ take: number, discard: number }} */
   get() {
     return {
-      ...this[kCounters]
+      ...this[_constants.K_COUNTERS]
     };
   }
 });
+
+/**
+ * Take the association and publish association.take.
+ * @param {Record<string, any>} [content]
+ */
 Association.prototype.take = function take(content) {
   this.logger.debug(`<${this.id}> take target <${this.targetId}>`);
-  ++this[kCounters].take;
+  ++this[_constants.K_COUNTERS].take;
   this._publishEvent('take', content);
   return true;
 };
+
+/**
+ * Discard the association and publish association.discard.
+ * @param {Record<string, any>} [content]
+ */
 Association.prototype.discard = function discard(content) {
   this.logger.debug(`<${this.id}> discard target <${this.targetId}>`);
-  ++this[kCounters].discard;
+  ++this[_constants.K_COUNTERS].discard;
   this._publishEvent('discard', content);
   return true;
 };
+
+/**
+ * Snapshot association state. Returns undefined when broker has no state and
+ * `disableTrackState` is set.
+ * @returns {import('#types').AssociationState | undefined}
+ */
 Association.prototype.getState = function getState() {
   const brokerState = this.broker.getState(true);
   if (!brokerState && this.environment.settings.disableTrackState) return;
@@ -80,18 +104,35 @@ Association.prototype.getState = function getState() {
     broker: brokerState
   };
 };
+
+/**
+ * Restore association state captured by getState.
+ * @param {import('#types').AssociationState} state
+ */
 Association.prototype.recover = function recover(state) {
-  Object.assign(this[kCounters], state.counters);
+  Object.assign(this[_constants.K_COUNTERS], state.counters);
   this.broker.recover(state.broker);
 };
+
+/**
+ * Resolve an association-scoped Api wrapper.
+ * @param {import('#types').ElementBrokerMessage} [message]
+ * @returns {import('#types').IApi<this>}
+ */
 Association.prototype.getApi = function getApi(message) {
   return new _Api.Api('association', this.broker, message || {
     content: this._createMessageContent()
   });
 };
+
+/**
+ * Stop the association's broker.
+ */
 Association.prototype.stop = function stop() {
   this.broker.stop();
 };
+
+/** @internal */
 Association.prototype._publishEvent = function publishEvent(action, content) {
   const eventContent = this._createMessageContent({
     action,
@@ -102,6 +143,8 @@ Association.prototype._publishEvent = function publishEvent(action, content) {
     type: action
   });
 };
+
+/** @internal */
 Association.prototype._createMessageContent = function createMessageContent(override) {
   return {
     ...override,

package/dist/flows/MessageFlow.js

@@ -3,13 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = MessageFlow;
+exports.MessageFlow = MessageFlow;
 var _shared = require("../shared.js");
 var _messageHelper = require("../messageHelper.js");
 var _EventBroker = require("../EventBroker.js");
 var _Api = require("../Api.js");
-const kCounters = Symbol.for('counters');
-const kSourceElement = Symbol.for('sourceElement');
+var _constants = require("../constants.js");
+const K_SOURCE_ELEMENT = Symbol.for('sourceElement');
+
+/**
+ * Message flow connecting a source activity (or process) to a target. Subscribes to the
+ * source's `end` event and publishes `message.outbound` whenever the source completes,
+ * carrying any message payload through to the target.
+ * @param {import('moddle-context-serializer').MessageFlow} flowDef
+ * @param {import('#types').ContextInstance} context
+ */
 function MessageFlow(flowDef, context) {
   const {
     id,
@@ -26,10 +34,11 @@ function MessageFlow(flowDef, context) {
   this.parent = (0, _messageHelper.cloneParent)(parent);
   this.source = source;
   this.target = target;
+  /** @type {Record<string, any>} */
   this.behaviour = behaviour;
   this.environment = context.environment;
   this.context = context;
-  this[kCounters] = {
+  this[_constants.K_COUNTERS] = {
     messages: 0
   };
   const {
@@ -44,16 +53,23 @@ function MessageFlow(flowDef, context) {
   this.once = once;
   this.emit = emit;
   this.waitFor = waitFor;
-  this[kSourceElement] = context.getActivityById(source.id) || context.getProcessById(source.processId);
+  this[K_SOURCE_ELEMENT] = context.getActivityById(source.id) || context.getProcessById(source.processId);
   this.logger = context.environment.Logger(type.toLowerCase());
 }
 Object.defineProperty(MessageFlow.prototype, 'counters', {
+  /** @returns {{ messages: number }} */
   get() {
     return {
-      ...this[kCounters]
+      ...this[_constants.K_COUNTERS]
     };
   }
 });
+
+/**
+ * Snapshot message-flow state. Returns undefined when broker has no state and
+ * `disableTrackState` is set.
+ * @returns {import('#types').MessageFlowState | undefined}
+ */
 MessageFlow.prototype.getState = function getState() {
   const brokerState = this.broker.getState(true);
   if (!brokerState && this.environment.settings.disableTrackState) return;
@@ -64,17 +80,32 @@ MessageFlow.prototype.getState = function getState() {
     broker: brokerState
   };
 };
+
+/**
+ * Restore message-flow state captured by getState.
+ * @param {import('#types').MessageFlowState} state
+ */
 MessageFlow.prototype.recover = function recover(state) {
-  Object.assign(this[kCounters], state.counters);
+  Object.assign(this[_constants.K_COUNTERS], state.counters);
   this.broker.recover(state.broker);
 };
+
+/**
+ * Resolve a message-scoped Api wrapper.
+ * @param {import('#types').ElementBrokerMessage} [message]
+ * @returns {import('#types').IApi<this>}
+ */
 MessageFlow.prototype.getApi = function getApi(message) {
   return new _Api.Api('message', this.broker, message || {
     content: this._createMessageContent()
   });
 };
+
+/**
+ * Subscribe to the source element's message and end events to bridge the message across.
+ */
 MessageFlow.prototype.activate = function activate() {
-  const sourceElement = this[kSourceElement];
+  const sourceElement = this[K_SOURCE_ELEMENT];
   const safeId = (0, _shared.brokerSafeId)(this.id);
   sourceElement.on('message', this.deactivate.bind(this), {
     consumerTag: `_message-on-message-${safeId}`
@@ -83,21 +114,29 @@ MessageFlow.prototype.activate = function activate() {
     consumerTag: `_message-on-end-${safeId}`
   });
 };
+
+/**
+ * Cancel the source element subscriptions added by activate.
+ */
 MessageFlow.prototype.deactivate = function deactivate() {
-  const sourceElement = this[kSourceElement];
+  const sourceElement = this[K_SOURCE_ELEMENT];
   const safeId = (0, _shared.brokerSafeId)(this.id);
   sourceElement.broker.cancel(`_message-on-end-${safeId}`);
   sourceElement.broker.cancel(`_message-on-message-${safeId}`);
 };
+
+/** @internal */
 MessageFlow.prototype._onSourceEnd = function onSourceEnd({
   content
 }) {
-  ++this[kCounters].messages;
+  ++this[_constants.K_COUNTERS].messages;
   const source = this.source;
   const target = this.target;
   this.logger.debug(`<${this.id}> sending message from <${source.processId}.${source.id}> to <${target.id ? `${target.processId}.${target.id}` : target.processId}>`);
   this.broker.publish('event', 'message.outbound', this._createMessageContent(content.message));
 };
+
+/** @internal */
 MessageFlow.prototype._createMessageContent = function createMessage(message) {
   return {
     id: this.id,