@bpmn-io/extract-process-variables - npm Package Compare versions

Comparing version 0.4.5 to 0.5.0

CHANGELOG.md

@@ -9,2 +9,6 @@ # Changelog
 
+## 0.5.0
+
+* `FEAT`: add support for Camunda Platform 8 diagrams ([#20](https://github.com/bpmn-io/extract-process-variables/pull/20))
+
 ## 0.4.5
@@ -11,0 +15,0 @@

package.json

 {
   "name": "@bpmn-io/extract-process-variables",
-  "version": "0.4.5",
+  "version": "0.5.0",
   "description": "A util for bpmn-js to extract Camunda BPM process variables from a BPMN 2.0 diagram.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./zeebe": "./dist/zeebe/index.js"
+  },
   "source": "src/index.js",
@@ -13,4 +17,4 @@ "scripts": {
     "prepublishOnly": "run-s distro",
-    "dev": "mocha -r esm --reporter=spec --recursive --watch test/spec",
-    "test": "nyc --reporter=lcov mocha -r esm --reporter=spec --recursive test/spec",
+    "dev": "mocha -r esm --reporter=spec --recursive --watch test/**/*Spec.js",
+    "test": "nyc --reporter=lcov mocha -r esm --reporter=spec --recursive test/**/*Spec.js",
     "test:build": "mocha --reporter=spec --recursive test/distro",
@@ -42,3 +46,4 @@ "all": "run-s lint test distro"
     "nyc": "^15.1.0",
-    "rollup": "^2.23.0"
+    "rollup": "^2.23.0",
+    "zeebe-bpmn-moddle": "0.12.1"
   },
@@ -45,0 +50,0 @@ "dependencies": {

README.md

@@ -7,3 +7,3 @@ # extract-process-variables
 
-## Installation 
+## Installation
 
@@ -16,2 +16,3 @@ ```sh
 
+### Camunda Platform 7
 Given [this example diagram](./test/fixtures/sub-process-own-scope.bpmn)
@@ -25,2 +26,8 @@
 
+// For Camunda Platform 8 diagrams, use the /zeebe submodule
+// import {
+//   getProcessVariables,
+//   getVariablesForScope,
+// } from '@bpmn-io/extract-process-variables/zeebe';
+
 const canvas = modeler.get('canvas');
@@ -31,3 +38,3 @@
 const allVariables = getProcessVariables(rootElement.businessObject);
-/* 
+/*
   [
@@ -53,3 +60,3 @@ {
 const scopeVariables = getVariablesForScope('Process_1', rootElement.businessObject);
-/* 
+/*
   [
@@ -72,7 +79,8 @@ {
 
-Note that [camunda-bpmn-moddle](https://github.com/camunda/camunda-bpmn-moddle) descriptors have to be installed.
+Note that [camunda-bpmn-moddle](https://github.com/camunda/camunda-bpmn-moddle) or [zeebe-bpmn-moddle](https://github.com/camunda-cloud/zeebe-bpmn-moddle) descriptors have to be installed.
 
 ## Properties support
 
-We are currently [extracting process variables](https://github.com/bpmn-io/extract-process-variables/tree/main/src/extractors) from the following diagram properties
+### Camunda Platform 7
+We are currently [extracting process variables](https://github.com/bpmn-io/extract-process-variables/tree/main/src/camunda-platform/extractors) from the following diagram properties
 * `camunda:formField`
@@ -86,2 +94,10 @@ * `camunda:outputParameter`
 
+### Camunda Platform 8
+We are currently [extracting process variables](https://github.com/bpmn-io/extract-process-variables/tree/main/src/zeebe/extractors) from the following diagram properties
+* `zeebe:input`
+* `zeebe:output`
+* `zeebe:loopCharacteristics > inputElement`
+* `zeebe:loopCharacteristics > outputCollection`
+* `zeebe:calledDecision > resultVariable`
+
 ## See also
@@ -91,2 +107,4 @@
 * [Camunda BPM Process Variables Documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/)
+* [zeebe-bpmn-moddle](https://github.com/camunda-cloud/zeebe-bpmn-moddle)
+* [Camunda Platform 8 Variables Documentation](https://docs.camunda.io/docs/components/concepts/variables)
 
@@ -93,0 +111,0 @@ ## License

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

75168

increased by81.29%

Number of package files

9

increased by28.57%

Lines of code

2221

increased by94.65%

Number of lines in readme file

106

increased by20.45%

Worsened metrics

Dev dependency count

14

increased by7.69%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes