@alwatr/fsm 2.0.3 → 2.0.4

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 CHANGED
@@ -3,6 +3,10 @@
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
+ ## [2.0.4](https://github.com/Alwatr/signal/compare/@alwatr/fsm@2.0.2...@alwatr/fsm@2.0.4) (2023-12-19)
7
+
8
+ **Note:** Version bump only for package @alwatr/fsm
9
+
6
10
  ## [2.0.3](https://github.com/Alwatr/signal/compare/@alwatr/fsm@2.0.2...@alwatr/fsm@2.0.3) (2023-11-09)
7
11
 
8
12
  **Note:** Version bump only for package @alwatr/fsm
package/base.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["src/base.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,gBAAgB,CAAC;AAKhD,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAgB,sBAA2D,SAAQ,gBAAmB;IAC1G;;OAEG;IACH,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,QAAQ,EAAG,CAAC;IAC1B,CAAC;IAcD,YAAY,MAA8D;QACxE,MAAM,CAAC,YAAY,KAAnB,MAAM,CAAC,YAAY,GAAK,KAAK,EAAC;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;QAdhB;;WAEG;QACO,iBAAY,GAAsB,EAAE,CAAC;QAE/C;;WAEG;QACO,kBAAa,GAAuB,EAAE,CAAC;QAO/C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,YAAoC;QAC9D,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,mBAAmB,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,WAAW,CAAC,KAAQ;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;QAEzF,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,aAAa,EAAE,EAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAC,CAAC,CAAC;QAEzE,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,sBAAsB,EAAE;gBAC5D,SAAS;gBACT,KAAK;aACN,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,WAAW,GAA2B,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAC,CAAC;QAElF,IAAI,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QAEjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,aAAa,CAAC,WAAmC;QAC/D,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAE3D,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;QAEjE,IAAI,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE,EAAE;YACvC,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,IAAI,OAAO,EAAE,WAAW,CAAC,CAAC;YACrE,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;YACxD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;SACrE;QAED,IAAI,OAAO,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,IAAI,EAAE;YAC1D,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;SAChF;aACI;YACH,IAAI,CAAC,YAAY,CAAC,WAAW,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,IAAsB,EAAE,WAAmC;QAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SAC1D;IACH,CAAC;IAED;;OAEG;IACO,MAAM;QACd,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC;IACnC,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport {definePackage} from '@alwatr/logger';\nimport {AlwatrObservable} from '@alwatr/signal';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\nimport type {MaybePromise} from '@alwatr/type';\n\ndefinePackage('fsm', '2.x');\n\n/**\n * Finite State Machine Base Class\n */\nexport abstract class FiniteStateMachineBase<S extends string, E extends string> extends AlwatrObservable<S> {\n /**\n * Current state\n */\n protected get _state(): S {\n return this._getData()!;\n }\n\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 constructor(config: {name: string; loggerPrefix?: string; initialState: S}) {\n config.loggerPrefix ??= 'fsm';\n super(config);\n this._initialState = config.initialState;\n this._reset();\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 finite state machine instance to new state.\n */\n protected async _transition(event: E): Promise<void> {\n const fromState = this._state;\n const toState = this._stateRecord[fromState]?.[event] ?? this._stateRecord._all?.[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 if ((await this._shouldTransition(eventDetail)) !== true) return;\n\n this._notify(toState);\n\n this._transitioned(eventDetail);\n }\n\n /**\n * Execute all actions for current state.\n */\n protected async _transitioned(eventDetail: StateEventDetail<S, E>): Promise<void> {\n this._logger.logMethodArgs?.('_transitioned', eventDetail);\n\n await this._$execAction(`_on_${eventDetail.event}`, eventDetail);\n\n if (eventDetail.from !== eventDetail.to) {\n await this._$execAction(`_on_state_exit`, eventDetail);\n await this._$execAction(`_on_${eventDetail.from}_exit`, eventDetail);\n await this._$execAction(`_on_state_enter`, eventDetail);\n await this._$execAction(`_on_${eventDetail.to}_enter`, eventDetail);\n }\n\n if (`_on_${eventDetail.from}_${eventDetail.event}` in this) {\n this._$execAction(`_on_${eventDetail.from}_${eventDetail.event}`, eventDetail);\n }\n else {\n this._$execAction(`_on_all_${eventDetail.event}`, eventDetail);\n }\n }\n\n /**\n * Execute action name if defined in _actionRecord.\n */\n protected _$execAction(name: ActionName<S, E>, 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 this._actionRecord[name]?.call(this, eventDetail);\n }\n }\n\n /**\n * Reset machine to initial state.\n */\n protected _reset(): void {\n this._$data = this._initialState;\n }\n}\n"]}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["src/base.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAC,aAAa,EAAC,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,gBAAgB,CAAC;AAKhD,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAgB,sBAA2D,SAAQ,gBAAmB;IAC1G;;OAEG;IACH,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,QAAQ,EAAG,CAAC;IAC1B,CAAC;IAcD,YAAY,MAA8D;QACxE,MAAM,CAAC,YAAY,KAAnB,MAAM,CAAC,YAAY,GAAK,KAAK,EAAC;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;QAdhB;;WAEG;QACO,iBAAY,GAAsB,EAAE,CAAC;QAE/C;;WAEG;QACO,kBAAa,GAAuB,EAAE,CAAC;QAO/C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,YAAoC;QAC9D,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,mBAAmB,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,WAAW,CAAC,KAAQ;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;QAEzF,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,aAAa,EAAE,EAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAC,CAAC,CAAC;QAEzE,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,sBAAsB,EAAE;gBAC5D,SAAS;gBACT,KAAK;aACN,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAA2B,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAC,CAAC;QAElF,IAAI,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QAEjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,aAAa,CAAC,WAAmC;QAC/D,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAE3D,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;QAEjE,IAAI,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,IAAI,OAAO,EAAE,WAAW,CAAC,CAAC;YACrE,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;YACxD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,OAAO,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC;YAC3D,IAAI,CAAC,YAAY,CAAC,OAAO,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;QACjF,CAAC;aACI,CAAC;YACJ,IAAI,CAAC,YAAY,CAAC,WAAW,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,IAAsB,EAAE,WAAmC;QAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;OAEG;IACO,MAAM;QACd,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC;IACnC,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport {definePackage} from '@alwatr/logger';\nimport {AlwatrObservable} from '@alwatr/signal';\n\nimport type {ActionName, ActionRecord, StateEventDetail, StateRecord} from './type.js';\nimport type {MaybePromise} from '@alwatr/type';\n\ndefinePackage('fsm', '2.x');\n\n/**\n * Finite State Machine Base Class\n */\nexport abstract class FiniteStateMachineBase<S extends string, E extends string> extends AlwatrObservable<S> {\n /**\n * Current state\n */\n protected get _state(): S {\n return this._getData()!;\n }\n\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 constructor(config: {name: string; loggerPrefix?: string; initialState: S}) {\n config.loggerPrefix ??= 'fsm';\n super(config);\n this._initialState = config.initialState;\n this._reset();\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 finite state machine instance to new state.\n */\n protected async _transition(event: E): Promise<void> {\n const fromState = this._state;\n const toState = this._stateRecord[fromState]?.[event] ?? this._stateRecord._all?.[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 if ((await this._shouldTransition(eventDetail)) !== true) return;\n\n this._notify(toState);\n\n this._transitioned(eventDetail);\n }\n\n /**\n * Execute all actions for current state.\n */\n protected async _transitioned(eventDetail: StateEventDetail<S, E>): Promise<void> {\n this._logger.logMethodArgs?.('_transitioned', eventDetail);\n\n await this._$execAction(`_on_${eventDetail.event}`, eventDetail);\n\n if (eventDetail.from !== eventDetail.to) {\n await this._$execAction(`_on_state_exit`, eventDetail);\n await this._$execAction(`_on_${eventDetail.from}_exit`, eventDetail);\n await this._$execAction(`_on_state_enter`, eventDetail);\n await this._$execAction(`_on_${eventDetail.to}_enter`, eventDetail);\n }\n\n if (`_on_${eventDetail.from}_${eventDetail.event}` in this) {\n this._$execAction(`_on_${eventDetail.from}_${eventDetail.event}`, eventDetail);\n }\n else {\n this._$execAction(`_on_all_${eventDetail.event}`, eventDetail);\n }\n }\n\n /**\n * Execute action name if defined in _actionRecord.\n */\n protected _$execAction(name: ActionName<S, E>, 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 this._actionRecord[name]?.call(this, eventDetail);\n }\n }\n\n /**\n * Reset machine to initial state.\n */\n protected _reset(): void {\n this._$data = this._initialState;\n }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwatr/fsm",
3
- "version": "2.0.3",
3
+ "version": "2.0.4",
4
4
  "description": "Managing invocations finite-state machines for lit-element written in tiny TypeScript module.",
5
5
  "keywords": [
6
6
  "state",
@@ -34,13 +34,13 @@
34
34
  "url": "https://github.com/Alwatr/signal/issues"
35
35
  },
36
36
  "dependencies": {
37
- "@alwatr/logger": "^2.1.3",
38
- "@alwatr/signal": "^2.0.3",
39
- "@alwatr/type": "^1.1.5",
37
+ "@alwatr/logger": "^2.4.0",
38
+ "@alwatr/signal": "^2.0.4",
39
+ "@alwatr/type": "^1.2.4",
40
40
  "tslib": "^2.6.2"
41
41
  },
42
42
  "devDependencies": {
43
- "@types/node": "^20.9.0"
43
+ "@types/node": "^20.10.5"
44
44
  },
45
- "gitHead": "863c678c0921b312f0155c212326945804e5d701"
45
+ "gitHead": "3b5a8f673644ecd7f8ea3b6889ea4db5710ae85f"
46
46
  }