bpmn-engine 23.0.2 → 24.0.1

package/lib/index.cjs

@@ -280,6 +280,12 @@ Engine.prototype.stop = function stop() {
 };
 
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
+  if (this[kExecution]?.isRunning) {
+    this.logger.error('recover during running execution will be deprecated next major version');
+    this.logger.debug(`<${this.name}> stopping current running execution`);
+    this[kExecution].stop();
+  }
+
   if (!savedState) return this;
 
   let name = this.name;
@@ -287,7 +293,10 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
 
   this.logger.debug(`<${name}> recover`);
 
-  if (recoverOptions) this[kEnvironment] = new Elements__namespace.Environment(recoverOptions);
+  if (recoverOptions) {
+    this[kEnvironment] = this[kEnvironment].clone(recoverOptions);
+  }
+
   if (savedState.environment) this[kEnvironment] = this[kEnvironment].recover(savedState.environment);
 
   if (!savedState.definitions) return this;
@@ -577,7 +586,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.#');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "23.0.2",
+  "version": "24.0.1",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -62,14 +62,14 @@
     "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"
+    "texample": "^0.0.7"
   },
   "dependencies": {
-    "bpmn-elements": "^16.2.1",
+    "bpmn-elements": "^17.0.0",
     "bpmn-moddle": "^9.0.1",
     "debug": "^4.3.7",
     "moddle-context-serializer": "^4.2.1"

package/src/index.js

@@ -134,6 +134,12 @@ Engine.prototype.stop = function stop() {
 };
 
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
+  if (this[kExecution]?.isRunning) {
+    this.logger.error('recover during running execution will be deprecated next major version');
+    this.logger.debug(`<${this.name}> stopping current running execution`);
+    this[kExecution].stop();
+  }
+
   if (!savedState) return this;
 
   let name = this.name;
@@ -141,7 +147,10 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
 
   this.logger.debug(`<${name}> recover`);
 
-  if (recoverOptions) this[kEnvironment] = new Elements.Environment(recoverOptions);
+  if (recoverOptions) {
+    this[kEnvironment] = this[kEnvironment].clone(recoverOptions);
+  }
+
   if (savedState.environment) this[kEnvironment] = this[kEnvironment].recover(savedState.environment);
 
   if (!savedState.definitions) return this;
@@ -431,7 +440,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.#');

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;
   }
 }