bpmn-elements 16.2.2 → 17.0.0

package/dist/MessageFormatter.js

@@ -10,7 +10,13 @@ var _Errors = require("./error/Errors.js");
 var _smqp = require("smqp");
 const kOnMessage = Symbol.for('onMessage');
 const kExecution = Symbol.for('execution');
-function Formatter(element, formatQ) {
+const EXEC_ROUTING_KEY = 'run._formatting.exec';
+
+/**
+ * Message formatter used to enrich an element run message before continuing to the next run message
+ * @param {import('types').ElementBase} element
+ */
+function Formatter(element) {
   const {
     id,
     broker,
@@ -19,16 +25,19 @@ function Formatter(element, formatQ) {
   this.id = id;
   this.broker = broker;
   this.logger = logger;
-  this.formatQ = formatQ;
   this[kOnMessage] = this._onMessage.bind(this);
 }
+
+/**
+ * Format message
+ * @param {import('types').ElementBrokerMessage} message
+ * @param {CallableFunction} callback
+ */
 Formatter.prototype.format = function format(message, callback) {
   const correlationId = this._runId = (0, _shared.getUniqueId)(message.fields.routingKey);
   const consumerTag = '_formatter-' + correlationId;
-  const formatQ = this.formatQ;
-  formatQ.queueMessage({
-    routingKey: '_formatting.exec'
-  }, {}, {
+  const broker = this.broker;
+  broker.publish('format', EXEC_ROUTING_KEY, {}, {
     correlationId,
     persistent: false
   });
@@ -37,11 +46,11 @@ Formatter.prototype.format = function format(message, callback) {
     formatKey: message.fields.routingKey,
     runMessage: (0, _messageHelper.cloneMessage)(message),
     callback,
-    pending: [],
+    pending: new Set(),
     formatted: false,
     executeMessage: null
   };
-  formatQ.consume(this[kOnMessage], {
+  broker.consume('format-run-q', this[kOnMessage], {
     consumerTag,
     prefetch: 100
   });
@@ -53,41 +62,33 @@ Formatter.prototype._onMessage = function onMessage(routingKey, message) {
     pending,
     executeMessage
   } = this[kExecution];
-  const asyncFormatting = pending.length;
-  switch (routingKey) {
-    case '_formatting.exec':
-      if (message.properties.correlationId !== correlationId) return message.ack();
-      if (!asyncFormatting) {
-        message.ack();
-        return this._complete(message);
-      }
-      this[kExecution].executeMessage = message;
-      break;
-    default:
-      {
-        message.ack();
-        const endRoutingKey = message.content?.endRoutingKey;
-        if (endRoutingKey) {
-          this._decorate(message.content);
-          pending.push(message);
-          return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
-        }
-        if (asyncFormatting) {
-          const {
-            isError,
-            message: startMessage
-          } = this._popFormatStart(pending, routingKey);
-          if (startMessage) startMessage.ack();
-          if (isError) {
-            return this._complete(message, true);
-          }
-        }
-        this._decorate(message.content);
-        this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
-        if (executeMessage && asyncFormatting && !pending.length) {
-          this._complete(message);
-        }
+  const asyncFormatting = pending.size;
+  if (routingKey === EXEC_ROUTING_KEY) {
+    if (message.properties.correlationId !== correlationId) return message.ack();
+    message.ack();
+    if (!asyncFormatting) {
+      return this._complete(message);
+    }
+    this[kExecution].executeMessage = message;
+  } else {
+    message.ack();
+    const endRoutingKey = message.content?.endRoutingKey;
+    if (endRoutingKey) {
+      this._enrich(message.content);
+      pending.add(message);
+      return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
+    }
+    if (asyncFormatting) {
+      const isError = this._popFormatStart(pending, routingKey).isError;
+      if (isError) {
+        return this._complete(message, true);
       }
+    }
+    this._enrich(message.content);
+    this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+    if (executeMessage && !pending.size) {
+      this._complete(message);
+    }
   }
 };
 Formatter.prototype._complete = function complete(message, isError) {
@@ -109,7 +110,7 @@ Formatter.prototype._complete = function complete(message, isError) {
   }
   return callback(null, runMessage.content, formatted);
 };
-Formatter.prototype._decorate = function decorate(withContent) {
+Formatter.prototype._enrich = function enrich(withContent) {
   const content = this[kExecution].runMessage.content;
   for (const key in withContent) {
     switch (key) {
@@ -134,20 +135,19 @@ Formatter.prototype._decorate = function decorate(withContent) {
   }
 };
 Formatter.prototype._popFormatStart = function popFormattingStart(pending, routingKey) {
-  for (let idx = 0; idx < pending.length; idx++) {
-    const msg = pending[idx];
+  for (const msg of pending) {
     const {
       endRoutingKey,
       errorRoutingKey = '#.error'
     } = msg.content;
     if (endRoutingKey && (0, _smqp.getRoutingKeyPattern)(endRoutingKey).test(routingKey)) {
       this._debug(`completed formatting ${msg.fields.routingKey} message content with formatter ${routingKey}`);
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return {
         message: msg
       };
     } else if ((0, _smqp.getRoutingKeyPattern)(errorRoutingKey).test(routingKey)) {
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return {
         isError: true,
         message: msg

package/dist/activity/Activity.js

@@ -156,12 +156,7 @@ Object.defineProperties(Activity.prototype, {
     get() {
       let formatter = this[kFormatter];
       if (formatter) return formatter;
-      const broker = this.broker;
-      formatter = this[kFormatter] = new _MessageFormatter.Formatter({
-        id: this.id,
-        broker,
-        logger: this.logger
-      }, broker.getQueue('format-run-q'));
+      formatter = this[kFormatter] = new _MessageFormatter.Formatter(this);
       return formatter;
     }
   },
@@ -430,7 +425,13 @@ Activity.prototype._discardRun = function discardRun() {
   if (!status) return;
   const execution = this[kExec].get('execution');
   if (execution && !execution.completed) return;
+  let discardRoutingKey = 'run.discard';
   switch (status) {
+    case 'executed':
+      {
+        discardRoutingKey = 'run.discarded';
+        break;
+      }
     case 'end':
     case 'executing':
     case 'error':
@@ -442,7 +443,9 @@ Activity.prototype._discardRun = function discardRun() {
   if (this.extensions) this.extensions.deactivate((0, _messageHelper.cloneMessage)(stateMessage));
   const broker = this.broker;
   broker.getQueue('run-q').purge();
-  broker.publish('run', 'run.discard', (0, _messageHelper.cloneContent)(stateMessage.content));
+  broker.publish('run', discardRoutingKey, (0, _messageHelper.cloneContent)(stateMessage.content), {
+    correlationId: stateMessage.properties.correlationId
+  });
   this[kConsuming] = true;
   this._consumeRunQ();
 };
@@ -609,9 +612,11 @@ Activity.prototype._onRunMessage = function onRunMessage(routingKey, message, me
   const preStatus = this.status;
   this.status = 'formatting';
   return this.formatter.format(message, (err, formattedContent, formatted) => {
-    if (err) return this.emitFatal(err, message.content);
-    if (formatted) message.content = formattedContent;
     this.status = preStatus;
+    if (err) {
+      return this.emitFatal(err, message.content);
+    }
+    if (formatted) message.content = formattedContent;
     this._continueRunMessage(routingKey, message, messageProperties);
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "16.2.2",
+  "version": "17.0.0",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -98,12 +98,12 @@
     "mocha": "^11.0.1",
     "mocha-cakes-2": "^3.3.0",
     "moddle-context-serializer": "^4.2.1",
-    "nock": "^13.5.3",
+    "nock": "^14.0.0",
     "prettier": "^3.2.5",
     "texample": "^0.0.6"
   },
   "dependencies": {
     "@0dep/piso": "^2.4.0",
-    "smqp": "^9.0.4"
+    "smqp": "^9.0.6"
   }
 }

package/src/Api.js

@@ -64,7 +64,7 @@ Api.prototype.resolveExpression = function resolveExpression(expression) {
       content: this.content,
       properties: this.messageProperties,
     },
-    this.owner,
+    this.owner
   );
 };
 

package/src/MessageFormatter.js

@@ -6,42 +6,43 @@ import { getRoutingKeyPattern } from 'smqp';
 const kOnMessage = Symbol.for('onMessage');
 const kExecution = Symbol.for('execution');
 
-export function Formatter(element, formatQ) {
+const EXEC_ROUTING_KEY = 'run._formatting.exec';
+
+/**
+ * Message formatter used to enrich an element run message before continuing to the next run message
+ * @param {import('types').ElementBase} element
+ */
+export function Formatter(element) {
   const { id, broker, logger } = element;
   this.id = id;
   this.broker = broker;
   this.logger = logger;
-  this.formatQ = formatQ;
   this[kOnMessage] = this._onMessage.bind(this);
 }
 
+/**
+ * Format message
+ * @param {import('types').ElementBrokerMessage} message
+ * @param {CallableFunction} callback
+ */
 Formatter.prototype.format = function format(message, callback) {
   const correlationId = (this._runId = getUniqueId(message.fields.routingKey));
   const consumerTag = '_formatter-' + correlationId;
-  const formatQ = this.formatQ;
-
-  formatQ.queueMessage(
-    {
-      routingKey: '_formatting.exec',
-    },
-    {},
-    {
-      correlationId,
-      persistent: false,
-    },
-  );
+  const broker = this.broker;
+
+  broker.publish('format', EXEC_ROUTING_KEY, {}, { correlationId, persistent: false });
 
   this[kExecution] = {
     correlationId,
     formatKey: message.fields.routingKey,
     runMessage: cloneMessage(message),
     callback,
-    pending: [],
+    pending: new Set(),
     formatted: false,
     executeMessage: null,
   };
 
-  formatQ.consume(this[kOnMessage], {
+  broker.consume('format-run-q', this[kOnMessage], {
     consumerTag,
     prefetch: 100,
   });
@@ -49,43 +50,40 @@ Formatter.prototype.format = function format(message, callback) {
 
 Formatter.prototype._onMessage = function onMessage(routingKey, message) {
   const { formatKey, correlationId, pending, executeMessage } = this[kExecution];
-  const asyncFormatting = pending.length;
-
-  switch (routingKey) {
-    case '_formatting.exec':
-      if (message.properties.correlationId !== correlationId) return message.ack();
-      if (!asyncFormatting) {
-        message.ack();
-        return this._complete(message);
-      }
-      this[kExecution].executeMessage = message;
-      break;
-    default: {
-      message.ack();
-
-      const endRoutingKey = message.content?.endRoutingKey;
-      if (endRoutingKey) {
-        this._decorate(message.content);
-        pending.push(message);
-        return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
-      }
+  const asyncFormatting = pending.size;
 
-      if (asyncFormatting) {
-        const { isError, message: startMessage } = this._popFormatStart(pending, routingKey);
-        if (startMessage) startMessage.ack();
+  if (routingKey === EXEC_ROUTING_KEY) {
+    if (message.properties.correlationId !== correlationId) return message.ack();
+    message.ack();
+    if (!asyncFormatting) {
+      return this._complete(message);
+    }
+    this[kExecution].executeMessage = message;
+  } else {
+    message.ack();
 
-        if (isError) {
-          return this._complete(message, true);
-        }
-      }
+    const endRoutingKey = message.content?.endRoutingKey;
 
-      this._decorate(message.content);
-      this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+    if (endRoutingKey) {
+      this._enrich(message.content);
+      pending.add(message);
+      return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
+    }
+
+    if (asyncFormatting) {
+      const isError = this._popFormatStart(pending, routingKey).isError;
 
-      if (executeMessage && asyncFormatting && !pending.length) {
-        this._complete(message);
+      if (isError) {
+        return this._complete(message, true);
       }
     }
+
+    this._enrich(message.content);
+    this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+
+    if (executeMessage && !pending.size) {
+      this._complete(message);
+    }
   }
 };
 
@@ -106,7 +104,7 @@ Formatter.prototype._complete = function complete(message, isError) {
   return callback(null, runMessage.content, formatted);
 };
 
-Formatter.prototype._decorate = function decorate(withContent) {
+Formatter.prototype._enrich = function enrich(withContent) {
   const content = this[kExecution].runMessage.content;
   for (const key in withContent) {
     switch (key) {
@@ -131,16 +129,14 @@ Formatter.prototype._decorate = function decorate(withContent) {
 };
 
 Formatter.prototype._popFormatStart = function popFormattingStart(pending, routingKey) {
-  for (let idx = 0; idx < pending.length; idx++) {
-    const msg = pending[idx];
+  for (const msg of pending) {
     const { endRoutingKey, errorRoutingKey = '#.error' } = msg.content;
-
     if (endRoutingKey && getRoutingKeyPattern(endRoutingKey).test(routingKey)) {
       this._debug(`completed formatting ${msg.fields.routingKey} message content with formatter ${routingKey}`);
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return { message: msg };
     } else if (getRoutingKeyPattern(errorRoutingKey).test(routingKey)) {
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return { isError: true, message: msg };
     }
   }

package/src/activity/Activity.js

@@ -143,15 +143,7 @@ Object.defineProperties(Activity.prototype, {
       let formatter = this[kFormatter];
       if (formatter) return formatter;
 
-      const broker = this.broker;
-      formatter = this[kFormatter] = new Formatter(
-        {
-          id: this.id,
-          broker,
-          logger: this.logger,
-        },
-        broker.getQueue('format-run-q'),
-      );
+      formatter = this[kFormatter] = new Formatter(this);
       return formatter;
     },
   },
@@ -430,7 +422,12 @@ Activity.prototype._discardRun = function discardRun() {
   const execution = this[kExec].get('execution');
   if (execution && !execution.completed) return;
 
+  let discardRoutingKey = 'run.discard';
   switch (status) {
+    case 'executed': {
+      discardRoutingKey = 'run.discarded';
+      break;
+    }
     case 'end':
     case 'executing':
     case 'error':
@@ -442,10 +439,11 @@ Activity.prototype._discardRun = function discardRun() {
 
   const stateMessage = this[kStateMessage];
   if (this.extensions) this.extensions.deactivate(cloneMessage(stateMessage));
+
   const broker = this.broker;
   broker.getQueue('run-q').purge();
 
-  broker.publish('run', 'run.discard', cloneContent(stateMessage.content));
+  broker.publish('run', discardRoutingKey, cloneContent(stateMessage.content), { correlationId: stateMessage.properties.correlationId });
   this[kConsuming] = true;
   this._consumeRunQ();
 };
@@ -602,10 +600,13 @@ Activity.prototype._onRunMessage = function onRunMessage(routingKey, message, me
 
   const preStatus = this.status;
   this.status = 'formatting';
+
   return this.formatter.format(message, (err, formattedContent, formatted) => {
-    if (err) return this.emitFatal(err, message.content);
-    if (formatted) message.content = formattedContent;
     this.status = preStatus;
+    if (err) {
+      return this.emitFatal(err, message.content);
+    }
+    if (formatted) message.content = formattedContent;
     this._continueRunMessage(routingKey, message, messageProperties);
   });
 };
@@ -700,7 +701,7 @@ Activity.prototype._continueRunMessage = function continueRunMessage(routingKey,
           ...content,
           error: isRedelivered ? makeErrorFromMessage(message) : content.error,
         },
-        { correlationId },
+        { correlationId }
       );
       break;
     }
@@ -819,7 +820,7 @@ Activity.prototype._doRunLeave = function doRunLeave(message, isDiscarded, onOut
       cloneContent(content, {
         ...(outbound.length && { outbound }),
       }),
-      { correlationId },
+      { correlationId }
     );
 
     onOutbound();
@@ -891,7 +892,7 @@ Activity.prototype._publishRunOutbound = function publishRunOutbound(outboundFlo
         sequenceId: getUniqueId(`${flowId}_${action}`),
         ...(discardSequence && { discardSequence: discardSequence.slice() }),
       },
-    }),
+    })
   );
 };
 

package/src/activity/ActivityExecution.js

@@ -306,7 +306,7 @@ ActivityExecution.prototype._onExecutionDiscarded = function onExecutionDiscarde
 ActivityExecution.prototype._publishExecutionCompleted = function publishExecutionCompleted(
   completionType,
   completeContent,
-  correlationId,
+  correlationId
 ) {
   this[kCompleted] = true;
 
@@ -317,7 +317,7 @@ ActivityExecution.prototype._publishExecutionCompleted = function publishExecuti
       ...completeContent,
       state: completionType,
     },
-    { type: completionType, correlationId },
+    { type: completionType, correlationId }
   );
 };
 

package/src/activity/outbound-evaluator.js

@@ -88,7 +88,7 @@ OutboundEvaluator.prototype.evaluateFlow = function evaluateFlow(flow) {
         result,
         evaluationId,
       }),
-      { persistent: false },
+      { persistent: false }
     );
   });
 };

package/src/definition/Definition.js

@@ -219,7 +219,7 @@ Definition.prototype._shakeProcess = function shakeProcess(shakeBp, startId) {
       {
         broker: this.broker,
         exchange: 'event',
-      },
+      }
     );
   }
 
@@ -404,7 +404,7 @@ Definition.prototype._onRunMessage = function onRunMessage(routingKey, message)
           ...content,
           error: fields.redelivered ? makeErrorFromMessage(message) : content.error,
         },
-        { mandatory: true },
+        { mandatory: true }
       );
       break;
     }

package/src/definition/DefinitionExecution.js

@@ -439,7 +439,7 @@ DefinitionExecution.prototype._onProcessMessage = function onProcessMessage(rout
             executionId: calledFrom.executionId,
             error: content.error,
           },
-          { mandatory: true, type: 'error' },
+          { mandatory: true, type: 'error' }
         );
       } else {
         for (const bp of new Set(this[kProcesses].running)) {
@@ -502,7 +502,7 @@ DefinitionExecution.prototype._onStopped = function onStopped(message) {
     cloneContent(this[kExecuteMessage].content, {
       ...message.content,
     }),
-    { type: 'stopped', persistent: false },
+    { type: 'stopped', persistent: false }
   );
 };
 
@@ -563,7 +563,7 @@ DefinitionExecution.prototype._onMessageOutbound = function onMessageOutbound(ro
 
   this._debug(
     `conveying message from <${source.processId}.${source.id}> to`,
-    target.id ? `<${target.processId}.${target.id}>` : `<${target.processId}>`,
+    target.id ? `<${target.processId}.${target.id}>` : `<${target.processId}>`
   );
 
   const targetProcesses = this.getProcessesById(target.processId);
@@ -654,7 +654,7 @@ DefinitionExecution.prototype._onDelegateMessage = function onDelegateMessage(ro
   const message = reference?.resolve(executeMessage);
 
   this._debug(
-    `<${reference ? `${messageType} ${delegateMessage.id}>` : `anonymous ${messageType}`} event received from <${content.parent.id}.${content.id}>. Delegating.`,
+    `<${reference ? `${messageType} ${delegateMessage.id}>` : `anonymous ${messageType}`} event received from <${content.parent.id}.${content.id}>. Delegating.`
   );
 
   this.getApi().sendApiMessage(
@@ -669,7 +669,7 @@ DefinitionExecution.prototype._onDelegateMessage = function onDelegateMessage(ro
       message,
       originalMessage: content.message,
     },
-    { delegate: true, type: messageType },
+    { delegate: true, type: messageType }
   );
 
   this.broker.publish(
@@ -678,7 +678,7 @@ DefinitionExecution.prototype._onDelegateMessage = function onDelegateMessage(ro
     this._createMessage({
       message: message && cloneContent(message),
     }),
-    { type: messageType },
+    { type: messageType }
   );
 };
 
@@ -706,7 +706,7 @@ DefinitionExecution.prototype._complete = function complete(completionType, cont
       ...content,
       state: completionType,
     },
-    { type: completionType, mandatory: completionType === 'error', ...options },
+    { type: completionType, mandatory: completionType === 'error', ...options }
   );
 };
 

package/src/error/Errors.js

@@ -50,13 +50,13 @@ export function makeErrorFromMessage(errorMessage) {
       return new ActivityError(
         error.message || error.description,
         error.source,
-        error.inner ? error.inner : { code: error.code, name: error.name },
+        error.inner ? error.inner : { code: error.code, name: error.name }
       );
     case 'RunError':
       return new RunError(
         error.message || error.description,
         error.source,
-        error.inner ? error.inner : { code: error.code, name: error.name },
+        error.inner ? error.inner : { code: error.code, name: error.name }
       );
     case 'BpmnError':
       return new BpmnError(error.message || error.description, error, error.source);

package/src/eventDefinitions/CancelEventDefinition.js

@@ -56,7 +56,7 @@ CancelEventDefinition.prototype.executeCatch = function executeCatch(executeMess
       pattern: 'activity.execution.cancel',
       exchange: 'execution',
       expectRoutingKey,
-    }),
+    })
   );
 
   const waitContent = cloneContent(executeContent, {

package/src/eventDefinitions/CompensateEventDefinition.js

@@ -79,7 +79,7 @@ CompensateEventDefinition.prototype.executeCatch = function executeCatch(execute
       sourceExchange: 'execution',
       bindExchange: 'compensate',
       expect: 'compensate',
-    }),
+    })
   );
 };
 

package/src/eventDefinitions/ConditionalEventDefinition.js

@@ -95,7 +95,7 @@ ConditionalEventDefinition.prototype.evaluateCallback = function evaluateCallbac
     return broker.publish(
       'execution',
       'execute.error',
-      cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true }),
+      cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true })
     );
   }
 
@@ -106,7 +106,7 @@ ConditionalEventDefinition.prototype.evaluateCallback = function evaluateCallbac
     'activity.condition',
     cloneContent(this[kExecuteMessage].content, {
       conditionResult: result,
-    }),
+    })
   );
 
   if (!result) return;

