@sanity/workflow-engine-test 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -3,7 +3,6 @@ import type { CompleteEffectArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsResult } from "@sanity/workflow-engine";
 import { DispatchResult } from "@sanity/workflow-engine";
-import { EffectsContextEntry } from "@sanity/workflow-engine";
 import type { EvaluateArgs } from "@sanity/workflow-engine";
 import type { FireActionArgs } from "@sanity/workflow-engine";
 import type { Grant } from "@sanity/workflow-engine";
@@ -275,6 +274,7 @@ declare type EngineWrappers = {
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
   guardsForInstance: (instanceId: string) => Promise<MutationGuardDoc[]>;
+  guardsForDefinition: (definition: string) => Promise<MutationGuardDoc[]>;
 };
 
 /**
@@ -527,52 +527,50 @@ declare type QueryHelpers = {
 declare type ReadHelpers = {
   /** Read the workflow instance by id. Throws if missing. */
   getInstance: (instanceId: string) => Promise<WorkflowInstance>;
-  /** Current stage id of an instance. */
+  /** Current stage name of an instance. */
   currentStage: (instanceId: string) => Promise<string>;
   /** Pending effects on an instance. */
   pendingEffects: (instanceId: string) => Promise<PendingEffect[]>;
   /** Status of a single task on an instance, or undefined if missing. */
   taskStatus: (
     instanceId: string,
-    taskId: string,
+    task: string,
   ) => Promise<TaskStatus | undefined>;
