https://github.com/opuscapita/fsm-workflow

FSM workflow (for Node.js)
https://github.com/opuscapita/fsm-workflow

finite-state-machine fsm javascript js state-machine statemachine workflow

Last synced: 4 months ago
JSON representation

FSM workflow (for Node.js)

• Host: GitHub
• URL: https://github.com/opuscapita/fsm-workflow
• Owner: OpusCapita
• License: apache-2.0
• Created: 2017-05-25T07:05:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-10-25T09:51:16.000Z (over 2 years ago)
• Last Synced: 2024-10-01T20:33:14.748Z (5 months ago)
• Topics: finite-state-machine, fsm, javascript, js, state-machine, statemachine, workflow
• Language: JavaScript
• Homepage: https://demo.core.dev.opuscapita.com/fsm-workflow/master
• Size: 49.1 MB
• Stars: 28
• Watchers: 18
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## FSM Workflow (for Node.js)

[![CircleCI Status](https://circleci.com/gh/OpusCapita/fsm-workflow/tree/master.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/OpusCapita/fsm-workflow)

![badge-license](https://img.shields.io/github/license/OpusCapita/fsm-workflow.svg)

### Demo

- [Complete demo app](https://demo.core.dev.opuscapita.com/fsm-workflow/master)

- [Worflow editor demo (showroom)](https://opuscapita.github.io/fsm-workflow/branches/master/editor/?currentComponentName=WorkflowEditor&maxContainerWidth=100%25)

### Introduction

[Finite State Machine](https://en.wikipedia.org/wiki/Finite-state_machine) workflow is implemented in JS using [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)-s.

- state is stored in the business object related to workflow(machine), not in an extra

workflow generic object. Multiple workflows could be defined for one business object,

it means that for each workflow own state field should be used

- one state per workflow execution (no parallelism)

- actions are executed in the transition, not in the node/state

- no event sending inside the workflow itself (in action)

- no variables in state workflow: all variables/data need to be stored in

the business objects

- events: visible/available in UI as action buttons for the user

- workflow definition stored as JSON

- guard support (transition/event availability is defined via

condition/expression/function = guard)

- hierarchical states are not supported

#### Notes

The following things will be implemented later as extensions/helpers (separate sibling library) or in specific application:

- automatic transitions

- task list is based on domain object

- graphical editor

- logging

- analysis

**P.S.** basic ideas on how FSM API looks like are taken from [fsm-as-promised](https://github.com/vstirbu/fsm-as-promised)

### FSM (Core)

FSM core could be found here [here](packages/core/README.md)

### Task/Work Management

Task management is implemented as additional library. You can find more detailed info [here](packages/task-manager/README.md).

### Workflow Transition History

Workflow Transition History is implemented as separate library. You can find more information [here](packages/history/README.md).

### FAQ for developers

**How do I set a version for all packages?**

Define it as `version` value in `lerna.json` file. There's no need to rewrite version in packages, release process will handle it itself.

### References

[Existing FSM libs review](existingFsmLibsReview.md)

### Contributors

| [](https://github.com/kvolkovich-sc) | [**Alexey Sergeev**](https://github.com/asergeev-sc)     |

| :---: | :---: |

| [](https://github.com/kvolkovich-sc) | [**Kirill Volkovich**](https://github.com/kvolkovich-sc) |

| [](https://github.com/dzhitomirsky-sc) | [**Daniel Zhitomirsky**](https://github.com/dzhitomirsky-sc) |

| [](https://github.com/estambakio-sc) | [**Egor Stambakio**](https://github.com/estambakio-sc) |

Contributing are welcome. We need YOU! :metal: