Changelog

All notable changes to the bpmn-js-token-simulation are documented here. We use semantic versioning for releases.

Unreleased

Note: Yet to be released changes appear here.

0.36.0

FEAT: support bpmn-js@18 (#196)
FIX: clear animation when destroying diagram (#196)
FIX: do not complete animation when clearing it (#196)

0.35.1

FIX: allow errors to propagate upwards (#187)

0.35.0

FEAT: support catch-all error and escalation events (#184)

0.34.5

FIX: make parallel join BPMN spec compliant (#130)
DEPS: use [email protected]

0.34.4

DEPS: do not mark diagram-js as explicit dependency

0.34.3

FIX: explicitly hide context pad when token simulation is enabled (#185)

0.34.2

FIX: add aria-label to log close button (#177)

0.34.1

FIX: gracefully handle missing event definitions (#171)

0.34.0

FEAT: make log icons more precise (#167)

0.33.2

FIX: use inset box shadow instead of border to add border (#164)

0.33.1

FIX: hide all other overlays when token simulation active (#160, #162)

0.33.0

FEAT: support implicit start events (#144)
CHORE: add module exports

0.32.0

FEAT: support inclusive gateways (#110, #88)
CHORE: require node >= 16

0.31.1

FIX: support exclusive gateway without outgoings (#134)

0.31.0

FEAT: trigger none, condition, and timer boundary events independently (#129)
DEPS: fix audit warnings

0.30.2

FIX: reset colors before export (#124)
FIX: do not set colors on elements that do not support them 588415c

0.30.1

FIX: don't trigger simulation editorActions when simulation is disabled (#127)

0.30.0

FEAT: make simulation log auto-scrolling adaptive
FEAT: make simulation log button toggle the log
FEAT: remove simulation log date
FEAT: truncate external text to reasonable width
FEAT: reposition simulation log to the right
FEAT: add simulation log header
CHORE: remove button hover animation

0.29.0

FEAT: align receive and send task behavior more closely with the BPMN spec (#120)
FIX: explicitly depend on inherits-browser utility (10b1d6e5)

0.28.0

DEPS: support bpmn-js@10
DEPS: bump utility dependencies

0.27.0

DEPS: support bpmn-js@9

0.26.0

FEAT: add simulation support to programatically control the token simulation (#112)

0.25.1

FIX: correctly triggering of multiple signal start events (#109)

0.25.0

FEAT: rewrite simulator using event scopes and subscriptions (#101)
FEAT: support event rethrow and "absorption" (#100)
FEAT: trigger all startable elements inside bpmn:SubProcess (#107, acdae242)
FEAT: support transactions and cancel events (#76, #102, 5026298b)
FEAT: support compensation (#76, #102, bcdad034)
FEAT: eagerly interrupt when entering event sub-process (452ce5ec)
FEAT: add Simulator APIs for (BPMN) event triggering and subscriptions (5da21ed8)
FEAT: add Simulator#waitForScopes API (e23e57f0)
FIX: don't allow pause on event sub-process (af04910b)
FIX: correct pause handling on receive tasks (#99)
FIX: ensure technically equal events can still be signaled individually (#103, #107 15d14062)
CHORE: implement termination as a behavior (e92e8ff8)
CHORE: remove destroyed scopes (b3662dc8)
CHORE: namespace CSS (#30)
CHORE: add properties panel to example (104)
DEPS: update to [email protected]

Breaking Changes

Generated markup and used CSS classes changed; things are consistently prefixed with bts now to avoid foreign classes crashing (#30)
Drop destroyContext in favor of dedicated scope state (failed/ended) (#101)
Reworked way the outside interacts with the simulator: Rather than signaling the simulator with knowledge of internal working mechanisms you trigger an event on a particular scope, notifying all registered subscribers. (#101)
Destroyed scopes are now longer kept around by simulator (b3662dc8)

0.24.0

FEAT: return Simulator#signal scope
FEAT: return Simulator#enter scope
FEAT: support token sinks other than end events (#94)
FEAT: support error throw events (017aa885)
FIX: read and restore colors in bpmn-js >= 8.7 compatible manner (#90)
FIX: correct context-pads interaction with scope filters (6dc14819)
FIX: make pause context-pad handler scope filter aware (7253969f)
CHORE: various example improvements

0.23.0

FEAT: add pause at node feature (f6c6b06b, #91)
FEAT: update context-pads rather than add and remove (84d288e7)
FEAT: tick on out of bounds elementChanged (53230707)
FEAT: update and inline icons (dc6eb1195)
FEAT: allow configuration of ActivityBehavior wait semantics (dcf1e855)
FIX: reduce visual noise caused by context-pad updates
FIX: mark parent as changed on {create,destroy}Scope (410659bc)

0.22.0

FEAT: allow simulation of bi-directional message flows (#77)
FEAT: execute message flows in interaction order
FEAT: signal message receive with initiator
FIX: prevent undirected message receive from signaling participant
CHORE: detect message flow by element, not initiator

0.21.2

FIX: make parallel gateway join properly (#89)
CHORE: make log optional in editor actions

0.21.1

FIX: revert main to module entry point rename

0.21.0

CHORE: complete migration to ES modules
CHORE: mark package as side-effect free

Breaking Changes

We do now export a module rather than a main file.

0.20.0

FEAT: rework animation (#82)
FEAT: display parent scope in log and trace notifications (de08d9c7)
FIX: only signal event sub-processes if parent is running (5aa7b019)
FIX: do not reset token position on animation speed change
FIX: escape element names displayed in log (3d4ed8f0)
DEPS: remove SVG.js dependency
DEPS: update to [email protected]

0.19.3

FIX: do not override global styles

0.19.2

FIX: emit element changed events on simulation reset

0.19.1

FIX: ignore destroyed scopes in Scope#getTokensByElement

0.19.0

FEAT: support escalation
FEAT: signal event-based gateway on signal

0.18.0

FEAT: support signals
FEAT: handle scope interruption according to BPMN 2.0 spec
FEAT: signal event-based gateway on incoming messages
FEAT: scope all activities

Breaking Changes

In order to start a process you must now signal the process element, not the start event contained in it.

0.17.0

FEAT: improve scope filter behavior on scope creation and destruction
FIX: correct trigger activity context pad activation

0.16.0

FEAT: hide context pads if no action available in selected scope
CHORE: migrate most components to ES6

0.15.1

FIX: prevent signal of activities with active child scopes

0.15.0

FEAT: allow to signal all waiting activities
FEAT: various example improvements

0.14.0

FEAT: add support for event sub-process (#71)
FEAT: add support for event-based gateway (#72)
FEAT: support boundary events on tasks
FEAT: rework context pads open/close handling
FEAT: batch simulator element changed events
FIX: correct scope filter integration with context pads

0.13.0

FEAT: allow to toggle explicit mode
FEAT: handle diagram import during simulation
FIX: do not re-add toggle mode UI on diagram re-import

Breaking Changes

tokenSimulation.toggleMode event active flag renamed from simulationModeActive to active

0.12.0

A complete rewrite of the simulator, vastly improving stability.

FEAT: extract simulator into standalone component (#65, #66)
FEAT: show scope in notification and log panel
FEAT: color tokens and element notifications according to scope
FEAT: make notification and log panel aware of active scope filter
FEAT: support multiple parallel scopes
FEAT: support message flows
FEAT: require external trigger on all activities with incoming message flows
FEAT: support link events
FEAT: increase fastest animation speed
FEAT: improve animation speed on longer connections
FIX: correct end event behaving like terminate end event (#59)
FIX: correct gateway toggle inside sub-process (#61)
FIX: better scope highlight color for canvas (fdbf665f)
CHORE: migrate to GitHub actions
CHORE: upgrade the code base to ES6

Breaking Changes

A modern browser supporting ES6 or additional transpilation is now required to use this library
Reworked data-handling and most internal components. If you are looking to drive the simulation via API or query the simulation state refer to the simulator.

0.11.1

FIX: correct setting animation speed

0.11.0

FEAT: ignore bpmn:Group elements (#58)
FEAT: ignore bpmn:MessageFlow elements during simulation (#52)
FEAT: support bpmn:SentTask and bpmn:ReceiveTask (#57)
FEAT: make token move duration a constant time (0156fb8e)
FEAT: color sequence flow labels along with sequence flows (a310ac66)
FIX: consistently ease in and ease out token animations (76562b6d)
FIX: make intermediate throw events work, again (#53)
FIX: do not interfer with base bpmn-js styles
FIX: hide context pads for completed sub-process scopes (26d68763)
FIX: correct process instance state finished detection (#28)
CHORE: improve button and overlay colors

0.10.0

CHORE: update colors
CHORE: update to bpmn-js@7

0.9.1

FIX: fix simulation state (#51)

0.9.0

FEAT: add support for call activity (#49)

0.8.1

FIX: don't override default modeler keybindings (#41)
FIX: bind keyboard listeners on keyboard.init (not diagram import)

0.8.0

CHORE: update to bpmn-js@3 (#34)
CHORE: drop lodash dependency for smaller bundle sizes
CHORE: ignore dev assets in packaged bundle
CHORE: add linting and test coverage

Breaking Changes

This drops support for bpmn-js<3.

...

Check git log for earlier history.