bpmn-engine 23.0.1 → 24.0.0

package/lib/index.cjs

@@ -145,7 +145,7 @@ Object.defineProperties(ProcessOutputDataObject.prototype, {
 ProcessOutputDataObject.prototype.read = function readDataObject(broker, exchange, routingKeyPrefix, messageProperties) {
   const environment = this.environment;
   const { id, name, type } = this;
-  const value = environment.variables.data && environment.variables.data[this.id];
+  const value = environment.variables.data?.[this.id];
   return broker.publish(exchange, `${routingKeyPrefix}response`, { id, name, type, value }, messageProperties);
 };
 
@@ -153,15 +153,15 @@ ProcessOutputDataObject.prototype.write = function writeDataObject(broker, excha
   const environment = this.environment;
   const { id, name, type } = this;
 
-  environment.variables.data = environment.variables.data || {};
-  environment.variables.data[id] = value;
+  const data = (environment.variables.data = environment.variables.data || {});
+  data[id] = value;
 
-  environment.output.data = environment.output.data || {};
-  environment.output.data[id] = value;
+  const outputData = (environment.output.data = environment.output.data || {});
+  outputData[id] = value;
   return broker.publish(exchange, `${routingKeyPrefix}response`, { id, name, type, value }, messageProperties);
 };
 
-const nodeRequire = node_module.createRequire(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+const nodeRequire = node_module.createRequire(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
 const { version: engineVersion } = nodeRequire('../package.json');
 
 const kEngine = Symbol.for('engine');
@@ -175,14 +175,14 @@ const kState = Symbol.for('state');
 const kStopped = Symbol.for('stopped');
 const kTypeResolver = Symbol.for('type resolver');
 
-function Engine(options = {}) {
+function Engine(options) {
   if (!(this instanceof Engine)) return new Engine(options);
 
   node_events.EventEmitter.call(this);
 
   const opts = (this.options = {
     Logger: Logger,
-    scripts: new Scripts(options.disableDummyScript),
+    scripts: new Scripts(options?.disableDummyScript),
     ...options,
   });
 
@@ -334,11 +334,11 @@ Engine.prototype.resume = async function resume(...args) {
   return execution._resume(resumeOptions, callback);
 };
 
-Engine.prototype.addSource = function addSource({ sourceContext: addContext } = {}) {
-  if (!addContext) return;
+Engine.prototype.addSource = function addSource(options) {
+  if (!options?.sourceContext) return;
   const loadedDefinitions = this[kLoadedDefinitions];
   if (loadedDefinitions) loadedDefinitions.splice(0);
-  this[kPendingSources].add(addContext);
+  this[kPendingSources].add(options.sourceContext);
 };
 
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -382,9 +382,7 @@ Engine.prototype._loadDefinitions = async function loadDefinitions(executeOption
   return loadedDefinitions;
 };
 
-Engine.prototype._loadDefinition = function loadDefinition(serializedContext, executeOptions = {}) {
-  const { settings, variables } = executeOptions;
-
+Engine.prototype._loadDefinition = function loadDefinition(serializedContext, executeOptions) {
   const environment = this.environment;
   const context = new Elements__namespace.Context(
     serializedContext,
@@ -393,11 +391,11 @@ Engine.prototype._loadDefinition = function loadDefinition(serializedContext, ex
       ...executeOptions,
       settings: {
         ...environment.settings,
-        ...settings,
+        ...executeOptions?.settings,
       },
       variables: {
         ...environment.variables,
-        ...variables,
+        ...executeOptions?.variables,
       },
       source: serializedContext,
     })
@@ -570,8 +568,8 @@ Execution.prototype.stop = async function stop() {
   return result;
 };
 
-Execution.prototype._setup = function setup(setupOptions = {}) {
-  const listener = setupOptions.listener || this.options.listener;
+Execution.prototype._setup = function setup(setupOptions) {
+  const listener = setupOptions?.listener || this.options.listener;
   if (listener && typeof listener.emit !== 'function') throw new Error('listener.emit is not a function');
 
   const onChildMessage = this._onChildMessage.bind(this);
@@ -579,7 +577,10 @@ Execution.prototype._setup = function setup(setupOptions = {}) {
   for (const definition of this.definitions) {
     if (listener) definition.environment.options.listener = listener;
 
-    const { queueName } = definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, { noAck: true, consumerTag: '_engine_definition' });
+    const { queueName } = definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, {
+      noAck: true,
+      consumerTag: '_engine_definition',
+    });
     definition.broker.bindQueue(queueName, 'event', 'process.#');
     definition.broker.bindQueue(queueName, 'event', 'activity.#');
     definition.broker.bindQueue(queueName, 'event', 'flow.#');
@@ -717,9 +718,9 @@ Execution.prototype.getPostponed = function getPostponed() {
   return result;
 };
 
-Execution.prototype.signal = function signal(payload, { ignoreSameDefinition } = {}) {
+Execution.prototype.signal = function signal(payload, signalOptions) {
   for (const definition of this[kExecuting]) {
-    if (ignoreSameDefinition && payload?.parent?.id === definition.id) continue;
+    if (signalOptions?.ignoreSameDefinition && payload?.parent?.id === definition.id) continue;
     definition.signal(payload);
   }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "23.0.1",
+  "version": "24.0.0",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -52,7 +52,7 @@
   ],
   "devDependencies": {
     "@bonniernews/hot-bev": "^0.4.0",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-commonjs": "^28.0.0",
     "@types/bpmn-moddle": "^5.1.6",
     "@types/node": "^18.19.31",
     "bent": "^7.3.12",
@@ -62,17 +62,19 @@
     "chronokinesis": "^6.0.0",
     "eslint": "^9.10.0",
     "markdown-toc": "^1.2.0",
-    "mocha": "^10.2.0",
+    "mocha": "^11.0.1",
     "mocha-cakes-2": "^3.3.0",
     "prettier": "^3.2.5",
     "rollup": "^4.10.0",
     "texample": "^0.0.6"
   },
   "dependencies": {
-    "bpmn-elements": "^16.1.0",
+    "bpmn-elements": "^17.0.0",
     "bpmn-moddle": "^9.0.1",
     "debug": "^4.3.7",
-    "moddle-context-serializer": "^4.2.1",
-    "smqp": "^9.0.2"
+    "moddle-context-serializer": "^4.2.1"
+  },
+  "peerDependencies": {
+    "smqp": ">=9"
   }
 }

package/src/extensions/ProcessOutputDataObject.js

@@ -24,7 +24,7 @@ Object.defineProperties(ProcessOutputDataObject.prototype, {
 ProcessOutputDataObject.prototype.read = function readDataObject(broker, exchange, routingKeyPrefix, messageProperties) {
   const environment = this.environment;
   const { id, name, type } = this;
-  const value = environment.variables.data && environment.variables.data[this.id];
+  const value = environment.variables.data?.[this.id];
   return broker.publish(exchange, `${routingKeyPrefix}response`, { id, name, type, value }, messageProperties);
 };
 
@@ -32,10 +32,10 @@ ProcessOutputDataObject.prototype.write = function writeDataObject(broker, excha
   const environment = this.environment;
   const { id, name, type } = this;
 
-  environment.variables.data = environment.variables.data || {};
-  environment.variables.data[id] = value;
+  const data = (environment.variables.data = environment.variables.data || {});
+  data[id] = value;
 
-  environment.output.data = environment.output.data || {};
-  environment.output.data[id] = value;
+  const outputData = (environment.output.data = environment.output.data || {});
+  outputData[id] = value;
   return broker.publish(exchange, `${routingKeyPrefix}response`, { id, name, type, value }, messageProperties);
 };

package/src/index.js

@@ -29,14 +29,14 @@ const kTypeResolver = Symbol.for('type resolver');
 export default Engine;
 export { JavaScripts };
 
-export function Engine(options = {}) {
+export function Engine(options) {
   if (!(this instanceof Engine)) return new Engine(options);
 
   EventEmitter.call(this);
 
   const opts = (this.options = {
     Logger: DebugLogger,
-    scripts: new JavaScripts(options.disableDummyScript),
+    scripts: new JavaScripts(options?.disableDummyScript),
     ...options,
   });
 
@@ -188,11 +188,11 @@ Engine.prototype.resume = async function resume(...args) {
   return execution._resume(resumeOptions, callback);
 };
 
-Engine.prototype.addSource = function addSource({ sourceContext: addContext } = {}) {
-  if (!addContext) return;
+Engine.prototype.addSource = function addSource(options) {
+  if (!options?.sourceContext) return;
   const loadedDefinitions = this[kLoadedDefinitions];
   if (loadedDefinitions) loadedDefinitions.splice(0);
-  this[kPendingSources].add(addContext);
+  this[kPendingSources].add(options.sourceContext);
 };
 
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -236,9 +236,7 @@ Engine.prototype._loadDefinitions = async function loadDefinitions(executeOption
   return loadedDefinitions;
 };
 
-Engine.prototype._loadDefinition = function loadDefinition(serializedContext, executeOptions = {}) {
-  const { settings, variables } = executeOptions;
-
+Engine.prototype._loadDefinition = function loadDefinition(serializedContext, executeOptions) {
   const environment = this.environment;
   const context = new Elements.Context(
     serializedContext,
@@ -247,11 +245,11 @@ Engine.prototype._loadDefinition = function loadDefinition(serializedContext, ex
       ...executeOptions,
       settings: {
         ...environment.settings,
-        ...settings,
+        ...executeOptions?.settings,
       },
       variables: {
         ...environment.variables,
-        ...variables,
+        ...executeOptions?.variables,
       },
       source: serializedContext,
     })
@@ -424,8 +422,8 @@ Execution.prototype.stop = async function stop() {
   return result;
 };
 
-Execution.prototype._setup = function setup(setupOptions = {}) {
-  const listener = setupOptions.listener || this.options.listener;
+Execution.prototype._setup = function setup(setupOptions) {
+  const listener = setupOptions?.listener || this.options.listener;
   if (listener && typeof listener.emit !== 'function') throw new Error('listener.emit is not a function');
 
   const onChildMessage = this._onChildMessage.bind(this);
@@ -433,7 +431,10 @@ Execution.prototype._setup = function setup(setupOptions = {}) {
   for (const definition of this.definitions) {
     if (listener) definition.environment.options.listener = listener;
 
-    const { queueName } = definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, { noAck: true, consumerTag: '_engine_definition' });
+    const { queueName } = definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, {
+      noAck: true,
+      consumerTag: '_engine_definition',
+    });
     definition.broker.bindQueue(queueName, 'event', 'process.#');
     definition.broker.bindQueue(queueName, 'event', 'activity.#');
     definition.broker.bindQueue(queueName, 'event', 'flow.#');
@@ -571,9 +572,9 @@ Execution.prototype.getPostponed = function getPostponed() {
   return result;
 };
 
-Execution.prototype.signal = function signal(payload, { ignoreSameDefinition } = {}) {
+Execution.prototype.signal = function signal(payload, signalOptions) {
   for (const definition of this[kExecuting]) {
-    if (ignoreSameDefinition && payload?.parent?.id === definition.id) continue;
+    if (signalOptions?.ignoreSameDefinition && payload?.parent?.id === definition.id) continue;
     definition.signal(payload);
   }
 };

package/types/bpmn-engine.d.ts

@@ -3,11 +3,7 @@
 
 import { EventEmitter } from 'node:events';
 import { Definitions as BpmnModdleDefinitions } from 'bpmn-moddle';
-import {
-  extendFn,
-  SerializableContext,
-  TypeResolver,
-} from 'moddle-context-serializer';
+import { extendFn, SerializableContext, TypeResolver } from 'moddle-context-serializer';
 import {
   ActivityStatus,
   ElementBroker,
@@ -61,10 +57,7 @@ declare module 'bpmn-engine' {
         flow.discard: The sequence flow was discarded
         flow.looped: The sequence is looped
    */
-  export type BpmnSequenceFlowEvent =
-    | 'flow.take'
-    | 'flow.discard'
-    | 'flow.looped';
+  export type BpmnSequenceFlowEvent = 'flow.take' | 'flow.discard' | 'flow.looped';
 
   export interface BpmnMessage {
     id?: string;
@@ -173,10 +166,7 @@ declare module 'bpmn-engine' {
      */
     execute(): Promise<Execution>;
     execute(options: BpmnEngineExecuteOptions): Promise<Execution>;
-    execute(
-      options: BpmnEngineExecuteOptions,
-      cb: (err: Error, execution?: Execution) => void
-    ): Promise<Execution>;
+    execute(options: BpmnEngineExecuteOptions, cb: (err: Error, execution?: Execution) => void): Promise<Execution>;
     execute(cb: (err: Error) => void): Promise<Execution>;
 
     /**
@@ -207,10 +197,7 @@ declare module 'bpmn-engine' {
      * @param options
      * @param callback
      */
-    resume(
-      options?: BpmnEngineExecuteOptions,
-      callback?: (err: Error, execution?: Execution) => void
-    ): Promise<Execution>;
+    resume(options?: BpmnEngineExecuteOptions, callback?: (err: Error, execution?: Execution) => void): Promise<Execution>;
 
     /**
      * Stop execution. The instance is terminated.
@@ -320,10 +307,7 @@ declare module 'bpmn-engine' {
      * @param message {BpmnMessage}
      * @param options
      */
-    signal(
-      message?: BpmnMessage,
-      options?: { ignoreSameDefinition?: boolean }
-    ): void;
+    signal(message?: BpmnMessage, options?: { ignoreSameDefinition?: boolean }): void;
 
     /**
      * send cancel activity to execution, distributed to all definitions
@@ -345,9 +329,6 @@ declare module 'bpmn-engine' {
      */
     constructor(disableDummy?: boolean);
     register(activity: any): Script | undefined;
-    getScript(
-      language: string,
-      identifier: { id: string; [x: string]: any }
-    ): Script;
+    getScript(language: string, identifier: { id: string; [x: string]: any }): Script;
   }
 }