@real-router/fsm 0.4.0 → 0.5.0
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 +1 -1
- package/dist/cjs/index.d.ts +9 -5
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.d.mts +9 -5
- package/dist/esm/index.d.mts.map +1 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/index.mjs.map +1 -1
- package/package.json +4 -5
- package/src/fsm.ts +0 -154
- package/src/index.ts +0 -3
- package/src/types.ts +0 -26
package/README.md
CHANGED
|
@@ -40,7 +40,7 @@ fsm.getContext(); // { count: 0 }
|
|
|
40
40
|
| `getContext()` | Context object (same reference as config) |
|
|
41
41
|
| `onTransition(listener)` | Subscribe to transitions, returns unsubscribe |
|
|
42
42
|
| `on(from, event, action)` | Register action for specific `(from, event)` pair |
|
|
43
|
-
| `forceState(state)` | Direct state update — no actions, no listeners |
|
|
43
|
+
| `forceState(state)` | Direct state update — no actions, no listeners; throws on an undeclared state |
|
|
44
44
|
|
|
45
45
|
### Type-Safe Payloads
|
|
46
46
|
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -4,12 +4,12 @@ interface FSMConfig<TStates extends string, TEvents extends string, TContext> {
|
|
|
4
4
|
context: TContext;
|
|
5
5
|
transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;
|
|
6
6
|
}
|
|
7
|
-
|
|
7
|
+
type TransitionInfo<TStates extends string, TEvents extends string, TPayloadMap extends Partial<Record<TEvents, unknown>>> = TEvents extends infer E extends TEvents ? {
|
|
8
8
|
from: TStates;
|
|
9
9
|
to: TStates;
|
|
10
|
-
event:
|
|
11
|
-
payload: TPayloadMap[
|
|
12
|
-
}
|
|
10
|
+
event: E;
|
|
11
|
+
payload: E extends keyof TPayloadMap ? TPayloadMap[E] : undefined;
|
|
12
|
+
} : never;
|
|
13
13
|
//#endregion
|
|
14
14
|
//#region src/fsm.d.ts
|
|
15
15
|
/**
|
|
@@ -25,11 +25,15 @@ interface TransitionInfo<TStates extends string, TEvents extends string, TPayloa
|
|
|
25
25
|
declare class FSM<TStates extends string, TEvents extends string, TContext, TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>> {
|
|
26
26
|
#private;
|
|
27
27
|
constructor(config: FSMConfig<TStates, TEvents, TContext>);
|
|
28
|
-
send(event:
|
|
28
|
+
send<E extends TEvents>(event: E, ...args: E extends keyof TPayloadMap ? [TPayloadMap[E]] : [undefined?]): TStates;
|
|
29
29
|
canSend(event: TEvents): boolean;
|
|
30
30
|
/**
|
|
31
31
|
* Directly sets FSM state without triggering actions or listeners.
|
|
32
32
|
* Use for hot-path optimizations where the caller handles side effects.
|
|
33
|
+
*
|
|
34
|
+
* Throws if `state` is not declared in `config.transitions`: an undeclared
|
|
35
|
+
* state would leave `#currentTransitions` undefined and brick the next
|
|
36
|
+
* `canSend`/`send`. The state is left unchanged when the guard rejects.
|
|
33
37
|
*/
|
|
34
38
|
forceState(state: TStates): void;
|
|
35
39
|
getState(): TStates;
|
package/dist/cjs/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/fsm.ts"],"mappings":";UAAiB,SAAA;EAKf,OAAA,EAAS,OAAA;EACT,OAAA,EAAS,QAAA;EACT,WAAA,EAAa,MAAA,CAAO,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,OAAA,EAAS,OAAA;AAAA;AAAA,
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/fsm.ts"],"mappings":";UAAiB,SAAA;EAKf,OAAA,EAAS,OAAA;EACT,OAAA,EAAS,QAAA;EACT,WAAA,EAAa,MAAA,CAAO,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,OAAA,EAAS,OAAA;AAAA;AAAA,KAG3C,cAAA,qEAGU,OAAA,CAAQ,MAAA,CAAO,OAAA,eACjC,OAAA,yBAAgC,OAAA;EAE9B,IAAA,EAAM,OAAA;EACN,EAAA,EAAI,OAAA;EACJ,KAAA,EAAO,CAAA;EACP,OAAA,EAAS,CAAA,eAAgB,WAAA,GAAc,WAAA,CAAY,CAAA;AAAA;;;AAnBzD;;;;;;;;;;AAAA,cCoCa,GAAA,+EAIS,OAAA,CAAQ,MAAA,CAAO,OAAA,cAAqB,MAAA;EAAA;cAe5C,MAAA,EAAQ,SAAA,CAAU,OAAA,EAAS,OAAA,EAAS,QAAA;EAWhD,IAAA,WAAe,OAAA,EACb,KAAA,EAAO,CAAA,KACJ,IAAA,EAAM,CAAA,eAAgB,WAAA,IAAe,WAAA,CAAY,CAAA,oBACnD,OAAA;EA4CH,OAAA,CAAQ,KAAA,EAAO,OAAA;ED9Gf;;;;;;;;EC0HA,UAAA,CAAW,KAAA,EAAO,OAAA;EAOlB,QAAA,IAAY,OAAA;EAIZ,UAAA,IAAc,QAAA;EAId,EAAA,WAAa,OAAA,EACX,IAAA,EAAM,OAAA,EACN,KAAA,EAAO,CAAA,EACP,MAAA,EAAQ,CAAA,eAAgB,WAAA,IACnB,OAAA,EAAS,WAAA,CAAY,CAAA;EA2B5B,YAAA,CACE,QAAA,GAAW,IAAA,EAAM,cAAA,CAAe,OAAA,EAAS,OAAA,EAAS,WAAA;AAAA"}
|
package/dist/cjs/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});
|
|
1
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e,t,n){let r=e[t];if(r===void 0)throw Error(`[FSM.${n}] state "${t}" is not declared in config.transitions`);return r}var t=class{#e;#t;#n=0;#r=null;#i;#a;#o=[];constructor(t){this.#e=t.initial,this.#i=t.context,this.#a=t.transitions,this.#t=e(t.transitions,t.initial,`constructor`)}send(e,...t){let n=this.#t[e];if(n===void 0)return this.#e;let r=this.#e;this.#e=n,this.#t=this.#a[n];let i=t[0];if(this.#r!==null){let t=this.#r.get(r)?.get(e);t!==void 0&&t(i)}if(this.#n>0){let t={from:r,to:n,event:e,payload:i};for(let e of this.#o)e!==null&&e(t)}return this.#e}canSend(e){return this.#t[e]!==void 0}forceState(t){let n=e(this.#a,t,`forceState`);this.#e=t,this.#t=n}getState(){return this.#e}getContext(){return this.#i}on(t,n,r){e(this.#a,t,`on`),this.#r??=new Map;let i=this.#r.get(t);i||(i=new Map,this.#r.set(t,i));let a=r;return i.set(n,a),()=>{let e=this.#r?.get(t);e?.get(n)===a&&e.delete(n)}}onTransition(e){let t=this.#o.indexOf(null),n;t===-1?(n=this.#o.length,this.#o.push(e)):(this.#o[t]=e,n=t),this.#n++;let r=!0;return()=>{r&&(r=!1,this.#o[n]=null,this.#n--)}}};exports.FSM=t;
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["#context","#transitions","#listeners","#state","#currentTransitions","#actions","#listenerCount"],"sources":["../../src/fsm.ts"],"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
|
|
1
|
+
{"version":3,"file":"index.js","names":["#context","#transitions","#listeners","#state","#currentTransitions","#actions","#listenerCount"],"sources":["../../src/fsm.ts"],"sourcesContent":["import type { FSMConfig, TransitionInfo, TransitionListener } from \"./types\";\n\n/**\n * Shared guard for the engine-wide invariant \"the state is declared in\n * `config.transitions`\". Applied at every state-entry-point (constructor\n * `initial`, `forceState`, `on`'s `from`) so an undeclared state fails loud with\n * an explicit error instead of bricking the FSM or dead-registering an action\n * (#885). Returns the state's transition map for the caller to reuse.\n */\nfunction requireDeclared<TStates extends string, TEvents extends string>(\n transitions: Record<TStates, Partial<Record<TEvents, TStates>>>,\n state: TStates,\n where: string,\n): Partial<Record<TEvents, TStates>> {\n const stateTransitions = transitions[state];\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- runtime guard for JS / cast / string-typed callers passing a state outside TStates\n if (stateTransitions === undefined) {\n throw new Error(\n `[FSM.${where}] state \"${state}\" is not declared in config.transitions`,\n );\n }\n\n return stateTransitions;\n}\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 = requireDeclared(\n config.transitions,\n config.initial,\n \"constructor\",\n );\n }\n\n send<E extends TEvents>(\n event: E,\n ...args: E extends keyof TPayloadMap ? [TPayloadMap[E]] : [undefined?]\n ): 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 const payload = args[0] as TPayloadMap[TEvents] | undefined;\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 // `info` is structurally a valid TransitionInfo, but the distributive\n // union can't be matched to one variant while `event`/`payload` are\n // generic here — erase through `unknown` (TS2352), same spirit as the\n // `args[0]` cast above.\n const info = {\n from,\n to: nextState,\n event,\n payload,\n } as unknown as TransitionInfo<TStates, TEvents, TPayloadMap>;\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 * Throws if `state` is not declared in `config.transitions`: an undeclared\n * state would leave `#currentTransitions` undefined and brick the next\n * `canSend`/`send`. The state is left unchanged when the guard rejects.\n */\n forceState(state: TStates): void {\n const transitions = requireDeclared(this.#transitions, state, \"forceState\");\n\n this.#state = state;\n this.#currentTransitions = transitions;\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 requireDeclared(this.#transitions, from, \"on\");\n\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 const capturedAction = action as (payload: unknown) => void;\n\n stateActions.set(event, capturedAction);\n\n return () => {\n const stateMap = this.#actions?.get(from);\n\n if (stateMap?.get(event) === capturedAction) {\n stateMap.delete(event);\n }\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"],"mappings":"mEASA,SAAS,EACP,EACA,EACA,EACmC,CACnC,IAAM,EAAmB,EAAY,GAGrC,GAAI,IAAqB,IAAA,GACvB,MAAU,MACR,QAAQ,EAAM,WAAW,EAAM,wCACjC,EAGF,OAAO,CACT,CAYA,IAAa,EAAb,KAKE,CACA,GACA,GACA,GAAiB,EACjB,GACE,KACF,GACA,GACA,GAIc,CAAC,EAEf,YAAY,EAA+C,CACzD,KAAKG,GAAS,EAAO,QACrB,KAAKH,GAAW,EAAO,QACvB,KAAKC,GAAe,EAAO,YAC3B,KAAKG,GAAsB,EACzB,EAAO,YACP,EAAO,QACP,aACF,CACF,CAEA,KACE,EACA,GAAG,EACM,CACT,IAAM,EAAY,KAAKA,GAAoB,GAE3C,GAAI,IAAc,IAAA,GAChB,OAAO,KAAKD,GAGd,IAAM,EAAO,KAAKA,GAElB,KAAKA,GAAS,EACd,KAAKC,GAAsB,KAAKH,GAAa,GAE7C,IAAM,EAAU,EAAK,GAErB,GAAI,KAAKI,KAAa,KAAM,CAC1B,IAAM,EAAS,KAAKA,GAAS,IAAI,CAAI,CAAC,EAAE,IAAI,CAAK,EAE7C,IAAW,IAAA,IACb,EAAO,CAAO,CAElB,CAEA,GAAI,KAAKC,GAAiB,EAAG,CAK3B,IAAM,EAAO,CACX,OACA,GAAI,EACJ,QACA,SACF,EAEA,IAAK,IAAM,KAAY,KAAKJ,GACtB,IAAa,MACf,EAAS,CAAI,CAGnB,CAEA,OAAO,KAAKC,EACd,CAEA,QAAQ,EAAyB,CAC/B,OAAO,KAAKC,GAAoB,KAAW,IAAA,EAC7C,CAUA,WAAW,EAAsB,CAC/B,IAAM,EAAc,EAAgB,KAAKH,GAAc,EAAO,YAAY,EAE1E,KAAKE,GAAS,EACd,KAAKC,GAAsB,CAC7B,CAEA,UAAoB,CAClB,OAAO,KAAKD,EACd,CAEA,YAAuB,CACrB,OAAO,KAAKH,EACd,CAEA,GACE,EACA,EACA,EAGY,CACZ,EAAgB,KAAKC,GAAc,EAAM,IAAI,EAE7C,KAAKI,KAAa,IAAI,IAEtB,IAAI,EAAe,KAAKA,GAAS,IAAI,CAAI,EAEpC,IACH,EAAe,IAAI,IACnB,KAAKA,GAAS,IAAI,EAAM,CAAY,GAGtC,IAAM,EAAiB,EAIvB,OAFA,EAAa,IAAI,EAAO,CAAc,MAEzB,CACX,IAAM,EAAW,KAAKA,IAAU,IAAI,CAAI,EAEpC,GAAU,IAAI,CAAK,IAAM,GAC3B,EAAS,OAAO,CAAK,CAEzB,CACF,CAEA,aACE,EACY,CACZ,IAAM,EAAY,KAAKH,GAAW,QAAQ,IAAI,EAC1C,EAEA,IAAc,IAChB,EAAQ,KAAKA,GAAW,OACxB,KAAKA,GAAW,KAAK,CAAQ,IAE7B,KAAKA,GAAW,GAAa,EAC7B,EAAQ,GAGV,KAAKI,KACL,IAAI,EAAa,GAEjB,UAAa,CACN,IAIL,EAAa,GACb,KAAKJ,GAAW,GAAS,KACzB,KAAKI,KACP,CACF,CACF"}
|
package/dist/esm/index.d.mts
CHANGED
|
@@ -4,12 +4,12 @@ interface FSMConfig<TStates extends string, TEvents extends string, TContext> {
|
|
|
4
4
|
context: TContext;
|
|
5
5
|
transitions: Record<TStates, Partial<Record<TEvents, TStates>>>;
|
|
6
6
|
}
|
|
7
|
-
|
|
7
|
+
type TransitionInfo<TStates extends string, TEvents extends string, TPayloadMap extends Partial<Record<TEvents, unknown>>> = TEvents extends infer E extends TEvents ? {
|
|
8
8
|
from: TStates;
|
|
9
9
|
to: TStates;
|
|
10
|
-
event:
|
|
11
|
-
payload: TPayloadMap[
|
|
12
|
-
}
|
|
10
|
+
event: E;
|
|
11
|
+
payload: E extends keyof TPayloadMap ? TPayloadMap[E] : undefined;
|
|
12
|
+
} : never;
|
|
13
13
|
//#endregion
|
|
14
14
|
//#region src/fsm.d.ts
|
|
15
15
|
/**
|
|
@@ -25,11 +25,15 @@ interface TransitionInfo<TStates extends string, TEvents extends string, TPayloa
|
|
|
25
25
|
declare class FSM<TStates extends string, TEvents extends string, TContext, TPayloadMap extends Partial<Record<TEvents, unknown>> = Record<never, never>> {
|
|
26
26
|
#private;
|
|
27
27
|
constructor(config: FSMConfig<TStates, TEvents, TContext>);
|
|
28
|
-
send(event:
|
|
28
|
+
send<E extends TEvents>(event: E, ...args: E extends keyof TPayloadMap ? [TPayloadMap[E]] : [undefined?]): TStates;
|
|
29
29
|
canSend(event: TEvents): boolean;
|
|
30
30
|
/**
|
|
31
31
|
* Directly sets FSM state without triggering actions or listeners.
|
|
32
32
|
* Use for hot-path optimizations where the caller handles side effects.
|
|
33
|
+
*
|
|
34
|
+
* Throws if `state` is not declared in `config.transitions`: an undeclared
|
|
35
|
+
* state would leave `#currentTransitions` undefined and brick the next
|
|
36
|
+
* `canSend`/`send`. The state is left unchanged when the guard rejects.
|
|
33
37
|
*/
|
|
34
38
|
forceState(state: TStates): void;
|
|
35
39
|
getState(): TStates;
|
package/dist/esm/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/types.ts","../../src/fsm.ts"],"mappings":";UAAiB,SAAA;EAKf,OAAA,EAAS,OAAA;EACT,OAAA,EAAS,QAAA;EACT,WAAA,EAAa,MAAA,CAAO,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,OAAA,EAAS,OAAA;AAAA;AAAA,
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/types.ts","../../src/fsm.ts"],"mappings":";UAAiB,SAAA;EAKf,OAAA,EAAS,OAAA;EACT,OAAA,EAAS,QAAA;EACT,WAAA,EAAa,MAAA,CAAO,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,OAAA,EAAS,OAAA;AAAA;AAAA,KAG3C,cAAA,qEAGU,OAAA,CAAQ,MAAA,CAAO,OAAA,eACjC,OAAA,yBAAgC,OAAA;EAE9B,IAAA,EAAM,OAAA;EACN,EAAA,EAAI,OAAA;EACJ,KAAA,EAAO,CAAA;EACP,OAAA,EAAS,CAAA,eAAgB,WAAA,GAAc,WAAA,CAAY,CAAA;AAAA;;;AAnBzD;;;;;;;;;;AAAA,cCoCa,GAAA,+EAIS,OAAA,CAAQ,MAAA,CAAO,OAAA,cAAqB,MAAA;EAAA;cAe5C,MAAA,EAAQ,SAAA,CAAU,OAAA,EAAS,OAAA,EAAS,QAAA;EAWhD,IAAA,WAAe,OAAA,EACb,KAAA,EAAO,CAAA,KACJ,IAAA,EAAM,CAAA,eAAgB,WAAA,IAAe,WAAA,CAAY,CAAA,oBACnD,OAAA;EA4CH,OAAA,CAAQ,KAAA,EAAO,OAAA;ED9Gf;;;;;;;;EC0HA,UAAA,CAAW,KAAA,EAAO,OAAA;EAOlB,QAAA,IAAY,OAAA;EAIZ,UAAA,IAAc,QAAA;EAId,EAAA,WAAa,OAAA,EACX,IAAA,EAAM,OAAA,EACN,KAAA,EAAO,CAAA,EACP,MAAA,EAAQ,CAAA,eAAgB,WAAA,IACnB,OAAA,EAAS,WAAA,CAAY,CAAA;EA2B5B,YAAA,CACE,QAAA,GAAW,IAAA,EAAM,cAAA,CAAe,OAAA,EAAS,OAAA,EAAS,WAAA;AAAA"}
|
package/dist/esm/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
function e(e,t,n){let r=e[t];if(r===void 0)throw Error(`[FSM.${n}] state "${t}" is not declared in config.transitions`);return r}var t=class{#e;#t;#n=0;#r=null;#i;#a;#o=[];constructor(t){this.#e=t.initial,this.#i=t.context,this.#a=t.transitions,this.#t=e(t.transitions,t.initial,`constructor`)}send(e,...t){let n=this.#t[e];if(n===void 0)return this.#e;let r=this.#e;this.#e=n,this.#t=this.#a[n];let i=t[0];if(this.#r!==null){let t=this.#r.get(r)?.get(e);t!==void 0&&t(i)}if(this.#n>0){let t={from:r,to:n,event:e,payload:i};for(let e of this.#o)e!==null&&e(t)}return this.#e}canSend(e){return this.#t[e]!==void 0}forceState(t){let n=e(this.#a,t,`forceState`);this.#e=t,this.#t=n}getState(){return this.#e}getContext(){return this.#i}on(t,n,r){e(this.#a,t,`on`),this.#r??=new Map;let i=this.#r.get(t);i||(i=new Map,this.#r.set(t,i));let a=r;return i.set(n,a),()=>{let e=this.#r?.get(t);e?.get(n)===a&&e.delete(n)}}onTransition(e){let t=this.#o.indexOf(null),n;t===-1?(n=this.#o.length,this.#o.push(e)):(this.#o[t]=e,n=t),this.#n++;let r=!0;return()=>{r&&(r=!1,this.#o[n]=null,this.#n--)}}};export{t as FSM};
|
|
2
2
|
//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["#context","#transitions","#listeners","#state","#currentTransitions","#actions","#listenerCount"],"sources":["../../src/fsm.ts"],"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
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["#context","#transitions","#listeners","#state","#currentTransitions","#actions","#listenerCount"],"sources":["../../src/fsm.ts"],"sourcesContent":["import type { FSMConfig, TransitionInfo, TransitionListener } from \"./types\";\n\n/**\n * Shared guard for the engine-wide invariant \"the state is declared in\n * `config.transitions`\". Applied at every state-entry-point (constructor\n * `initial`, `forceState`, `on`'s `from`) so an undeclared state fails loud with\n * an explicit error instead of bricking the FSM or dead-registering an action\n * (#885). Returns the state's transition map for the caller to reuse.\n */\nfunction requireDeclared<TStates extends string, TEvents extends string>(\n transitions: Record<TStates, Partial<Record<TEvents, TStates>>>,\n state: TStates,\n where: string,\n): Partial<Record<TEvents, TStates>> {\n const stateTransitions = transitions[state];\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- runtime guard for JS / cast / string-typed callers passing a state outside TStates\n if (stateTransitions === undefined) {\n throw new Error(\n `[FSM.${where}] state \"${state}\" is not declared in config.transitions`,\n );\n }\n\n return stateTransitions;\n}\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 = requireDeclared(\n config.transitions,\n config.initial,\n \"constructor\",\n );\n }\n\n send<E extends TEvents>(\n event: E,\n ...args: E extends keyof TPayloadMap ? [TPayloadMap[E]] : [undefined?]\n ): 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 const payload = args[0] as TPayloadMap[TEvents] | undefined;\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 // `info` is structurally a valid TransitionInfo, but the distributive\n // union can't be matched to one variant while `event`/`payload` are\n // generic here — erase through `unknown` (TS2352), same spirit as the\n // `args[0]` cast above.\n const info = {\n from,\n to: nextState,\n event,\n payload,\n } as unknown as TransitionInfo<TStates, TEvents, TPayloadMap>;\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 * Throws if `state` is not declared in `config.transitions`: an undeclared\n * state would leave `#currentTransitions` undefined and brick the next\n * `canSend`/`send`. The state is left unchanged when the guard rejects.\n */\n forceState(state: TStates): void {\n const transitions = requireDeclared(this.#transitions, state, \"forceState\");\n\n this.#state = state;\n this.#currentTransitions = transitions;\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 requireDeclared(this.#transitions, from, \"on\");\n\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 const capturedAction = action as (payload: unknown) => void;\n\n stateActions.set(event, capturedAction);\n\n return () => {\n const stateMap = this.#actions?.get(from);\n\n if (stateMap?.get(event) === capturedAction) {\n stateMap.delete(event);\n }\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"],"mappings":"AASA,SAAS,EACP,EACA,EACA,EACmC,CACnC,IAAM,EAAmB,EAAY,GAGrC,GAAI,IAAqB,IAAA,GACvB,MAAU,MACR,QAAQ,EAAM,WAAW,EAAM,wCACjC,EAGF,OAAO,CACT,CAYA,IAAa,EAAb,KAKE,CACA,GACA,GACA,GAAiB,EACjB,GACE,KACF,GACA,GACA,GAIc,CAAC,EAEf,YAAY,EAA+C,CACzD,KAAKG,GAAS,EAAO,QACrB,KAAKH,GAAW,EAAO,QACvB,KAAKC,GAAe,EAAO,YAC3B,KAAKG,GAAsB,EACzB,EAAO,YACP,EAAO,QACP,aACF,CACF,CAEA,KACE,EACA,GAAG,EACM,CACT,IAAM,EAAY,KAAKA,GAAoB,GAE3C,GAAI,IAAc,IAAA,GAChB,OAAO,KAAKD,GAGd,IAAM,EAAO,KAAKA,GAElB,KAAKA,GAAS,EACd,KAAKC,GAAsB,KAAKH,GAAa,GAE7C,IAAM,EAAU,EAAK,GAErB,GAAI,KAAKI,KAAa,KAAM,CAC1B,IAAM,EAAS,KAAKA,GAAS,IAAI,CAAI,CAAC,EAAE,IAAI,CAAK,EAE7C,IAAW,IAAA,IACb,EAAO,CAAO,CAElB,CAEA,GAAI,KAAKC,GAAiB,EAAG,CAK3B,IAAM,EAAO,CACX,OACA,GAAI,EACJ,QACA,SACF,EAEA,IAAK,IAAM,KAAY,KAAKJ,GACtB,IAAa,MACf,EAAS,CAAI,CAGnB,CAEA,OAAO,KAAKC,EACd,CAEA,QAAQ,EAAyB,CAC/B,OAAO,KAAKC,GAAoB,KAAW,IAAA,EAC7C,CAUA,WAAW,EAAsB,CAC/B,IAAM,EAAc,EAAgB,KAAKH,GAAc,EAAO,YAAY,EAE1E,KAAKE,GAAS,EACd,KAAKC,GAAsB,CAC7B,CAEA,UAAoB,CAClB,OAAO,KAAKD,EACd,CAEA,YAAuB,CACrB,OAAO,KAAKH,EACd,CAEA,GACE,EACA,EACA,EAGY,CACZ,EAAgB,KAAKC,GAAc,EAAM,IAAI,EAE7C,KAAKI,KAAa,IAAI,IAEtB,IAAI,EAAe,KAAKA,GAAS,IAAI,CAAI,EAEpC,IACH,EAAe,IAAI,IACnB,KAAKA,GAAS,IAAI,EAAM,CAAY,GAGtC,IAAM,EAAiB,EAIvB,OAFA,EAAa,IAAI,EAAO,CAAc,MAEzB,CACX,IAAM,EAAW,KAAKA,IAAU,IAAI,CAAI,EAEpC,GAAU,IAAI,CAAK,IAAM,GAC3B,EAAS,OAAO,CAAK,CAEzB,CACF,CAEA,aACE,EACY,CACZ,IAAM,EAAY,KAAKH,GAAW,QAAQ,IAAI,EAC1C,EAEA,IAAc,IAChB,EAAQ,KAAKA,GAAW,OACxB,KAAKA,GAAW,KAAK,CAAQ,IAE7B,KAAKA,GAAW,GAAa,EAC7B,EAAQ,GAGV,KAAKI,KACL,IAAI,EAAa,GAEjB,UAAa,CACN,IAIL,EAAa,GACb,KAAKJ,GAAW,GAAS,KACzB,KAAKI,KACP,CACF,CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@real-router/fsm",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "Universal synchronous FSM engine for Real-Router",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -18,8 +18,7 @@
|
|
|
18
18
|
}
|
|
19
19
|
},
|
|
20
20
|
"files": [
|
|
21
|
-
"dist"
|
|
22
|
-
"src"
|
|
21
|
+
"dist"
|
|
23
22
|
],
|
|
24
23
|
"repository": {
|
|
25
24
|
"type": "git",
|
|
@@ -45,11 +44,11 @@
|
|
|
45
44
|
"scripts": {
|
|
46
45
|
"test": "vitest",
|
|
47
46
|
"test:properties": "vitest --config vitest.config.properties.mts --run",
|
|
48
|
-
"build": "tsdown --config-loader unrun",
|
|
49
47
|
"type-check": "tsc --noEmit",
|
|
50
48
|
"lint": "eslint --cache --ext .ts src/ tests/ --fix --max-warnings 0",
|
|
51
49
|
"lint:package": "publint",
|
|
52
50
|
"lint:types": "attw --pack .",
|
|
53
|
-
"bench": "NODE_OPTIONS='--expose-gc --max-old-space-size=4096' npx tsx tests/benchmarks/index.ts"
|
|
51
|
+
"bench": "NODE_OPTIONS='--expose-gc --max-old-space-size=4096' npx tsx tests/benchmarks/index.ts",
|
|
52
|
+
"bundle": "tsdown --config-loader unrun"
|
|
54
53
|
}
|
|
55
54
|
}
|
package/src/fsm.ts
DELETED
|
@@ -1,154 +0,0 @@
|
|
|
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
|
-
const capturedAction = action as (payload: unknown) => void;
|
|
115
|
-
|
|
116
|
-
stateActions.set(event, capturedAction);
|
|
117
|
-
|
|
118
|
-
return () => {
|
|
119
|
-
const stateMap = this.#actions?.get(from);
|
|
120
|
-
|
|
121
|
-
if (stateMap?.get(event) === capturedAction) {
|
|
122
|
-
stateMap.delete(event);
|
|
123
|
-
}
|
|
124
|
-
};
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
onTransition(
|
|
128
|
-
listener: (info: TransitionInfo<TStates, TEvents, TPayloadMap>) => void,
|
|
129
|
-
): () => void {
|
|
130
|
-
const nullIndex = this.#listeners.indexOf(null);
|
|
131
|
-
let index: number;
|
|
132
|
-
|
|
133
|
-
if (nullIndex === -1) {
|
|
134
|
-
index = this.#listeners.length;
|
|
135
|
-
this.#listeners.push(listener);
|
|
136
|
-
} else {
|
|
137
|
-
this.#listeners[nullIndex] = listener;
|
|
138
|
-
index = nullIndex;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
this.#listenerCount++;
|
|
142
|
-
let subscribed = true;
|
|
143
|
-
|
|
144
|
-
return () => {
|
|
145
|
-
if (!subscribed) {
|
|
146
|
-
return;
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
subscribed = false;
|
|
150
|
-
this.#listeners[index] = null;
|
|
151
|
-
this.#listenerCount--;
|
|
152
|
-
};
|
|
153
|
-
}
|
|
154
|
-
}
|
package/src/index.ts
DELETED
package/src/types.ts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
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;
|