@real-router/fsm 0.2.0 → 0.2.2
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/README.md +34 -120
- package/dist/cjs/index.d.ts +6 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/metafile-cjs.json +1 -1
- package/dist/esm/index.d.mts +6 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/index.mjs.map +1 -1
- package/dist/esm/metafile-esm.json +1 -1
- package/package.json +5 -5
- package/src/fsm.ts +148 -0
- package/src/index.ts +3 -0
- package/src/types.ts +26 -0
package/README.md
CHANGED
|
@@ -1,23 +1,18 @@
|
|
|
1
1
|
# @real-router/fsm
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://www.typescriptlang.org/)
|
|
3
|
+
> Synchronous finite state machine engine.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
**Internal package** — consumed by `@real-router/core`. Published to npm by historical accident — do not depend on it directly.
|
|
7
6
|
|
|
8
|
-
##
|
|
7
|
+
## Purpose
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
yarn add @real-router/fsm
|
|
16
|
-
# or
|
|
17
|
-
bun add @real-router/fsm
|
|
18
|
-
```
|
|
9
|
+
Drives the router's lifecycle state machine (`STOPPED → STARTED → DISPOSED`). Synchronous, zero-dependency, O(1) transition lookup.
|
|
10
|
+
|
|
11
|
+
## Consumer
|
|
12
|
+
|
|
13
|
+
- `@real-router/core` — router lifecycle management
|
|
19
14
|
|
|
20
|
-
##
|
|
15
|
+
## Public API
|
|
21
16
|
|
|
22
17
|
```typescript
|
|
23
18
|
import { FSM } from "@real-router/fsm";
|
|
@@ -32,128 +27,47 @@ const fsm = new FSM({
|
|
|
32
27
|
},
|
|
33
28
|
});
|
|
34
29
|
|
|
35
|
-
fsm.send("TIMER");
|
|
36
|
-
fsm.send("TIMER");
|
|
37
|
-
fsm.
|
|
38
|
-
fsm.
|
|
39
|
-
fsm.getContext(); // { count: 0 }
|
|
30
|
+
fsm.send("TIMER"); // "yellow"
|
|
31
|
+
fsm.send("TIMER"); // "red"
|
|
32
|
+
fsm.getState(); // "red"
|
|
33
|
+
fsm.getContext(); // { count: 0 }
|
|
40
34
|
```
|
|
41
35
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
`config.context: TContext` — shared context object\
|
|
51
|
-
`config.transitions: Record<TStates, Partial<Record<TEvents, TStates>>>` — transition table
|
|
36
|
+
| Method | Description |
|
|
37
|
+
|--------|-------------|
|
|
38
|
+
| `send(event, payload?)` | Trigger transition, return current state. No-op if no transition defined |
|
|
39
|
+
| `getState()` | Current state |
|
|
40
|
+
| `getContext()` | Context object (same reference as config) |
|
|
41
|
+
| `onTransition(listener)` | Subscribe to transitions, returns unsubscribe |
|
|
42
|
+
| `on(from, event, action)` | Register action for specific `(from, event)` pair |
|
|
43
|
+
| `forceState(state)` | Direct state update — no actions, no listeners |
|
|
52
44
|
|
|
53
|
-
###
|
|
54
|
-
|
|
55
|
-
Sends an event to trigger a transition. Returns the current state after processing.\
|
|
56
|
-
If no transition exists for the event in the current state, returns the current state (no-op).\
|
|
57
|
-
State is updated before listeners fire (reentrancy-safe).
|
|
45
|
+
### Type-Safe Payloads
|
|
58
46
|
|
|
59
47
|
```typescript
|
|
60
|
-
fsm.send("TIMER"); // transitions and returns new state
|
|
61
|
-
fsm.send("RESET"); // no-op if no transition defined, returns current state
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### `fsm.getState(): TStates`
|
|
65
|
-
|
|
66
|
-
Returns the current state.
|
|
67
|
-
|
|
68
|
-
### `fsm.getContext(): TContext`
|
|
69
|
-
|
|
70
|
-
Returns the context object (same reference as provided in config).
|
|
71
|
-
|
|
72
|
-
### `fsm.onTransition(listener): () => void`
|
|
73
|
-
|
|
74
|
-
Subscribes a listener to state transitions. Returns an unsubscribe function.\
|
|
75
|
-
Listener receives `TransitionInfo` with `from`, `to`, `event`, and `payload` fields.\
|
|
76
|
-
Not called on no-op sends (when no transition exists).
|
|
77
|
-
|
|
78
|
-
```typescript
|
|
79
|
-
const unsub = fsm.onTransition((info) => {
|
|
80
|
-
console.log(`${info.from} -> ${info.to} via ${info.event}`);
|
|
81
|
-
});
|
|
82
|
-
|
|
83
|
-
fsm.send("TIMER"); // logs: "green -> yellow via TIMER"
|
|
84
|
-
unsub();
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
## Type-Safe Payloads
|
|
90
|
-
|
|
91
|
-
Use `TPayloadMap` to require payloads for specific events:
|
|
92
|
-
|
|
93
|
-
```typescript
|
|
94
|
-
import type { FSMConfig } from "@real-router/fsm";
|
|
95
|
-
|
|
96
|
-
type State = "idle" | "loading" | "done";
|
|
97
|
-
type Event = "FETCH" | "RESOLVE";
|
|
98
|
-
|
|
99
48
|
interface PayloadMap {
|
|
100
49
|
FETCH: { url: string };
|
|
101
50
|
}
|
|
102
51
|
|
|
103
|
-
const config: FSMConfig<State, Event, null> = {
|
|
104
|
-
initial: "idle",
|
|
105
|
-
context: null,
|
|
106
|
-
transitions: {
|
|
107
|
-
idle: { FETCH: "loading" },
|
|
108
|
-
loading: { RESOLVE: "done" },
|
|
109
|
-
done: {},
|
|
110
|
-
},
|
|
111
|
-
};
|
|
112
|
-
|
|
113
52
|
const fsm = new FSM<State, Event, null, PayloadMap>(config);
|
|
114
|
-
|
|
115
|
-
fsm.send("
|
|
116
|
-
fsm.send("
|
|
117
|
-
fsm.send("FETCH"); // TypeScript error — missing payload
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
## Types
|
|
123
|
-
|
|
124
|
-
```typescript
|
|
125
|
-
import type { FSMConfig, TransitionInfo } from "@real-router/fsm";
|
|
126
|
-
|
|
127
|
-
interface FSMConfig<TStates, TEvents, TContext> {
|
|
128
|
-
initial: TStates;
|
|
129
|
-
context: TContext;
|
|
130
|
-
transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
interface TransitionInfo<TStates, TEvents, TPayloadMap> {
|
|
134
|
-
from: TStates;
|
|
135
|
-
to: TStates;
|
|
136
|
-
event: TEvents;
|
|
137
|
-
payload: TPayloadMap[TEvents] | undefined;
|
|
138
|
-
}
|
|
53
|
+
fsm.send("FETCH", { url: "/api" }); // required
|
|
54
|
+
fsm.send("RESOLVE"); // no payload
|
|
55
|
+
fsm.send("FETCH"); // TS error
|
|
139
56
|
```
|
|
140
57
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
## Design
|
|
58
|
+
## Key Design Decisions
|
|
144
59
|
|
|
145
60
|
- **Synchronous** — no async, no promises, no microtasks
|
|
146
|
-
-
|
|
147
|
-
- **Zero-alloc hot path** — when no listeners
|
|
148
|
-
- **Null-slot listener array** —
|
|
149
|
-
- **Reentrancy-safe** —
|
|
150
|
-
|
|
151
|
-
---
|
|
61
|
+
- **`#currentTransitions` cache** — avoids double lookup `transitions[state][event]`
|
|
62
|
+
- **Zero-alloc hot path** — skips `TransitionInfo` allocation when no listeners
|
|
63
|
+
- **Null-slot listener array** — reuses slots from unsubscribed listeners
|
|
64
|
+
- **Reentrancy-safe** — state updated before listeners fire; callers responsible for preventing loops
|
|
65
|
+
- **`forceState()`** — bypasses `send()` overhead (~30ns saved per call) for router's navigate hot path
|
|
152
66
|
|
|
153
|
-
##
|
|
67
|
+
## Dependencies
|
|
154
68
|
|
|
155
|
-
|
|
69
|
+
None (zero dependencies).
|
|
156
70
|
|
|
157
71
|
## License
|
|
158
72
|
|
|
159
|
-
MIT
|
|
73
|
+
[MIT](../../LICENSE)
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -23,8 +23,13 @@ interface TransitionInfo<TStates extends string, TEvents extends string, TPayloa
|
|
|
23
23
|
declare class FSM<TStates extends string, TEvents extends string, TContext, TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>> {
|
|
24
24
|
#private;
|
|
25
25
|
constructor(config: FSMConfig<TStates, TEvents, TContext>);
|
|
26
|
-
send
|
|
26
|
+
send(event: TEvents, payload?: TPayloadMap[TEvents]): TStates;
|
|
27
27
|
canSend(event: TEvents): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Directly sets FSM state without triggering actions or listeners.
|
|
30
|
+
* Use for hot-path optimizations where the caller handles side effects.
|
|
31
|
+
*/
|
|
32
|
+
forceState(state: TStates): void;
|
|
28
33
|
getState(): TStates;
|
|
29
34
|
getContext(): TContext;
|
|
30
35
|
on<E extends TEvents>(from: TStates, event: E, action: E extends keyof TPayloadMap ? (payload: TPayloadMap[E]) => void : () => void): () => void;
|
package/dist/cjs/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
exports.FSM=class{#t;#s;#n=0;#i=null;#e;#r;#o=[];constructor(t){this.#t=t.initial,this.#e=t.context,this.#r=t.transitions,this.#s=t.transitions[t.initial]}send(t
|
|
1
|
+
exports.FSM=class{#t;#s;#n=0;#i=null;#e;#r;#o=[];constructor(t){this.#t=t.initial,this.#e=t.context,this.#r=t.transitions,this.#s=t.transitions[t.initial]}send(t,s){const n=this.#s[t];if(void 0===n)return this.#t;const i=this.#t;if(this.#t=n,this.#s=this.#r[n],null!==this.#i){const n=this.#i.get(i)?.get(t);void 0!==n&&n(s)}if(this.#n>0){const e={from:i,to:n,event:t,payload:s};for(const t of this.#o)null!==t&&t(e)}return this.#t}canSend(t){return void 0!==this.#s[t]}forceState(t){this.#t=t,this.#s=this.#r[t]}getState(){return this.#t}getContext(){return this.#e}on(t,s,n){this.#i??=new Map;let i=this.#i.get(t);return i||(i=new Map,this.#i.set(t,i)),i.set(s,n),()=>{this.#i?.get(t)?.delete(s)}}onTransition(t){const s=this.#o.indexOf(null);let n;-1===s?(n=this.#o.length,this.#o.push(t)):(this.#o[s]=t,n=s),this.#n++;let i=!0;return()=>{i&&(i=!1,this.#o[n]=null,this.#n--)}}};//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/fsm.ts"],"names":[],"mappings":";AAYO,IAAM,MAAN,MAKL;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA,GAAiB,CAAA;AAAA,EACjB,QAAA,
|
|
1
|
+
{"version":3,"sources":["../../src/fsm.ts"],"names":[],"mappings":";AAYO,IAAM,MAAN,MAKL;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA,GAAiB,CAAA;AAAA,EACjB,QAAA,GACE,IAAA;AAAA,EACO,QAAA;AAAA,EACA,YAAA;AAAA,EACA,aAIK,EAAC;AAAA,EAEf,YAAY,MAAA,EAA+C;AACzD,IAAA,IAAA,CAAK,SAAS,MAAA,CAAO,OAAA;AACrB,IAAA,IAAA,CAAK,WAAW,MAAA,CAAO,OAAA;AACvB,IAAA,IAAA,CAAK,eAAe,MAAA,CAAO,WAAA;AAC3B,IAAA,IAAA,CAAK,mBAAA,GAAsB,MAAA,CAAO,WAAA,CAAY,MAAA,CAAO,OAAO,CAAA;AAAA,EAC9D;AAAA,EAEA,IAAA,CAAK,OAAgB,OAAA,EAAyC;AAC5D,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,mBAAA,CAAoB,KAAK,CAAA;AAEhD,IAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,MAAA,OAAO,IAAA,CAAK,MAAA;AAAA,IACd;AAEA,IAAA,MAAM,OAAO,IAAA,CAAK,MAAA;AAElB,IAAA,IAAA,CAAK,MAAA,GAAS,SAAA;AACd,IAAA,IAAA,CAAK,mBAAA,GAAsB,IAAA,CAAK,YAAA,CAAa,SAAS,CAAA;AAEtD,IAAA,IAAI,IAAA,CAAK,aAAa,IAAA,EAAM;AAC1B,MAAA,MAAM,SAAS,IAAA,CAAK,QAAA,CAAS,IAAI,IAAI,CAAA,EAAG,IAAI,KAAK,CAAA;AAEjD,MAAA,IAAI,WAAW,MAAA,EAAW;AACxB,QAAA,MAAA,CAAO,OAAO,CAAA;AAAA,MAChB;AAAA,IACF;AAEA,IAAA,IAAI,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAC3B,MAAA,MAAM,IAAA,GAAsD;AAAA,QAC1D,IAAA;AAAA,QACA,EAAA,EAAI,SAAA;AAAA,QACJ,KAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,KAAA,MAAW,QAAA,IAAY,KAAK,UAAA,EAAY;AACtC,QAAA,IAAI,aAAa,IAAA,EAAM;AACrB,UAAA,QAAA,CAAS,IAAI,CAAA;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAEA,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEA,QAAQ,KAAA,EAAyB;AAC/B,IAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,KAAK,CAAA,KAAM,MAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,KAAA,EAAsB;AAC/B,IAAA,IAAA,CAAK,MAAA,GAAS,KAAA;AACd,IAAA,IAAA,CAAK,mBAAA,GAAsB,IAAA,CAAK,YAAA,CAAa,KAAK,CAAA;AAAA,EACpD;AAAA,EAEA,QAAA,GAAoB;AAClB,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEA,UAAA,GAAuB;AACrB,IAAA,OAAO,IAAA,CAAK,QAAA;AAAA,EACd;AAAA,EAEA,EAAA,CACE,IAAA,EACA,KAAA,EACA,MAAA,EAGY;AACZ,IAAA,IAAA,CAAK,QAAA,yBAAiB,GAAA,EAAI;AAE1B,IAAA,IAAI,YAAA,GAAe,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AAEzC,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA,YAAA,uBAAmB,GAAA,EAAI;AACvB,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAA,EAAM,YAAY,CAAA;AAAA,IACtC;AAEA,IAAA,YAAA,CAAa,GAAA,CAAI,OAAO,MAAoC,CAAA;AAE5D,IAAA,OAAO,MAAM;AACX,MAAA,IAAA,CAAK,QAAA,EAAU,GAAA,CAAI,IAAI,CAAA,EAAG,OAAO,KAAK,CAAA;AAAA,IACxC,CAAA;AAAA,EACF;AAAA,EAEA,aACE,QAAA,EACY;AACZ,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,UAAA,CAAW,OAAA,CAAQ,IAAI,CAAA;AAC9C,IAAA,IAAI,KAAA;AAEJ,IAAA,IAAI,cAAc,EAAA,EAAI;AACpB,MAAA,KAAA,GAAQ,KAAK,UAAA,CAAW,MAAA;AACxB,MAAA,IAAA,CAAK,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,IAC/B,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,UAAA,CAAW,SAAS,CAAA,GAAI,QAAA;AAC7B,MAAA,KAAA,GAAQ,SAAA;AAAA,IACV;AAEA,IAAA,IAAA,CAAK,cAAA,EAAA;AACL,IAAA,IAAI,UAAA,GAAa,IAAA;AAEjB,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,CAAC,UAAA,EAAY;AACf,QAAA;AAAA,MACF;AAEA,MAAA,UAAA,GAAa,KAAA;AACb,MAAA,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,GAAI,IAAA;AACzB,MAAA,IAAA,CAAK,cAAA,EAAA;AAAA,IACP,CAAA;AAAA,EACF;AACF","file":"index.js","sourcesContent":["import type { FSMConfig, TransitionInfo, TransitionListener } from \"./types\";\n\n/**\n * Synchronous finite state machine engine.\n *\n * Reentrancy: `send()` inside `onTransition` listener is allowed but unbounded —\n * callers are responsible for preventing infinite loops.\n *\n * Exceptions: if a listener throws, the exception propagates to the caller.\n * State is already updated before listeners fire, so `getState()` reflects the\n * new state even if the exception escapes `send()`.\n */\nexport class FSM<\n TStates extends string,\n TEvents extends string,\n TContext,\n TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>,\n> {\n #state: TStates;\n #currentTransitions: Partial<Record<TEvents, TStates>>;\n #listenerCount = 0;\n #actions: Map<TStates, Map<TEvents, (payload: unknown) => void>> | null =\n null;\n readonly #context: TContext;\n readonly #transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;\n readonly #listeners: (TransitionListener<\n TStates,\n TEvents,\n TPayloadMap\n > | null)[] = [];\n\n constructor(config: FSMConfig<TStates, TEvents, TContext>) {\n this.#state = config.initial;\n this.#context = config.context;\n this.#transitions = config.transitions;\n this.#currentTransitions = config.transitions[config.initial];\n }\n\n send(event: TEvents, payload?: TPayloadMap[TEvents]): TStates {\n const nextState = this.#currentTransitions[event];\n\n if (nextState === undefined) {\n return this.#state;\n }\n\n const from = this.#state;\n\n this.#state = nextState;\n this.#currentTransitions = this.#transitions[nextState];\n\n if (this.#actions !== null) {\n const action = this.#actions.get(from)?.get(event);\n\n if (action !== undefined) {\n action(payload);\n }\n }\n\n if (this.#listenerCount > 0) {\n const info: TransitionInfo<TStates, TEvents, TPayloadMap> = {\n from,\n to: nextState,\n event,\n payload: payload,\n };\n\n for (const listener of this.#listeners) {\n if (listener !== null) {\n listener(info);\n }\n }\n }\n\n return this.#state;\n }\n\n canSend(event: TEvents): boolean {\n return this.#currentTransitions[event] !== undefined;\n }\n\n /**\n * Directly sets FSM state without triggering actions or listeners.\n * Use for hot-path optimizations where the caller handles side effects.\n */\n forceState(state: TStates): void {\n this.#state = state;\n this.#currentTransitions = this.#transitions[state];\n }\n\n getState(): TStates {\n return this.#state;\n }\n\n getContext(): TContext {\n return this.#context;\n }\n\n on<E extends TEvents>(\n from: TStates,\n event: E,\n action: E extends keyof TPayloadMap\n ? (payload: TPayloadMap[E]) => void\n : () => void,\n ): () => void {\n this.#actions ??= new Map();\n\n let stateActions = this.#actions.get(from);\n\n if (!stateActions) {\n stateActions = new Map();\n this.#actions.set(from, stateActions);\n }\n\n stateActions.set(event, action as (payload: unknown) => void);\n\n return () => {\n this.#actions?.get(from)?.delete(event);\n };\n }\n\n onTransition(\n listener: (info: TransitionInfo<TStates, TEvents, TPayloadMap>) => void,\n ): () => void {\n const nullIndex = this.#listeners.indexOf(null);\n let index: number;\n\n if (nullIndex === -1) {\n index = this.#listeners.length;\n this.#listeners.push(listener);\n } else {\n this.#listeners[nullIndex] = listener;\n index = nullIndex;\n }\n\n this.#listenerCount++;\n let subscribed = true;\n\n return () => {\n if (!subscribed) {\n return;\n }\n\n subscribed = false;\n this.#listeners[index] = null;\n this.#listenerCount--;\n };\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.
|
|
1
|
+
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/fsm.ts":{"bytes":3754,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":88,"imports":[{"path":"src/fsm.ts","kind":"import-statement","original":"./fsm"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/cjs/index.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":5670},"dist/cjs/index.js":{"imports":[],"exports":["FSM"],"entryPoint":"src/index.ts","inputs":{"src/fsm.ts":{"bytesInOutput":2378},"src/index.ts":{"bytesInOutput":0}},"bytes":2410}}}
|
package/dist/esm/index.d.mts
CHANGED
|
@@ -23,8 +23,13 @@ interface TransitionInfo<TStates extends string, TEvents extends string, TPayloa
|
|
|
23
23
|
declare class FSM<TStates extends string, TEvents extends string, TContext, TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>> {
|
|
24
24
|
#private;
|
|
25
25
|
constructor(config: FSMConfig<TStates, TEvents, TContext>);
|
|
26
|
-
send
|
|
26
|
+
send(event: TEvents, payload?: TPayloadMap[TEvents]): TStates;
|
|
27
27
|
canSend(event: TEvents): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Directly sets FSM state without triggering actions or listeners.
|
|
30
|
+
* Use for hot-path optimizations where the caller handles side effects.
|
|
31
|
+
*/
|
|
32
|
+
forceState(state: TStates): void;
|
|
28
33
|
getState(): TStates;
|
|
29
34
|
getContext(): TContext;
|
|
30
35
|
on<E extends TEvents>(from: TStates, event: E, action: E extends keyof TPayloadMap ? (payload: TPayloadMap[E]) => void : () => void): () => void;
|
package/dist/esm/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var t=class{#t;#s;#n=0;#i=null;#e;#r;#o=[];constructor(t){this.#t=t.initial,this.#e=t.context,this.#r=t.transitions,this.#s=t.transitions[t.initial]}send(t
|
|
1
|
+
var t=class{#t;#s;#n=0;#i=null;#e;#r;#o=[];constructor(t){this.#t=t.initial,this.#e=t.context,this.#r=t.transitions,this.#s=t.transitions[t.initial]}send(t,s){const n=this.#s[t];if(void 0===n)return this.#t;const i=this.#t;if(this.#t=n,this.#s=this.#r[n],null!==this.#i){const n=this.#i.get(i)?.get(t);void 0!==n&&n(s)}if(this.#n>0){const e={from:i,to:n,event:t,payload:s};for(const t of this.#o)null!==t&&t(e)}return this.#t}canSend(t){return void 0!==this.#s[t]}forceState(t){this.#t=t,this.#s=this.#r[t]}getState(){return this.#t}getContext(){return this.#e}on(t,s,n){this.#i??=new Map;let i=this.#i.get(t);return i||(i=new Map,this.#i.set(t,i)),i.set(s,n),()=>{this.#i?.get(t)?.delete(s)}}onTransition(t){const s=this.#o.indexOf(null);let n;-1===s?(n=this.#o.length,this.#o.push(t)):(this.#o[s]=t,n=s),this.#n++;let i=!0;return()=>{i&&(i=!1,this.#o[n]=null,this.#n--)}}};export{t as FSM};//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/fsm.ts"],"names":[],"mappings":";AAYO,IAAM,MAAN,MAKL;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA,GAAiB,CAAA;AAAA,EACjB,QAAA,
|
|
1
|
+
{"version":3,"sources":["../../src/fsm.ts"],"names":[],"mappings":";AAYO,IAAM,MAAN,MAKL;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA,GAAiB,CAAA;AAAA,EACjB,QAAA,GACE,IAAA;AAAA,EACO,QAAA;AAAA,EACA,YAAA;AAAA,EACA,aAIK,EAAC;AAAA,EAEf,YAAY,MAAA,EAA+C;AACzD,IAAA,IAAA,CAAK,SAAS,MAAA,CAAO,OAAA;AACrB,IAAA,IAAA,CAAK,WAAW,MAAA,CAAO,OAAA;AACvB,IAAA,IAAA,CAAK,eAAe,MAAA,CAAO,WAAA;AAC3B,IAAA,IAAA,CAAK,mBAAA,GAAsB,MAAA,CAAO,WAAA,CAAY,MAAA,CAAO,OAAO,CAAA;AAAA,EAC9D;AAAA,EAEA,IAAA,CAAK,OAAgB,OAAA,EAAyC;AAC5D,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,mBAAA,CAAoB,KAAK,CAAA;AAEhD,IAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,MAAA,OAAO,IAAA,CAAK,MAAA;AAAA,IACd;AAEA,IAAA,MAAM,OAAO,IAAA,CAAK,MAAA;AAElB,IAAA,IAAA,CAAK,MAAA,GAAS,SAAA;AACd,IAAA,IAAA,CAAK,mBAAA,GAAsB,IAAA,CAAK,YAAA,CAAa,SAAS,CAAA;AAEtD,IAAA,IAAI,IAAA,CAAK,aAAa,IAAA,EAAM;AAC1B,MAAA,MAAM,SAAS,IAAA,CAAK,QAAA,CAAS,IAAI,IAAI,CAAA,EAAG,IAAI,KAAK,CAAA;AAEjD,MAAA,IAAI,WAAW,MAAA,EAAW;AACxB,QAAA,MAAA,CAAO,OAAO,CAAA;AAAA,MAChB;AAAA,IACF;AAEA,IAAA,IAAI,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAC3B,MAAA,MAAM,IAAA,GAAsD;AAAA,QAC1D,IAAA;AAAA,QACA,EAAA,EAAI,SAAA;AAAA,QACJ,KAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,KAAA,MAAW,QAAA,IAAY,KAAK,UAAA,EAAY;AACtC,QAAA,IAAI,aAAa,IAAA,EAAM;AACrB,UAAA,QAAA,CAAS,IAAI,CAAA;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAEA,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEA,QAAQ,KAAA,EAAyB;AAC/B,IAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,KAAK,CAAA,KAAM,MAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,KAAA,EAAsB;AAC/B,IAAA,IAAA,CAAK,MAAA,GAAS,KAAA;AACd,IAAA,IAAA,CAAK,mBAAA,GAAsB,IAAA,CAAK,YAAA,CAAa,KAAK,CAAA;AAAA,EACpD;AAAA,EAEA,QAAA,GAAoB;AAClB,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEA,UAAA,GAAuB;AACrB,IAAA,OAAO,IAAA,CAAK,QAAA;AAAA,EACd;AAAA,EAEA,EAAA,CACE,IAAA,EACA,KAAA,EACA,MAAA,EAGY;AACZ,IAAA,IAAA,CAAK,QAAA,yBAAiB,GAAA,EAAI;AAE1B,IAAA,IAAI,YAAA,GAAe,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AAEzC,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA,YAAA,uBAAmB,GAAA,EAAI;AACvB,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAA,EAAM,YAAY,CAAA;AAAA,IACtC;AAEA,IAAA,YAAA,CAAa,GAAA,CAAI,OAAO,MAAoC,CAAA;AAE5D,IAAA,OAAO,MAAM;AACX,MAAA,IAAA,CAAK,QAAA,EAAU,GAAA,CAAI,IAAI,CAAA,EAAG,OAAO,KAAK,CAAA;AAAA,IACxC,CAAA;AAAA,EACF;AAAA,EAEA,aACE,QAAA,EACY;AACZ,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,UAAA,CAAW,OAAA,CAAQ,IAAI,CAAA;AAC9C,IAAA,IAAI,KAAA;AAEJ,IAAA,IAAI,cAAc,EAAA,EAAI;AACpB,MAAA,KAAA,GAAQ,KAAK,UAAA,CAAW,MAAA;AACxB,MAAA,IAAA,CAAK,UAAA,CAAW,KAAK,QAAQ,CAAA;AAAA,IAC/B,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,UAAA,CAAW,SAAS,CAAA,GAAI,QAAA;AAC7B,MAAA,KAAA,GAAQ,SAAA;AAAA,IACV;AAEA,IAAA,IAAA,CAAK,cAAA,EAAA;AACL,IAAA,IAAI,UAAA,GAAa,IAAA;AAEjB,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,CAAC,UAAA,EAAY;AACf,QAAA;AAAA,MACF;AAEA,MAAA,UAAA,GAAa,KAAA;AACb,MAAA,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,GAAI,IAAA;AACzB,MAAA,IAAA,CAAK,cAAA,EAAA;AAAA,IACP,CAAA;AAAA,EACF;AACF","file":"index.mjs","sourcesContent":["import type { FSMConfig, TransitionInfo, TransitionListener } from \"./types\";\n\n/**\n * Synchronous finite state machine engine.\n *\n * Reentrancy: `send()` inside `onTransition` listener is allowed but unbounded —\n * callers are responsible for preventing infinite loops.\n *\n * Exceptions: if a listener throws, the exception propagates to the caller.\n * State is already updated before listeners fire, so `getState()` reflects the\n * new state even if the exception escapes `send()`.\n */\nexport class FSM<\n TStates extends string,\n TEvents extends string,\n TContext,\n TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>,\n> {\n #state: TStates;\n #currentTransitions: Partial<Record<TEvents, TStates>>;\n #listenerCount = 0;\n #actions: Map<TStates, Map<TEvents, (payload: unknown) => void>> | null =\n null;\n readonly #context: TContext;\n readonly #transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;\n readonly #listeners: (TransitionListener<\n TStates,\n TEvents,\n TPayloadMap\n > | null)[] = [];\n\n constructor(config: FSMConfig<TStates, TEvents, TContext>) {\n this.#state = config.initial;\n this.#context = config.context;\n this.#transitions = config.transitions;\n this.#currentTransitions = config.transitions[config.initial];\n }\n\n send(event: TEvents, payload?: TPayloadMap[TEvents]): TStates {\n const nextState = this.#currentTransitions[event];\n\n if (nextState === undefined) {\n return this.#state;\n }\n\n const from = this.#state;\n\n this.#state = nextState;\n this.#currentTransitions = this.#transitions[nextState];\n\n if (this.#actions !== null) {\n const action = this.#actions.get(from)?.get(event);\n\n if (action !== undefined) {\n action(payload);\n }\n }\n\n if (this.#listenerCount > 0) {\n const info: TransitionInfo<TStates, TEvents, TPayloadMap> = {\n from,\n to: nextState,\n event,\n payload: payload,\n };\n\n for (const listener of this.#listeners) {\n if (listener !== null) {\n listener(info);\n }\n }\n }\n\n return this.#state;\n }\n\n canSend(event: TEvents): boolean {\n return this.#currentTransitions[event] !== undefined;\n }\n\n /**\n * Directly sets FSM state without triggering actions or listeners.\n * Use for hot-path optimizations where the caller handles side effects.\n */\n forceState(state: TStates): void {\n this.#state = state;\n this.#currentTransitions = this.#transitions[state];\n }\n\n getState(): TStates {\n return this.#state;\n }\n\n getContext(): TContext {\n return this.#context;\n }\n\n on<E extends TEvents>(\n from: TStates,\n event: E,\n action: E extends keyof TPayloadMap\n ? (payload: TPayloadMap[E]) => void\n : () => void,\n ): () => void {\n this.#actions ??= new Map();\n\n let stateActions = this.#actions.get(from);\n\n if (!stateActions) {\n stateActions = new Map();\n this.#actions.set(from, stateActions);\n }\n\n stateActions.set(event, action as (payload: unknown) => void);\n\n return () => {\n this.#actions?.get(from)?.delete(event);\n };\n }\n\n onTransition(\n listener: (info: TransitionInfo<TStates, TEvents, TPayloadMap>) => void,\n ): () => void {\n const nullIndex = this.#listeners.indexOf(null);\n let index: number;\n\n if (nullIndex === -1) {\n index = this.#listeners.length;\n this.#listeners.push(listener);\n } else {\n this.#listeners[nullIndex] = listener;\n index = nullIndex;\n }\n\n this.#listenerCount++;\n let subscribed = true;\n\n return () => {\n if (!subscribed) {\n return;\n }\n\n subscribed = false;\n this.#listeners[index] = null;\n this.#listenerCount--;\n };\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"src/fsm.ts":{"bytes":
|
|
1
|
+
{"inputs":{"src/fsm.ts":{"bytes":3754,"imports":[],"format":"esm"},"src/index.ts":{"bytes":88,"imports":[{"path":"src/fsm.ts","kind":"import-statement","original":"./fsm"}],"format":"esm"}},"outputs":{"dist/esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5670},"dist/esm/index.mjs":{"imports":[],"exports":["FSM"],"entryPoint":"src/index.ts","inputs":{"src/fsm.ts":{"bytesInOutput":2378},"src/index.ts":{"bytesInOutput":0}},"bytes":2410}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@real-router/fsm",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "Universal synchronous FSM engine for Real-Router",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"types": "./dist/esm/index.d.mts",
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
11
|
+
"development": "./src/index.ts",
|
|
11
12
|
"types": {
|
|
12
13
|
"import": "./dist/esm/index.d.mts",
|
|
13
14
|
"require": "./dist/cjs/index.d.ts"
|
|
@@ -17,7 +18,8 @@
|
|
|
17
18
|
}
|
|
18
19
|
},
|
|
19
20
|
"files": [
|
|
20
|
-
"dist"
|
|
21
|
+
"dist",
|
|
22
|
+
"src"
|
|
21
23
|
],
|
|
22
24
|
"repository": {
|
|
23
25
|
"type": "git",
|
|
@@ -40,11 +42,9 @@
|
|
|
40
42
|
},
|
|
41
43
|
"homepage": "https://github.com/greydragon888/real-router",
|
|
42
44
|
"sideEffects": false,
|
|
43
|
-
"devDependencies": {
|
|
44
|
-
"mitata": "1.0.34"
|
|
45
|
-
},
|
|
46
45
|
"scripts": {
|
|
47
46
|
"test": "vitest",
|
|
47
|
+
"test:properties": "vitest --config vitest.config.properties.mts --run",
|
|
48
48
|
"build": "tsup",
|
|
49
49
|
"type-check": "tsc --noEmit",
|
|
50
50
|
"lint": "eslint --cache --ext .ts src/ tests/ --fix --max-warnings 0",
|
package/src/fsm.ts
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import type { FSMConfig, TransitionInfo, TransitionListener } from "./types";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Synchronous finite state machine engine.
|
|
5
|
+
*
|
|
6
|
+
* Reentrancy: `send()` inside `onTransition` listener is allowed but unbounded —
|
|
7
|
+
* callers are responsible for preventing infinite loops.
|
|
8
|
+
*
|
|
9
|
+
* Exceptions: if a listener throws, the exception propagates to the caller.
|
|
10
|
+
* State is already updated before listeners fire, so `getState()` reflects the
|
|
11
|
+
* new state even if the exception escapes `send()`.
|
|
12
|
+
*/
|
|
13
|
+
export class FSM<
|
|
14
|
+
TStates extends string,
|
|
15
|
+
TEvents extends string,
|
|
16
|
+
TContext,
|
|
17
|
+
TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>,
|
|
18
|
+
> {
|
|
19
|
+
#state: TStates;
|
|
20
|
+
#currentTransitions: Partial<Record<TEvents, TStates>>;
|
|
21
|
+
#listenerCount = 0;
|
|
22
|
+
#actions: Map<TStates, Map<TEvents, (payload: unknown) => void>> | null =
|
|
23
|
+
null;
|
|
24
|
+
readonly #context: TContext;
|
|
25
|
+
readonly #transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;
|
|
26
|
+
readonly #listeners: (TransitionListener<
|
|
27
|
+
TStates,
|
|
28
|
+
TEvents,
|
|
29
|
+
TPayloadMap
|
|
30
|
+
> | null)[] = [];
|
|
31
|
+
|
|
32
|
+
constructor(config: FSMConfig<TStates, TEvents, TContext>) {
|
|
33
|
+
this.#state = config.initial;
|
|
34
|
+
this.#context = config.context;
|
|
35
|
+
this.#transitions = config.transitions;
|
|
36
|
+
this.#currentTransitions = config.transitions[config.initial];
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
send(event: TEvents, payload?: TPayloadMap[TEvents]): TStates {
|
|
40
|
+
const nextState = this.#currentTransitions[event];
|
|
41
|
+
|
|
42
|
+
if (nextState === undefined) {
|
|
43
|
+
return this.#state;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
const from = this.#state;
|
|
47
|
+
|
|
48
|
+
this.#state = nextState;
|
|
49
|
+
this.#currentTransitions = this.#transitions[nextState];
|
|
50
|
+
|
|
51
|
+
if (this.#actions !== null) {
|
|
52
|
+
const action = this.#actions.get(from)?.get(event);
|
|
53
|
+
|
|
54
|
+
if (action !== undefined) {
|
|
55
|
+
action(payload);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
if (this.#listenerCount > 0) {
|
|
60
|
+
const info: TransitionInfo<TStates, TEvents, TPayloadMap> = {
|
|
61
|
+
from,
|
|
62
|
+
to: nextState,
|
|
63
|
+
event,
|
|
64
|
+
payload: payload,
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
for (const listener of this.#listeners) {
|
|
68
|
+
if (listener !== null) {
|
|
69
|
+
listener(info);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return this.#state;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
canSend(event: TEvents): boolean {
|
|
78
|
+
return this.#currentTransitions[event] !== undefined;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Directly sets FSM state without triggering actions or listeners.
|
|
83
|
+
* Use for hot-path optimizations where the caller handles side effects.
|
|
84
|
+
*/
|
|
85
|
+
forceState(state: TStates): void {
|
|
86
|
+
this.#state = state;
|
|
87
|
+
this.#currentTransitions = this.#transitions[state];
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
getState(): TStates {
|
|
91
|
+
return this.#state;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
getContext(): TContext {
|
|
95
|
+
return this.#context;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
on<E extends TEvents>(
|
|
99
|
+
from: TStates,
|
|
100
|
+
event: E,
|
|
101
|
+
action: E extends keyof TPayloadMap
|
|
102
|
+
? (payload: TPayloadMap[E]) => void
|
|
103
|
+
: () => void,
|
|
104
|
+
): () => void {
|
|
105
|
+
this.#actions ??= new Map();
|
|
106
|
+
|
|
107
|
+
let stateActions = this.#actions.get(from);
|
|
108
|
+
|
|
109
|
+
if (!stateActions) {
|
|
110
|
+
stateActions = new Map();
|
|
111
|
+
this.#actions.set(from, stateActions);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
stateActions.set(event, action as (payload: unknown) => void);
|
|
115
|
+
|
|
116
|
+
return () => {
|
|
117
|
+
this.#actions?.get(from)?.delete(event);
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
onTransition(
|
|
122
|
+
listener: (info: TransitionInfo<TStates, TEvents, TPayloadMap>) => void,
|
|
123
|
+
): () => void {
|
|
124
|
+
const nullIndex = this.#listeners.indexOf(null);
|
|
125
|
+
let index: number;
|
|
126
|
+
|
|
127
|
+
if (nullIndex === -1) {
|
|
128
|
+
index = this.#listeners.length;
|
|
129
|
+
this.#listeners.push(listener);
|
|
130
|
+
} else {
|
|
131
|
+
this.#listeners[nullIndex] = listener;
|
|
132
|
+
index = nullIndex;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
this.#listenerCount++;
|
|
136
|
+
let subscribed = true;
|
|
137
|
+
|
|
138
|
+
return () => {
|
|
139
|
+
if (!subscribed) {
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
subscribed = false;
|
|
144
|
+
this.#listeners[index] = null;
|
|
145
|
+
this.#listenerCount--;
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
}
|
package/src/index.ts
ADDED
package/src/types.ts
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export interface FSMConfig<
|
|
2
|
+
TStates extends string,
|
|
3
|
+
TEvents extends string,
|
|
4
|
+
TContext,
|
|
5
|
+
> {
|
|
6
|
+
initial: TStates;
|
|
7
|
+
context: TContext;
|
|
8
|
+
transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export interface TransitionInfo<
|
|
12
|
+
TStates extends string,
|
|
13
|
+
TEvents extends string,
|
|
14
|
+
TPayloadMap extends Partial<Record<TEvents, unknown>>,
|
|
15
|
+
> {
|
|
16
|
+
from: TStates;
|
|
17
|
+
to: TStates;
|
|
18
|
+
event: TEvents;
|
|
19
|
+
payload: TPayloadMap[TEvents] | undefined;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export type TransitionListener<
|
|
23
|
+
TStates extends string,
|
|
24
|
+
TEvents extends string,
|
|
25
|
+
TPayloadMap extends Partial<Record<TEvents, unknown>>,
|
|
26
|
+
> = (info: TransitionInfo<TStates, TEvents, TPayloadMap>) => void;
|