Skip to content

0.28.0
Compare
Choose a tag to compare
@tbouffard tbouffard released this 02 Nov 13:47
· 821 commits to refs/heads/master since this release
v0.28.0
1a71060

This new version brings improvements to the library integration, specially with TypeScript.

Thanks to all the contributors of this release 🌈: @tbouffard

See milestone 0.28.0 to get the list of issues covered by this release.

Highlights

TypeScript requirement decreases from 4.5 to 4.0

bpmn-visualization can now be integrated into applications using TypeScript 4.0 or higher.

This was a long process that started when we received feedback from a user who could not integrate the library into an Angular 11 application. Angular 11 doesn't support TypeScript 4.5, which was the version required by bpmn-visualization at that time. See #2221 for more details.

Historically, we didn't clarify the required TypeScript version when integrating bpmn-visualization.

We began to improve this by providing guidance in the README in version 0.26.2, and then by generating explicit errors and declaring the requirements in the npm package in version 0.27.0. But at a minimum, TypeScript 4.5 was still required. In version 0.28.0, we were able to reduce this requirement to version 4.0.

Typescript 4.0 was released over 2 years ago, on August 20th, 2020. So, we expect that all projects will now be able to integrate bpmn-visualization.

In addition to this change, we now provide a single file containing the types in the npm package.

This cleans up some internal bpmn-visualization types that were previously exported by mistake, while their corresponding implementation is not exported in the JavaScript files. This could have led to runtime errors if such types were used.

See #2231 for more details and #2249 for an example of additional types that were previously exported.

New demos available

Process Mining scenario

This demo was created to demonstrate the capabilities of bpmn-visualization at the Process Mining Conference 2022.

If you want to test it yourself, try the ⏩ live ICPM 2022 demo.

online_monitoring.mp4

Online Monitoring scenario

This demo was added to version 0.27.1 as part of the release of the getting started tutorial.

It shows a concrete process analytics scenario that is online monitoring. In online monitoring, an administrator monitors the process execution at runtime. It displays two important pieces of information:

  • The running instances and their number ⚙️.
  • The status of the running instances: whether or not they violate the predefined Key Performance Indicators (KPI) ⏱️.

This demo complements the "monitoring" demo that has been around for a while.

Check out the ⏩ live getting started tutorial demo.

getting_started

Breaking changes: npm package content change

We removed all CommonJS (minified and unminified) bundles and the minified ESM bundle from the npm package.

For more information about the reasons of this change, see #2313.

Please use the ESM bundle instead. This change should be transparent for applications integrating bpmn-visualization. Our tests with different bundlers, tools and frameworks (Vite, Parcel, Webpack, Rollup, Angular, ...) showed no issues.

The size of the package decreased thanks to these removals.

bpmn-visualization - Package Phobia
bpmn-visualization - Package Phobia

What's Changed

Full Changelog: v0.27.1...v0.28.0

⤵️ Library Integration

  • [FEAT] Downlevel the minimum supported TS version from 4.5 to 4.0 (#2326) @tbouffard
  • [REFACTOR] Include a single file for types in the npm package (#2325) @tbouffard
  • [INFRA] Remove CommonJS and minified ESM bundles from the npm package (#2313) @tbouffard

📝 Documentation

🎮 Demo and Examples

Contributors

tbouffard
Assets 2
Loading