anbaric-tsapi 1.14.2 → 1.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anbaric-tsapi",
-  "version": "1.14.2",
+  "version": "1.16.0",
   "description": "These are the shared libraries - types, classes, etc - that both the public state-machine and hosting services share",
   "license": "MIT",
   "author": "chris@anbaric.ai",

package/src/api/cloud/WorkflowDefinition.ts

@@ -0,0 +1,19 @@
+/* The serialisable graph of a state machine: its states, each state's actions
+   (identity only — the run/predicate bodies aren't persistable) and
+   transitions. Recorded as the details of an audit record when a state machine
+   initialises. */
+type WorkflowDefinition = {
+
+    workflowId : string,
+    startState : string,
+    dataSchema : Array<{ id : string, required : boolean }>,
+    states : Array<{
+        id : string,
+        isTerminal : boolean,
+        actions : Array<{ name : string, description : string, actor : { id : string, type : string, role : string } }>,
+        transitions : Array<{ to : string }>,
+    }>,
+
+};
+
+export type { WorkflowDefinition }

package/src/index.ts

@@ -21,4 +21,5 @@ export * from "./api/documents/JsonSchema"
 export * from "./api/state-machine/Queue"
 export * from "./api/state-machine/Consumer"
 export * from "./api/cloud/QueueMessage"
+export * from "./api/cloud/WorkflowDefinition"
 export * from "./api/cloud/AuditRecord"