major update of bpmn-elements@17, mitigate issue #197

paed01 · paed01 · commit 184464e8713d · 2025-02-09T05:19:18.000+01:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -3,14 +3,15 @@ name: Build
 on:
   pull_request:
   push:
-    branches: master
+    branches:
+      - master
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18, 20, latest]
+        node-version: [18, 20, 22, latest]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,5 +1,6 @@
 {
-  "endOfLine": "lf",
+  "tabWidth": 2,
+  "printWidth": 140,
   "singleQuote": true,
   "trailingComma": "es5"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,33 +1,37 @@
 # Changelog
 
-## 23.0.2
+## [24.0.0] - 2025-02-08
+
+- major update [`bpmn-elements@17`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md), something about mitigating weird formatting behaviour
+
+## [23.0.2] - 2024-10-22
 
 - move `smqp` to peerDependencies since it's included in `bpmn-elements`
 - patch [`bpmn-elements@16.2.1`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md)
 - use optional chaining and remove futile object creations
 
-## 23.0.1
+## [23.0.1] - 2024-09-08
 
 - patch [`bpmn-elements@16.1.0`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md)
 - fix AppVeyor build badge
 
-## 23.0.0
+## [23.0.0] - 2024-08-08
 
 ### Breaking
 
 - changed `ConditionalEventDefinition` behaviour in [`bpmn-elements@16`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md)
 
-## 22.0.2
+## [22.0.2] - 2024-07-10
 
 - patch [`bpmn-elements@15.0.3`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md)
 
-## 22.0.1
+## [22.0.1] - 2024-06-19
 
 - for a number of years the `extendFn` option has been accepted, but never passed to moddle-context-serializer. Now it is
 - fix type declaration for options `extendFn` and `TypeResolver`
 - type declare that a generic listener instance with an emit function works just as well as a full blown new EventEmitter
 
-## 22.0.0
+## [22.0.0] - 2024-06-14
 
 Performance tweaks.
 
@@ -39,11 +43,11 @@ Performance tweaks.
 - drop support for node 14 and 16
 - JavaScripts.Script property scripts is now a Map
 
-## 21.1.0
+## [21.1.0] - 2024-05-17
 
 - minor bump [`bpmn-elements@14.1.0`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md), addresses issue #180
 
-## 21.0.0
+## [21.0.0] - 2024-05-04
 
 Stop execution if invalid time duration, cycle, or date is encountered.
 
diff --git a/docs/API.md b/docs/API.md
@@ -1,6 +1,6 @@
 <!-- version -->
 
-# 23.0.2 API Reference
+# 24.0.0 API Reference
 
 <!-- versionstop -->
 
diff --git a/lib/index.cjs b/lib/index.cjs
@@ -577,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.#');
diff --git a/package.json b/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.0",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -69,7 +69,7 @@
     "texample": "^0.0.6"
   },
   "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"
diff --git a/src/index.js b/src/index.js
@@ -431,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.#');
diff --git a/test/feature/multiple-sources-feature.js b/test/feature/multiple-sources-feature.js
@@ -68,7 +68,11 @@ Feature('Multiple sources', () => {
     Then('admin is notified that spot price has been updated', () => {
       const [, , adminApprove] = execution.getPostponed();
       expect(adminApprove).to.have.property('id', 'approveSpotPrice');
-      expect(adminApprove.content).to.have.property('form').with.property('fields').with.property('newPrice').with.property('defaultValue', 110);
+      expect(adminApprove.content)
+        .to.have.property('form')
+        .with.property('fields')
+        .with.property('newPrice')
+        .with.property('defaultValue', 110);
     });
 
     And('the tasks can be retrieved by getActivityById', () => {
@@ -256,7 +260,11 @@ Feature('Multiple sources', () => {
 
     When('admin approves new spot price', () => {
       expect(approveSpotPrice).to.have.property('id', 'approveSpotPrice');
-      expect(approveSpotPrice.content).to.have.property('form').with.property('fields').with.property('newPrice').with.property('defaultValue', 100);
+      expect(approveSpotPrice.content)
+        .to.have.property('form')
+        .with.property('fields')
+        .with.property('newPrice')
+        .with.property('defaultValue', 100);
 
       approveSpotPrice.signal({
         form: {
@@ -642,7 +650,11 @@ function getExtendedEngine(options) {
         if (activity.behaviour.expression) {
           activity.behaviour.Service = ServiceExpression;
         }
-        if (activity.isStart && activity.eventDefinitions && activity.eventDefinitions.find(({ type }) => type === 'bpmn:SignalEventDefinition')) {
+        if (
+          activity.isStart &&
+          activity.eventDefinitions &&
+          activity.eventDefinitions.find(({ type }) => type === 'bpmn:SignalEventDefinition')
+        ) {
           activity.on('end', (api) => {
             activity.environment.variables.message = api.content.output;
           });
diff --git a/types/bpmn-engine.d.ts b/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;
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`		`- "endOfLine": "lf",`
	`2`	`+ "tabWidth": 2,`
	`3`	`+ "printWidth": 140,`
`3`	`4`	`"singleQuote": true,`
`4`	`5`	`"trailingComma": "es5"`
`5`	`6`	`}`