@alwatr/fsm 4.0.0 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.d.ts.map +1 -1
- package/dist/main.cjs +14 -12
- package/dist/main.cjs.map +3 -3
- package/dist/main.mjs +14 -12
- package/dist/main.mjs.map +3 -3
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [4.0.1](https://github.com/Alwatr/flux/compare/v4.0.0...v4.0.1) (2024-11-06)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* **fsm:** resetToInitialState logic and enhance logging in state transitions ([1e81527](https://github.com/Alwatr/flux/commit/1e81527501fe68e5194f9df059ebf41d1623558e)) by @
|
|
11
|
+
|
|
6
12
|
## [4.0.0](https://github.com/Alwatr/flux/compare/v3.2.2...v4.0.0) (2024-11-06)
|
|
7
13
|
|
|
8
14
|
### ⚠ BREAKING CHANGES
|
package/dist/base.d.ts
CHANGED
|
@@ -22,10 +22,11 @@ export declare abstract class AlwatrFluxStateMachineBase<S extends string, E ext
|
|
|
22
22
|
state: S;
|
|
23
23
|
};
|
|
24
24
|
constructor(config: AlwatrFluxStateMachineConfig<S>);
|
|
25
|
+
private firstResetToInitialState__;
|
|
25
26
|
/**
|
|
26
27
|
* Reset machine to initial state without notify.
|
|
27
28
|
*/
|
|
28
|
-
protected resetToInitialState_(): void
|
|
29
|
+
protected resetToInitialState_(): Promise<void>;
|
|
29
30
|
/**
|
|
30
31
|
* Transition condition.
|
|
31
32
|
*/
|
package/dist/base.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAE,KAAK,sBAAsB,EAAC,MAAM,oBAAoB,CAAC;AAEjF,OAAO,KAAK,EAAa,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAIvF,MAAM,WAAW,4BAA4B,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,sBAAsB;IAC5F,YAAY,EAAE,CAAC,CAAC;CACjB;AAED;;GAEG;AACH,8BAAsB,0BAA0B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAE,SAAQ,gBAAgB,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAC,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAM;IAE/C;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAM;IAEjD,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IAE3B,UAAmB,QAAQ,EAAE;QAAC,KAAK,EAAE,CAAC,CAAA;KAAC,CAAC;gBAE5B,MAAM,EAAE,4BAA4B,CAAC,CAAC,CAAC;IASnD;;OAEG;IACH,SAAS,CAAC,oBAAoB,IAAI,IAAI;
|
|
1
|
+
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAE,KAAK,sBAAsB,EAAC,MAAM,oBAAoB,CAAC;AAEjF,OAAO,KAAK,EAAa,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAIvF,MAAM,WAAW,4BAA4B,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,sBAAsB;IAC5F,YAAY,EAAE,CAAC,CAAC;CACjB;AAED;;GAEG;AACH,8BAAsB,0BAA0B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAE,SAAQ,gBAAgB,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAC,CAAC;IACvH;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAM;IAE/C;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAM;IAEjD,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IAE3B,UAAmB,QAAQ,EAAE;QAAC,KAAK,EAAE,CAAC,CAAA;KAAC,CAAC;gBAE5B,MAAM,EAAE,4BAA4B,CAAC,CAAC,CAAC;IASnD,OAAO,CAAC,0BAA0B,CAAQ;IAC1C;;OAEG;IACH,SAAS,CAAC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAe/C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC;IAKxF;;OAEG;cACa,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBpD;;OAEG;YACW,gBAAgB;IAe9B;;OAEG;IACH,OAAO,CAAC,YAAY;CAOrB"}
|
package/dist/main.cjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @alwatr/fsm v4.0.
|
|
1
|
+
/* @alwatr/fsm v4.0.1 */
|
|
2
2
|
"use strict";
|
|
3
3
|
var __defProp = Object.defineProperty;
|
|
4
4
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
@@ -29,7 +29,7 @@ module.exports = __toCommonJS(main_exports);
|
|
|
29
29
|
// src/base.ts
|
|
30
30
|
var import_nanolib = require("@alwatr/nanolib");
|
|
31
31
|
var import_observable = require("@alwatr/observable");
|
|
32
|
-
__dev_mode__: import_nanolib.packageTracer.add("@alwatr/fsm", "4.0.
|
|
32
|
+
__dev_mode__: import_nanolib.packageTracer.add("@alwatr/fsm", "4.0.1");
|
|
33
33
|
var AlwatrFluxStateMachineBase = class extends import_observable.AlwatrObservable {
|
|
34
34
|
constructor(config) {
|
|
35
35
|
config.loggerPrefix ?? (config.loggerPrefix = "flux-state-machine");
|
|
@@ -42,22 +42,26 @@ var AlwatrFluxStateMachineBase = class extends import_observable.AlwatrObservabl
|
|
|
42
42
|
* Bind actions name to class methods
|
|
43
43
|
*/
|
|
44
44
|
this.actionRecord_ = {};
|
|
45
|
+
this.firstResetToInitialState__ = true;
|
|
45
46
|
this.initialState_ = config.initialState;
|
|
46
47
|
this.message_ = { state: this.initialState_ };
|
|
47
|
-
this.resetToInitialState_();
|
|
48
|
+
setTimeout(this.resetToInitialState_.bind(this), 0);
|
|
48
49
|
}
|
|
49
50
|
/**
|
|
50
51
|
* Reset machine to initial state without notify.
|
|
51
52
|
*/
|
|
52
53
|
resetToInitialState_() {
|
|
53
54
|
this.logger_.logMethod?.("resetToInitialState_");
|
|
55
|
+
if (this.firstResetToInitialState__) {
|
|
56
|
+
this.firstResetToInitialState__ = false;
|
|
57
|
+
const eventDetail2 = { from: this.initialState_, event: "reset", to: this.initialState_ };
|
|
58
|
+
this.execAction__(`on_state_${this.initialState_}_enter`, eventDetail2);
|
|
59
|
+
return this.postTransition__(eventDetail2);
|
|
60
|
+
}
|
|
54
61
|
const from = this.message_.state;
|
|
55
62
|
this.message_ = { state: this.initialState_ };
|
|
56
|
-
this.
|
|
57
|
-
|
|
58
|
-
event: "reset",
|
|
59
|
-
to: this.initialState_
|
|
60
|
-
});
|
|
63
|
+
const eventDetail = { from, event: "reset", to: this.initialState_ };
|
|
64
|
+
return this.postTransition__(eventDetail);
|
|
61
65
|
}
|
|
62
66
|
/**
|
|
63
67
|
* Transition condition.
|
|
@@ -81,15 +85,13 @@ var AlwatrFluxStateMachineBase = class extends import_observable.AlwatrObservabl
|
|
|
81
85
|
return;
|
|
82
86
|
}
|
|
83
87
|
const eventDetail = { from: fromState, event, to: toState };
|
|
84
|
-
if (await this.shouldTransition_(eventDetail) !== true) return;
|
|
85
|
-
this.notify_({ state: toState });
|
|
86
88
|
this.postTransition__(eventDetail);
|
|
87
89
|
}
|
|
88
90
|
/**
|
|
89
91
|
* Execute all actions for current state.
|
|
90
92
|
*/
|
|
91
93
|
async postTransition__(eventDetail) {
|
|
92
|
-
this.logger_.logMethodArgs?.("
|
|
94
|
+
this.logger_.logMethodArgs?.("postTransition__", eventDetail);
|
|
93
95
|
await this.execAction__(`on_event_${eventDetail.event}`, eventDetail);
|
|
94
96
|
if (eventDetail.from !== eventDetail.to) {
|
|
95
97
|
await this.execAction__(`on_any_state_exit`, eventDetail);
|
|
@@ -105,7 +107,7 @@ var AlwatrFluxStateMachineBase = class extends import_observable.AlwatrObservabl
|
|
|
105
107
|
execAction__(name, eventDetail) {
|
|
106
108
|
const actionFn = this.actionRecord_[name];
|
|
107
109
|
if (typeof actionFn === "function") {
|
|
108
|
-
this.logger_.logMethodArgs?.("
|
|
110
|
+
this.logger_.logMethodArgs?.("execAction__", name);
|
|
109
111
|
return actionFn.call(this, eventDetail);
|
|
110
112
|
}
|
|
111
113
|
}
|
package/dist/main.cjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/main.ts", "../src/base.ts", "../src/fsm.ts"],
|
|
4
|
-
"sourcesContent": ["export * from './base.js';\nexport * from './fsm.js';\nexport * from './type.js';\n", "import {packageTracer} from '@alwatr/nanolib';\nimport {AlwatrObservable, type AlwatrObservableConfig} from '@alwatr/observable';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport interface AlwatrFluxStateMachineConfig<S extends string> extends AlwatrObservableConfig {\n initialState: S;\n}\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachineBase<S extends string, E extends string> extends AlwatrObservable<{state: S}> {\n /**\n * States and transitions config.\n */\n protected stateRecord_: StateRecord<S, E> = {};\n\n /**\n * Bind actions name to class methods\n */\n protected actionRecord_: ActionRecord<S, E> = {};\n\n protected initialState_: S;\n\n protected override message_: {state: S};\n\n constructor(config: AlwatrFluxStateMachineConfig<S>) {\n config.loggerPrefix ??= 'flux-state-machine';\n super(config);\n\n this.initialState_ = config.initialState;\n this.message_ = {state: this.initialState_};\n this.resetToInitialState_();\n }\n\n /**\n * Reset machine to initial state without notify.\n */\n protected resetToInitialState_(): void {\n this.logger_.logMethod?.('resetToInitialState_');\n const from = this.message_.state;\n this.message_ = {state: this.initialState_};\n
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,qBAA4B;AAC5B,wBAA4D;AAI5D,aAAc,8BAAc,IAAI,eAAkB,OAAmB;AAS9D,IAAe,6BAAf,cAAsF,mCAA6B;AAAA,EAexH,YAAY,QAAyC;AACnD,WAAO,iBAAP,OAAO,eAAiB;AACxB,UAAM,MAAM;AAbd;AAAA;AAAA;AAAA,SAAU,eAAkC,CAAC;AAK7C;AAAA;AAAA;AAAA,SAAU,gBAAoC,CAAC;
|
|
6
|
-
"names": []
|
|
4
|
+
"sourcesContent": ["export * from './base.js';\nexport * from './fsm.js';\nexport * from './type.js';\n", "import {packageTracer} from '@alwatr/nanolib';\nimport {AlwatrObservable, type AlwatrObservableConfig} from '@alwatr/observable';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport interface AlwatrFluxStateMachineConfig<S extends string> extends AlwatrObservableConfig {\n initialState: S;\n}\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachineBase<S extends string, E extends string> extends AlwatrObservable<{state: S}> {\n /**\n * States and transitions config.\n */\n protected stateRecord_: StateRecord<S, E> = {};\n\n /**\n * Bind actions name to class methods\n */\n protected actionRecord_: ActionRecord<S, E> = {};\n\n protected initialState_: S;\n\n protected override message_: {state: S};\n\n constructor(config: AlwatrFluxStateMachineConfig<S>) {\n config.loggerPrefix ??= 'flux-state-machine';\n super(config);\n\n this.initialState_ = config.initialState;\n this.message_ = {state: this.initialState_};\n setTimeout(this.resetToInitialState_.bind(this), 0);\n }\n\n private firstResetToInitialState__ = true;\n /**\n * Reset machine to initial state without notify.\n */\n protected resetToInitialState_(): Promise<void> {\n this.logger_.logMethod?.('resetToInitialState_');\n if (this.firstResetToInitialState__) {\n this.firstResetToInitialState__ = false;\n const eventDetail: StateEventDetail<S, E> = {from: this.initialState_, event: 'reset', to: this.initialState_};\n this.execAction__(`on_state_${this.initialState_}_enter`, eventDetail);\n return this.postTransition__(eventDetail);\n }\n // else {\n const from = this.message_.state;\n this.message_ = {state: this.initialState_};\n const eventDetail: StateEventDetail<S, E> = {from, event: 'reset', to: this.initialState_};\n return this.postTransition__(eventDetail);\n }\n\n /**\n * Transition condition.\n */\n protected shouldTransition_(_eventDetail: StateEventDetail<S, E>): MaybePromise<boolean> {\n this.logger_.logMethodFull?.('shouldTransition_', _eventDetail, true);\n return true;\n }\n\n /**\n * Transition flux state machine instance to new state.\n */\n protected async transition_(event: E): Promise<void> {\n const fromState = this.message_.state;\n const toState = this.stateRecord_[fromState]?.[event];\n\n this.logger_.logMethodArgs?.('transition_', {fromState, event, toState});\n\n if (toState == null) {\n this.logger_.incident?.('transition', 'invalid_target_state', {\n fromState,\n event,\n });\n return;\n }\n\n const eventDetail: StateEventDetail<S, E> = {from: fromState, event, to: toState};\n\n\n this.postTransition__(eventDetail);\n }\n\n /**\n * Execute all actions for current state.\n */\n private async postTransition__(eventDetail: StateEventDetail<S, E>): Promise<void> {\n this.logger_.logMethodArgs?.('postTransition__', eventDetail);\n\n await this.execAction__(`on_event_${eventDetail.event}`, eventDetail);\n\n if (eventDetail.from !== eventDetail.to) {\n await this.execAction__(`on_any_state_exit`, eventDetail);\n await this.execAction__(`on_state_${eventDetail.from}_exit`, eventDetail);\n await this.execAction__(`on_any_state_enter`, eventDetail);\n await this.execAction__(`on_state_${eventDetail.to}_enter`, eventDetail);\n }\n\n this.execAction__(`on_state_${eventDetail.from}_event_${eventDetail.event}`, eventDetail);\n }\n\n /**\n * Execute action name if defined in _actionRecord.\n */\n private execAction__(name: ActionName<S, E | 'reset'>, eventDetail: StateEventDetail<S, E>): MaybePromise<void> {\n const actionFn = this.actionRecord_[name];\n if (typeof actionFn === 'function') {\n this.logger_.logMethodArgs?.('execAction__', name);\n return actionFn.call(this, eventDetail);\n }\n }\n}\n", "import {AlwatrFluxStateMachineBase} from './base.js';\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachine<S extends string, E extends string> extends AlwatrFluxStateMachineBase<S, E> {\n /**\n * Current state.\n */\n get state(): S {\n return this.message_.state;\n }\n\n /**\n * Transition flux state machine instance to new state.\n */\n transition(event: E): void {\n this.transition_(event);\n }\n\n /**\n * Reset machine to initial state without notify.\n */\n resetToInitialState(): void {\n this.resetToInitialState_();\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,qBAA4B;AAC5B,wBAA4D;AAI5D,aAAc,8BAAc,IAAI,eAAkB,OAAmB;AAS9D,IAAe,6BAAf,cAAsF,mCAA6B;AAAA,EAexH,YAAY,QAAyC;AACnD,WAAO,iBAAP,OAAO,eAAiB;AACxB,UAAM,MAAM;AAbd;AAAA;AAAA;AAAA,SAAU,eAAkC,CAAC;AAK7C;AAAA;AAAA;AAAA,SAAU,gBAAoC,CAAC;AAe/C,SAAQ,6BAA6B;AALnC,SAAK,gBAAgB,OAAO;AAC5B,SAAK,WAAW,EAAC,OAAO,KAAK,cAAa;AAC1C,eAAW,KAAK,qBAAqB,KAAK,IAAI,GAAG,CAAC;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAMU,uBAAsC;AAC9C,SAAK,QAAQ,YAAY,sBAAsB;AAC/C,QAAI,KAAK,4BAA4B;AACnC,WAAK,6BAA6B;AAClC,YAAMA,eAAsC,EAAC,MAAM,KAAK,eAAe,OAAO,SAAS,IAAI,KAAK,cAAa;AAC7G,WAAK,aAAa,YAAY,KAAK,aAAa,UAAUA,YAAW;AACrE,aAAO,KAAK,iBAAiBA,YAAW;AAAA,IAC1C;AAEA,UAAM,OAAO,KAAK,SAAS;AAC3B,SAAK,WAAW,EAAC,OAAO,KAAK,cAAa;AAC1C,UAAM,cAAsC,EAAC,MAAM,OAAO,SAAS,IAAI,KAAK,cAAa;AACzF,WAAO,KAAK,iBAAiB,WAAW;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKU,kBAAkB,cAA6D;AACvF,SAAK,QAAQ,gBAAgB,qBAAqB,cAAc,IAAI;AACpE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAgB,YAAY,OAAyB;AACnD,UAAM,YAAY,KAAK,SAAS;AAChC,UAAM,UAAU,KAAK,aAAa,SAAS,IAAI,KAAK;AAEpD,SAAK,QAAQ,gBAAgB,eAAe,EAAC,WAAW,OAAO,QAAO,CAAC;AAEvE,QAAI,WAAW,MAAM;AACnB,WAAK,QAAQ,WAAW,cAAc,wBAAwB;AAAA,QAC5D;AAAA,QACA;AAAA,MACF,CAAC;AACD;AAAA,IACF;AAEA,UAAM,cAAsC,EAAC,MAAM,WAAW,OAAO,IAAI,QAAO;AAGhF,SAAK,iBAAiB,WAAW;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,iBAAiB,aAAoD;AACjF,SAAK,QAAQ,gBAAgB,oBAAoB,WAAW;AAE5D,UAAM,KAAK,aAAa,YAAY,YAAY,KAAK,IAAI,WAAW;AAEpE,QAAI,YAAY,SAAS,YAAY,IAAI;AACvC,YAAM,KAAK,aAAa,qBAAqB,WAAW;AACxD,YAAM,KAAK,aAAa,YAAY,YAAY,IAAI,SAAS,WAAW;AACxE,YAAM,KAAK,aAAa,sBAAsB,WAAW;AACzD,YAAM,KAAK,aAAa,YAAY,YAAY,EAAE,UAAU,WAAW;AAAA,IACzE;AAEA,SAAK,aAAa,YAAY,YAAY,IAAI,UAAU,YAAY,KAAK,IAAI,WAAW;AAAA,EAC1F;AAAA;AAAA;AAAA;AAAA,EAKQ,aAAa,MAAkC,aAAyD;AAC9G,UAAM,WAAW,KAAK,cAAc,IAAI;AACxC,QAAI,OAAO,aAAa,YAAY;AAClC,WAAK,QAAQ,gBAAgB,gBAAgB,IAAI;AACjD,aAAO,SAAS,KAAK,MAAM,WAAW;AAAA,IACxC;AAAA,EACF;AACF;;;AC/GO,IAAe,yBAAf,cAAkF,2BAAiC;AAAA;AAAA;AAAA;AAAA,EAIxH,IAAI,QAAW;AACb,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAgB;AACzB,SAAK,YAAY,KAAK;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKA,sBAA4B;AAC1B,SAAK,qBAAqB;AAAA,EAC5B;AACF;",
|
|
6
|
+
"names": ["eventDetail"]
|
|
7
7
|
}
|
package/dist/main.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/* @alwatr/fsm v4.0.
|
|
1
|
+
/* @alwatr/fsm v4.0.1 */
|
|
2
2
|
|
|
3
3
|
// src/base.ts
|
|
4
4
|
import { packageTracer } from "@alwatr/nanolib";
|
|
5
5
|
import { AlwatrObservable } from "@alwatr/observable";
|
|
6
|
-
__dev_mode__: packageTracer.add("@alwatr/fsm", "4.0.
|
|
6
|
+
__dev_mode__: packageTracer.add("@alwatr/fsm", "4.0.1");
|
|
7
7
|
var AlwatrFluxStateMachineBase = class extends AlwatrObservable {
|
|
8
8
|
constructor(config) {
|
|
9
9
|
config.loggerPrefix ?? (config.loggerPrefix = "flux-state-machine");
|
|
@@ -16,22 +16,26 @@ var AlwatrFluxStateMachineBase = class extends AlwatrObservable {
|
|
|
16
16
|
* Bind actions name to class methods
|
|
17
17
|
*/
|
|
18
18
|
this.actionRecord_ = {};
|
|
19
|
+
this.firstResetToInitialState__ = true;
|
|
19
20
|
this.initialState_ = config.initialState;
|
|
20
21
|
this.message_ = { state: this.initialState_ };
|
|
21
|
-
this.resetToInitialState_();
|
|
22
|
+
setTimeout(this.resetToInitialState_.bind(this), 0);
|
|
22
23
|
}
|
|
23
24
|
/**
|
|
24
25
|
* Reset machine to initial state without notify.
|
|
25
26
|
*/
|
|
26
27
|
resetToInitialState_() {
|
|
27
28
|
this.logger_.logMethod?.("resetToInitialState_");
|
|
29
|
+
if (this.firstResetToInitialState__) {
|
|
30
|
+
this.firstResetToInitialState__ = false;
|
|
31
|
+
const eventDetail2 = { from: this.initialState_, event: "reset", to: this.initialState_ };
|
|
32
|
+
this.execAction__(`on_state_${this.initialState_}_enter`, eventDetail2);
|
|
33
|
+
return this.postTransition__(eventDetail2);
|
|
34
|
+
}
|
|
28
35
|
const from = this.message_.state;
|
|
29
36
|
this.message_ = { state: this.initialState_ };
|
|
30
|
-
this.
|
|
31
|
-
|
|
32
|
-
event: "reset",
|
|
33
|
-
to: this.initialState_
|
|
34
|
-
});
|
|
37
|
+
const eventDetail = { from, event: "reset", to: this.initialState_ };
|
|
38
|
+
return this.postTransition__(eventDetail);
|
|
35
39
|
}
|
|
36
40
|
/**
|
|
37
41
|
* Transition condition.
|
|
@@ -55,15 +59,13 @@ var AlwatrFluxStateMachineBase = class extends AlwatrObservable {
|
|
|
55
59
|
return;
|
|
56
60
|
}
|
|
57
61
|
const eventDetail = { from: fromState, event, to: toState };
|
|
58
|
-
if (await this.shouldTransition_(eventDetail) !== true) return;
|
|
59
|
-
this.notify_({ state: toState });
|
|
60
62
|
this.postTransition__(eventDetail);
|
|
61
63
|
}
|
|
62
64
|
/**
|
|
63
65
|
* Execute all actions for current state.
|
|
64
66
|
*/
|
|
65
67
|
async postTransition__(eventDetail) {
|
|
66
|
-
this.logger_.logMethodArgs?.("
|
|
68
|
+
this.logger_.logMethodArgs?.("postTransition__", eventDetail);
|
|
67
69
|
await this.execAction__(`on_event_${eventDetail.event}`, eventDetail);
|
|
68
70
|
if (eventDetail.from !== eventDetail.to) {
|
|
69
71
|
await this.execAction__(`on_any_state_exit`, eventDetail);
|
|
@@ -79,7 +81,7 @@ var AlwatrFluxStateMachineBase = class extends AlwatrObservable {
|
|
|
79
81
|
execAction__(name, eventDetail) {
|
|
80
82
|
const actionFn = this.actionRecord_[name];
|
|
81
83
|
if (typeof actionFn === "function") {
|
|
82
|
-
this.logger_.logMethodArgs?.("
|
|
84
|
+
this.logger_.logMethodArgs?.("execAction__", name);
|
|
83
85
|
return actionFn.call(this, eventDetail);
|
|
84
86
|
}
|
|
85
87
|
}
|
package/dist/main.mjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/base.ts", "../src/fsm.ts"],
|
|
4
|
-
"sourcesContent": ["import {packageTracer} from '@alwatr/nanolib';\nimport {AlwatrObservable, type AlwatrObservableConfig} from '@alwatr/observable';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport interface AlwatrFluxStateMachineConfig<S extends string> extends AlwatrObservableConfig {\n initialState: S;\n}\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachineBase<S extends string, E extends string> extends AlwatrObservable<{state: S}> {\n /**\n * States and transitions config.\n */\n protected stateRecord_: StateRecord<S, E> = {};\n\n /**\n * Bind actions name to class methods\n */\n protected actionRecord_: ActionRecord<S, E> = {};\n\n protected initialState_: S;\n\n protected override message_: {state: S};\n\n constructor(config: AlwatrFluxStateMachineConfig<S>) {\n config.loggerPrefix ??= 'flux-state-machine';\n super(config);\n\n this.initialState_ = config.initialState;\n this.message_ = {state: this.initialState_};\n this.resetToInitialState_();\n }\n\n /**\n * Reset machine to initial state without notify.\n */\n protected resetToInitialState_(): void {\n this.logger_.logMethod?.('resetToInitialState_');\n const from = this.message_.state;\n this.message_ = {state: this.initialState_};\n
|
|
5
|
-
"mappings": ";;;AAAA,SAAQ,qBAAoB;AAC5B,SAAQ,wBAAoD;AAI5D,aAAc,eAAc,IAAI,eAAkB,OAAmB;AAS9D,IAAe,6BAAf,cAAsF,iBAA6B;AAAA,EAexH,YAAY,QAAyC;AACnD,WAAO,iBAAP,OAAO,eAAiB;AACxB,UAAM,MAAM;AAbd;AAAA;AAAA;AAAA,SAAU,eAAkC,CAAC;AAK7C;AAAA;AAAA;AAAA,SAAU,gBAAoC,CAAC;
|
|
6
|
-
"names": []
|
|
4
|
+
"sourcesContent": ["import {packageTracer} from '@alwatr/nanolib';\nimport {AlwatrObservable, type AlwatrObservableConfig} from '@alwatr/observable';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport interface AlwatrFluxStateMachineConfig<S extends string> extends AlwatrObservableConfig {\n initialState: S;\n}\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachineBase<S extends string, E extends string> extends AlwatrObservable<{state: S}> {\n /**\n * States and transitions config.\n */\n protected stateRecord_: StateRecord<S, E> = {};\n\n /**\n * Bind actions name to class methods\n */\n protected actionRecord_: ActionRecord<S, E> = {};\n\n protected initialState_: S;\n\n protected override message_: {state: S};\n\n constructor(config: AlwatrFluxStateMachineConfig<S>) {\n config.loggerPrefix ??= 'flux-state-machine';\n super(config);\n\n this.initialState_ = config.initialState;\n this.message_ = {state: this.initialState_};\n setTimeout(this.resetToInitialState_.bind(this), 0);\n }\n\n private firstResetToInitialState__ = true;\n /**\n * Reset machine to initial state without notify.\n */\n protected resetToInitialState_(): Promise<void> {\n this.logger_.logMethod?.('resetToInitialState_');\n if (this.firstResetToInitialState__) {\n this.firstResetToInitialState__ = false;\n const eventDetail: StateEventDetail<S, E> = {from: this.initialState_, event: 'reset', to: this.initialState_};\n this.execAction__(`on_state_${this.initialState_}_enter`, eventDetail);\n return this.postTransition__(eventDetail);\n }\n // else {\n const from = this.message_.state;\n this.message_ = {state: this.initialState_};\n const eventDetail: StateEventDetail<S, E> = {from, event: 'reset', to: this.initialState_};\n return this.postTransition__(eventDetail);\n }\n\n /**\n * Transition condition.\n */\n protected shouldTransition_(_eventDetail: StateEventDetail<S, E>): MaybePromise<boolean> {\n this.logger_.logMethodFull?.('shouldTransition_', _eventDetail, true);\n return true;\n }\n\n /**\n * Transition flux state machine instance to new state.\n */\n protected async transition_(event: E): Promise<void> {\n const fromState = this.message_.state;\n const toState = this.stateRecord_[fromState]?.[event];\n\n this.logger_.logMethodArgs?.('transition_', {fromState, event, toState});\n\n if (toState == null) {\n this.logger_.incident?.('transition', 'invalid_target_state', {\n fromState,\n event,\n });\n return;\n }\n\n const eventDetail: StateEventDetail<S, E> = {from: fromState, event, to: toState};\n\n\n this.postTransition__(eventDetail);\n }\n\n /**\n * Execute all actions for current state.\n */\n private async postTransition__(eventDetail: StateEventDetail<S, E>): Promise<void> {\n this.logger_.logMethodArgs?.('postTransition__', eventDetail);\n\n await this.execAction__(`on_event_${eventDetail.event}`, eventDetail);\n\n if (eventDetail.from !== eventDetail.to) {\n await this.execAction__(`on_any_state_exit`, eventDetail);\n await this.execAction__(`on_state_${eventDetail.from}_exit`, eventDetail);\n await this.execAction__(`on_any_state_enter`, eventDetail);\n await this.execAction__(`on_state_${eventDetail.to}_enter`, eventDetail);\n }\n\n this.execAction__(`on_state_${eventDetail.from}_event_${eventDetail.event}`, eventDetail);\n }\n\n /**\n * Execute action name if defined in _actionRecord.\n */\n private execAction__(name: ActionName<S, E | 'reset'>, eventDetail: StateEventDetail<S, E>): MaybePromise<void> {\n const actionFn = this.actionRecord_[name];\n if (typeof actionFn === 'function') {\n this.logger_.logMethodArgs?.('execAction__', name);\n return actionFn.call(this, eventDetail);\n }\n }\n}\n", "import {AlwatrFluxStateMachineBase} from './base.js';\n\n/**\n * Flux (Finite) State Machine Base Class\n */\nexport abstract class AlwatrFluxStateMachine<S extends string, E extends string> extends AlwatrFluxStateMachineBase<S, E> {\n /**\n * Current state.\n */\n get state(): S {\n return this.message_.state;\n }\n\n /**\n * Transition flux state machine instance to new state.\n */\n transition(event: E): void {\n this.transition_(event);\n }\n\n /**\n * Reset machine to initial state without notify.\n */\n resetToInitialState(): void {\n this.resetToInitialState_();\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;AAAA,SAAQ,qBAAoB;AAC5B,SAAQ,wBAAoD;AAI5D,aAAc,eAAc,IAAI,eAAkB,OAAmB;AAS9D,IAAe,6BAAf,cAAsF,iBAA6B;AAAA,EAexH,YAAY,QAAyC;AACnD,WAAO,iBAAP,OAAO,eAAiB;AACxB,UAAM,MAAM;AAbd;AAAA;AAAA;AAAA,SAAU,eAAkC,CAAC;AAK7C;AAAA;AAAA;AAAA,SAAU,gBAAoC,CAAC;AAe/C,SAAQ,6BAA6B;AALnC,SAAK,gBAAgB,OAAO;AAC5B,SAAK,WAAW,EAAC,OAAO,KAAK,cAAa;AAC1C,eAAW,KAAK,qBAAqB,KAAK,IAAI,GAAG,CAAC;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAMU,uBAAsC;AAC9C,SAAK,QAAQ,YAAY,sBAAsB;AAC/C,QAAI,KAAK,4BAA4B;AACnC,WAAK,6BAA6B;AAClC,YAAMA,eAAsC,EAAC,MAAM,KAAK,eAAe,OAAO,SAAS,IAAI,KAAK,cAAa;AAC7G,WAAK,aAAa,YAAY,KAAK,aAAa,UAAUA,YAAW;AACrE,aAAO,KAAK,iBAAiBA,YAAW;AAAA,IAC1C;AAEA,UAAM,OAAO,KAAK,SAAS;AAC3B,SAAK,WAAW,EAAC,OAAO,KAAK,cAAa;AAC1C,UAAM,cAAsC,EAAC,MAAM,OAAO,SAAS,IAAI,KAAK,cAAa;AACzF,WAAO,KAAK,iBAAiB,WAAW;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKU,kBAAkB,cAA6D;AACvF,SAAK,QAAQ,gBAAgB,qBAAqB,cAAc,IAAI;AACpE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAgB,YAAY,OAAyB;AACnD,UAAM,YAAY,KAAK,SAAS;AAChC,UAAM,UAAU,KAAK,aAAa,SAAS,IAAI,KAAK;AAEpD,SAAK,QAAQ,gBAAgB,eAAe,EAAC,WAAW,OAAO,QAAO,CAAC;AAEvE,QAAI,WAAW,MAAM;AACnB,WAAK,QAAQ,WAAW,cAAc,wBAAwB;AAAA,QAC5D;AAAA,QACA;AAAA,MACF,CAAC;AACD;AAAA,IACF;AAEA,UAAM,cAAsC,EAAC,MAAM,WAAW,OAAO,IAAI,QAAO;AAGhF,SAAK,iBAAiB,WAAW;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,iBAAiB,aAAoD;AACjF,SAAK,QAAQ,gBAAgB,oBAAoB,WAAW;AAE5D,UAAM,KAAK,aAAa,YAAY,YAAY,KAAK,IAAI,WAAW;AAEpE,QAAI,YAAY,SAAS,YAAY,IAAI;AACvC,YAAM,KAAK,aAAa,qBAAqB,WAAW;AACxD,YAAM,KAAK,aAAa,YAAY,YAAY,IAAI,SAAS,WAAW;AACxE,YAAM,KAAK,aAAa,sBAAsB,WAAW;AACzD,YAAM,KAAK,aAAa,YAAY,YAAY,EAAE,UAAU,WAAW;AAAA,IACzE;AAEA,SAAK,aAAa,YAAY,YAAY,IAAI,UAAU,YAAY,KAAK,IAAI,WAAW;AAAA,EAC1F;AAAA;AAAA;AAAA;AAAA,EAKQ,aAAa,MAAkC,aAAyD;AAC9G,UAAM,WAAW,KAAK,cAAc,IAAI;AACxC,QAAI,OAAO,aAAa,YAAY;AAClC,WAAK,QAAQ,gBAAgB,gBAAgB,IAAI;AACjD,aAAO,SAAS,KAAK,MAAM,WAAW;AAAA,IACxC;AAAA,EACF;AACF;;;AC/GO,IAAe,yBAAf,cAAkF,2BAAiC;AAAA;AAAA;AAAA;AAAA,EAIxH,IAAI,QAAW;AACb,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAgB;AACzB,SAAK,YAAY,KAAK;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKA,sBAA4B;AAC1B,SAAK,qBAAqB;AAAA,EAC5B;AACF;",
|
|
6
|
+
"names": ["eventDetail"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwatr/fsm",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.1",
|
|
4
4
|
"description": "A robust TypeScript library for implementing Flux (Finite) State Machines, enabling clear and organized management of application state and transitions.",
|
|
5
5
|
"author": "S. Ali Mihandoost <ali.mihandoost@gmail.com> (https://ali.mihandoost.com)",
|
|
6
6
|
"keywords": [
|
|
@@ -70,5 +70,5 @@
|
|
|
70
70
|
"jest": "^29.7.0",
|
|
71
71
|
"typescript": "^5.6.3"
|
|
72
72
|
},
|
|
73
|
-
"gitHead": "
|
|
73
|
+
"gitHead": "b0b82cdd92fa7c4c2f67da917cb21d7449d126df"
|
|
74
74
|
}
|