bpmn-elements 17.3.0 → 18.0.1

package/README.md

@@ -30,6 +30,7 @@ The following elements are tested and supported.
 - ErrorEventDefinition
   - throw
   - catch
+- [Escalation](/docs/MessageElements.md)
 - EscalationEventDefinition
   - throw
   - catch
@@ -42,6 +43,7 @@ The following elements are tested and supported.
 - LinkEventDefinition
   - throw
   - catch
+- [Message](/docs/MessageElements.md)
 - MessageEventDefinition
   - throw
   - catch
@@ -58,7 +60,7 @@ The following elements are tested and supported.
 - [ServiceTask](/docs/ServiceTask.md)
   - BusinessRuleTask: Same behaviour as ServiceTask
   - SendTask: Same behaviour as ServiceTask
-- Signal
+- [Signal](/docs/MessageElements.md)
 - SignalEventDefinition
   - throw
   - catch

package/dist/Api.js

@@ -10,18 +10,54 @@ exports.FlowApi = FlowApi;
 exports.ProcessApi = ProcessApi;
 var _messageHelper = require("./messageHelper.js");
 var _shared = require("./shared.js");
+/**
+ * Build an activity-scoped Api wrapper. Routing keys are published under `activity.*`.
+ * @param {any} broker
+ * @param {import('#types').ElementBrokerMessage} apiMessage
+ * @param {import('#types').Environment} [environment]
+ */
 function ActivityApi(broker, apiMessage, environment) {
   return new Api('activity', broker, apiMessage, environment);
 }
+
+/**
+ * Build a definition-scoped Api wrapper. Routing keys are published under `definition.*`.
+ * @param {any} broker
+ * @param {import('#types').ElementBrokerMessage} apiMessage
+ * @param {import('#types').Environment} [environment]
+ */
 function DefinitionApi(broker, apiMessage, environment) {
   return new Api('definition', broker, apiMessage, environment);
 }
+
+/**
+ * Build a process-scoped Api wrapper. Routing keys are published under `process.*`.
+ * @param {any} broker
+ * @param {import('#types').ElementBrokerMessage} apiMessage
+ * @param {import('#types').Environment} [environment]
+ */
 function ProcessApi(broker, apiMessage, environment) {
   return new Api('process', broker, apiMessage, environment);
 }
+
+/**
+ * Build a flow-scoped Api wrapper. Routing keys are published under `flow.*`.
+ * @param {any} broker
+ * @param {import('#types').ElementBrokerMessage} apiMessage
+ * @param {import('#types').Environment} [environment]
+ */
 function FlowApi(broker, apiMessage, environment) {
   return new Api('flow', broker, apiMessage, environment);
 }
