@statewalker/fsm 0.15.2 → 0.20.0

package/CHANGELOG.md

@@ -0,0 +1,59 @@
+# @statewalker/fsm
+
+## 0.16.0
+
+### Minor Changes
+
+- Fix logical bug in transitions loading
+
+## 0.15.2
+
+### Patch Changes
+
+- Update rollup and dependencies
+- Updated dependencies
+  - @statewalker/tree@0.10.2
+
+## 0.15.1
+
+### Patch Changes
+
+- Normalize package.json files
+- Updated dependencies
+  - @statewalker/tree@0.10.1
+
+## 0.15.0
+
+### Minor Changes
+
+- Migrage the "initAsyncProcess" method from the @statewalker/fsm to @statewalker/fsm-process package and add process utility methods
+
+## 0.14.0
+
+### Minor Changes
+
+- Update exports
+
+## 0.13.0
+
+### Minor Changes
+
+- Fix exports
+
+## 0.12.0
+
+### Minor Changes
+
+- Update version
+
+## 0.11.0
+
+### Minor Changes
+
+- Add initialization function for async processes
+
+## 0.10.1
+
+### Patch Changes
+
+- Migrate the @statewalker/fsm project from the @statewalker/statewalker monorepo

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+declare class FsmBaseClass {
+    handlers: Record<string, Function[]>;
+    data: Record<string, unknown>;
+    constructor();
+    setData<T>(key: string, value: T): this;
+    getData<T>(key: string): T | undefined;
+    _addHandler(type: string, handler: Function, direct?: boolean): () => void;
+    _removeHandler(type: string, handler: Function): void;
+    _runHandlerSync(type: string, ...args: unknown[]): any[];
+    _runHandler(type: string, ...args: unknown[]): Promise<void>;
+    _handleError(error: Error | unknown): Promise<void>;
+}
+
+declare const STATE_ANY = "*";
+declare const STATE_INITIAL = "";
+declare const STATE_FINAL = "";
+declare const EVENT_ANY = "*";
+declare const EVENT_EMPTY = "";
+type FsmStateConfig = {
+    key: string;
+    transitions: [string, string, string][];
+    states?: FsmStateConfig[];
+};
+
+declare class FsmStateDescriptor {
+    transitions: Record<string, Record<string, string>>;
+    states: Record<string, FsmStateDescriptor>;
+    static build(config: FsmStateConfig): FsmStateDescriptor;
+    getTargetStateKey(stateKey: string, eventKey: string): string;
+}
+
+type FsmStateDump = Record<string, any> & {
+    key: string;
+    data: Record<string, unknown>;
+};
+type FsmStateHandler = (state: FsmState, ...args: unknown[]) => void | Promise<void>;
+type FsmStateSyncHandler = (state: FsmState, ...args: unknown[]) => void;
+type FsmStateDumpHandler = (state: FsmState, dump: FsmStateDump) => void | Promise<void>;
+type FsmStateErrorHandler = (state: FsmState, error: any) => void | Promise<void>;
+declare class FsmState extends FsmBaseClass {
+    process: FsmProcess;
+    key: string;
+    parent?: FsmState;
+    descriptor?: FsmStateDescriptor;
+    constructor(process: FsmProcess, parent: FsmState | undefined, key: string, descriptor?: FsmStateDescriptor);
+    onEnter(handler: FsmStateHandler): () => void;
+    onExit(handler: FsmStateHandler): () => void;
+    onStateError(handler: FsmStateErrorHandler): () => void;
+    dump(handler: FsmStateDumpHandler): () => void;
+    restore(handler: FsmStateDumpHandler): () => void;
+    getData<T>(key: string, recursive?: boolean): T | undefined;
+    useData<T>(key: string): (((recursive?: boolean) => T | undefined) | ((value: T) => this))[];
+    _handleError(error: Error | unknown): Promise<void>;
+}
+
+declare const STATUS_NONE = 0;
+declare const STATUS_FIRST = 1;
+declare const STATUS_NEXT = 2;
+declare const STATUS_LEAF = 4;
+declare const STATUS_LAST = 8;
+declare const STATUS_FINISHED = 16;
+declare const STATUS_ENTER: number;
+declare const STATUS_EXIT: number;
+type FsmProcessHandler = (process: FsmProcess, ...args: any[]) => void | Promise<void>;
+type FsmProcessDump = Record<string, any> & {
+    status: number;
+    event?: string;
+    stack: FsmStateDump[];
+};
+type FsmProcessDumpHandler = (process: FsmProcess, dump: FsmProcessDump) => void | Promise<void>;
+declare class FsmProcess extends FsmBaseClass {
+    state?: FsmState;
+    event?: string;
+    status: number;
+    config: FsmStateConfig;
+    rootDescriptor: FsmStateDescriptor;
+    constructor(config: FsmStateConfig);
+    dispatch(event: string, mask?: number): Promise<boolean>;
+    dump(...args: unknown[]): Promise<FsmProcessDump>;
+    restore(dump: FsmProcessDump, ...args: unknown[]): Promise<this>;
+    onStateCreate(handler: FsmStateSyncHandler): () => void;
+    onStateError(handler: (state: FsmState, error: any) => void | Promise<void>): () => void;
+    _handleStateError(state: FsmState, error: Error | unknown): Promise<void>;
+    _newState(parent: FsmState | undefined, key: string, descriptor: FsmStateDescriptor | undefined): FsmState;
+    _getSubstate(parent: FsmState | undefined, prevStateKey: string | undefined): FsmState | undefined;
+    _newSubstate(parent: FsmState | undefined, toState: string): FsmState;
+    _update(): boolean;
+}
+
+declare const KEY_HANDLERS = "handlers";
+declare function callStateHandlers(state: FsmState): void;
+declare function addSubstateHandlers(state: FsmState, handlers: Record<string, FsmStateHandler>): void;
+
+type Printer = (...args: any[]) => void;
+type PrinterConfig = {
+    prefix?: string;
+    print?: (...args: any[]) => void;
+    lineNumbers?: boolean;
+};
+declare const KEY_PRINTER = "printer";
+declare function preparePrinter(process: FsmProcess, { prefix, print, lineNumbers }: PrinterConfig): Printer;
+declare function setPrinter(state: FsmState, config?: PrinterConfig): void;
+declare function setProcessPrinter(process: FsmProcess, config?: PrinterConfig): void;
+declare function getPrinter(state: FsmState): Printer;
+
+declare function setProcessTracer(process: FsmProcess, print?: Printer): () => void;
+declare function setStateTracer(state: FsmState, print?: Printer): void;
+
+export { EVENT_ANY, EVENT_EMPTY, FsmProcess, type FsmProcessDump, type FsmProcessDumpHandler, type FsmProcessHandler, FsmState, type FsmStateConfig, FsmStateDescriptor, type FsmStateDump, type FsmStateDumpHandler, type FsmStateErrorHandler, type FsmStateHandler, type FsmStateSyncHandler, KEY_HANDLERS, KEY_PRINTER, type Printer, type PrinterConfig, STATE_ANY, STATE_FINAL, STATE_INITIAL, STATUS_ENTER, STATUS_EXIT, STATUS_FINISHED, STATUS_FIRST, STATUS_LAST, STATUS_LEAF, STATUS_NEXT, STATUS_NONE, addSubstateHandlers, callStateHandlers, getPrinter, preparePrinter, setPrinter, setProcessPrinter, setProcessTracer, setStateTracer };