bpmn-elements 17.2.2 → 18.0.0

package/dist/io/EnvironmentDataStore.js

@@ -3,7 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = EnvironmentDataStore;
+exports.EnvironmentDataStore = EnvironmentDataStore;
+/**
+ * Builtin data store. Reads from / writes to `environment.variables._data`.
+ * @param {import('moddle-context-serializer').DataStore} dataStoreDef
+ * @param {import('#types').ContextInstance} context
+ * @satisfies {import('#types').IIOData}
+ */
 function EnvironmentDataStore(dataStoreDef, {
   environment
 }) {
@@ -17,16 +23,33 @@ function EnvironmentDataStore(dataStoreDef, {
   this.id = id;
   this.type = type;
   this.name = name;
+  /** @type {Record<string, any>} */
   this.behaviour = behaviour;
+  /** @type {import('moddle-context-serializer').Parent | undefined} */
   this.parent = parent;
   this.environment = environment;
 }
+
+/**
+ * @param {import('smqp').Broker} broker
+ * @param {string} exchange
+ * @param {string} routingKeyPrefix
+ * @param {Record<string, any>} [messageProperties]
+ */
 EnvironmentDataStore.prototype.read = function read(broker, exchange, routingKeyPrefix, messageProperties) {
   const environment = this.environment;
   const value = environment.variables._data?.[this.id];
   const content = this._createContent(value);
   return broker.publish(exchange, `${routingKeyPrefix}response`, content, messageProperties);
 };
+
+/**
+ * @param {import('smqp').Broker} broker
+ * @param {string} exchange
+ * @param {string} routingKeyPrefix
+ * @param {any} value
+ * @param {Record<string, any>} [messageProperties]
+ */
 EnvironmentDataStore.prototype.write = function write(broker, exchange, routingKeyPrefix, value, messageProperties) {
   const environment = this.environment;
   environment.variables._data = environment.variables._data || {};

package/dist/io/EnvironmentDataStoreReference.js

@@ -3,7 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = EnvironmentDataStoreReference;
+exports.EnvironmentDataStoreReference = EnvironmentDataStoreReference;
+/**
+ * Builtin data store reference. Reads from / writes to `environment.variables._data`.
+ * @param {import('moddle-context-serializer').DataStore} dataObjectDef
+ * @param {import('#types').ContextInstance} context
+ * @satisfies {import('#types').IIOData}
+ */
 function EnvironmentDataStoreReference(dataObjectDef, {
   environment
 }) {
@@ -17,16 +23,33 @@ function EnvironmentDataStoreReference(dataObjectDef, {
   this.id = id;
   this.type = type;
   this.name = name;
+  /** @type {Record<string, any>} */
   this.behaviour = behaviour;
+  /** @type {import('moddle-context-serializer').Parent | undefined} */
   this.parent = parent;
   this.environment = environment;
 }
+
+/**
+ * @param {import('smqp').Broker} broker
+ * @param {string} exchange
+ * @param {string} routingKeyPrefix
+ * @param {Record<string, any>} [messageProperties]
+ */
 EnvironmentDataStoreReference.prototype.read = function read(broker, exchange, routingKeyPrefix, messageProperties) {
   const environment = this.environment;
   const value = environment.variables._data?.[this.id];
   const content = this._createContent(value);
   return broker.publish(exchange, `${routingKeyPrefix}response`, content, messageProperties);
 };
+
+/**
+ * @param {import('smqp').Broker} broker
+ * @param {string} exchange
+ * @param {string} routingKeyPrefix
+ * @param {any} value
+ * @param {Record<string, any>} [messageProperties]
+ */
 EnvironmentDataStoreReference.prototype.write = function write(broker, exchange, routingKeyPrefix, value, messageProperties) {
   const environment = this.environment;
   environment.variables._data = environment.variables._data || {};

package/dist/io/InputOutputSpecification.js

@@ -3,11 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = IoSpecification;
-var _getPropertyValue = _interopRequireDefault(require("../getPropertyValue.js"));
+exports.IoSpecification = IoSpecification;
+var _getPropertyValue = require("../getPropertyValue.js");
 var _shared = require("../shared.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kConsuming = Symbol.for('consuming');
+var _constants = require("../constants.js");
+/**
+ * Activity ioSpecification behaviour. Reads bound data objects on enter and writes them on completion.
+ * @param {import('#types').Activity} activity
+ * @param {import('moddle-context-serializer').IoSpecification} ioSpecificationDef
+ * @param {import('#types').ContextInstance} context
+ * @satisfies {import('#types').IExtension}
+ */
 function IoSpecification(activity, ioSpecificationDef, context) {
   const {
     id,
@@ -21,20 +27,24 @@ function IoSpecification(activity, ioSpecificationDef, context) {
   this.broker = activity.broker;
   this.context = context;
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} [message]
+ */
 IoSpecification.prototype.activate = function activate(message) {
-  if (this[kConsuming]) return;
+  if (this[_constants.K_CONSUMING]) return;
   if (message?.fields.redelivered && message.fields.routingKey === 'run.start') {
     this._onFormatEnter();
   }
   if (message?.fields.redelivered && message.fields.routingKey === 'run.end') {
     this._onFormatComplete(message);
   }
-  this[kConsuming] = this.broker.subscribeTmp('event', 'activity.#', this._onActivityEvent.bind(this), {
+  this[_constants.K_CONSUMING] = this.broker.subscribeTmp('event', 'activity.#', this._onActivityEvent.bind(this), {
     noAck: true
   });
 };
 IoSpecification.prototype.deactivate = function deactivate() {
-  if (this[kConsuming]) this[kConsuming] = this[kConsuming].cancel();
+  if (this[_constants.K_CONSUMING]) this[_constants.K_CONSUMING] = this[_constants.K_CONSUMING].cancel();
 };
 IoSpecification.prototype._onActivityEvent = function onActivityEvent(routingKey, message) {
   const {
@@ -73,7 +83,7 @@ IoSpecification.prototype._onFormatEnter = function onFormatOnEnter() {
       name: ioSource.name
     };
     result.sources.push(source);
-    const dataObjectId = (0, _getPropertyValue.default)(ioSource, 'behaviour.association.source.dataObject.id');
+    const dataObjectId = (0, _getPropertyValue.getPropertyValue)(ioSource, 'behaviour.association.source.dataObject.id');
     if (!dataObjectId) return result;
     const dataObject = this.context.getDataObjectById(dataObjectId);
     if (!dataObject) return result;
@@ -118,8 +128,8 @@ IoSpecification.prototype._onFormatEnter = function onFormatOnEnter() {
 };
 IoSpecification.prototype._onFormatComplete = function formatOnComplete(message) {
   const safeType = (0, _shared.brokerSafeId)(this.type).toLowerCase();
-  const messageInputs = (0, _getPropertyValue.default)(message, 'content.ioSpecification.dataInputs');
-  const messageOutputs = (0, _getPropertyValue.default)(message, 'content.output.ioSpecification.dataOutputs') || [];
+  const messageInputs = (0, _getPropertyValue.getPropertyValue)(message, 'content.ioSpecification.dataInputs');
+  const messageOutputs = (0, _getPropertyValue.getPropertyValue)(message, 'content.output.ioSpecification.dataOutputs') || [];
   const dataOutputs = this.behaviour.dataOutputs;
   const broker = this.broker;
   const context = this.context;
@@ -137,7 +147,7 @@ IoSpecification.prototype._onFormatComplete = function formatOnComplete(message)
       value
     };
     result.sources.push(source);
-    const dataObjectId = (0, _getPropertyValue.default)(ioSource, 'behaviour.association.target.dataObject.id');
+    const dataObjectId = (0, _getPropertyValue.getPropertyValue)(ioSource, 'behaviour.association.target.dataObject.id');
     if (!dataObjectId) return result;
     const dataObject = context.getDataObjectById(dataObjectId);
     if (!dataObject) return result;

package/dist/io/Properties.js

@@ -3,15 +3,22 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = Properties;
-var _getPropertyValue = _interopRequireDefault(require("../getPropertyValue.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kProperties = Symbol.for('properties');
-const kConsuming = Symbol.for('consuming');
+exports.Properties = Properties;
+var _getPropertyValue = require("../getPropertyValue.js");
+var _constants = require("../constants.js");
+const K_PROPERTIES = Symbol.for('properties');
+
+/**
+ * Activity properties behaviour. Resolves bound data input/output references during the run.
+ * @param {import('#types').Activity} activity
+ * @param {{ type: 'properties', values: import('moddle-context-serializer').IElement[] }} propertiesDef
+ * @param {import('#types').ContextInstance} context
+ * @satisfies {import('#types').IExtension}
+ */
 function Properties(activity, propertiesDef, context) {
   this.activity = activity;
   this.broker = activity.broker;
-  const props = this[kProperties] = {
+  const props = this[K_PROPERTIES] = {
     properties: new Set(),
     dataInputObjects: new Set(),
     dataOutputObjects: new Set()
@@ -26,10 +33,10 @@ function Properties(activity, propertiesDef, context) {
       name: def.behaviour?.name
     };
     props.properties.add(source);
-    const inputDataObjectId = (0, _getPropertyValue.default)(def, 'behaviour.dataInput.association.source.dataObject.id');
-    const outputDataObjectId = (0, _getPropertyValue.default)(def, 'behaviour.dataOutput.association.target.dataObject.id');
-    const inputDataStoreId = (0, _getPropertyValue.default)(def, 'behaviour.dataInput.association.source.dataStore.id');
-    const outputDataStoreId = (0, _getPropertyValue.default)(def, 'behaviour.dataOutput.association.target.dataStore.id');
+    const inputDataObjectId = (0, _getPropertyValue.getPropertyValue)(def, 'behaviour.dataInput.association.source.dataObject.id');
+    const outputDataObjectId = (0, _getPropertyValue.getPropertyValue)(def, 'behaviour.dataOutput.association.target.dataObject.id');
+    const inputDataStoreId = (0, _getPropertyValue.getPropertyValue)(def, 'behaviour.dataInput.association.source.dataStore.id');
+    const outputDataStoreId = (0, _getPropertyValue.getPropertyValue)(def, 'behaviour.dataOutput.association.target.dataStore.id');
     if (inputDataObjectId) {
       const reference = context.getDataObjectById(inputDataObjectId);
       props.dataInputObjects.add({
@@ -72,20 +79,24 @@ function Properties(activity, propertiesDef, context) {
     }
   }
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} message
+ */
 Properties.prototype.activate = function activate(message) {
-  if (this[kConsuming]) return;
+  if (this[_constants.K_CONSUMING]) return;
   if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
     this._onActivityEvent('activity.enter', message);
   }
   if (message.fields.redelivered && message.content.properties) {
     this._onActivityEvent('activity.extension.resume', message);
   }
-  this[kConsuming] = this.broker.subscribeTmp('event', 'activity.#', this._onActivityEvent.bind(this), {
+  this[_constants.K_CONSUMING] = this.broker.subscribeTmp('event', 'activity.#', this._onActivityEvent.bind(this), {
     noAck: true
   });
 };
 Properties.prototype.deactivate = function deactivate() {
-  if (this[kConsuming]) this[kConsuming] = this[kConsuming].cancel();
+  if (this[_constants.K_CONSUMING]) this[_constants.K_CONSUMING] = this[_constants.K_CONSUMING].cancel();
 };
 Properties.prototype._onActivityEvent = function onActivityEvent(routingKey, message) {
   switch (routingKey) {
@@ -98,7 +109,7 @@ Properties.prototype._onActivityEvent = function onActivityEvent(routingKey, mes
 };
 Properties.prototype._formatOnEnter = function formatOnEnter(message) {
   const startRoutingKey = 'run.enter.bpmn-properties';
-  const dataInputObjects = this[kProperties].dataInputObjects;
+  const dataInputObjects = this[K_PROPERTIES].dataInputObjects;
   const broker = this.broker;
   if (!dataInputObjects.size) {
     return broker.getQueue('format-run-q').queueMessage({
@@ -122,9 +133,9 @@ Properties.prototype._formatOnEnter = function formatOnEnter(message) {
 };
 Properties.prototype._formatOnComplete = function formatOnComplete(message) {
   const startRoutingKey = 'run.end.bpmn-properties';
-  const messageOutput = (0, _getPropertyValue.default)(message, 'content.output.properties') || {};
+  const messageOutput = (0, _getPropertyValue.getPropertyValue)(message, 'content.output.properties') || {};
   const outputProperties = this._getProperties(message, messageOutput);
-  const dataOutputObjects = this[kProperties].dataOutputObjects;
+  const dataOutputObjects = this[K_PROPERTIES].dataOutputObjects;
   const broker = this.broker;
   if (!dataOutputObjects.size) {
     return broker.getQueue('format-run-q').queueMessage({
@@ -157,7 +168,7 @@ Properties.prototype._getProperties = function getProperties(message, values) {
     id,
     type,
     name
-  } of this[kProperties].properties) {
+  } of this[K_PROPERTIES].properties) {
     if (!(id in response)) {
       response[id] = {
         id,

package/dist/messageHelper.js

@@ -9,14 +9,21 @@ exports.cloneParent = cloneParent;
 exports.pushParent = pushParent;
 exports.shiftParent = shiftParent;
 exports.unshiftParent = unshiftParent;
+/**
+ * Clone message content
+ * @param {import('#types').ElementMessageContent} content
+ * @param {Record<string, any>} [extend]
+ * @returns cloned content
+ */
 function cloneContent(content, extend) {
   const {
-    discardSequence,
     inbound,
     outbound,
     parent,
     sequence
   } = content;
+
+  /** @type {import('#types').ElementMessageContent} */
   const clone = {
     ...content,
     ...extend
@@ -24,9 +31,6 @@ function cloneContent(content, extend) {
   if (parent) {
     clone.parent = cloneParent(parent);
   }
-  if (discardSequence) {
-    clone.discardSequence = discardSequence.slice();
-  }
   if (inbound) {
     clone.inbound = inbound.map(c => cloneContent(c));
   }
@@ -38,6 +42,13 @@ function cloneContent(content, extend) {
   }
   return clone;
 }
+
+/**
+ * Clone message
+ * @param {import('#types').ElementBrokerMessage} message
+ * @param {Record<string, any>} [overrideContent]
+ * @returns {Pick<ElementBrokerMessage, 'fields' | 'content', 'properties'>}
+ */
 function cloneMessage(message, overrideContent) {
   return {
     fields: {
@@ -49,6 +60,12 @@ function cloneMessage(message, overrideContent) {
     }
   };
 }
+
+/**
+ * Clone parent
+ * @param {import('#types').ElementParent} parent
+ * @returns {import('#types').ElementParent} cloned parent
+ */
 function cloneParent(parent) {
   const {
     path
@@ -64,6 +81,13 @@ function cloneParent(parent) {
   });
   return clone;
 }
+
+/**
+ * Add parent to top of path
+ * @param {import('#types').ElementParent} parent
+ * @param {import('#types').ElementMessageContent} adoptingParent
+ * @returns {import('#types').ElementParent}
+ */
 function unshiftParent(parent, adoptingParent) {
   const {
     id,
@@ -94,6 +118,12 @@ function unshiftParent(parent, adoptingParent) {
   });
   return clone;
 }
+
+/**
+ * Remove top parent from path
+ * @param {import('#types').ElementParent} parent
+ * @returns {import('#types').ElementParent}
+ */
 function shiftParent(parent) {
   if (!parent) return;
   if (!parent.path || !parent.path.length) return;
@@ -109,6 +139,13 @@ function shiftParent(parent) {
   clone.path = clone.path.length ? clone.path : undefined;
   return clone;
 }
+
+/**
+ * Add ancestor parent at end
+ * @param {import('#types').ElementParent} parent
+ * @param {import('#types').ElementMessageContent} ancestor
+ * @returns {import('#types').ElementParent}
+ */
 function pushParent(parent, ancestor) {
   const {
     id,

package/dist/process/Lane.js

@@ -3,8 +3,15 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = Lane;
-const kProcess = Symbol.for('process');
+exports.Lane = Lane;
+const K_PROCESS = Symbol.for('process');
+
+/**
+ * Process lane. Wraps a `<bpmn:lane>` definition and points back to its owning process;
+ * activities reference their lane through `Activity.lane`.
+ * @param {import('#types').Process} process
+ * @param {import('moddle-context-serializer').SerializableElement} laneDefinition
+ */
 function Lane(process, laneDefinition) {
   const {
     broker,
@@ -15,14 +22,17 @@ function Lane(process, laneDefinition) {
     type,
     behaviour
   } = laneDefinition;
-  this[kProcess] = process;
+  this[K_PROCESS] = process;
   this.id = id;
   this.type = type;
+  /** @type {string} */
   this.name = behaviour.name;
+  /** @type {import('moddle-context-serializer').Parent} */
   this.parent = {
     id: process.id,
     type: process.type
   };
+  /** @type {Record<string, any>} */
   this.behaviour = {
     ...behaviour
   };
@@ -32,7 +42,8 @@ function Lane(process, laneDefinition) {
   this.logger = environment.Logger(type.toLowerCase());
 }
 Object.defineProperty(Lane.prototype, 'process', {
+  /** @returns {import('#types').Process} */
   get() {
-    return this[kProcess];
+    return this[K_PROCESS];
   }
 });