package/src/eventDefinitions/ErrorEventDefinition.js

@@ -85,7 +85,7 @@ ErrorEventDefinition.prototype.executeCatch = function executeCatch(executeMessa
         exchange: 'execution',
         expectRoutingKey,
         expect: { ...info.message },
-      }),
+      })
     );
 
     if (this[kCompleted]) return this._stop();
@@ -123,7 +123,7 @@ ErrorEventDefinition.prototype.executeThrow = function executeThrow(executeMessa
     'execute.completed',
     cloneContent(executeContent, {
       message: { ...info.message },
-    }),
+    })
   );
 };
 
@@ -178,7 +178,7 @@ ErrorEventDefinition.prototype._catchError = function catchError(routingKey, mes
       output: error,
       cancelActivity: true,
       state: 'catch',
-    }),
+    })
   );
 };
 

package/src/eventDefinitions/LinkEventDefinition.js

@@ -168,7 +168,7 @@ LinkEventDefinition.prototype._onDiscard = function onDiscard(_, message) {
       message: { ...this.reference },
       state: 'discard',
     }),
-    { type: 'link', delegate: true },
+    { type: 'link', delegate: true }
   );
 };
 

package/src/eventDefinitions/MessageEventDefinition.js

@@ -124,7 +124,7 @@ MessageEventDefinition.prototype._onCatchMessage = function onCatchMessage(routi
     {
       correlationId,
       type,
-    },
+    }
   );
 
   this._complete('caught', message.content.message, { correlationId });