+
+/**
+ * Lightweight wrapper over the broker that exposes signal/cancel/fail/stop and other api actions.
+ * @param {string} pfx Message prefix, e.g. `activity`, `process`, `definition`, `flow`
+ * @param {any} broker
+ * @param {import('#types').ElementBrokerMessage} sourceMessage Cloned to back the api
+ * @param {import('#types').Environment} [environment] Defaults to `broker.owner.environment`
+ * @throws {Error} when sourceMessage is missing
+ */
 function Api(pfx, broker, sourceMessage, environment) {
   if (!sourceMessage) throw new Error('Api requires message');
   const apiMessage = (0, _messageHelper.cloneMessage)(sourceMessage);
@@ -43,27 +79,57 @@ function Api(pfx, broker, sourceMessage, environment) {
   this.owner = broker.owner;
   this.messagePrefix = pfx;
 }
+
+/**
+ * Send a cancel api message.
+ * @param {import('#types').signalMessage} [message]
+ * @param {any} [options]
+ */
 Api.prototype.cancel = function cancel(message, options) {
   this.sendApiMessage('cancel', {
     message
   }, options);
 };
+
+/**
+ * Send a discard api message.
+ */
 Api.prototype.discard = function discard() {
   this.sendApiMessage('discard');
 };
+
+/**
+ * Send an error api message that fails the activity.
+ * @param {Error} error
+ */
 Api.prototype.fail = function fail(error) {
   this.sendApiMessage('error', {
     error
   });
 };
+
+/**
+ * Send a signal api message.
+ * @param {import('#types').signalMessage} [message]
+ * @param {any} [options]
+ */
 Api.prototype.signal = function signal(message, options) {
   this.sendApiMessage('signal', {
     message
   }, options);
 };
+
+/**
+ * Send a stop api message.
+ */
 Api.prototype.stop = function stop() {
   this.sendApiMessage('stop');
 };
+
+/**
+ * Resolve an expression with the api message as scope and the broker owner as context.
+ * @param {string} expression
+ */
 Api.prototype.resolveExpression = function resolveExpression(expression) {
   return this.environment.resolveExpression(expression, {
     fields: this.fields,
@@ -71,6 +137,13 @@ Api.prototype.resolveExpression = function resolveExpression(expression) {
     properties: this.messageProperties
   }, this.owner);
 };
+
+/**
+ * Publish a custom api message to the broker.
+ * @param {string} action Routing key suffix, e.g. `signal`, `cancel`
+ * @param {import('#types').signalMessage} [content] Merged into the message content
+ * @param {any} [options]
+ */
 Api.prototype.sendApiMessage = function sendApiMessage(action, content, options) {
   const correlationId = options?.correlationId || (0, _shared.getUniqueId)(`${this.id || this.messagePrefix}_signal`);
   let key = `${this.messagePrefix}.${action}`;
@@ -81,11 +154,21 @@ Api.prototype.sendApiMessage = function sendApiMessage(action, content, options)
     type: action
   });
 };
+
+/**
+ * List currently postponed activities, falling back to a sub-process execution when applicable.
+ * @param {import('#types').filterPostponed} [filterFn]
+ */
 Api.prototype.getPostponed = function getPostponed(...args) {
   if (this.owner.getPostponed) return this.owner.getPostponed(...args);
   if (this.owner.isSubProcess && this.owner.execution) return this.owner.execution.getPostponed(...args);
   return [];
 };
