bpmn-engine 26.0.4 → 26.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +18 -11
  2. package/lib/index.cjs +1 -1
  3. package/package.json +6 -6
  4. package/src/index.js +1 -1
  5. package/types/index.d.ts +0 -6
package/README.md CHANGED
@@ -2,24 +2,31 @@
2
2
 
3
3
  [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
4
4
 
5
- [![Build](https://github.com/paed01/bpmn-engine/actions/workflows/build.yaml/badge.svg)](https://github.com/paed01/bpmn-engine/actions/workflows/build.yaml)[![Build status](https://ci.appveyor.com/api/projects/status/670n39fivq1g3nu5/branch/master?svg=true)](https://ci.appveyor.com/project/paed01/bpmn-engine/branch/master)[![Coverage Status](https://coveralls.io/repos/github/paed01/bpmn-engine/badge.svg?branch=master)](https://coveralls.io/github/paed01/bpmn-engine?branch=master)
5
+ [![Build](https://github.com/paed01/bpmn-engine/actions/workflows/build.yaml/badge.svg)](https://github.com/paed01/bpmn-engine/actions/workflows/build.yaml)[![Build (Windows)](https://github.com/paed01/bpmn-engine/actions/workflows/build-windows.yaml/badge.svg)](https://github.com/paed01/bpmn-engine/actions/workflows/build-windows.yaml)[![Coverage Status](https://coveralls.io/repos/github/paed01/bpmn-engine/badge.svg?branch=master)](https://coveralls.io/github/paed01/bpmn-engine?branch=master)
6
6
 
7
7
  # Introduction
8
8
 
9
9
  BPMN 2.0 execution engine. Open source javascript workflow engine.
10
10
 
11
+ Documentation:
12
+
11
13
  - [API](/docs/API.md)
12
- - [Changelog](/CHANGELOG.md)
13
14
  - [Examples](/docs/Examples.md)
14
15
  - [Upgrade version](/docs/Upgrade.md)
15
- - [Peer dependencies](#peer-dependencies)
16
16
  - [bpmn-moddle 9 vs 10](/docs/bpmn-moddle.md)
17
+ - [Changelog](/CHANGELOG.md)
18
+
19
+ <!-- toc -->
20
+
21
+ - [Peer dependencies](#peer-dependencies)
17
22
  - [Supported elements](#supported-elements)
18
23
  - [Extensions](#extensions)
19
24
  - [Debug](#debug)
20
- - [Example process](#a-pretty-image-of-a-process)
25
+ - [A pretty image of a process](#a-pretty-image-of-a-process)
21
26
  - [Acknowledgments](#acknowledgments)
22
27
 
28
+ <!-- /toc -->
29
+
23
30
  # Peer dependencies
24
31
 
25
32
  The runtime dependencies are declared as **peer dependencies**, so you install and pin them yourself and the engine reuses your single copy:
@@ -28,13 +35,13 @@ The runtime dependencies are declared as **peer dependencies**, so you install a
28
35
  npm install bpmn-engine bpmn-elements bpmn-moddle moddle-context-serializer debug smqp
29
36
  ```
30
37
 
31
- | Peer dependency | Range | Role |
32
- | ---------------------------------------------------------------------------------- | --------- | ------------------------------------------------- |
33
- | [`bpmn-elements`](https://github.com/paed01/bpmn-elements) | `>=18` | element behaviour functions |
34
- | [`bpmn-moddle`](https://github.com/bpmn-io/bpmn-moddle) | `>=9` | BPMN XML parser ([9 vs 10](/docs/bpmn-moddle.md)) |
35
- | [`moddle-context-serializer`](https://github.com/paed01/moddle-context-serializer) | `>=6` | persistable source context |
36
- | [`smqp`](https://github.com/paed01/smqp) | `^13.0.1` | message broker driving execution |
37
- | [`debug`](https://github.com/debug-js/debug) | `>=4` | logging |
38
+ | Peer dependency | Range | Role |
39
+ | ---------------------------------------------------------------------------------- | ----------- | ------------------------------------------------- |
40
+ | [`bpmn-elements`](https://github.com/paed01/bpmn-elements) | `>=18.0.25` | element behaviour functions |
41
+ | [`bpmn-moddle`](https://github.com/bpmn-io/bpmn-moddle) | `>=9` | BPMN XML parser ([9 vs 10](/docs/bpmn-moddle.md)) |
42
+ | [`moddle-context-serializer`](https://github.com/paed01/moddle-context-serializer) | `>=6` | persistable source context |
43
+ | [`smqp`](https://github.com/paed01/smqp) | `>=15` | message broker driving execution |
44
+ | [`debug`](https://github.com/debug-js/debug) | `>=4` | logging |
38
45
 
39
46
  `bpmn-moddle` spans a major version on purpose — see [bpmn-moddle 9 vs 10](/docs/bpmn-moddle.md) for the import change and how persisted state stays compatible across the upgrade.
40
47
 
package/lib/index.cjs CHANGED
@@ -481,7 +481,7 @@ Engine.prototype._getModdleContext = function getModdleContext(source) {
481
481
 
482
482
  /**
483
483
  * @param {Engine} engine
484
- * @param {any[]} definitions
484
+ * @param {import('bpmn-elements').Definition[]} definitions
485
485
  * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [options]
486
486
  * @param {boolean} [isRecovered]
487
487
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bpmn-engine",
3
3
  "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
4
- "version": "26.0.4",
4
+ "version": "26.0.5",
5
5
  "type": "module",
6
6
  "module": "./src/index.js",
7
7
  "main": "./lib/index.cjs",
@@ -34,10 +34,9 @@
34
34
  "test": "mocha -p -R @bonniernews/hot-bev",
35
35
  "posttest": "npm run lint && npm run toc && npm run dist && npm run test:md",
36
36
  "lint": "eslint . --cache && prettier . -c --cache",
37
- "wintest": "mocha",
38
37
  "cov:html": "c8 -r html -r text mocha -p -R @bonniernews/hot-bev",
39
38
  "test:lcov": "c8 -r lcov mocha && npm run lint",
40
- "toc": "node scripts/generate-api-toc ./docs/API.md,./docs/Examples.md",
39
+ "toc": "toc README.md docs/API.md docs/Examples.md docs/Upgrade.md",
41
40
  "test:md": "texample ./docs/API.md,./docs/Examples.md,./docs/Upgrade.md -c .mocharc.json",
42
41
  "dist": "rollup -c",
43
42
  "prepack": "npm run dist"
@@ -63,6 +62,7 @@
63
62
  }
64
63
  },
65
64
  "devDependencies": {
65
+ "@0dep/toc": "^1.0.1",
66
66
  "@bonniernews/hot-bev": "^0.4.0",
67
67
  "@eslint/js": "^10.0.1",
68
68
  "@rollup/plugin-commonjs": "^29.0.0",
@@ -71,7 +71,7 @@
71
71
  "@types/mocha": "^10.0.10",
72
72
  "@types/node": "^20.19.40",
73
73
  "bent": "^7.3.12",
74
- "bpmn-elements": "^18.0.15",
74
+ "bpmn-elements": "^18.0.24",
75
75
  "bpmn-moddle": "^9.0.4",
76
76
  "bpmn-moddle-10": "npm:bpmn-moddle@^10.0.0",
77
77
  "c8": "^12.0.0",
@@ -91,10 +91,10 @@
91
91
  "typescript": "^7.0.2"
92
92
  },
93
93
  "peerDependencies": {
94
- "bpmn-elements": ">=18",
94
+ "bpmn-elements": ">=18.0.25",
95
95
  "bpmn-moddle": ">=9",
96
96
  "debug": ">=4",
97
97
  "moddle-context-serializer": ">=6",
98
- "smqp": ">=13"
98
+ "smqp": ">=15"
99
99
  }
100
100
  }
package/src/index.js CHANGED
@@ -334,7 +334,7 @@ Engine.prototype._getModdleContext = function getModdleContext(source) {
334
334
 
335
335
  /**
336
336
  * @param {Engine} engine
337
- * @param {any[]} definitions
337
+ * @param {import('bpmn-elements').Definition[]} definitions
338
338
  * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [options]
339
339
  * @param {boolean} [isRecovered]
340
340
  */
package/types/index.d.ts CHANGED
@@ -183,12 +183,6 @@ declare module 'bpmn-engine' {
183
183
  waitFor<R>(eventName: BpmnEngineEvent | string): Promise<R>;
184
184
  }
185
185
 
186
- export function Execution(
187
- engine: Engine,
188
- definitions: Definition[],
189
- options?: BpmnEngineExecuteOptions,
190
- isRecovered?: boolean
191
- ): Execution;
192
186
  export class Execution {
193
187
  constructor(engine: Engine, definitions: Definition[], options?: BpmnEngineExecuteOptions, isRecovered?: boolean);
194
188
  options: BpmnEngineExecuteOptions;