@@ -171,7 +171,7 @@ MessageEventDefinition.prototype._complete = function complete(verb, output, opt
       output,
       state: 'catch',
     }),
-    options,
+    options
   );
 };
 

package/src/eventDefinitions/SignalEventDefinition.js

@@ -128,7 +128,7 @@ SignalEventDefinition.prototype._onCatchMessage = function onCatchMessage(routin
     {
       correlationId,
       type,
-    },
+    }
   );
 
   return this._complete(message.content.message, message.properties);
@@ -164,7 +164,7 @@ SignalEventDefinition.prototype._complete = function complete(output, options) {
       output,
       state: 'signal',
     }),
-    options,
+    options
   );
 };
 

package/src/eventDefinitions/TimerEventDefinition.js

@@ -153,7 +153,7 @@ TimerEventDefinition.prototype._onDelegatedApiMessage = function onDelegatedApiM
         ...content.message,
       },
     }),
-    { correlationId, type },
+    { correlationId, type }
   );
 
   return this._onApiMessage(routingKey, message);
@@ -170,7 +170,7 @@ TimerEventDefinition.prototype._onApiMessage = function onApiMessage(routingKey,
           state: 'cancel',
           ...(message.content.message && { message: message.content.message }),
         },
-        { correlationId },
+        { correlationId }
       );
     }
     case 'stop': {

package/src/events/BoundaryEvent.js

@@ -105,7 +105,7 @@ BoundaryEventBehaviour.prototype._onCompleted = function onCompleted(_, { conten
     return this.broker.publish(
       'execution',
       'execute.completed',
-      cloneContent(content, { isDefinitionScope: false, cancelActivity: false }),
+      cloneContent(content, { isDefinitionScope: false, cancelActivity: false })
     );
   }
 
@@ -116,7 +116,7 @@ BoundaryEventBehaviour.prototype._onCompleted = function onCompleted(_, { conten
   const attachedTo = this.attachedTo;
 
   this.activity.logger.debug(
-    `<${executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`,
+    `<${executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`
   );
 
   if (content.isRecovered && !attachedTo.isRunning) {
@@ -128,7 +128,7 @@ BoundaryEventBehaviour.prototype._onCompleted = function onCompleted(_, { conten
       () => {
         attachedTo.getApi({ content: attachedToContent }).discard();
       },
-      { consumerTag: attachedExecuteTag },
+      { consumerTag: attachedExecuteTag }
     );
   } else {
     attachedTo.getApi({ content: attachedToContent }).discard();
@@ -165,7 +165,7 @@ BoundaryEventBehaviour.prototype._onExpectMessage = function onExpectMessage(_,
       noAck: true,
       consumerTag: errorConsumerTag,
       priority: 400,
-    },
+    }
   );
 };
 
@@ -195,7 +195,7 @@ BoundaryEventBehaviour.prototype._onDetachMessage = function onDetachMessage(_,
     },
     {
       cloneMessage,
-    },
+    }
   );
 
   const detachContent = cloneContent(content, {
@@ -215,7 +215,7 @@ BoundaryEventBehaviour.prototype._onDetachMessage = function onDetachMessage(_,
     },
     {
       consumerTag: `_execution-completed-${executionId}`,
-    },
+    }
   );
 };
 

