zeebe-node - npm Package Versions

Version 8.1.5

New Features

New shiny stuff.

• The ZBClient now implements the modifyProcessInstance API, introduced in Zeebe 8.1. This allows you to modify a running process instance, moving execution tokens and changing variables. This can be used, for example, to migrate a running process instance to a new version of the process model. See #294 for more details.
• The ZBClient createProcessInstance method now allows you to specify startInstructions (introduced in Zeebe 8.1), allowing you to start a new process instance from an arbitrary point. Along with modifyProcessInstance, this is a powerful primitive for building migration functionality. See [#295] for more details.

Version 8.1.4

Fixes

Things that were broken and are now fixed.

• The @grpc dependencies are now pinned to a specific version - 1.8.7 for grpc-js and 0.7.4 for proto-loader. This is to avoid broken upstream dependencies impacting installs. Previously, with the dependency unpinned, an install on different days could result in a library that worked, or did not work, depending on the state of the upstream libraries. Now, the same dependencies are installed every time, resulting in a consistent experience. Thanks to @nikku and @barmac from the Camunda Modeler team for identifying this. See #290 for more context.
• The docker subdirectory is back, with a docker-compose.yml file to start a local broker for testing purposes. See #289 for more details.

New Features

New shiny stuff.

• A custom SSL certificate is now able to be used for the oAuth endpoint. The got library used for the token exchange needs the certificate explicitly, and it can now be passed in as a customRootCert property to the oAuth property in the ZBClient constructor. Thanks to luca-waldmann-cimt for the feature. See #284 for more details.

Version 8.1.2

Fixes

Things that were broken and are now fixed.

• In 8.1.1, the update to the version of got introduced a regression that broke the OAuth token request with certain gateway configurations. This is now reverted, and a test has been introduced to ensure this regression does not happen again. See #280 for more details.

New Features

New shiny stuff.

• Applications can now extend the user agent identifier by setting a value for the environment variable ZEEBE_CLIENT_CUSTOM_AGENT_STRING. This will be appended to the standard user agent string. See #279 for more details.

Version 8.1.1

Chores

Things that shouldn't have a visible impact.

• Bump got to 11.8.5 to fix CVE-2022-33987. Thanks to @nithinssabu for the PR. See #275 for more detail.

Version 8.1

Breaking changes

Changes in APIs or behaviour that may affect existing applications that use zeebe-node.

• Remove all deprecated APIs. All methods and interfaces that were marked as deprecated in the 1.3.0 release have been removed. All support for application code using the pre-1.0 Zeebe API is now gone. You will need to update your application code to refactor the deprecated methods and interfaces, or stay on version 8.0.3 of the package.

Fixes

Things that were broken and are now fixed.

• Previously, the connectionTolerance option to createWorker did not take a MaybeTimeDuration, requiring users to provide a number (the value units is milliseconds). The signature has now been fixed, and connectionTolerance can now take a number or a typed Duration. See #260 for more detail. Thanks to @dancrumb for reporting this.
• Previously, the autogenerated code for a BPMN model used the deprecated worker constructor and did not return the job acknowledgement token. It now uses the object constructor and correctly returns the job acknowledgement token. See #257 for more details. Thanks to @megankirkbride for reporting this issue.
• Previously, the OAuth token request sent by the library used JSON encoding. This worked with Camunda SaaS, but would fail with Keycloak in self-managed. The library now correctly encodes the request as x-www-form-urlencoded. See #272 for more details. Thanks to @AdrianErnstLGLN for reporting this issue and providing a patch.

Version 8.0.3

Fixes

Things that were broken and are now fixed.

• Previously, the fetchVariable option passed to createWorker had no effect. All variables were always fetched by workers. This option setting is now respected, allowing you to constrain the variables fetched by workers. See #264 for details. Thanks to @Veckatimest for reporting this.

Version 8.0.0

Version 8.0.0 is the release to support Camunda Platform 8. The semver change does not denote a breaking API change. It's a product marketing alignment, rather than a technical semver change.

New Features

New shiny stuff.

• Zeebe 8.0.0 and later support an optional retry backoff for failed jobs. This is a communication to the broker about how long it should delay before making the job available for activation again. This is implemented as a new interface for job.fail. See [#248] for more details.

Version 2.4.0

Breaking changes

Changes in APIs or behaviour that may affect existing applications that use zeebe-node.

• The C-based gRPC implementation has been removed in this release. It is unmaintained, and does not build with Node 17. The Zeebe Node client now uses the pure JS gRPC implementation and requires Node version 12.22.5+, 14.17.5+, or 16.6.1+. See #201 and #247 for more details.

Known Issues

Things that don't work or don't work as expected, and which will be addressed in a future release

• The onConnectionError and onReady events do not work as expected. Applications that rely on these should not upgrade until this is fixed. See #215.