@sanity/workflow-engine-test 0.5.0 → 0.6.0

package/dist/index.d.cts

@@ -3,7 +3,7 @@ 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 type { EditStateArgs } from "@sanity/workflow-engine";
+import type { EditFieldArgs } 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";
@@ -61,8 +61,8 @@ declare type BenchCompleteEffectArgs = Omit<
   actor?: Actor;
 };
 
-declare type BenchEditStateArgs = Omit<
-  EditStateArgs,
+declare type BenchEditFieldArgs = Omit<
+  EditFieldArgs,
   "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
@@ -285,7 +285,7 @@ declare type EngineWrappers = {
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
-  editState: (args: BenchEditStateArgs) => Promise<DispatchResult>;
+  editField: (args: BenchEditFieldArgs) => Promise<DispatchResult>;
   completeEffect: (args: BenchCompleteEffectArgs) => Promise<DispatchResult>;
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
@@ -569,7 +569,7 @@ declare type ReadHelpers = {
     task?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All workflow instances whose `doc.ref` state entry named
+   * All workflow instances whose `doc.ref` field entry named
    * `entryName` (default `"subject"`) matches the given doc id. Useful
    * for "what workflow is running on this document?" questions. Pass
    * `entryName` for workflows whose subject entry uses a different name.

package/dist/index.d.ts

@@ -3,7 +3,7 @@ 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 type { EditStateArgs } from "@sanity/workflow-engine";
+import type { EditFieldArgs } 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";
@@ -61,8 +61,8 @@ declare type BenchCompleteEffectArgs = Omit<
   actor?: Actor;
 };
 
-declare type BenchEditStateArgs = Omit<
-  EditStateArgs,
+declare type BenchEditFieldArgs = Omit<
+  EditFieldArgs,
   "client" | "tag" | "workflowResource" | "access"
 > & {
   access?: WorkflowAccess;
@@ -285,7 +285,7 @@ declare type EngineWrappers = {
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
-  editState: (args: BenchEditStateArgs) => Promise<DispatchResult>;
+  editField: (args: BenchEditFieldArgs) => Promise<DispatchResult>;
   completeEffect: (args: BenchCompleteEffectArgs) => Promise<DispatchResult>;
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
@@ -569,7 +569,7 @@ declare type ReadHelpers = {
     task?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
-   * All workflow instances whose `doc.ref` state entry named
+   * All workflow instances whose `doc.ref` field entry named
    * `entryName` (default `"subject"`) matches the given doc id. Useful
    * for "what workflow is running on this document?" questions. Pass
    * `entryName` for workflows whose subject entry uses a different name.

package/dist/index.js

@@ -5093,7 +5093,7 @@ function createEngineWrappers(scope, access, clock) {
     deployDefinitions: (args) => workflow.deployDefinitions({ ...scope, ...args }),
     startInstance: (args) => workflow.startInstance(withAccess(args)),
     fireAction: (args) => workflow.fireAction(withAccess(args)),
-    editState: (args) => workflow.editState(withAccess(args)),
+    editField: (args) => workflow.editField(withAccess(args)),
     completeEffect: (args) => workflow.completeEffect(withAccess(args)),
     tick: (args) => workflow.tick(withAccess(args)),
     evaluate: (args) => workflow.evaluate(withAccess(args)),
@@ -5157,13 +5157,13 @@ function createReadHelpers(scope) {
       ...task !== void 0 ? { task } : {}
     }),
     instancesForSubject: async (subjectRef, entryName = "subject") => (
-      // Subjects live on a workflow-scope `doc.ref` state entry. Match
+      // Subjects live on a workflow-scope `doc.ref` field 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_TYPE}"
-          && state[_type == "doc.ref" && name == $entry][0].value.id == $ref
+          && fields[_type == "doc.ref" && name == $entry][0].value.id == $ref
           && ${tagScopeFilter()}] | order(startedAt asc)`,
         { ref: subjectRef, entry: entryName, tag }
       )