bpmn-elements 17.2.2 → 18.0.0

package/src/io/EnvironmentDataStore.js

@@ -1,13 +1,27 @@
-export default function EnvironmentDataStore(dataStoreDef, { environment }) {
+/**
+ * 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}
+ */
+export function EnvironmentDataStore(dataStoreDef, { environment }) {
   const { id, type, name, behaviour, parent } = 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];
@@ -15,6 +29,13 @@ EnvironmentDataStore.prototype.read = function read(broker, exchange, routingKey
   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/src/io/EnvironmentDataStoreReference.js

@@ -1,13 +1,27 @@
-export default function EnvironmentDataStoreReference(dataObjectDef, { environment }) {
+/**
+ * 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}
+ */
+export function EnvironmentDataStoreReference(dataObjectDef, { environment }) {
   const { id, type, name, behaviour, parent } = 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];
@@ -15,6 +29,13 @@ EnvironmentDataStoreReference.prototype.read = function read(broker, exchange, r
   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/src/io/InputOutputSpecification.js

@@ -1,9 +1,15 @@
-import getPropertyValue from '../getPropertyValue.js';
+import { getPropertyValue } from '../getPropertyValue.js';
 import { brokerSafeId } from '../shared.js';
-
-const kConsuming = Symbol.for('consuming');
-
-export default function IoSpecification(activity, ioSpecificationDef, context) {
+import { K_CONSUMING } from '../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}
+ */
+export function IoSpecification(activity, ioSpecificationDef, context) {
   const { id, type = 'iospecification', behaviour = {} } = ioSpecificationDef;
   this.id = id;
   this.type = type;
@@ -13,19 +19,22 @@ export default function IoSpecification(activity, ioSpecificationDef, context) {
   this.context = context;
 }
 
+/**
+ * @param {import('#types').ElementBrokerMessage} [message]
+ */
 IoSpecification.prototype.activate = function activate(message) {
-  if (this[kConsuming]) return;
+  if (this[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), { noAck: true });
+  this[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[K_CONSUMING]) this[K_CONSUMING] = this[K_CONSUMING].cancel();
 };
 
 IoSpecification.prototype._onActivityEvent = function onActivityEvent(routingKey, message) {

package/src/io/Properties.js

@@ -1,13 +1,20 @@
-import getPropertyValue from '../getPropertyValue.js';
-
-const kProperties = Symbol.for('properties');
-const kConsuming = Symbol.for('consuming');
-
-export default function Properties(activity, propertiesDef, context) {
+import { getPropertyValue } from '../getPropertyValue.js';
+import { K_CONSUMING } from '../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}
+ */
+export 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(),
@@ -57,8 +64,11 @@ export default function Properties(activity, propertiesDef, context) {
   }
 }
 
+/**
+ * @param {import('#types').ElementBrokerMessage} message
+ */
 Properties.prototype.activate = function activate(message) {
-  if (this[kConsuming]) return;
+  if (this[K_CONSUMING]) return;
   if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
     this._onActivityEvent('activity.enter', message);
   }
@@ -67,11 +77,11 @@ Properties.prototype.activate = function activate(message) {
     this._onActivityEvent('activity.extension.resume', message);
   }
 
-  this[kConsuming] = this.broker.subscribeTmp('event', 'activity.#', this._onActivityEvent.bind(this), { noAck: true });
+  this[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[K_CONSUMING]) this[K_CONSUMING] = this[K_CONSUMING].cancel();
 };
 
 Properties.prototype._onActivityEvent = function onActivityEvent(routingKey, message) {
@@ -87,7 +97,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(
@@ -120,7 +130,7 @@ Properties.prototype._formatOnComplete = function formatOnComplete(message) {
   const messageOutput = 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(
@@ -154,7 +164,7 @@ Properties.prototype._getProperties = function getProperties(message, values) {
     response = { ...message.content.properties };
   }
 
-  for (const { id, type, name } of this[kProperties].properties) {
+  for (const { id, type, name } of this[K_PROPERTIES].properties) {
     if (!(id in response)) {
       response[id] = { id, type, name };
     }

package/src/messageHelper.js

@@ -1,6 +1,13 @@
+/**
+ * Clone message content
+ * @param {import('#types').ElementMessageContent} content
+ * @param {Record<string, any>} [extend]
+ * @returns cloned content
+ */
 export function cloneContent(content, extend) {
-  const { discardSequence, inbound, outbound, parent, sequence } = content;
+  const { inbound, outbound, parent, sequence } = content;
 
+  /** @type {import('#types').ElementMessageContent} */
   const clone = {
     ...content,
     ...extend,
@@ -9,9 +16,6 @@ export 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));
   }
@@ -25,6 +29,12 @@ export function cloneContent(content, extend) {
   return clone;
 }
 
+/**
+ * Clone message
+ * @param {import('#types').ElementBrokerMessage} message
+ * @param {Record<string, any>} [overrideContent]
+ * @returns {Pick<ElementBrokerMessage, 'fields' | 'content', 'properties'>}
+ */
 export function cloneMessage(message, overrideContent) {
   return {
     fields: { ...message.fields },
@@ -33,6 +43,11 @@ export function cloneMessage(message, overrideContent) {
   };
 }
 
+/**
+ * Clone parent
+ * @param {import('#types').ElementParent} parent
+ * @returns {import('#types').ElementParent} cloned parent
+ */
 export function cloneParent(parent) {
   const { path } = parent;
   const clone = { ...parent };
@@ -45,6 +60,12 @@ export 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}
+ */
 export function unshiftParent(parent, adoptingParent) {
   const { id, type, executionId } = adoptingParent;
   if (!parent) {
@@ -67,6 +88,11 @@ export function unshiftParent(parent, adoptingParent) {
   return clone;
 }
 
+/**
+ * Remove top parent from path
+ * @param {import('#types').ElementParent} parent
+ * @returns {import('#types').ElementParent}
+ */
 export function shiftParent(parent) {
   if (!parent) return;
   if (!parent.path || !parent.path.length) return;
@@ -80,6 +106,12 @@ export function shiftParent(parent) {
   return clone;
 }
 
+/**
+ * Add ancestor parent at end
+ * @param {import('#types').ElementParent} parent
+ * @param {import('#types').ElementMessageContent} ancestor
+ * @returns {import('#types').ElementParent}
+ */
 export function pushParent(parent, ancestor) {
   const { id, type, executionId } = ancestor;
   if (!parent) return { id, type, executionId };

package/src/process/Lane.js

@@ -1,18 +1,27 @@
-const kProcess = Symbol.for('process');
+const K_PROCESS = Symbol.for('process');
 
-export default function Lane(process, laneDefinition) {
+/**
+ * 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
+ */
+export function Lane(process, laneDefinition) {
   const { broker, environment } = process;
   const { id, 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 };
   this.environment = environment;
   this.broker = broker;
@@ -21,7 +30,8 @@ export default function Lane(process, laneDefinition) {
 }
 
 Object.defineProperty(Lane.prototype, 'process', {
+  /** @returns {import('#types').Process} */
   get() {
-    return this[kProcess];
+    return this[K_PROCESS];
   },
 });