@axi-engine/states 0.3.1 → 0.3.2

package/dist/index.d.mts

@@ -1,9 +1,32 @@
 import { Emitter } from '@axijs/emitter';
 
+/**
+ * Represents a lifecycle handler function for a state.
+ * If a payload type `P` is provided and is not `void`, the handler receives the payload.
+ * Supports both synchronous and asynchronous execution.
+ *
+ * @template P The type of the payload passed to the handler.
+ */
 type StateHandler<P = void> = P extends void ? () => void | Promise<void> : (payload: P) => void | Promise<void>;
+/**
+ * Configuration object for defining a state's behavior and transition rules.
+ *
+ * @template T The type used for state identifiers.
+ * @template P The type of the payload passed to the `onEnter` handler.
+ */
 interface StateHandlerConfig<T, P = void> {
+    /**
+     * Hook executed when transitioning into this state.
+     */
     onEnter?: StateHandler<P>;
+    /**
+     * Hook executed when transitioning out of this state.
+     */
     onExit?: () => void | Promise<void>;
+    /**
+     * Optional list of states from which a transition to this state is permitted.
+     * If undefined, the state can be entered from any state.
+     */
     allowedFrom?: T[];
 }
 type StateHandlerRegistration<T, P = void> = StateHandler<P> | StateHandlerConfig<T, P>;

package/dist/index.d.ts

@@ -1,9 +1,32 @@
 import { Emitter } from '@axijs/emitter';
 
+/**
+ * Represents a lifecycle handler function for a state.
+ * If a payload type `P` is provided and is not `void`, the handler receives the payload.
+ * Supports both synchronous and asynchronous execution.
+ *
+ * @template P The type of the payload passed to the handler.
+ */
 type StateHandler<P = void> = P extends void ? () => void | Promise<void> : (payload: P) => void | Promise<void>;
+/**
+ * Configuration object for defining a state's behavior and transition rules.
+ *
+ * @template T The type used for state identifiers.
+ * @template P The type of the payload passed to the `onEnter` handler.
+ */
 interface StateHandlerConfig<T, P = void> {
+    /**
+     * Hook executed when transitioning into this state.
+     */
     onEnter?: StateHandler<P>;
+    /**
+     * Hook executed when transitioning out of this state.
+     */
     onExit?: () => void | Promise<void>;
+    /**
+     * Optional list of states from which a transition to this state is permitted.
+     * If undefined, the state can be entered from any state.
+     */
     allowedFrom?: T[];
 }
 type StateHandlerRegistration<T, P = void> = StateHandler<P> | StateHandlerConfig<T, P>;

package/dist/index.js

@@ -98,7 +98,7 @@ var StateMachine = class {
    */
   async call(newState, payload) {
     const oldState = this._state;
-    const oldStateConfig = this._state ? this.states.get(this._state) : void 0;
+    const oldStateConfig = (0, import_ensure.isUndefined)(this._state) ? void 0 : this.states.get(this._state);
     const newStateConfig = this.states.get(newState);
     (0, import_ensure.throwIfEmpty)(newStateConfig, `State ${String(newState)} is not registered.`);
     (0, import_ensure.throwIf)(

package/dist/index.mjs

@@ -72,7 +72,7 @@ var StateMachine = class {
    */
   async call(newState, payload) {
     const oldState = this._state;
-    const oldStateConfig = this._state ? this.states.get(this._state) : void 0;
+    const oldStateConfig = isUndefined(this._state) ? void 0 : this.states.get(this._state);
     const newStateConfig = this.states.get(newState);
     throwIfEmpty(newStateConfig, `State ${String(newState)} is not registered.`);
     throwIf(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/states",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "A minimal, type-safe state machine for the Axi Engine, designed for managing game logic and component states with a simple API.",
   "license": "MIT",
   "repository": {
@@ -32,8 +32,9 @@
   },
   "scripts": {
     "build": "tsup",
-    "docs": "typedoc src/index.ts --out docs/api --options ../../typedoc.json",
-    "test": "echo 'No tests yet for @axi-engine/states'"
+    "prebuild": "npm test",
+    "test": "vitest run",
+    "docs": "typedoc src/index.ts --out docs/api --options ../../typedoc.json"
   },
   "files": [
     "dist"