@sanity/workflow-engine 0.10.0 → 0.11.0

package/dist/index.js

@@ -1,6 +1,6 @@
 import { parse, evaluate } from "groq-js";
 import { actorFulfillsRole, isTerminalTaskStatus, WORKFLOW_DEFINITION_TYPE, andConditions, DOCUMENT_VALUE_PERMISSIONS } from "./_chunks-es/schema.js";
-import { isStartableDefinition } from "./_chunks-es/schema.js";
+import { DRIVER_KINDS, TASK_KINDS, isStartableDefinition } from "./_chunks-es/schema.js";
 import * as v from "valibot";
 function findOpenStageEntry(host) {
   return host.stages.find((s) => s.name === host.currentStage && s.exitedAt === void 0);
@@ -1651,12 +1651,16 @@ function buildInstanceBase(args) {
     lastChangedAt: now
   };
 }
-const MAX_SPAWN_DEPTH = 6, SUBWORKFLOWS_ALL_DONE = "count($subworkflows[status != 'done']) == 0", FAIL_WHEN_SYSTEM_ID = "engine.failWhen", COMPLETE_WHEN_SYSTEM_ID = "engine.completeWhen";
+const ENGINE_ACTOR_ID_PREFIX = "engine.";
+function engineSystemActor(name) {
+  return { kind: "system", id: `${ENGINE_ACTOR_ID_PREFIX}${name}` };
+}
+function isEngineActor(actor) {
+  return actor.kind === "system" && actor.id.startsWith(ENGINE_ACTOR_ID_PREFIX);
+}
+const MAX_SPAWN_DEPTH = 6, SUBWORKFLOWS_ALL_DONE = "count($subworkflows[status != 'done']) == 0";
 function gateActor(outcome) {
-  return {
-    kind: "system",
-    id: outcome === "failed" ? FAIL_WHEN_SYSTEM_ID : COMPLETE_WHEN_SYSTEM_ID
-  };
+  return engineSystemActor(outcome === "failed" ? "failWhen" : "completeWhen");
 }
 function effectiveCompleteWhen(task) {
   return task.completeWhen ?? (task.subworkflows !== void 0 ? SUBWORKFLOWS_ALL_DONE : void 0);
@@ -2295,7 +2299,7 @@ function resolveMachineStep(mutation, task, entry, now) {
     stage: mutation.currentStage,
     to: "done",
     at: now,
-    actor: { kind: "system", id: "engine.machineStep" }
+    actor: engineSystemActor("machineStep")
   });
 }
 async function buildStageTasks(ctx, stage) {
@@ -2783,6 +2787,18 @@ function editDisabledReason(args) {
   if (!predicateSatisfied)
     return { kind: "editor-not-permitted", predicate: effective === !0 ? "true" : effective };
 }
+function hasItems(arr) {
+  return arr !== void 0 && arr.length > 0;
+}
+function deriveTaskKind(task) {
+  return hasItems(task.actions) ? "user" : hasItems(task.effects) ? "service" : task.completeWhen !== void 0 || task.subworkflows !== void 0 ? "receive" : "script";
+}
+function taskKind(task) {
+  return task.kind ?? deriveTaskKind(task);
+}
+function driverKind(actor) {
+  return actor.kind === "user" ? "person" : actor.kind === "ai" ? "agent" : isEngineActor(actor) ? "engine" : "service";
+}
 async function evaluateInstance(args) {
   const { client, tag, instanceId, resourceClients } = args, now = (args.clock ?? wallClock)();
   validateTag(tag);
@@ -2972,6 +2988,7 @@ async function evaluateTask(args) {
   return {
     task,
     status,
+    kind: taskKind(task),
     // "pending on actor" treats both `pending` and `active` as waiting on
     // the assignee — pending tasks just haven't been activated yet, but
     // they're still inbox items. The inbox reads the assignees-kind field
@@ -3226,7 +3243,7 @@ async function commitAction(ctx, taskName, actionName, callerParams, options) {
     stage: stage.name,
     task: taskName,
     action: actionName,
-    ...actor !== void 0 ? { actor } : {}
+    ...actor !== void 0 ? { actor, driverKind: driverKind(actor) } : {}
   });
   const statusBefore = mutEntry.status, ranOps = await runOps({
     ops: action.ops,
@@ -4054,7 +4071,7 @@ async function drainEffectsInternal(args) {
     effectHandlers,
     missingHandler,
     logger
-  } = args, drainerActor = args.access?.actor ?? { kind: "system", id: "engine.drainEffects" }, completionAccess = {
+  } = args, drainerActor = args.access?.actor ?? engineSystemActor("drainEffects"), completionAccess = {
     actor: drainerActor,
     ...args.access?.grants !== void 0 ? { grants: args.access.grants } : {}
   };
@@ -4571,6 +4588,35 @@ const HISTORY_DISPLAY = {
     title: "Workflow instance",
     description: "A running (or finished) workflow against its declared fields."
   }
+}, TASK_KIND_DISPLAY = {
+  user: {
+    title: "User task",
+    description: "A person acts via the app \u2014 renders action buttons ranked by outcome."
+  },
+  service: {
+    title: "Service task",
+    description: "An automated system or effect does the work \u2014 renders effect drain status."
+  },
+  script: {
+    title: "Script task",
+    description: "The engine runs a step inline and resolves on activation \u2014 an audit row."
+  },
+  manual: {
+    title: "Manual task",
+    description: "Work done off-system, acknowledged by a person or verified by a predicate \u2014 renders an instruction card with a deep-link."
+  },
+  receive: {
+    title: "Receive task",
+    description: 'No actor; the engine waits on a condition \u2014 renders "waiting until \u2026", no buttons.'
+  }
+}, DRIVER_KIND_DISPLAY = {
+  person: { title: "Person", description: "A human fired this action." },
+  agent: { title: "Agent", description: "An AI agent fired this action." },
+  service: { title: "Service", description: "An external system or Function fired this action." },
+  engine: {
+    title: "Engine",
+    description: "The workflow engine itself drove this \u2014 a gate, machine step, or housekeeping."
+  }
 }, DISPLAY = {
   ...HISTORY_DISPLAY,
   ...FIELD_SLOT_DISPLAY,
@@ -4594,6 +4640,8 @@ export {
   ConcurrentFireActionError,
   DEFAULT_CONTENT_PERSPECTIVE,
   DISPLAY,
+  DRIVER_KINDS,
+  DRIVER_KIND_DISPLAY,
   EFFECTS_CONTEXT_DISPLAY,
   EditFieldDeniedError,
   FIELD_SLOT_DISPLAY,
@@ -4605,6 +4653,8 @@ export {
   OP_DISPLAY,
   PartialGuardDeployError,
   RequiredFieldNotProvidedError,
+  TASK_KINDS,
+  TASK_KIND_DISPLAY,
   WORKFLOW_DEFINITION_TYPE,
   WORKFLOW_INSTANCE_TYPE,
   WorkflowStateDivergedError,
@@ -4620,11 +4670,13 @@ export {
   defaultLoggerFactory,
   denyingGuards,
   deployStageGuards,
+  deriveTaskKind,
   diagnoseInputFromEvaluation,
   diagnoseInstance,
   diffEntry,
   displayDescription,
   displayTitle,
+  driverKind,
   effectsContextMap,
   evaluateFromSnapshot,
   evaluateMutationGuard,
@@ -4657,6 +4709,7 @@ export {
   subscriptionDocument,
   subscriptionDocumentsForInstance,
   tagScopeFilter,
+  taskKind,
   validateDefinition,
   validateTag,
   verdictGuardsForInstance,