package/src/events/IntermediateCatchEvent.js

@@ -43,7 +43,7 @@ IntermediateCatchEventBehaviour.prototype._onApiMessage = function onApiMessage(
         'execute.completed',
         cloneContent(executeMessage.content, {
           output: message.content.message,
-        }),
+        })
       );
     }
     case 'discard': {

package/src/events/StartEvent.js

@@ -64,7 +64,7 @@ StartEventBehaviour.prototype._onApiMessage = function onApiMessage(routingKey,
           output: message.content.message,
           state: 'signal',
         }),
-        { correlationId },
+        { correlationId }
       );
     }
     case 'discard': {
@@ -97,7 +97,7 @@ StartEventBehaviour.prototype._onDelegatedApiMessage = function onDelegatedApiMe
     {
       correlationId,
       type,
-    },
+    }
   );
 
   return this._onApiMessage(routingKey, message);

package/src/flows/MessageFlow.js

@@ -80,7 +80,7 @@ MessageFlow.prototype._onSourceEnd = function onSourceEnd({ content }) {
   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.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));
 };

package/src/io/InputOutputSpecification.js

@@ -71,7 +71,7 @@ IoSpecification.prototype._onFormatEnter = function onFormatOnEnter() {
     {
       dataObjects: [],
       sources: [],
-    },
+    }
   );
 
   if (!dataObjects.length) {
@@ -135,7 +135,7 @@ IoSpecification.prototype._onFormatComplete = function formatOnComplete(message)
     {
       dataObjects: [],
       sources: [],
-    },
+    }
   );
 
   const startRoutingKey = `run.onend.${safeType}`;

