@j0u1/finity 1.0.3 → 1.0.5

package/README.md

@@ -1,9 +1,10 @@
 # @j0u1/finity
 
+Lightweight finite state machine (FSM) library for TypeScript.
+
 [![npm](https://img.shields.io/npm/v/@j0u1/finity)](https://www.npmjs.com/package/@j0u1/finity)
 [![wakatime](https://wakatime.com/badge/user/42e0f82b-2688-4a48-85af-5eedd1812f70/project/7cf65f9a-042d-4ed8-ac25-717b8b4ff28b.svg)](https://wakatime.com/badge/user/42e0f82b-2688-4a48-85af-5eedd1812f70/project/7cf65f9a-042d-4ed8-ac25-717b8b4ff28b)
-
-Lightweight finite state machine (FSM) library for TypeScript.
+[![Socket Badge](https://badge.socket.dev/npm/package/@j0u1/finity)](https://badge.socket.dev/npm/package/@j0u1/finity)
 
 ## Install
 
@@ -15,6 +16,8 @@ npm install @j0u1/finity
 
 ## Usage
 
+Single transition per state:
+
 ```ts
 import { createMachine } from "@j0u1/finity"
 
@@ -27,11 +30,27 @@ const traffic = createMachine({
   },
 })
 
-traffic.current   // "red"
-traffic.next()    // "yellow"
-traffic.current   // "yellow"
-traffic.canChangeTo("green")  // true
-traffic.canChangeTo("red")    // false
+traffic.current                 // "red"
+traffic.moveTo("yellow")        // "yellow"
+traffic.canChangeTo("green")    // true
+traffic.canChangeTo("red")      // false
+```
+
+Multiple transitions per state:
+
+```ts
+const order = createMachine({
+  initial: "pending",
+  transitions: {
+    pending: ["success", "fail"],
+    success: [],
+    fail: [],
+  },
+})
+
+order.canChangeTo("success")   // true
+order.canChangeTo("fail")      // true
+order.moveTo("success")        // "success"
 ```
 
 ## API
@@ -43,10 +62,14 @@ Creates a new state machine.
 | Parameter | Type | Description |
 |---|---|---|
 | `config.initial` | `string` | Initial state |
-| `config.transitions` | `Record<string, string>` | Map of state transitions |
+| `config.transitions` | `Record<string, string \| string[]>` | Map of state transitions |
 
 Returns an object with:
 
 - **`current`** — current state
-- **`next()`** — transitions to the next state, returns new state. Throws if no transition exists.
-- **`canChangeTo(state)`** — returns `true` if transition to given state is possible from current state
+- **`moveTo(state)`** — transitions to the given state. Throws if transition is not allowed.
+- **`canChangeTo(state)`** — returns `true` if transition to given state is possible from current state
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 interface ConfigType {
     initial: string;
-    transitions: Record<string, string>;
+    transitions: Record<string, string | string[]>;
 }
 export declare function createMachine(config: ConfigType): {
     current: string;
-    transitions: Record<string, string>;
-    next(): string;
+    transitions: Record<string, string | string[]>;
+    moveTo(state: string): string;
     canChangeTo(state: string): boolean;
 };
 export {};

package/dist/index.js

@@ -9,14 +9,17 @@ function createMachine(config) {
   return {
     current: config.initial,
     transitions: config.transitions,
-    next() {
-      const nextState = this.transitions[this.current];
-      if (!nextState)
-        throw new FinityError(`No transition from "${this.current}"`);
-      return this.current = nextState;
+    moveTo(state) {
+      const available = this.transitions[this.current];
+      const states = Array.isArray(available) ? available : [available];
+      if (!states.includes(state))
+        throw new FinityError(`No transition from "${this.current}" to "${state}"`);
+      return this.current = state;
     },
     canChangeTo(state) {
-      return this.transitions[this.current] === state;
+      const available = this.transitions[this.current];
+      const states = Array.isArray(available) ? available : [available];
+      return states.includes(state);
     }
   };
 }

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@j0u1/finity",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": " Lightweight finite state machine library for TypeScript",
   "author": "j0u1",
   "keywords": [
     "fsm",
-    "state-machine"
+    "state-machine",
+    "finite-state-machine",
+    "fsm-library"
   ],
   "files": [
     "dist"