+
+/**
+ * Build a message body by merging the given content onto the source content.
+ * @param {Record<string, any>} [content]
+ */
 Api.prototype.createMessage = function createMessage(content) {
   return {
     ...this.content,

package/dist/Context.js

@@ -3,39 +3,64 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = Context;
-var _BpmnIO = _interopRequireDefault(require("./io/BpmnIO.js"));
-var _Environment = _interopRequireDefault(require("./Environment.js"));
+exports.Context = Context;
+exports.ContextInstance = ContextInstance;
+var _BpmnIO = require("./io/BpmnIO.js");
+var _Environment = require("./Environment.js");
 var _shared = require("./shared.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kOwner = Symbol.for('owner');
-const kActivated = Symbol.for('activated');
+var _constants = require("./constants.js");
+const K_OWNER = Symbol.for('owner');
+
+/**
+ * Build a runtime Context from a parsed BPMN definition.
+ * @param {import('moddle-context-serializer').SerializableContext} definitionContext
+ * @param {import('#types').Environment} [environment] Existing environment to clone; a fresh one is created when omitted
+ */
 function Context(definitionContext, environment) {
-  environment = environment ? environment.clone() : new _Environment.default();
+  environment = environment ? environment.clone() : new _Environment.Environment();
   return new ContextInstance(definitionContext, environment);
 }
-function ContextInstance(definitionContext, environment, owner) {
+
+/**
+ * Per-execution registry that lazily upserts activities, flows, and processes from the parsed BPMN definition.
+ * @param {import('moddle-context-serializer').SerializableContext} definitionContext
+ * @param {import('#types').Environment} environment
+ * @param {import('#types').Process | import('#types').Activity} [owner] Process or sub-process activity that owns this context
+ * @param {Map<string, any>} [peersCache] Shared converging parallel gateway peer cache; created at the root and propagated to every clone
+ */
+function ContextInstance(definitionContext, environment, owner, peersCache) {
   const {
     id = 'Def',
     name,
     type = 'context'
   } = definitionContext;
-  const sid = (0, _shared.getUniqueId)(id);
   this.id = id;
   this.name = name;
   this.type = type;
-  this.sid = sid;
+  /** Unique instance id */
+  this.sid = (0, _shared.getUniqueId)(id);
   this.definitionContext = definitionContext;
   this.environment = environment;
+  /** Discovered parallel gateway peers, keyed by gateway id, shared with all clones. Runtime-only, not serialized. */
+  this.peersCache = peersCache || new Map();
+  /** @type {import('#types').IExtensionsMapper}  */
   this.extensionsMapper = new ExtensionsMapper(this);
+  /** @private */
   this.refs = new Map([['activityRefs', new Map()], ['sequenceFlowRefs', new Map()], ['processRefs', new Map()], ['messageFlows', new Set()], ['associationRefs', new Map()], ['dataObjectRefs', new Map()], ['dataStoreRefs', new Map()]]);
-  this[kOwner] = owner;
+  this[K_OWNER] = owner;
 }
 Object.defineProperty(ContextInstance.prototype, 'owner', {
+  /** @returns {import('#types').Process | import('#types').Activity | undefined} Process or sub-process activity that owns this context */
   get() {
-    return this[kOwner];
+    return this[K_OWNER];
   }
 });
+
+/**
+ * Get or create the activity instance for the given id.
+ * @param {string} activityId
+ * @returns {import('./activity/Activity.js').Activity | null}
+ */
 ContextInstance.prototype.getActivityById = function getActivityById(activityId) {
   const activityInstance = this.refs.get('activityRefs').get(activityId);
   if (activityInstance) return activityInstance;
@@ -43,6 +68,12 @@ ContextInstance.prototype.getActivityById = function getActivityById(activityId)
   if (!activity) return null;
   return this.upsertActivity(activity);
 };
+
+/**
+ * Return the cached activity instance, instantiating it the first time it is referenced.
+ * @param {import('moddle-context-serializer').SerializableElement} activityDef
+ * @returns {import('./activity/Activity.js').Activity}
+ */
 ContextInstance.prototype.upsertActivity = function upsertActivity(activityDef) {
   let activityInstance = this.refs.get('activityRefs').get(activityDef.id);
   if (activityInstance) return activityInstance;
@@ -50,6 +81,12 @@ ContextInstance.prototype.upsertActivity = function upsertActivity(activityDef)
   this.refs.get('activityRefs').set(activityDef.id, activityInstance);
   return activityInstance;
 };
+
+/**
+ * Get or create the sequence flow instance for the given id.
+ * @param {string} sequenceFlowId
+ * @returns {import('./flows/SequenceFlow.js').SequenceFlow | null}
+ */
 ContextInstance.prototype.getSequenceFlowById = function getSequenceFlowById(sequenceFlowId) {
   const flowInstance = this.refs.get('sequenceFlowRefs').get(sequenceFlowId);
   if (flowInstance) return flowInstance;
@@ -57,24 +94,56 @@ ContextInstance.prototype.getSequenceFlowById = function getSequenceFlowById(seq
   if (!flowDef) return null;
   return this.upsertSequenceFlow(flowDef);
 };
+
+/**
+ * @param {string} activityId
+ */
 ContextInstance.prototype.getInboundSequenceFlows = function getInboundSequenceFlows(activityId) {
   return (this.definitionContext.getInboundSequenceFlows(activityId) || []).map(flow => this.upsertSequenceFlow(flow));
 };
+
+/**
+ * @param {string} activityId
+ */
 ContextInstance.prototype.getOutboundSequenceFlows = function getOutboundSequenceFlows(activityId) {
   return (this.definitionContext.getOutboundSequenceFlows(activityId) || []).map(flow => this.upsertSequenceFlow(flow));
 };
+
+/**
+ * @param {string} activityId
+ */
 ContextInstance.prototype.getInboundAssociations = function getInboundAssociations(activityId) {
   return (this.definitionContext.getInboundAssociations(activityId) || []).map(association => this.upsertAssociation(association));
 };
+
+/**
+ * @param {string} activityId
+ */
 ContextInstance.prototype.getOutboundAssociations = function getOutboundAssociations(activityId) {
   return (this.definitionContext.getOutboundAssociations(activityId) || []).map(association => this.upsertAssociation(association));
 };
+
+/**
+ * Get every activity in the definition, optionally narrowed to a parent scope.
+ * @param {string} [scopeId] Process or sub-process id
+ */
 ContextInstance.prototype.getActivities = function getActivities(scopeId) {
   return (this.definitionContext.getActivities(scopeId) || []).map(activityDef => this.upsertActivity(activityDef));
 };
+
+/**
+ * Get every sequence flow in the definition, optionally narrowed to a parent scope.
+ * @param {string} [scopeId] Process or sub-process id
+ */
 ContextInstance.prototype.getSequenceFlows = function getSequenceFlows(scopeId) {
   return (this.definitionContext.getSequenceFlows(scopeId) || []).map(flow => this.upsertSequenceFlow(flow));
 };
+
+/**
+ * Return the cached sequence flow, instantiating it the first time it is referenced.
+ * @param {import('moddle-context-serializer').SerializableElement} flowDefinition
+ * @returns {import('./flows/SequenceFlow.js').SequenceFlow}
+ */
 ContextInstance.prototype.upsertSequenceFlow = function upsertSequenceFlow(flowDefinition) {
   const sequenceFlowRefs = this.refs.get('sequenceFlowRefs');
   let flowInstance = sequenceFlowRefs.get(flowDefinition.id);
@@ -83,9 +152,19 @@ ContextInstance.prototype.upsertSequenceFlow = function upsertSequenceFlow(flowD
   sequenceFlowRefs.set(flowDefinition.id, flowInstance);
   return flowInstance;
 };
+
+/**
+ * Get association flows
+ * @param {string} [scopeId] Process or sub-process id
+ */
 ContextInstance.prototype.getAssociations = function getAssociations(scopeId) {
   return (this.definitionContext.getAssociations(scopeId) || []).map(association => this.upsertAssociation(association));
 };
+
+/**
+ * @param {import('moddle-context-serializer').SerializableElement} associationDefinition
+ * @returns {import('./flows/Association.js').Association}
+ */
 ContextInstance.prototype.upsertAssociation = function upsertAssociation(associationDefinition) {
   const associationRefs = this.refs.get('associationRefs');
   let instance = associationRefs.get(associationDefinition.id);
@@ -94,9 +173,39 @@ ContextInstance.prototype.upsertAssociation = function upsertAssociation(associa
   associationRefs.set(associationDefinition.id, instance);
   return instance;
 };
+
+/**
+ * Create a new context that shares the parsed definition but optionally swaps environment and owner.
+ * @param {import('#types').Environment} [newEnvironment]
+ * @param {import('#types').Process | import('#types').Activity} [newOwner]
+ */
 ContextInstance.prototype.clone = function clone(newEnvironment, newOwner) {
-  return new ContextInstance(this.definitionContext, newEnvironment || this.environment, newOwner);
+  return new ContextInstance(this.definitionContext, newEnvironment || this.environment, newOwner, this.peersCache);
 };
+
+/**
+ * Cached converging parallel gateway peers discovered by an earlier shake.
+ * @param {string} gatewayId
+ * @returns {Array<[string, string[]]> | undefined}
+ */
+ContextInstance.prototype.getShakenPeers = function getShakenPeers(gatewayId) {
+  return this.peersCache.get(gatewayId);
+};
+
+/**
+ * Store converging parallel gateway peers so subsequent runs can skip the graph shake.
+ * @param {string} gatewayId
+ * @param {Array<[string, string[]]>} peers
+ */
+ContextInstance.prototype.setShakenPeers = function setShakenPeers(gatewayId, peers) {
+  this.peersCache.set(gatewayId, peers);
+};
+
+/**
+ * Get or create the process instance for the given id. Each process gets its own cloned environment.
+ * @param {string} processId
+ * @returns {import('#types').Process | null}
+ */
 ContextInstance.prototype.getProcessById = function getProcessById(processId) {
   const processRefs = this.refs.get('processRefs');
   let bp = processRefs.get(processId);
@@ -106,27 +215,49 @@ ContextInstance.prototype.getProcessById = function getProcessById(processId) {
   const bpContext = this.clone(this.environment.clone());
   bp = new processDefinition.Behaviour(processDefinition, bpContext);
   processRefs.set(processId, bp);
-  bpContext[kOwner] = bp;
+  bpContext[K_OWNER] = bp;
   return bp;
 };
+
+/**
+ * Build a fresh, uncached process instance for the given id. Used by call activities.
+ * @param {string} processId
+ * @returns {import('#types').Process | null}
+ */
 ContextInstance.prototype.getNewProcessById = function getNewProcessById(processId) {
   if (!this.getProcessById(processId)) return null;
   const bpDef = this.definitionContext.getProcessById(processId);
   const bpContext = this.clone(this.environment.clone());
   const bp = new bpDef.Behaviour(bpDef, bpContext);
-  bpContext[kOwner] = bp;
+  bpContext[K_OWNER] = bp;
   return bp;
 };
+
+/**
+ * Get every process in the definition.
+ * @returns {import('#types').Process[]}
+ */
 ContextInstance.prototype.getProcesses = function getProcesses() {
   return this.definitionContext.getProcesses().map(({
     id: processId
   }) => this.getProcessById(processId));
 };
+
+/**
+ * Get processes flagged executable in the definition.
+ * @returns {import('#types').Process[]}
+ */
 ContextInstance.prototype.getExecutableProcesses = function getExecutableProcesses() {
   return this.definitionContext.getExecutableProcesses().map(({
     id: processId
   }) => this.getProcessById(processId));
 };
+
+/**
+ * Get message flows that originate from the given process id.
+ * @param {string} sourceId Source process id
+ * @returns {import('./flows/MessageFlow.js').MessageFlow[]}
+ */
 ContextInstance.prototype.getMessageFlows = function getMessageFlows(sourceId) {
   const messageFlowRefs = this.refs.get('messageFlows');
   const result = [];
@@ -144,6 +275,12 @@ ContextInstance.prototype.getMessageFlows = function getMessageFlows(sourceId) {
   }
   return result;
 };
+
+/**
+ * Get or create a data object instance for the given reference id.
+ * @param {string} referenceId
+ * @return {import('#types').IIOData | undefined}
+ */
 ContextInstance.prototype.getDataObjectById = function getDataObjectById(referenceId) {
   const dataObjectRefs = this.refs.get('dataObjectRefs');
   let dataObject;
@@ -154,6 +291,12 @@ ContextInstance.prototype.getDataObjectById = function getDataObjectById(referen
   dataObjectRefs.set(dataObjectDef.id, dataObject);
   return dataObject;
 };
+
+/**
+ * Get or create a data store instance for the given reference id.
+ * @param {string} referenceId
+ * @return {import('#types').IIOData | undefined}
+ */
 ContextInstance.prototype.getDataStoreById = function getDataStoreById(referenceId) {
   const dataStoreRefs = this.refs.get('dataStoreRefs');
   let dataStore;
@@ -164,6 +307,12 @@ ContextInstance.prototype.getDataStoreById = function getDataStoreById(reference
   dataStoreRefs.set(dataStoreDef.id, dataStore);
   return dataStore;
 };
+
+/**
+ * Get start activities, optionally filtered by referenced event definition or restricted to a parent scope.
+ * @param {import('#types').startActivityFilterOptions} [filterOptions]
+ * @param {string} [scopeId] Process or sub-process id
+ */
 ContextInstance.prototype.getStartActivities = function getStartActivities(filterOptions, scopeId) {
   const referenceId = filterOptions?.referenceId;
   const referenceType = filterOptions?.referenceType || 'unknown';
@@ -183,15 +332,70 @@ ContextInstance.prototype.getStartActivities = function getStartActivities(filte
   }
   return result;
 };
+
+/**
+ * Inspect an activity def for link event definitions.
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @returns {{ linkBehaviour?: Function, linkNames?: string[] }}
+ */
+ContextInstance.prototype.getLinkEventDefinitionInfo = function getLinkEventDefinitionInfo(activityDef) {
+  const eds = activityDef.behaviour?.eventDefinitions;
+  if (!eds) return {};
+  let linkBehaviour;
+  const names = new Set();
+  for (const ed of eds) {
+    if (linkBehaviour ? ed.Behaviour === linkBehaviour : ed.type?.endsWith('LinkEventDefinition')) {
+      if (!linkBehaviour) linkBehaviour = ed.Behaviour;
+      if (ed.behaviour?.name) names.add(ed.behaviour.name);
+    }
+  }
+  if (!linkBehaviour || !names.size) return {};
+  return {
+    linkBehaviour,
+    linkNames: [...names]
+  };
+};
+
+/**
+ * Get activities whose event definitions include the given Behaviour with a matching name.
+ * @param {Function} Behaviour Behaviour constructor to match against `ed.Behaviour`
+ * @param {string[] | Iterable<string>} names
+ * @param {string} [scopeId] Process or sub-process id
+ */
+ContextInstance.prototype.getActivitiesByEventDefinitionBehaviour = function getActivitiesByEventDefinitionBehaviour(Behaviour, names, scopeId) {
+  const wanted = new Set(names);
+  if (!Behaviour || !wanted.size) return [];
+  const result = [];
+  const rawDefs = this.definitionContext.getActivities(scopeId) || [];
+  for (const rawDef of rawDefs) {
+    const eds = rawDef.behaviour?.eventDefinitions;
+    if (!eds) continue;
+    if (!eds.some(ed => ed.Behaviour === Behaviour && wanted.has(ed.behaviour?.name))) continue;
+    result.push(this.upsertActivity(rawDef));
+  }
+  return result;
+};
+
+/**
+ * Resolve user-registered extensions and the built-in BpmnIO extension for an activity.
+ * Returns undefined when the activity has no extensions to attach.
+ * @param {import('#types').ElementBase} activity
+ * @returns {import('#types').IExtension | undefined}
+ */
 ContextInstance.prototype.loadExtensions = function loadExtensions(activity) {
-  const io = new _BpmnIO.default(activity, this);
+  const io = new _BpmnIO.BpmnIO(activity, this);
   const extensions = this.extensionsMapper.get(activity);
   if (io.hasIo) extensions.extensions.push(io);
   if (!extensions.extensions.length) return;
   return extensions;
 };
+
+/**
+ * Resolve the parent process or sub-process activity that owns the given activity.
+ * @param {string} activityId
+ */
 ContextInstance.prototype.getActivityParentById = function getActivityParentById(activityId) {
-  const owner = this[kOwner];
+  const owner = this[K_OWNER];
   if (owner) return owner;
   const activity = this.getActivityById(activityId);
   const parentId = activity.parent.id;
@@ -203,6 +407,8 @@ function ExtensionsMapper(context) {
 ExtensionsMapper.prototype.get = function get(activity) {
   return new Extensions(activity, this.context, this._getExtensions());
 };
+
+/** @internal */
 ExtensionsMapper.prototype._getExtensions = function getExtensions() {
   let extensions;
   if (!(extensions = this.context.environment.extensions)) return [];
@@ -214,7 +420,7 @@ function Extensions(activity, context, extensions) {
     const extension = Extension(activity, context);
     if (extension) result.push(extension);
   }
-  this[kActivated] = false;
+  this[_constants.K_ACTIVATED] = false;
 }
 Object.defineProperty(Extensions.prototype, 'count', {
   get() {
@@ -222,12 +428,12 @@ Object.defineProperty(Extensions.prototype, 'count', {
   }
 });
 Extensions.prototype.activate = function activate(message) {
-  if (this[kActivated]) return;
-  this[kActivated] = true;
+  if (this[_constants.K_ACTIVATED]) return;
+  this[_constants.K_ACTIVATED] = true;
   for (const extension of this.extensions) extension.activate(message);
 };
 Extensions.prototype.deactivate = function deactivate(message) {
-  if (!this[kActivated]) return;
-  this[kActivated] = false;
+  if (!this[_constants.K_ACTIVATED]) return;
+  this[_constants.K_ACTIVATED] = false;
   for (const extension of this.extensions) extension.deactivate(message);
 };