@statewalker/fsm 0.20.0 → 0.21.0

package/dist/context/index.d.ts

@@ -0,0 +1,23 @@
+import { FsmState, FsmStateHandler, FsmProcess } from '../index.js';
+
+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 getProcessPrinter(process: FsmProcess): Printer;
+declare function getPrinter(state: FsmState): Printer;
+
+declare function setProcessTracer(process: FsmProcess, print?: Printer): () => void;
+declare function setStateTracer(state: FsmState, print?: Printer): void;
+
+export { KEY_HANDLERS, KEY_PRINTER, type Printer, type PrinterConfig, addSubstateHandlers, callStateHandlers, getPrinter, getProcessPrinter, preparePrinter, setPrinter, setProcessPrinter, setProcessTracer, setStateTracer };

package/dist/context/index.js

@@ -0,0 +1,78 @@
+// src/context/handlers.ts
+var KEY_HANDLERS = "handlers";
+function callStateHandlers(state) {
+  const key = state.key;
+  for (let parent = state.parent; !!parent; parent = parent?.parent) {
+    const handlers = parent.getData(KEY_HANDLERS)?.[key];
+    handlers?.forEach((handler) => handler(state));
+  }
+}
+function addSubstateHandlers(state, handlers) {
+  const oldIndex = state.getData(KEY_HANDLERS);
+  const index = oldIndex ? { ...oldIndex } : {};
+  for (const [key, handler] of Object.entries(handlers)) {
+    const list = index[key] = index[key] || [];
+    list.push(handler);
+  }
+  state.setData(KEY_HANDLERS, index);
+}
+
+// src/context/printer.ts
+var KEY_PRINTER = "printer";
+function preparePrinter(process, { prefix = "", print = console.log, lineNumbers = false }) {
+  let lineCounter = 0;
+  const shift = () => {
+    let prefix2 = "";
+    for (let s = process.state?.parent; !!s; s = s.parent) {
+      prefix2 += "  ";
+    }
+    return prefix2;
+  };
+  const getPrefix = lineNumbers ? () => `[${++lineCounter}]${shift()}` : shift;
+  const printer = (...args) => print(prefix, getPrefix(), ...args);
+  return printer;
+}
+function setPrinter(state, config = {}) {
+  const printer = preparePrinter(state.process, config);
+  state.setData(KEY_PRINTER, printer);
+}
+function setProcessPrinter(process, config = {}) {
+  const printer = preparePrinter(process, config);
+  process.setData(KEY_PRINTER, printer);
+}
+function getProcessPrinter(process) {
+  return process.getData(KEY_PRINTER) || console.log;
+}
+function getPrinter(state) {
+  return state.getData(KEY_PRINTER, true) || getProcessPrinter(state.process);
+}
+
+// src/context/tracer.ts
+function setProcessTracer(process, print) {
+  return process.onStateCreate((state) => {
+    setStateTracer(state, print);
+  });
+}
+function setStateTracer(state, print) {
+  state.onEnter(() => {
+    const printLine = print || getPrinter(state);
+    printLine(`<${state?.key} event="${state.process.event}">`);
+  });
+  state.onExit(() => {
+    const printLine = print || getPrinter(state);
+    printLine(`</${state.key}> <!-- event="${state.process.event}" -->`);
+  });
+}
+export {
+  KEY_HANDLERS,
+  KEY_PRINTER,
+  addSubstateHandlers,
+  callStateHandlers,
+  getPrinter,
+  getProcessPrinter,
+  preparePrinter,
+  setPrinter,
+  setProcessPrinter,
+  setProcessTracer,
+  setStateTracer
+};

package/dist/index.d.ts

@@ -16,11 +16,13 @@ declare const STATE_INITIAL = "";
 declare const STATE_FINAL = "";
 declare const EVENT_ANY = "*";
 declare const EVENT_EMPTY = "";
