npmpackage.info

vue-easy-state-machine

Light state machine packaged as a vue component

0.1.0

MIT

Vue

Installations

npm install vue-easy-state-machine

Score

Supply Chain

83.1

Quality

69.9

Maintenance

Vulnerability

95.3

License

Pull Requests

Open

19

Total

25

Closed

6

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

tomgrv

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

8.14.0

NPM Version

6.4.1 Statistics

7 Commits

2 Watching

21 Branches

1 Contributors

Updated on 06 Oct 2019

Languages

Vue (79.38%)

JavaScript (20.62%)

Total Downloads

Cumulative downloads

Total Downloads

998

Last day

-87.5%

Compared to previous day

Last week

144.4%

Compared to previous week

Last month

1,500%

Compared to previous month

Last year

-1.3%

158

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

vue-easy-state-machine

Light state machine packaged as a vue component

Installation

1$ npm install vue-easy-state-machine

Overview

This packages provides a <easy-state-machine> component managing a small state machine for UI management

Usage

Declare as Vue plugin:

1import VueEasyStateMachine from "vue-easy-state-machine";
2Vue.use(VueEasyStateMachine);

In your component <script> section, declare your state table with states & associated behavior:

1export default {
2  data() {
3    return {
4      states: {
5        askEmail: {
6          entry: true,
7          success: "askPassword",
8          failure: "askEmail"
9        },
10        askPassword: {
11          success: "login",
12          failure: "askEmail"
13        },
14        login: {
15          success: this.initSession,
16          failure: "askEmail"
17        },
18
19        //...
20
21        stateXXX: {
22          success: "stateYYY",
23          failure: "stateZZZ"
24        }
25
26        //...
27      }
28    };
29  },
30  methods: {
31    initSession() {
32      //...
33    }
34  }
35};

In your component <template> section, wrap the state machine around components related to each state:

State table is provide through states prop.
Each declared state value is available through #default variable, in current array; Only the active state is set to true, all other are set to false.
easy-state-machine component exposes success() and failure() methods to trigger evolution; You can use restart() to ... restart.

1<easy-state-machine :states="states" #default="state">
2  <div v-if="state.current.askEmail">
3    <input type="email" placeholder="Email" />
4    <button type="button" @click="state.success">Next</button>
5  </div>
6  <div v-if="state.current.askPassword">
7    <input type="password" placeholder="Password" />
8    <button type="button" @click="state.success">Next</button>
9    <button type="button" @click="state.failure">Previous</button>
10  </div>
11  <div v-if="state.current.login">
12    <strong>You are logged</strong>
13    <button type="button" @click="state.success">Init Session</button>
14    <button type="button" @click="state.failure">Restart</button>
15  </div>
16</easy-state-machine>

And that's it !

State Table Advanced Configuration

Each state can handle following items:

1{
2   "entry": true,
3   "onEnter" : () => {},
4   "success": "stateXXX",
5   "failure": "stateYYY",
6   "onLeave" : () => {},
7}

`entry`

Type: Boolean
Default: false
Details: Indicates state to start with
Restrictions: Only one true entry per state table. If multiple entries, only the first one is taken.

`success`

Type: String or Function
Default: undefined
Details: Indicates state to go to in case of successful operation at current state. Can be a function returning state name.
Restrictions: Will trigger state machine error if pointing nowhere....

`failure`

Type: String or Function
Default: value of success entry
Details: Indicates state to go to in case of failed operation at current state. Can be a function returning state name.
Restrictions: Will trigger state machine error if pointing nowhere...

`onEnter`

Type: Function
Default: undefined
Details: Function to call on state arrival
Restrictions: Must be current component functions, not called if empty

`onLeave`

Type: Function
Default: undefined
Details: Function to call on state leaving
Restrictions: Must be current component functions, not called if empty

Advanced usage & Tips

Complex branching

You can manage complex branching with success and failure functions:

1{
2   "success": () => { return this.myBooleanValue ? 'stateXXX' : 'stateYYY' },
3   "failure": this.myBranchingFunction,
4}

Where myBranchingFunction is defined in methods block:

1methods: {}
2    myBranchingFunction() {
3        if ( /** my test **/ )
4            return 'stateXXX';
5        else
6            return 'stateYYY';
7    }
8}

Events

`stateChange`

When: On each state change, after onLeave and before onEnter are called
First argument: previous state name
Second argument: next state name

Transitions

You can use with <transition> for a beautiful effect:

1<easy-state-machine :states="states" #default="state">
2  <transition
3    name="transition-login"
4    enter-active-class="animated fadeIn"
5    leave-active-class="animated fadeOut"
6    mode="out-in"
7  >
8    <div v-if="state.current.askEmail" key="askEmail">
9      ...
10    </div>
11    <div v-if="state.current.askPassword" key="askPassword">
12      ...
13    </div>
14    <div v-if="state.current.login" key="login">
15      ...
16    </div>
17  </transition>
18</easy-state-machine>

Validating/Testing

Sample application provided in sample direcory for testing purpose:

1$ npm run sample

Add then open ./sample/index.html in your browser

No vulnerabilities found.

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.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

131 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w
Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf
Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-18

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

Other packages similar to vue-easy-state-machine

little-state-machine

4.8.0

State management made super simple

javascript-state-machine

3.1.0

A finite state machine library

@babel/plugin-transform-regenerator

7.25.9

Explode async and generator functions into a state machine.

fsm-iterator

1.1.0

A finite state machine iterator for JavaScript

vue-easy-state-machine

Installations

Score

Pull Requests

19

25

6

Issues

0

0

0

Releases

Unable to fetch releases

Developer

tomgrv

Developer Guide

CommonJS

No

8.14.0

6.4.1

Statistics

Languages

Total Downloads

998

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

vue-easy-state-machine

Installation

Overview

Usage

State Table Advanced Configuration

entry

success

failure

onEnter

onLeave

Advanced usage & Tips

Complex branching

Events

stateChange

Transitions

Validating/Testing

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to vue-easy-state-machine

`entry`

`success`

`failure`

`onEnter`

`onLeave`

`stateChange`