bpmn-elements 9.1.3 → 9.2.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+# 9.2.0
+
+- move outbound sequence flow evaluation logic from activity to sequence flow, where it belongs
+- spread sequence flow evaluation result, if object, to sequence flow take message
+
 # 9.1.3
 
 - type declare execution scope

package/dist/activity/Activity.js

@@ -837,10 +837,12 @@ Activity.prototype._doRunOutbound = function doRunOutbound(outboundList, content
   for (const outboundFlow of outboundList) {
     const {
       id: flowId,
-      action
+      action,
+      result
     } = outboundFlow;
     this.broker.publish('run', 'run.outbound.' + action, (0, _messageHelper.cloneContent)(content, {
       flow: {
+        ...(result && typeof result === 'object' && result),
         ...outboundFlow,
         sequenceId: (0, _shared.getUniqueId)(`${flowId}_${action}`),
         ...(discardSequence && {
@@ -1027,26 +1029,11 @@ OutboundEvaluator.prototype.onEvaluated = function onEvaluated(routingKey, messa
 };
 OutboundEvaluator.prototype.evaluateFlow = function evaluateFlow(flow) {
   const broker = this.broker;
-  if (flow.isDefault) {
-    return broker.publish('execution', 'evaluate.flow.take', formatFlowAction(flow, {
-      action: 'take'
-    }), {
-      persistent: false
-    });
-  }
-  const flowCondition = flow.getCondition();
-  if (!flowCondition) {
-    return broker.publish('execution', 'evaluate.flow.take', formatFlowAction(flow, {
-      action: 'take'
-    }), {
-      persistent: false
-    });
-  }
   const {
     fromMessage,
     evaluationId
   } = this.evaluateArgs;
-  flowCondition.execute((0, _messageHelper.cloneMessage)(fromMessage), (err, result) => {
+  flow.evaluate((0, _messageHelper.cloneMessage)(fromMessage), (err, result) => {
     if (err) return this.completed(err);
     const action = result ? 'take' : 'discard';
     return broker.publish('execution', 'evaluate.flow.' + action, formatFlowAction(flow, {

package/dist/flows/SequenceFlow.js

@@ -124,7 +124,7 @@ SequenceFlow.prototype.shake = function shake(message) {
     persistent: false,
     type: 'shake'
   });
-  for (const s of message.content.sequence) {
+  for (const s of message.content.sequence || []) {
     if (s.id === this.id) return this.broker.publish('event', 'flow.shake.loop', content, {
       persistent: false,
       type: 'shake'
@@ -164,6 +164,16 @@ SequenceFlow.prototype.createMessage = function createMessage(override) {
     parent: (0, _messageHelper.cloneParent)(this.parent)
   };
 };
+SequenceFlow.prototype.evaluate = function evaluate(fromMessage, callback) {
+  if (this.isDefault) {
+    return callback(null, true);
+  }
+  const flowCondition = this.getCondition();
+  if (!flowCondition) {
+    return callback(null, true);
+  }
+  flowCondition.execute(fromMessage, callback);
+};
 SequenceFlow.prototype._publishEvent = function publishEvent(action, content) {
   const eventContent = this.createMessage({
     action,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "9.1.3",
+  "version": "9.2.0",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "dist/index.js",
@@ -55,7 +55,7 @@
     "chai": "^4.3.7",
     "chronokinesis": "^5.0.2",
     "debug": "^4.3.4",
-    "eslint": "^8.38.0",
+    "eslint": "^8.39.0",
     "eslint-plugin-import": "^2.27.5",
     "got": "^12.6.0",
     "mocha": "^10.1.0",

package/src/activity/Activity.js

@@ -807,9 +807,10 @@ Activity.prototype._doOutbound = function doOutbound(fromMessage, isDiscarded, c
 
 Activity.prototype._doRunOutbound = function doRunOutbound(outboundList, content, discardSequence) {
   for (const outboundFlow of outboundList) {
-    const {id: flowId, action} = outboundFlow;
+    const {id: flowId, action, result} = outboundFlow;
     this.broker.publish('run', 'run.outbound.' + action, cloneContent(content, {
       flow: {
+        ...(result && typeof result === 'object' && result),
         ...outboundFlow,
         sequenceId: getUniqueId(`${flowId}_${action}`),
         ...(discardSequence && {discardSequence: discardSequence.slice()}),
@@ -1000,17 +1001,8 @@ OutboundEvaluator.prototype.onEvaluated = function onEvaluated(routingKey, messa
 
 OutboundEvaluator.prototype.evaluateFlow = function evaluateFlow(flow) {
   const broker = this.broker;
-  if (flow.isDefault) {
-    return broker.publish('execution', 'evaluate.flow.take', formatFlowAction(flow, {action: 'take'}), {persistent: false});
-  }
-
-  const flowCondition = flow.getCondition();
-  if (!flowCondition) {
-    return broker.publish('execution', 'evaluate.flow.take', formatFlowAction(flow, {action: 'take'}), {persistent: false});
-  }
-
   const {fromMessage, evaluationId} = this.evaluateArgs;
-  flowCondition.execute(cloneMessage(fromMessage), (err, result) => {
+  flow.evaluate(cloneMessage(fromMessage), (err, result) => {
     if (err) return this.completed(err);
     const action = result ? 'take' : 'discard';
     return broker.publish('execution', 'evaluate.flow.' + action, formatFlowAction(flow, {

package/src/flows/SequenceFlow.js

@@ -101,7 +101,7 @@ SequenceFlow.prototype.shake = function shake(message) {
 
   if (content.id === this.targetId) return this.broker.publish('event', 'flow.shake.loop', content, {persistent: false, type: 'shake'});
 
-  for (const s of message.content.sequence) {
+  for (const s of message.content.sequence || []) {
     if (s.id === this.id) return this.broker.publish('event', 'flow.shake.loop', content, {persistent: false, type: 'shake'});
   }
 
@@ -140,6 +140,19 @@ SequenceFlow.prototype.createMessage = function createMessage(override) {
   };
 };
 
+SequenceFlow.prototype.evaluate = function evaluate(fromMessage, callback) {
+  if (this.isDefault) {
+    return callback(null, true);
+  }
+
+  const flowCondition = this.getCondition();
+  if (!flowCondition) {
+    return callback(null, true);
+  }
+
+  flowCondition.execute(fromMessage, callback);
+};
+
 SequenceFlow.prototype._publishEvent = function publishEvent(action, content) {
   const eventContent = this.createMessage({
     action,

package/types/index.d.ts

@@ -481,6 +481,13 @@ declare module 'bpmn-elements' {
     shake(message: any): number;
     getCondition(): any;
     createMessage(override?: any): object;
+    /**
+     * Evaluate flow
+     * Executes condition if any, default flow is
+     * @param fromMessage Activity message
+     * @param {evaluateCallback} callback Callback with evaluation result, if truthy flow should be taken
+     */
+    evaluate(fromMessage: ElementBrokerMessage, callback: (err: Error, result: any) => void): void;
   }
 
   interface MessageFlowReference {
@@ -635,3 +642,10 @@ declare module 'bpmn-elements' {
     constructor(description: string, sourceMessage: MessageMessage, inner?: Error);
   }
 }
+
+/**
+ * Evaluate flow callback
+ * @callback evaluateCallback
+ * @param {Error} err Evaluation error
+ * @param {boolean|object} evaluationResult If thruthy flow should be taken
+ */