+type FsmStateKey = string;
+type FsmEventKey = string;
 type FsmStateConfig = {
-    key: string;
-    transitions: [string, string, string][];
+    key: FsmStateKey;
+    transitions?: [from: FsmStateKey, event: FsmEventKey, to: FsmStateKey][];
     states?: FsmStateConfig[];
-};
+} & Record<string, any>;
 
 declare class FsmStateDescriptor {
     transitions: Record<string, Record<string, string>>;
@@ -75,6 +77,7 @@ declare class FsmProcess extends FsmBaseClass {
     config: FsmStateConfig;
     rootDescriptor: FsmStateDescriptor;
     constructor(config: FsmStateConfig);
+    shutdown(event?: string): Promise<void>;
     dispatch(event: string, mask?: number): Promise<boolean>;
     dump(...args: unknown[]): Promise<FsmProcessDump>;
     restore(dump: FsmProcessDump, ...args: unknown[]): Promise<this>;
@@ -87,23 +90,4 @@ declare class FsmProcess extends FsmBaseClass {
     _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 };
+export { EVENT_ANY, EVENT_EMPTY, type FsmEventKey, FsmProcess, type FsmProcessDump, type FsmProcessDumpHandler, type FsmProcessHandler, FsmState, type FsmStateConfig, FsmStateDescriptor, type FsmStateDump, type FsmStateDumpHandler, type FsmStateErrorHandler, type FsmStateHandler, type FsmStateKey, type FsmStateSyncHandler, STATE_ANY, STATE_FINAL, STATE_INITIAL, STATUS_ENTER, STATUS_EXIT, STATUS_FINISHED, STATUS_FIRST, STATUS_LAST, STATUS_LEAF, STATUS_NEXT, STATUS_NONE };

package/dist/index.js

@@ -9,9 +9,11 @@ function bindMethods(obj, ...methods) {
 
 // src/FsmBaseClass.ts
 var FsmBaseClass = class {
-  handlers = {};
-  data = {};
+  handlers;
+  data;
   constructor() {
+    this.handlers = {};
+    this.data = {};
     bindMethods(this, "setData", "getData");
   }
   setData(key, value) {
@@ -30,8 +32,7 @@ var FsmBaseClass = class {
   }
   _removeHandler(type, handler) {
     let list = this.handlers[type];
-    if (!list)
-      return;
+    if (!list) return;
     list = list.filter((h) => h !== handler);
     if (list.length > 0) {
       this.handlers[type] = list;
@@ -123,7 +124,7 @@ var FsmStateDescriptor = class _FsmStateDescriptor {
   states = {};
   static build(config) {
     const descriptor = new _FsmStateDescriptor();
-    for (const [from, event, to] of config.transitions) {
+    for (const [from, event, to] of config.transitions || []) {
       const index = descriptor.transitions[from] = descriptor.transitions[from] || {};
       index[event] = to;
     }
@@ -145,8 +146,7 @@ var FsmStateDescriptor = class _FsmStateDescriptor {
     for (let i = 0, len = pairs.length; targetKey === void 0 && i < len; i++) {
       const [stateKey2, eventKey2] = pairs[i];
       const stateTransitions = this.transitions[stateKey2];
-      if (!stateTransitions)
-        continue;
+      if (!stateTransitions) continue;
       targetKey = stateTransitions[eventKey2];
     }
     return targetKey !== void 0 ? targetKey : STATE_FINAL;
@@ -165,28 +165,35 @@ var STATUS_EXIT = STATUS_LEAF | STATUS_LAST;
 var FsmProcess = class extends FsmBaseClass {
   state;
   event;
-  status = 0;
+  status;
   config;
   rootDescriptor;
   constructor(config) {
     super();
+    this.status = 0;
     this.rootDescriptor = FsmStateDescriptor.build(config);
     this.config = config;
     bindMethods(this, "dispatch", "dump", "restore");
   }
+  async shutdown(event) {
+    while (this.state) {
+      this.event = event;
+      this.status = STATUS_FINISHED;
+      await this.state?._runHandler("onExit", this.state);
+      this.state = this.state.parent;
+    }
+  }
   async dispatch(event, mask = STATUS_LEAF) {
     this.event = event;
     while (true) {
       if (this.status & STATUS_EXIT) {
         await this.state?._runHandler("onExit", this.state);
       }
-      if (!this._update())
-        return false;
+      if (!this._update()) return false;
       if (this.status & STATUS_ENTER) {
         await this.state?._runHandler("onEnter", this.state);
       }
-      if (this.status & mask)
-        return true;
+      if (this.status & mask) return true;
     }
   }
   async dump(...args) {
@@ -199,8 +206,7 @@ var FsmProcess = class extends FsmBaseClass {
       return stateDump;
     };
     const dumpStates = async (state, stack = []) => {
-      if (!state)
-        return stack;
+      if (!state) return stack;
       state.parent && await dumpStates(state.parent, stack);
       stack.push(await dumpState(state));
       return stack;
@@ -244,14 +250,12 @@ var FsmProcess = class extends FsmBaseClass {
     return state;
   }
   _getSubstate(parent, prevStateKey) {
-    if (!parent)
-      return;
+    if (!parent) return;
     const toState = parent.descriptor?.getTargetStateKey(
       prevStateKey || STATE_INITIAL,
       this.event || EVENT_EMPTY
     ) || STATE_FINAL;
-    if (!toState)
-      return;
+    if (!toState) return;
     return this._newSubstate(parent, toState);
   }
   _newSubstate(parent, toState) {
@@ -262,8 +266,7 @@ var FsmProcess = class extends FsmBaseClass {
     return this._newState(parent, toState, descriptor);
   }
   _update() {
-    if (this.status & STATUS_FINISHED)
-      return false;
+    if (this.status & STATUS_FINISHED) return false;
     const nextState = this.status !== STATUS_NONE ? this.status & STATUS_ENTER ? this._getSubstate(this.state, STATE_INITIAL) : this._getSubstate(this.state?.parent, this.state?.key) : this._newState(void 0, this.config.key, this.rootDescriptor);
     if (nextState !== void 0) {
       this.state = nextState;
@@ -275,82 +278,17 @@ var FsmProcess = class extends FsmBaseClass {
       } else {
         this.status = STATUS_LEAF;
       }
-      if (!this.state)
-        this.status = STATUS_FINISHED;
+      if (!this.state) this.status = STATUS_FINISHED;
     }
     return !(this.status & STATUS_FINISHED);
   }
 };
-
-// src/context/handlers.ts
-var KEY_HANDLERS = "handlers";
-function callStateHandlers(state) {
-  const key = state.key;
-  for (let parent = state.parent; !!parent; parent = parent?.parent) {
-    const handlers = parent.getData(KEY_HANDLERS)?.[key];
-    handlers?.forEach((handler) => handler(state));
-  }
-}
-function addSubstateHandlers(state, handlers) {
-  const oldIndex = state.getData(KEY_HANDLERS);
-  const index = oldIndex ? { ...oldIndex } : {};
-  for (const [key, handler] of Object.entries(handlers)) {
-    const list = index[key] = index[key] || [];
-    list.push(handler);
-  }
-  state.setData(KEY_HANDLERS, index);
-}
-
-// src/context/printer.ts
-var KEY_PRINTER = "printer";
-function preparePrinter(process, { prefix = "", print = console.log, lineNumbers = false }) {
-  let lineCounter = 0;
-  const shift = () => {
-    let prefix2 = "";
-    for (let s = process.state?.parent; !!s; s = s.parent) {
-      prefix2 += "  ";
-    }
-    return prefix2;
-  };
-  const getPrefix = lineNumbers ? () => `[${++lineCounter}]${shift()}` : shift;
-  const printer = (...args) => print(prefix, getPrefix(), ...args);
-  return printer;
-}
-function setPrinter(state, config = {}) {
-  const printer = preparePrinter(state.process, config);
-  state.setData(KEY_PRINTER, printer);
-}
-function setProcessPrinter(process, config = {}) {
-  const printer = preparePrinter(process, config);
-  process.setData(KEY_PRINTER, printer);
-}
-function getPrinter(state) {
-  return state.getData(KEY_PRINTER, true) || state.process.getData(KEY_PRINTER) || console.log;
-}
-
-// src/context/tracer.ts
-function setProcessTracer(process, print) {
-  return process.onStateCreate((state) => {
-    setStateTracer(state, print);
-  });
-}
-function setStateTracer(state, print) {
-  const printLine = print || getPrinter(state);
-  state.onEnter(() => {
-    printLine(`<${state?.key} event="${state.process.event}">`);
-  });
-  state.onExit(() => {
-    printLine(`</${state.key}> <!-- event="${state.process.event}" -->`);
-  });
-}
 export {
   EVENT_ANY,
   EVENT_EMPTY,
   FsmProcess,
   FsmState,
   FsmStateDescriptor,
-  KEY_HANDLERS,
-  KEY_PRINTER,
   STATE_ANY,
   STATE_FINAL,
   STATE_INITIAL,
@@ -361,13 +299,5 @@ export {
   STATUS_LAST,
   STATUS_LEAF,
   STATUS_NEXT,
-  STATUS_NONE,
-  addSubstateHandlers,
-  callStateHandlers,
-  getPrinter,
-  preparePrinter,
-  setPrinter,
-  setProcessPrinter,
-  setProcessTracer,
-  setStateTracer
+  STATUS_NONE
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statewalker/fsm",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "HFSM Implementation",
   "keywords": [],
   "homepage": "https://github.com/statewalker/statewalker-fsm",
@@ -20,14 +20,11 @@
   "unpkg": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./src/index.ts"
-    }
-  },
-  "dependencies": {
-    "@statewalker/tree": "0.10.2"
+    ".": "./dist/index.js",
+    "./context": "./dist/context/index.js"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.27.7",
     "@statewalker/eslint-config": "*",
     "@statewalker/typescript-config": "*",
     "eslint": "^9.0.0",
@@ -40,7 +37,8 @@
     "url": "git@github.com:statewalker/statewalker-fsm.git"
   },
   "scripts": {
-    "build": "yarn test && tsup",
+    "dist": "yarn test && tsup",
+    "build": "yarn dist",
     "watch": "tsup --watch",
     "clean": "rm -rf dist",
     "lint": "eslint \"**/*.(js|ts)\"",

package/src/FsmBaseClass.ts

@@ -1,9 +1,11 @@
 import { bindMethods } from "./utils/bindMethods.ts";
 
 export class FsmBaseClass {
-  handlers: Record<string, Function[]> = {};
-  data: Record<string, unknown> = {};
+  handlers: Record<string, Function[]>;
+  data: Record<string, unknown>;
   constructor() {
+    this.handlers = {};
+    this.data = {};
     bindMethods(this, "setData", "getData");
   }
   setData<T>(key: string, value: T) {

package/src/FsmProcess.ts

@@ -1,10 +1,6 @@
 import { bindMethods } from "./utils/bindMethods.ts";
 import { FsmBaseClass } from "./FsmBaseClass.ts";
-import {
-  FsmState,
-  FsmStateDump,
-  FsmStateSyncHandler,
-} from "./FsmState.ts";
+import { FsmState, FsmStateDump, FsmStateSyncHandler } from "./FsmState.ts";
 import {
   EVENT_EMPTY,
   FsmStateConfig,
@@ -43,17 +39,27 @@ export type FsmProcessDumpHandler = (
 export class FsmProcess extends FsmBaseClass {
   state?: FsmState;
   event?: string;
-  status: number = 0;
+  status: number;
   config: FsmStateConfig;
   rootDescriptor: FsmStateDescriptor;
 
   constructor(config: FsmStateConfig) {
     super();
+    this.status = 0;
     this.rootDescriptor = FsmStateDescriptor.build(config);
     this.config = config;
     bindMethods(this, "dispatch", "dump", "restore");
   }
 
+  async shutdown(event?: string) {
+    while (this.state) {
+      this.event = event;
+      this.status = STATUS_FINISHED;
+      await this.state?._runHandler("onExit", this.state);
+      this.state = this.state.parent;
+    }
+  }
+
   async dispatch(event: string, mask: number = STATUS_LEAF) {
     this.event = event;
     while (true) {

package/src/FsmStateConfig.ts

@@ -4,10 +4,10 @@ export const STATE_FINAL = "";
 export const EVENT_ANY = "*";
 export const EVENT_EMPTY = "";
 
+export type FsmStateKey = string;
+export type FsmEventKey = string;
 export type FsmStateConfig = {
-  key: string;
-
-  transitions: [string, string, string][];
-
+  key: FsmStateKey;
+  transitions?: [from: FsmStateKey, event: FsmEventKey, to: FsmStateKey][];
   states?: FsmStateConfig[];
-};
+} & Record<string, any>;

package/src/FsmStateDescriptor.ts

@@ -11,7 +11,7 @@ export class FsmStateDescriptor {
 
   static build(config: FsmStateConfig) {
     const descriptor = new FsmStateDescriptor();
-    for (const [from, event, to] of config.transitions) {
+    for (const [from, event, to] of config.transitions || []) {
       const index = (descriptor.transitions[from] =
         descriptor.transitions[from] || {});
       index[event] = to;

package/src/context/handlers.ts

@@ -1,4 +1,4 @@
-import { FsmState, FsmStateHandler } from "../FsmState.ts";
+import type { FsmState, FsmStateHandler } from "../FsmState.ts";
 
 export const KEY_HANDLERS = "handlers";
 

package/src/context/printer.ts

@@ -1,5 +1,5 @@
-import { type FsmProcess } from "../FsmProcess.ts";
-import { type FsmState } from "../FsmState.ts";
+import type { FsmProcess } from "../FsmProcess.ts";
+import type { FsmState } from "../FsmState.ts";
 export type Printer = (...args: any[]) => void;
 export type PrinterConfig = {
   prefix?: string;
@@ -39,10 +39,10 @@ export function setProcessPrinter(
   process.setData(KEY_PRINTER, printer);
 }
 
+export function getProcessPrinter(process: FsmProcess): Printer {
+  return process.getData(KEY_PRINTER) || console.log;
+}
+
 export function getPrinter(state: FsmState): Printer {
-  return (
-    state.getData(KEY_PRINTER, true) ||
-    state.process.getData(KEY_PRINTER) ||
-    console.log
-  );
+  return state.getData(KEY_PRINTER, true) || getProcessPrinter(state.process);
 }

package/src/context/tracer.ts

@@ -1,5 +1,5 @@
-import { FsmProcess } from "../FsmProcess.ts";
-import { FsmState } from "../FsmState.ts";
+import type { FsmProcess } from "../FsmProcess.ts";
+import type { FsmState } from "../FsmState.ts";
 import { getPrinter, type Printer } from "./printer.ts";
 
 export function setProcessTracer(process: FsmProcess, print?: Printer) {
@@ -9,11 +9,12 @@ export function setProcessTracer(process: FsmProcess, print?: Printer) {
 }
 
 export function setStateTracer(state: FsmState, print?: Printer) {
-  const printLine = print || getPrinter(state);
   state.onEnter(() => {
+    const printLine = print || getPrinter(state);
     printLine(`<${state?.key} event="${state.process.event}">`);
   });
   state.onExit(() => {
+    const printLine = print || getPrinter(state);
     printLine(`</${state.key}> <!-- event="${state.process.event}" -->`);
   });
 }

package/src/index.ts

@@ -2,4 +2,3 @@ export * from "./FsmProcess.ts";
 export * from "./FsmState.ts";
 export * from "./FsmStateConfig.ts";
 export * from "./FsmStateDescriptor.ts";
-export * from "./context/index.ts";