package/src/io/Properties.js

@@ -94,7 +94,7 @@ Properties.prototype._formatOnEnter = function formatOnEnter(message) {
       { routingKey: startRoutingKey },
       {
         properties: this._getProperties(message),
-      },
+      }
     );
   }
 
@@ -104,7 +104,7 @@ Properties.prototype._formatOnEnter = function formatOnEnter(message) {
     {
       endRoutingKey,
       properties: this._getProperties(message),
-    },
+    }
   );
 
   return read(broker, [...dataInputObjects], (_, responses) => {
@@ -127,7 +127,7 @@ Properties.prototype._formatOnComplete = function formatOnComplete(message) {
       { routingKey: startRoutingKey },
       {
         properties: outputProperties,
-      },
+      }
     );
   }
 
@@ -137,7 +137,7 @@ Properties.prototype._formatOnComplete = function formatOnComplete(message) {
     {
       endRoutingKey,
       properties: outputProperties,
-    },
+    }
   );
 
   return write(broker, [...dataOutputObjects], outputProperties, (_, responses) => {

package/src/process/Process.js

@@ -274,7 +274,7 @@ Process.prototype._onRunMessage = function onRunMessage(routingKey, message) {
         'error',
         cloneContent(content, {
           error: fields.redelivered ? makeErrorFromMessage(message) : content.error,
-        }),
+        })
       );
       break;
     }

