npmpackage.info

Gathering detailed insights and metrics for @bpmn-io/extract-process-variables

@bpmn-io/extract-process-variables - 1.0.1 | npmpackage.info

@bpmn-io/extract-process-variables

An util for bpmn-js to extract Camunda process variables from a BPMN 2.0 diagram.

1.0.1

MIT

JavaScript

109.67 kB

3.9

Installations

npm install @bpmn-io/extract-process-variables

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Node Version

20.11.1

NPM Version

10.9.2 Pull Requests

Open

0

Total

25

Closed

2

Merged

23

Issues

Open

2

Total

8

Closed

6

Releases

v1.0.1

Updated on Jan 02, 2025

v1.0.0

Updated on Sep 23, 2024

v0.9.0

Updated on Aug 28, 2024

View All 3 releases

Languages

JavaScript

JavaScript (100%)

Developer

bpmn-io

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1 Stars

116 Commits

2 Forks

6 Watchers

3 Branches

11 Contributors

Updated on Feb 04, 2025

Maintainers

View All 11 Contributors

Package Meta Information

Latest Version

1.0.1

Package Id

@bpmn-io/extract-process-variables@1.0.1

Unpacked Size

109.67 kB

Size

11.40 kB

File Count

NPM Version

10.9.2

Node Version

20.11.1

Published on

Jan 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

min-dash

Dev Dependencies

@rollup/plugin-commonjs @rollup/plugin-json @rollup/plugin-node-resolve bpmn-moddle camunda-bpmn-moddle chai eslint eslint-plugin-bpmn-io esm mocha npm-run-all nyc rollup zeebe-bpmn-moddle

extract-process-variables

An util for bpmn-js to extract Camunda BPM process variables from a BPMN 2.0 diagram.

Installation

1$ npm i --save @bpmn-io/extract-process-variables

Usage

Camunda Platform 7

Given this example diagram

1import {
2  getProcessVariables,
3  getVariablesForScope,
4} from '@bpmn-io/extract-process-variables';
5
6// For Camunda Platform 8 diagrams, use the /zeebe submodule
7// import {
8//   getProcessVariables,
9//   getVariablesForScope,
10// } from '@bpmn-io/extract-process-variables/zeebe';
11
12const canvas = modeler.get('canvas');
13
14const rootElement = canvas.getRootElement();
15
16const allVariables = getProcessVariables(rootElement.businessObject);
17/*
18  [
19    {
20      "name": "variable1",
21      "origin": [ "Task_1" ],
22      "scope": "Process_1"
23    },
24    {
25      "name": "variable2",
26      "origin": [ "Task_1" ],
27      "scope": "Process_1"
28    },
29    {
30      "name": "variable3",
31      "origin": [ "Task_2" ],
32      "scope": "SubProcess_1"
33    }
34  ]
35*/
36
37const scopeVariables = getVariablesForScope('Process_1', rootElement.businessObject);
38/*
39  [
40    {
41      "name": "variable1",
42      "origin": [ "Task_1" ],
43      "scope": "Process_1"
44    },
45    {
46      "name": "variable2",
47      "origin": [ "Task_1" ],
48      "scope": "Process_1"
49    }
50  ]
51*/

Note that origin and scope retrieves the full moddle element. The example outputs are reduced due to better readibility.

Note that camunda-bpmn-moddle or zeebe-bpmn-moddle descriptors have to be installed.

Properties support

Camunda Platform 7

We are currently extracting process variables from the following diagram properties

camunda:formField
camunda:outputParameter
camunda:out
camunda:resultVariable
camunda:errorCodeVariable
camunda:errorMessageVariable
camunda:escalationCodeVariable

Camunda Platform 8

We are currently extracting process variables from the following diagram properties

zeebe:input
zeebe:output
zeebe:loopCharacteristics > inputElement
zeebe:loopCharacteristics > outputCollection
zeebe:calledDecision > resultVariable
zeebe:script > resultVariable

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@bpmn-io/extract-process-variables

Installations

Developer Guide

No

CommonJS, ESM

20.11.1

10.9.2

Pull Requests

0

25

2

23

Issues

2

8

6

Releases

Languages

Developer

bpmn-io

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

extract-process-variables

Installation

Usage

Camunda Platform 7

Properties support

Camunda Platform 7

Camunda Platform 8

See also

License

10

10

10

10

4

4

2

0

0

0

0

0

0

3.9

/10