bpmn-engine 26.0.0 → 26.0.1

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 (2) hide show
  1. package/README.md +30 -0
  2. package/package.json +10 -7
package/README.md CHANGED
@@ -12,17 +12,47 @@ BPMN 2.0 execution engine. Open source javascript workflow engine.
12
12
  - [Changelog](/CHANGELOG.md)
13
13
  - [Examples](/docs/Examples.md)
14
14
  - [Upgrade version](/docs/Upgrade.md)
15
+ - [Peer dependencies](#peer-dependencies)
16
+ - [bpmn-moddle 9 vs 10](/docs/bpmn-moddle.md)
15
17
  - [Supported elements](#supported-elements)
18
+ - [Extensions](#extensions)
16
19
  - [Debug](#debug)
17
20
  - [Example process](#a-pretty-image-of-a-process)
18
21
  - [Acknowledgments](#acknowledgments)
19
22
 
23
+ # Peer dependencies
24
+
25
+ The runtime dependencies are declared as **peer dependencies**, so you install and pin them yourself and the engine reuses your single copy:
26
+
27
+ ```sh
28
+ npm install bpmn-engine bpmn-elements bpmn-moddle moddle-context-serializer debug smqp
29
+ ```
30
+
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
+
39
+ `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
+
20
41
  # Supported elements
21
42
 
22
43
  See [bpmn-elements](https://github.com/paed01/bpmn-elements) for supported elements. The engine only support elements and attributes included in the BPMN 2.0 scheme, but can be extended to understand other schemas and elements.
23
44
 
24
45
  The aim is to, at least, have BPMN 2.0 [core support](https://www.omg.org/bpmn/Samples/Elements/Core_BPMN_Elements.htm).
25
46
 
47
+ # Extensions
48
+
49
+ The engine can be extended to understand other schemas and elements. Docs, guides, and ready-made extensions for the BPMN stack are published at [0dep.se](https://0dep.se) — check there before writing a new extension from scratch.
50
+
51
+ Two ready-made extensions:
52
+
53
+ - [`@0dep/bpmn-extensions`](https://github.com/zerodep/bpmn-extensions)
54
+ - [`@onify/flow-extensions`](https://github.com/onify/flow-extensions)
55
+
26
56
  # Debug
27
57
 
28
58
  This package is shipped with [debug](https://github.com/debug-js/debug) activated with environment variable `DEBUG=bpmn-engine:*`. You can also provide your own logger.
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.0",
4
+ "version": "26.0.1",
5
5
  "type": "module",
6
6
  "module": "./src/index.js",
7
7
  "main": "./lib/index.cjs",
@@ -72,25 +72,28 @@
72
72
  "@types/bpmn-moddle": "^10.0.0",
73
73
  "@types/node": "^20.19.40",
74
74
  "bent": "^7.3.12",
75
+ "bpmn-elements": "^18.0.0",
76
+ "bpmn-moddle": "^9.0.4",
77
+ "bpmn-moddle-10": "npm:bpmn-moddle@^10.0.0",
75
78
  "c8": "^11.0.0",
76
79
  "camunda-bpmn-moddle": "^7.0.1",
77
80
  "chai": "^6.2.0",
78
81
  "chronokinesis": "^8.0.0",
82
+ "debug": "^4.4.3",
79
83
  "eslint": "^10.5.0",
80
84
  "globals": "^17.6.0",
85
+ "moddle-context-serializer": "^6.0.0",
81
86
  "mocha": "^11.0.1",
82
87
  "mocha-cakes-2": "^3.3.0",
83
88
  "prettier": "^3.2.5",
84
89
  "rollup": "^4.10.0",
85
90
  "texample": "^1.0.2"
86
91
  },
87
- "dependencies": {
88
- "bpmn-elements": "^18.0.0",
89
- "bpmn-moddle": "^9.0.4",
90
- "debug": "^4.4.3",
91
- "moddle-context-serializer": "^6.0.0"
92
- },
93
92
  "peerDependencies": {
93
+ "bpmn-elements": ">=18",
94
+ "bpmn-moddle": ">=9",
95
+ "debug": ">=4",
96
+ "moddle-context-serializer": ">=6",
94
97
  "smqp": "^13.0.1"
95
98
  }
96
99
  }