package/src/process/ProcessExecution.js

@@ -266,7 +266,7 @@ ProcessExecution.prototype.shake = function shake(fromId) {
         }
       }
     },
-    { noAck: true, consumerTag: `_shaker-${this.executionId}` },
+    { noAck: true, consumerTag: `_shaker-${this.executionId}` }
   );
 
   for (const a of toShake) a.shake();
@@ -301,7 +301,7 @@ ProcessExecution.prototype.discard = function discard() {
       type: this.type,
       executionId: this.executionId,
     },
-    { type: 'discard' },
+    { type: 'discard' }
   );
 };
 
@@ -313,7 +313,7 @@ ProcessExecution.prototype.cancel = function discard() {
       type: this.type,
       executionId: this.executionId,
     },
-    { type: 'cancel' },
+    { type: 'cancel' }
   );
 };
 
@@ -689,7 +689,7 @@ ProcessExecution.prototype._onChildCompleted = function onChildCompleted(message
         type: this.type,
         executionId: this.executionId,
       },
-      { type: 'cancel' },
+      { type: 'cancel' }
     );
   }
 
@@ -722,7 +722,7 @@ ProcessExecution.prototype._stopExecution = function stopExecution(message) {
       ...this[kExecuteMessage].content,
       ...(message && message.content),
     },
