bpmn-elements 17.2.2 → 18.0.0

package/dist/tasks/SubProcess.js

@@ -3,17 +3,22 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.SubProcess = SubProcess;
 exports.SubProcessBehaviour = SubProcessBehaviour;
-exports.default = SubProcess;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
-var _ProcessExecution = _interopRequireDefault(require("../process/ProcessExecution.js"));
+var _Activity = require("../activity/Activity.js");
+var _ProcessExecution = require("../process/ProcessExecution.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const kExecutions = Symbol.for('executions');
-const kOnExecutionCompleted = Symbol.for('execution completed handler');
+const K_EXECUTIONS = Symbol.for('executions');
+const K_ON_EXECUTION_COMPLETED = Symbol.for('execution completed handler');
+
+/**
+ * Sub process
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function SubProcess(activityDef, context) {
   const triggeredByEvent = activityDef.behaviour && activityDef.behaviour.triggeredByEvent;
-  const subProcess = new _Activity.default(SubProcessBehaviour, {
+  const subProcess = new _Activity.Activity(SubProcessBehaviour, {
     ...activityDef,
     isSubProcess: true,
     triggeredByEvent
@@ -32,7 +37,7 @@ function SubProcess(activityDef, context) {
       startId
     } = message.content;
     const last = message.content.sequence.pop();
-    const sequence = new _ProcessExecution.default(subProcess, context).shake(startId);
+    const sequence = new _ProcessExecution.ProcessExecution(subProcess, context).shake(startId);
     message.content.sequence.push({
       ...last,
       isSubProcess: true,
@@ -40,6 +45,12 @@ function SubProcess(activityDef, context) {
     });
   }
 }
+
+/**
+ * Sub process behaviour
+ * @param {import('#types').Activity} activity
+ * @param {import('#types').ContextInstance} context
+ */
 function SubProcessBehaviour(activity, context) {
   const {
     id,
@@ -48,27 +59,31 @@ function SubProcessBehaviour(activity, context) {
   } = activity;
   this.id = id;
   this.type = type;
+  /** @type {import('./LoopCharacteristics.js').LoopCharacteristics | undefined} */
   this.loopCharacteristics = behaviour.loopCharacteristics && new behaviour.loopCharacteristics.Behaviour(activity, behaviour.loopCharacteristics);
   this.activity = activity;
   this.context = context;
   this.environment = activity.environment;
   this.broker = activity.broker;
   this.executionId = undefined;
-  this[kExecutions] = new Set();
-  this[kOnExecutionCompleted] = this._onExecutionCompleted.bind(this);
+  this[K_EXECUTIONS] = new Set();
+  this[K_ON_EXECUTION_COMPLETED] = this._onExecutionCompleted.bind(this);
 }
-Object.defineProperties(SubProcessBehaviour.prototype, {
-  execution: {
-    get() {
-      return [...this[kExecutions]][0];
-    }
-  },
-  executions: {
-    get() {
-      return [...this[kExecutions]];
-    }
+Object.defineProperty(SubProcessBehaviour.prototype, 'execution', {
+  get() {
+    return [...this[K_EXECUTIONS]][0];
   }
 });
+Object.defineProperty(SubProcessBehaviour.prototype, 'executions', {
+  get() {
+    return [...this[K_EXECUTIONS]];
+  }
+});
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
   const {
     isRootScope,
@@ -86,7 +101,7 @@ SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
 };
 SubProcessBehaviour.prototype.getState = function getState() {
   const states = [];
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     const state = pe.getState();
     state.environment = pe.environment.getState();
     states.push(state);
@@ -100,7 +115,7 @@ SubProcessBehaviour.prototype.getState = function getState() {
 };
 SubProcessBehaviour.prototype.recover = function recover(state) {
   if (!state) return;
-  const executions = this[kExecutions];
+  const executions = this[K_EXECUTIONS];
   const loopCharacteristics = this.loopCharacteristics;
   if (loopCharacteristics && state.executions) {
     executions.clear();
@@ -114,13 +129,13 @@ SubProcessBehaviour.prototype.recover = function recover(state) {
   }
   const subEnvironment = this.environment.clone().recover(state.environment);
   const subContext = this.context.clone(subEnvironment, this.activity);
-  const execution = new _ProcessExecution.default(this.activity, subContext).recover(state);
+  const execution = new _ProcessExecution.ProcessExecution(this.activity, subContext).recover(state);
   executions.add(execution);
   return execution;
 };
 SubProcessBehaviour.prototype.getPostponed = function getPostponed() {
   let postponed = [];
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     postponed = postponed.concat(pe.getPostponed());
   }
   return postponed;
@@ -135,13 +150,13 @@ SubProcessBehaviour.prototype._upsertExecution = function upsertExecution(execut
   }
   const subEnvironment = this.environment.clone();
   const subContext = this.context.clone(subEnvironment, this.activity);
-  execution = new _ProcessExecution.default(this.activity, subContext);
-  this[kExecutions].add(execution);
+  execution = new _ProcessExecution.ProcessExecution(this.activity, subContext);
+  this[K_EXECUTIONS].add(execution);
   this._addListeners(executionId);
   return execution;
 };
 SubProcessBehaviour.prototype._addListeners = function addListeners(executionId) {
-  this.broker.subscribeTmp('subprocess-execution', `execution.#.${executionId}`, this[kOnExecutionCompleted], {
+  this.broker.subscribeTmp('subprocess-execution', `execution.#.${executionId}`, this[K_ON_EXECUTION_COMPLETED], {
     noAck: true,
     consumerTag: `_sub-process-execution-${executionId}`
   });
@@ -177,7 +192,7 @@ SubProcessBehaviour.prototype._onExecutionCompleted = function onExecutionComple
 SubProcessBehaviour.prototype._completeExecution = function completeExecution(completeRoutingKey, content) {
   if (this.loopCharacteristics) {
     const execution = this._getExecutionById(content.executionId);
-    this[kExecutions].delete(execution);
+    this[K_EXECUTIONS].delete(execution);
   }
   this.broker.publish('execution', completeRoutingKey, (0, _messageHelper.cloneContent)(content));
 };
@@ -194,7 +209,7 @@ SubProcessBehaviour.prototype.getApi = function getApi(apiMessage) {
   }
 };
 SubProcessBehaviour.prototype._getExecutionById = function getExecutionById(executionId) {
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     if (pe.executionId === executionId) return pe;
   }
 };

package/dist/tasks/Task.js

@@ -3,14 +3,23 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.Task = Task;
 exports.TaskBehaviour = TaskBehaviour;
-exports.default = Task;
-var _Activity = _interopRequireDefault(require("../activity/Activity.js"));
+var _Activity = require("../activity/Activity.js");
 var _messageHelper = require("../messageHelper.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Task
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function Task(activityDef, context) {
-  return new _Activity.default(TaskBehaviour, activityDef, context);
+  return new _Activity.Activity(TaskBehaviour, activityDef, context);
 }
+
+/**
+ * Task behaviour
+ * @param {import('#types').Activity} activity
+ */
 function TaskBehaviour(activity) {
   const {
     id,
@@ -20,9 +29,15 @@ function TaskBehaviour(activity) {
   } = activity;
   this.id = id;
   this.type = type;
+  /** @type {import('./LoopCharacteristics.js').LoopCharacteristics | undefined} */
   this.loopCharacteristics = behaviour.loopCharacteristics && new behaviour.loopCharacteristics.Behaviour(activity, behaviour.loopCharacteristics);
   this.broker = broker;
 }
+
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 TaskBehaviour.prototype.execute = function execute(executeMessage) {
   const executeContent = executeMessage.content;
   const loopCharacteristics = this.loopCharacteristics;

package/dist/tasks/Transaction.js

@@ -3,15 +3,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = Transaction;
-var _SubProcess = _interopRequireDefault(require("./SubProcess.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+exports.Transaction = Transaction;
+var _SubProcess = require("./SubProcess.js");
+/**
+ * Transaction
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
 function Transaction(activityDef, context) {
   const transaction = {
     type: 'transaction',
     ...activityDef,
     isTransaction: true
   };
-  const activity = (0, _SubProcess.default)(transaction, context);
+  const activity = (0, _SubProcess.SubProcess)(transaction, context);
   return activity;
 }

package/dist/tasks/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "CallActivity", {
   enumerable: true,
   get: function () {
-    return _CallActivity.default;
+    return _CallActivity.CallActivity;
   }
 });
 Object.defineProperty(exports, "CallActivityBehaviour", {
@@ -18,7 +18,7 @@ Object.defineProperty(exports, "CallActivityBehaviour", {
 Object.defineProperty(exports, "ReceiveTask", {
   enumerable: true,
   get: function () {
-    return _ReceiveTask.default;
+    return _ReceiveTask.ReceiveTask;
   }
 });
 Object.defineProperty(exports, "ReceiveTaskBehaviour", {
@@ -30,7 +30,7 @@ Object.defineProperty(exports, "ReceiveTaskBehaviour", {
 Object.defineProperty(exports, "ScriptTask", {
   enumerable: true,
   get: function () {
-    return _ScriptTask.default;
+    return _ScriptTask.ScriptTask;
   }
 });
 Object.defineProperty(exports, "ScriptTaskBehaviour", {
@@ -42,7 +42,7 @@ Object.defineProperty(exports, "ScriptTaskBehaviour", {
 Object.defineProperty(exports, "ServiceTask", {
   enumerable: true,
   get: function () {
-    return _ServiceTask.default;
+    return _ServiceTask.ServiceTask;
   }
 });
 Object.defineProperty(exports, "ServiceTaskBehaviour", {
@@ -54,7 +54,7 @@ Object.defineProperty(exports, "ServiceTaskBehaviour", {
 Object.defineProperty(exports, "SignalTask", {
   enumerable: true,
   get: function () {
-    return _SignalTask.default;
+    return _SignalTask.SignalTask;
   }
 });
 Object.defineProperty(exports, "SignalTaskBehaviour", {
@@ -66,7 +66,7 @@ Object.defineProperty(exports, "SignalTaskBehaviour", {
 Object.defineProperty(exports, "SubProcess", {
   enumerable: true,
   get: function () {
-    return _SubProcess.default;
+    return _SubProcess.SubProcess;
   }
 });
 Object.defineProperty(exports, "SubProcessBehaviour", {
@@ -78,7 +78,7 @@ Object.defineProperty(exports, "SubProcessBehaviour", {
 Object.defineProperty(exports, "Task", {
   enumerable: true,
   get: function () {
-    return _Task.default;
+    return _Task.Task;
   }
 });
 Object.defineProperty(exports, "TaskBehaviour", {
@@ -90,16 +90,14 @@ Object.defineProperty(exports, "TaskBehaviour", {
 Object.defineProperty(exports, "Transaction", {
   enumerable: true,
   get: function () {
-    return _Transaction.default;
+    return _Transaction.Transaction;
   }
 });
-var _CallActivity = _interopRequireWildcard(require("./CallActivity.js"));
-var _ReceiveTask = _interopRequireWildcard(require("./ReceiveTask.js"));
-var _ScriptTask = _interopRequireWildcard(require("./ScriptTask.js"));
-var _ServiceTask = _interopRequireWildcard(require("./ServiceTask.js"));
-var _SignalTask = _interopRequireWildcard(require("./SignalTask.js"));
-var _SubProcess = _interopRequireWildcard(require("./SubProcess.js"));
-var _Task = _interopRequireWildcard(require("./Task.js"));
-var _Transaction = _interopRequireDefault(require("./Transaction.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+var _CallActivity = require("./CallActivity.js");
+var _ReceiveTask = require("./ReceiveTask.js");
+var _ScriptTask = require("./ScriptTask.js");
+var _ServiceTask = require("./ServiceTask.js");
+var _SignalTask = require("./SignalTask.js");
+var _SubProcess = require("./SubProcess.js");
+var _Task = require("./Task.js");
+var _Transaction = require("./Transaction.js");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "17.2.2",
+  "version": "18.0.0",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,11 @@
       "require": "./dist/index.js",
       "import": "./src/index.js"
     },
+    "./errors": {
+      "types": "./types/index.d.ts",
+      "require": "./dist/error/Errors.js",
+      "import": "./src/error/Errors.js"
+    },
     "./events": {
       "types": "./types/index.d.ts",
       "require": "./dist/events/index.js",
@@ -43,12 +48,14 @@
   "scripts": {
     "test": "mocha -R @bonniernews/hot-bev -p -t 3000",
     "posttest": "npm run lint && npm run dist",
-    "lint": "eslint . --cache && prettier . --check --cache",
+    "lint": "eslint . --cache && prettier . --check --cache && npm run typecheck",
+    "typecheck": "tsc --noEmit",
     "prepack": "npm run dist",
     "test:md": "texample ./docs/Examples.md,./docs/StartEvent.md,./docs/Extension.md,./docs/ConditionalEventDefinition.md",
     "cov:html": "c8 -r html -r text mocha -R @bonniernews/hot-bev -p -t 3000",
     "test:lcov": "c8 -r lcov mocha && npm run lint",
-    "dist": "babel src -d dist/"
+    "dist": "babel src -d dist/ && npm run build:types",
+    "build:types": "node scripts/build-types.js"
   },
   "repository": {
     "type": "git",
@@ -78,6 +85,14 @@
       "src/**/*"
     ]
   },
+  "overrides": {
+    "c8": {
+      "yargs": "^18.0.0"
+    },
+    "mocha": {
+      "yargs": "^18.0.0"
+    }
+  },
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
     "@babel/cli": "^7.24.1",
@@ -85,24 +100,27 @@
     "@babel/preset-env": "^7.24.4",
     "@babel/register": "^7.23.7",
     "@bonniernews/hot-bev": "^0.4.0",
-    "@types/node": "^18.19.63",
-    "bpmn-moddle": "^9.0.1",
-    "c8": "^10.1.1",
+    "@eslint/js": "^10.0.1",
+    "@types/bpmn-moddle": "^10.0.0",
+    "@types/node": "^20.19.40",
+    "bpmn-moddle": "^10.0.0",
+    "c8": "^11.0.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^6.2.1",
-    "chronokinesis": "^7.0.0",
+    "chronokinesis": "^8.0.0",
     "debug": "^4.3.4",
-    "eslint": "^9.0.0",
-    "globals": "^16.0.0",
+    "dts-buddy": "^0.8.0",
+    "eslint": "^10.3.0",
+    "globals": "^17.0.0",
     "mocha": "^11.0.1",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^4.2.1",
+    "moddle-context-serializer": "^6.0.0",
     "nock": "^14.0.0",
     "prettier": "^3.2.5",
-    "texample": "^0.1.0"
+    "texample": "^1.0.1"
   },
   "dependencies": {
-    "@0dep/piso": "^3.0.1",
-    "smqp": "^10.0.0"
+    "@0dep/piso": "^4.0.0",
+    "smqp": "^13.0.0"
   }
 }

package/src/Api.js

@@ -1,22 +1,54 @@
 import { cloneMessage } from './messageHelper.js';
 import { getUniqueId } from './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]
+ */
 export 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]
+ */
 export 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]
+ */
 export 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]
+ */
 export 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
+ */
 export function Api(pfx, broker, sourceMessage, environment) {
   if (!sourceMessage) throw new Error('Api requires message');
 
@@ -36,26 +68,50 @@ export function Api(pfx, broker, sourceMessage, environment) {
   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,
@@ -68,6 +124,12 @@ Api.prototype.resolveExpression = function resolveExpression(expression) {
   );
 };
 
+/**
+ * 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 || getUniqueId(`${this.id || this.messagePrefix}_signal`);
   let key = `${this.messagePrefix}.${action}`;
@@ -75,12 +137,20 @@ Api.prototype.sendApiMessage = function sendApiMessage(action, content, options)
   this.broker.publish('api', key, this.createMessage(content), { ...options, correlationId, 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,