-  /** EffectsContext entries on an instance, keyed by `key`. */
-  effectsContextMap: (
-    instanceId: string,
-  ) => Promise<Record<string, EffectsContextEntry["value"]>>;
+  /** The rendered `$effects` map — context entries keyed by `name`,
+   *  completed-effect outputs namespaced under the effect's name. */
+  effectsContextMap: (instanceId: string) => Promise<Record<string, unknown>>;
   /**
-   * Spawned children of `parentInstanceId`. If `taskId` is provided,
+   * Spawned children of `parentInstanceId`. If `task` is provided,
    * only children spawned by that specific task on the parent.
    *
    * Walks `history.spawned` entries on the parent — this is the durable
-   * record. (The per-task `spawnedInstances` field on `stages[id == $stage && !defined(exitedAt)][0].tasks[]`
-   * gets wiped when the parent transitions past the spawning stage,
-   * since `taskStatus` is rebuilt on every transition.)
+   * record. (The per-task `spawnedInstances` field only lives on the
+   * open StageEntry's tasks; history survives transitions.)
    *
    * Returns children ordered by `startedAt` ascending.
    */
   children: (
     parentInstanceId: string,
-    taskId?: string,
+    task?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All workflow instances whose `workflow.state.doc.ref` slot named
-   * `slotId` (default `"subject"`) matches the given doc id. Useful
+   * All workflow instances whose `doc.ref` state entry named
+   * `entryName` (default `"subject"`) matches the given doc id. Useful
    * for "what workflow is running on this document?" questions. Pass
-   * `slotId` for workflows whose subject slot uses a different id.
+   * `entryName` for workflows whose subject entry uses a different name.
    */
   instancesForSubject: (
     subjectRef: string,
-    slotId?: string,
+    entryName?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All instances of `workflowId` currently at `stageId`. Includes
+   * All instances of `workflowName` currently at `stage`. Includes
    * completed instances (`completedAt != null`) by default; set
    * `{ openOnly: true }` to filter to in-flight only.
    */
   instancesByStage: (
-    workflowId: string,
-    stageId: string,
+    workflowName: string,
+    stage: string,
     options?: {
       openOnly?: boolean;
     },

package/dist/index.d.ts

@@ -3,7 +3,6 @@ import type { CompleteEffectArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsResult } from "@sanity/workflow-engine";
 import { DispatchResult } from "@sanity/workflow-engine";
-import { EffectsContextEntry } from "@sanity/workflow-engine";
 import type { EvaluateArgs } from "@sanity/workflow-engine";
 import type { FireActionArgs } from "@sanity/workflow-engine";
 import type { Grant } from "@sanity/workflow-engine";
@@ -275,6 +274,7 @@ declare type EngineWrappers = {
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
   guardsForInstance: (instanceId: string) => Promise<MutationGuardDoc[]>;
+  guardsForDefinition: (definition: string) => Promise<MutationGuardDoc[]>;
 };
 
 /**
@@ -527,52 +527,50 @@ declare type QueryHelpers = {
 declare type ReadHelpers = {
   /** Read the workflow instance by id. Throws if missing. */
   getInstance: (instanceId: string) => Promise<WorkflowInstance>;
-  /** Current stage id of an instance. */
+  /** Current stage name of an instance. */
   currentStage: (instanceId: string) => Promise<string>;
   /** Pending effects on an instance. */
   pendingEffects: (instanceId: string) => Promise<PendingEffect[]>;
   /** Status of a single task on an instance, or undefined if missing. */
   taskStatus: (
     instanceId: string,
-    taskId: string,
+    task: string,
   ) => Promise<TaskStatus | undefined>;
-  /** EffectsContext entries on an instance, keyed by `key`. */
-  effectsContextMap: (
-    instanceId: string,
-  ) => Promise<Record<string, EffectsContextEntry["value"]>>;
+  /** The rendered `$effects` map — context entries keyed by `name`,
+   *  completed-effect outputs namespaced under the effect's name. */
+  effectsContextMap: (instanceId: string) => Promise<Record<string, unknown>>;
   /**
-   * Spawned children of `parentInstanceId`. If `taskId` is provided,
+   * Spawned children of `parentInstanceId`. If `task` is provided,
    * only children spawned by that specific task on the parent.
    *
    * Walks `history.spawned` entries on the parent — this is the durable
-   * record. (The per-task `spawnedInstances` field on `stages[id == $stage && !defined(exitedAt)][0].tasks[]`
-   * gets wiped when the parent transitions past the spawning stage,
-   * since `taskStatus` is rebuilt on every transition.)
+   * record. (The per-task `spawnedInstances` field only lives on the
+   * open StageEntry's tasks; history survives transitions.)
    *
    * Returns children ordered by `startedAt` ascending.
    */
   children: (
     parentInstanceId: string,
-    taskId?: string,
+    task?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All workflow instances whose `workflow.state.doc.ref` slot named
-   * `slotId` (default `"subject"`) matches the given doc id. Useful
+   * All workflow instances whose `doc.ref` state entry named
+   * `entryName` (default `"subject"`) matches the given doc id. Useful
    * for "what workflow is running on this document?" questions. Pass
-   * `slotId` for workflows whose subject slot uses a different id.
+   * `entryName` for workflows whose subject entry uses a different name.
    */
   instancesForSubject: (
     subjectRef: string,
-    slotId?: string,
+    entryName?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All instances of `workflowId` currently at `stageId`. Includes
+   * All instances of `workflowName` currently at `stage`. Includes
    * completed instances (`completedAt != null`) by default; set
    * `{ openOnly: true }` to filter to in-flight only.
    */
   instancesByStage: (
-    workflowId: string,
-    stageId: string,
+    workflowName: string,
+    stage: string,
     options?: {
       openOnly?: boolean;
     },

package/dist/index.js

@@ -1,4 +1,4 @@
-import { guardsForResource, denyingGuards, MutationGuardDeniedError, workflow, validateTags } from "@sanity/workflow-engine";
+import { guardsForResource, denyingGuards, MutationGuardDeniedError, workflow, WORKFLOW_INSTANCE_TYPE, tagScopeFilter, effectsContextMap, validateTags } from "@sanity/workflow-engine";
 import require$$0 from "tty";
 import require$$1 from "util";
 function escapeRegExp(string2) {
@@ -5047,11 +5047,7 @@ function benchMutationGuard(getClient) {
       ...identity !== void 0 ? { identity } : {}
     });
     if (denied.length > 0)
-      throw new MutationGuardDeniedError({
-        documentId: id,
-        action,
-        denied: denied.map((g) => ({ guardId: g._id, ...g.name ? { name: g.name } : {} }))
-      });
+      throw MutationGuardDeniedError.fromGuards({ documentId: id, action, guards: denied });
   };
 }
 function resolveBenchClient(options) {
@@ -5100,7 +5096,8 @@ function createEngineWrappers(scope, access, clock) {
     completeEffect: (args) => workflow.completeEffect(withAccess(args)),
     tick: (args) => workflow.tick(withAccess(args)),
     evaluate: (args) => workflow.evaluate(withAccess(args)),
-    guardsForInstance: (instanceId) => workflow.guardsForInstance({ ...scope, instanceId })
+    guardsForInstance: (instanceId) => workflow.guardsForInstance({ ...scope, instanceId }),
+    guardsForDefinition: (definition) => workflow.guardsForDefinition({ ...scope, definition })
   };
 }
 function createGuardHelpers(client) {
@@ -5144,42 +5141,38 @@ function createReadHelpers(scope) {
   };
   return {
     getInstance,
-    currentStage: async (instanceId) => (await getInstance(instanceId)).currentStageId,
+    currentStage: async (instanceId) => (await getInstance(instanceId)).currentStage,
     pendingEffects: async (instanceId) => (await getInstance(instanceId)).pendingEffects,
-    taskStatus: async (instanceId, taskId) => {
+    taskStatus: async (instanceId, task) => {
       const instance = await getInstance(instanceId);
       return instance.stages.find(
-        (s) => s.id === instance.currentStageId && s.exitedAt === void 0
-      )?.tasks.find((t) => t.id === taskId)?.status;
-    },
-    effectsContextMap: async (instanceId) => {
-      const instance = await getInstance(instanceId), map2 = {};
-      for (const entry of instance.effectsContext) map2[entry.id] = entry.value;
-      return map2;
+        (s) => s.name === instance.currentStage && s.exitedAt === void 0
+      )?.tasks.find((t) => t.name === task)?.status;
     },
-    children: async (parentInstanceId, taskId) => workflow.children({
+    effectsContextMap: async (instanceId) => effectsContextMap(await getInstance(instanceId)),
+    children: async (parentInstanceId, task) => workflow.children({
       ...scope,
       instanceId: parentInstanceId,
-      ...taskId !== void 0 ? { taskId } : {}
+      ...task !== void 0 ? { task } : {}
     }),
-    instancesForSubject: async (subjectRef, slotId = "subject") => (
-      // Subjects live on a workflow-scope `state[id == $slot]` doc.ref
-      // slot. Match instances whose slot's value.id equals the supplied
-      // ref. The slot id is conventionally "subject" but workflows may
-      // name it otherwise.
+    instancesForSubject: async (subjectRef, entryName = "subject") => (
+      // Subjects live on a workflow-scope `doc.ref` state entry. Match
+      // instances whose entry's value.id equals the supplied ref. The
+      // entry name is conventionally "subject" but workflows may name
+      // it otherwise.
       client.fetch(
-        `*[_type == "workflow.instance"
-          && state[_type == "workflow.state.doc.ref" && id == $slot][0].value.id == $ref
-          && count(tags[@ in $engineTags]) > 0] | order(startedAt asc)`,
-        { ref: subjectRef, slot: slotId, engineTags: tags }
+        `*[_type == "${WORKFLOW_INSTANCE_TYPE}"
+          && state[_type == "doc.ref" && name == $entry][0].value.id == $ref
+          && ${tagScopeFilter()}] | order(startedAt asc)`,
+        { ref: subjectRef, entry: entryName, engineTags: tags }
       )
     ),
-    instancesByStage: async (workflowId, stageId, queryOptions) => {
+    instancesByStage: async (workflowName, stage, queryOptions) => {
       const filter = queryOptions?.openOnly ? " && completedAt == null" : "";
       return client.fetch(
-        `*[_type == "workflow.instance" && workflowId == $wf && currentStageId == $stage && count(tags[@ in $engineTags]) > 0${filter}]
+        `*[_type == "${WORKFLOW_INSTANCE_TYPE}" && definition == $wf && currentStage == $stage && ${tagScopeFilter()}${filter}]
           | order(startedAt asc)`,
-        { wf: workflowId, stage: stageId, engineTags: tags }
+        { wf: workflowName, stage, engineTags: tags }
       );
     },
     snapshot: () => client.snapshot()