-    { type: 'stopped', persistent: false },
+    { type: 'stopped', persistent: false }
   );
 };
 
@@ -760,7 +760,7 @@ ProcessExecution.prototype._onCancel = function onCancel() {
       'transaction.cancel',
       cloneMessage(this[kExecuteMessage], {
         state: 'cancel',
-      }),
+      })
     );
 
     for (const msg of running) {
@@ -817,7 +817,7 @@ ProcessExecution.prototype._delegateApiMessage = function delegateApiMessage(rou
         this._debug(`delegated api message was consumed by ${msg.content ? msg.content.executionId : 'unknown'}`);
       }
     },
-    { consumerTag: `_ct-delegate-${correlationId}`, noAck: true },
+    { consumerTag: `_ct-delegate-${correlationId}`, noAck: true }
   );
 
   for (const child of this[kElements].children) {
@@ -858,7 +858,7 @@ ProcessExecution.prototype._complete = function complete(completionType, content
       ...content,
       state: completionType,
     }),
-    { type: completionType, mandatory: completionType === 'error' },
+    { type: completionType, mandatory: completionType === 'error' }
   );
 };
 

package/src/tasks/CallActivity.js

@@ -39,8 +39,8 @@ CallActivityBehaviour.prototype.execute = function execute(executeMessage) {
         },
         {
           mandatory: true,
-        },
-      ),
+        }
+      )
     );
   }
 
@@ -55,7 +55,7 @@ CallActivityBehaviour.prototype.execute = function execute(executeMessage) {
       noAck: true,
       consumerTag: `_api-${executionId}`,
       priority: 300,
-    },
+    }
   );
   broker.subscribeTmp('api', '#.signal.*', (...args) => this._onDelegatedApiMessage(calledElement, executeMessage, ...args), {
     noAck: true,
@@ -75,7 +75,7 @@ CallActivityBehaviour.prototype.execute = function execute(executeMessage) {
     }),
     {
       type: 'call',
-    },
+    }
   );
 };
 
@@ -83,7 +83,7 @@ CallActivityBehaviour.prototype._onDelegatedApiMessage = function onDelegatedApi
   calledElement,
   executeMessage,
   routingKey,
-  message,
+  message
 ) {
   if (!message.properties.delegate) return;
   const { content: delegateContent } = message;
@@ -106,7 +106,7 @@ CallActivityBehaviour.prototype._onDelegatedApiMessage = function onDelegatedApi
     {
       correlationId,
       type: messageType,
-    },
+    }
   );
 
   return this._onApiMessage(calledElement, executeMessage, routingKey, message);
@@ -129,7 +129,7 @@ CallActivityBehaviour.prototype._onApiMessage = function onApiMessage(calledElem
         }),
         {
           type: 'cancel',
-        },
+        }
       );
     }
     case 'signal':
@@ -143,7 +143,7 @@ CallActivityBehaviour.prototype._onApiMessage = function onApiMessage(calledElem
         }),
         {
           correlationId,
-        },
+        }
       );
     case 'error':
       this._stop(executeContent.executionId);
