anbaric-state-machine 1.8.0 → 1.9.0

package/README.md

@@ -26,8 +26,8 @@ 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.
+update), merges the changed properties through `save` (which 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
@@ -48,17 +48,20 @@ 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
+`Code` and `Human` implement the `Actor` interface as pure identity objects:
+`new Code(id, role = "code")`, `new Human(id, role)`. An `Agent` is an actor
+too, but carries a `Client` for its model calls — construct a concrete
+`OpenAIAgent` (or `AnbaricServicesAgent` from `anbaric-services-client`) rather
+than a bare agent. Behaviour never lives on a plain 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.
+`AuditorFactory.instance()` returns the configured `Auditor` (a `ConsoleAuditor`
+by default, a `CloudAuditor` when `ANBARIC_AUDITOR_TYPE=cloud`). Its
+`audit(resourceType, resourceId, actor, interactions, description, details)`
+records who did what to which resource; the persistence bases call it for you,
+so app code rarely calls it directly.
 
 ## In-memory implementations and factories
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anbaric-state-machine",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "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",
@@ -15,8 +15,8 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "anbaric-impl-cloud": "^1.8.0",
-    "anbaric-tsapi": "^1.8.0"
+    "anbaric-impl-cloud": "^1.9.0",
+    "anbaric-tsapi": "^1.9.0"
   },
   "files": [
     "src"

package/src/StateMachine.ts

@@ -1,7 +1,6 @@
 import {
     Action,
     Actor,
-    AuditInteraction,
     Consumer,
     Job,
     JobPersistence,

package/src/auditing/ConsoleAuditor.ts

@@ -1,8 +1,8 @@
-import {Actor, AuditInteraction, Auditor} from "anbaric-tsapi";
+import {Actor, Auditor} from "anbaric-tsapi";
 
 class ConsoleAuditor implements Auditor {
 
-    async audit(resourceType : string, resourceId : string, actor : Actor, interaction : AuditInteraction[],
+    async audit(resourceType : string, resourceId : string, actor : Actor, interaction : Array<string>,
                 description : string, details : any) : Promise<void> {
         console.log(`[${resourceType} ${resourceId}] ${actor.id} ${interaction.join(",")} ${description} ${JSON.stringify(details ?? null)}`);
     }