anbaric-state-machine 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,78 @@
+# anbaric-state-machine
+
+The public state machine library: the `StateMachine` itself, the concrete
+actors, the auditor, and in-memory implementations of the
+[`anbaric-tsapi`](https://npmjs.com/package/anbaric-tsapi) contracts. App
+developers usually install [`anbaric`](https://npmjs.com/package/anbaric),
+which re-exports this package.
+
+## StateMachine
+
+```ts
+new StateMachine(workflowId, states, startState, dataSchema,
+    persistence = JobPersistenceFactory.instance(),
+    queue = QueueFactory.instance())
+```
+
+Construction subscribes a consumer (`ConsumerFactory.instance(queue)`) to
+the workflow, so jobs progress automatically whenever the queue delivers
+them. `cleanUp()` releases the consumer.
+
+**`startJob(properties?, actor?) : Promise<Job>`** — validates the
+properties (every key must be in the schema and pass its validation;
+`required` definitions must be present), persists the job and enqueues it.
+`startedBy` is the actor's id, or the workflowId when no actor is given.
+Throws `Invalid properties` / `Unauthorized`.
+
+**`updateJob(jobId, properties, actor) : Promise<void>`** — explicit change
+with a declared actor. Validates (required-ness is not re-checked on
+update), merges via `updateProperties`, audits `Properties updated`,
+re-enqueues.
+
+**`executeAction(jobId, action) : Promise<void>`** — runs one action now,
+its embedded actor as the responsible party. Refuses when the action's
+predicate rejects the job (`Action predicate unmet`) or when the returned
+properties fail the schema (`The action generated invalid properties`).
+Persists the returned properties and re-enqueues.
+
+**Progression** (internal, driven by the consumer): for the job's current
+state, every action whose `predicate` accepts the job is run; each returned
+property map is schema-validated (invalid output is discarded and audited,
+not applied) and merged into the job. Then transitions are evaluated in
+order — the first whose predicate accepts wins, at most one per progression,
+and transitions to undefined states are skipped. The transition is recorded
+in the job's history with the workflow as actor. Only when something
+actually changed is the job saved and re-enqueued — so multi-state flows
+chain automatically and an unchanged progression is a no-op. All changes are
+audited through a transaction flushed at the end.
+
+## Actors
+
+`Code`, `Human` and `Agent` implement the `Actor` interface as pure identity
+objects: `new Code(id, role = "code")`, `new Human(id, role)`,
+`new Agent(id, role)`. Behaviour never lives on an actor — an `Action`'s
+`run` field carries the code, the actor says who is responsible.
+
+## Auditing
+
+`Auditor.instance()` is a singleton logging
+`[jobId] actorId description details`. `audit(jobId, actor, description, details)`
+logs immediately; `transaction()` returns an `AuditorTransaction` that
+collects entries and `flush()`es them in order, once.
+
+## In-memory implementations and factories
+
+`InMemoryJobPersistence`, `InMemoryQueue` (implements `Dequeue`, with
+`schedule` releasing messages when due), `PullConsumer` (polls a `Dequeue`
+on an interval, re-enqueues on failure or missing subscriber).
+
+Factories switch on environment and default to in-memory:
+
+| Factory | Env var | `cloud` gives |
+| --- | --- | --- |
+| `JobPersistenceFactory.instance()` | `ANBARIC_JOB_PERSISTENCE_TYPE` | `CloudJobPersistence` |
+| `QueueFactory.instance()` | `ANBARIC_QUEUE_TYPE` | `CloudQueue` |
+| `ConsumerFactory.instance(queue)` | — structural — | `PullConsumer` when the queue supports `dequeueSome`, else the push `CloudConsumer` |
+
+An Anbaric platform injects the `cloud` values into deployed apps; never set
+them manually in app code.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anbaric-state-machine",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "This is the state machine library that one can use to add state management to an application. It will, by default, be locally runnable but can deployed to the Anbaric Cloud via the CLI",
   "license": "MIT",
   "author": "chris@anbaric.ai",