@@ -158,8 +158,8 @@ CallActivityBehaviour.prototype._onApiMessage = function onApiMessage(calledElem
           {
             mandatory: true,
             correlationId,
-          },
-        ),
+          }
+        )
       );
     case 'discard':
       return this.broker.publish(
@@ -171,7 +171,7 @@ CallActivityBehaviour.prototype._onApiMessage = function onApiMessage(calledElem
         }),
         {
           type: 'discard',
-        },
+        }
       );
   }
 };

package/src/tasks/LoopCharacteristics.js

@@ -326,7 +326,7 @@ Characteristics.prototype.subscribe = function subscribe(onIterationCompleteMess
     `activity.*.${this.parentExecutionId}`,
     this.onApiMessage,
     { noAck: true, consumerTag: '_api-multi-instance-tag' },
-    { priority: 400 },
+    { priority: 400 }
   );
   this.broker.subscribeTmp('execution', 'execute.*', onComplete, {
     noAck: true,

package/src/tasks/ReceiveTask.js

@@ -163,7 +163,7 @@ ReceiveTaskExecution.prototype._setupMessageHandling = function setupMessageHand
     },
     {
       noAck: true,
-    },
+    }
   );
   broker.subscribeTmp('api', `activity.stop.${executionId}`, this._onStopApiMessage.bind(this), {
     noAck: true,
@@ -180,7 +180,7 @@ ReceiveTaskExecution.prototype._setupMessageHandling = function setupMessageHand
     },
     {
       noAck: true,
-    },
+    }
   );
 };
 

package/src/tasks/ScriptTask.js

@@ -35,7 +35,7 @@ ScriptTaskBehaviour.prototype.execute = function execute(executeMessage) {
   if (!script) {
     return activity.emitFatal(
       new ActivityError(`Script format ${scriptFormat} is unsupported or was not registered for <${activity.id}>`, executeMessage),
-      executeContent,
+      executeContent
     );
   }
 
@@ -47,7 +47,7 @@ ScriptTaskBehaviour.prototype.execute = function execute(executeMessage) {
       return activity.broker.publish(
         'execution',
         'execute.error',
-        cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true }),
+        cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true })
       );
     }
     return activity.broker.publish('execution', 'execute.completed', cloneContent(executeContent, { output }));

package/src/tasks/ServiceTask.js

@@ -41,7 +41,7 @@ ServiceTaskBehaviour.prototype.execute = function execute(executeMessage) {
       return broker.publish(
         'execution',
         'execute.error',
-        cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true }),
+        cloneContent(executeContent, { error: new ActivityError(err.message, executeMessage, err) }, { mandatory: true })
       );
     }
 

package/src/tasks/SignalTask.js

@@ -59,7 +59,7 @@ SignalTaskBehaviour.prototype._onDelegatedApiMessage = function onDelegatedApiMe
     {
       correlationId,
       type: messageType,
-    },
+    }
   );
 
   return this._onApiMessage(executeMessage, routingKey, message);
@@ -82,7 +82,7 @@ SignalTaskBehaviour.prototype._onApiMessage = function onApiMessage(executeMessa
         }),
         {
           correlationId,
-        },
+        }
       );
     case 'error':
       this._stop(executeContent.executionId);
@@ -97,8 +97,8 @@ SignalTaskBehaviour.prototype._onApiMessage = function onApiMessage(executeMessa
           {
             mandatory: true,
             correlationId,
-          },
-        ),
+          }
+        )
       );
     case 'discard':
       this._stop(executeContent.executionId);

package/types/types.d.ts

@@ -699,6 +699,13 @@ declare interface IScripts {
   getScript(language: string, identifier: { id: string; [x: string]: any }): Script;
 }
 
+declare class MessageFormatter {
+  id: string;
+  broker: Broker;
+  logger: ILogger;
+  format(message: MessageElement, callback: CallableFunction): void;
+}
+
 declare class Activity extends Element<Activity> {
   constructor(behaviour: IActivityBehaviour, activityDef: SerializableElement, context: ContextInstance);
   get Behaviour(): IActivityBehaviour;
@@ -721,6 +728,7 @@ declare class Activity extends Element<Activity> {
   get triggeredByEvent(): boolean;
   get attachedTo(): Activity;
   get eventDefinitions(): EventDefinition[];
+  get formatter(): MessageFormatter;
   /** Parent element process or sub process reference */
   get parentElement(): Process | Activity;
   activate(): void;
@@ -733,7 +741,7 @@ declare class Activity extends Element<Activity> {
   evaluateOutbound(
     fromMessage: ElementBrokerMessage,
     discardRestAtTake: boolean,
-    callback: (err: Error, evaluationResult: any) => void,
+    callback: (err: Error, evaluationResult: any) => void
   ): void;
   getState(): ActivityState | undefined;
 }