@sanity/workflow-engine-test 0.4.2 → 0.6.0

package/dist/index.d.cts

@@ -3,6 +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 { 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";
@@ -35,11 +36,13 @@ declare interface ActionResult {
 export declare const ALL_ACCESS: WorkflowAccess;
 
 /**
- * The default actor used when tests don't specify one. Has the
- * conventional `"*"` wildcard role — `Action.roles` checks treat
- * `"*"` as matching any required role, and `Task.assignees` of
- * `{kind: "role"}` are satisfied by it too. Production code should
- * never see this id.
+ * The default actor used when tests don't specify one. Its `"*"` role is an
+ * inert placeholder, NOT a wildcard: role matching is literal membership, so
+ * this actor satisfies no `Action.roles` gate or `{kind: "role"}` assignee on
+ * its own — a test that exercises a role gate passes an actor carrying the
+ * real role (and the definition's `roleAliases` decide what fulfills it). The
+ * bench's all-access default is really {@link WILDCARD_GRANTS}, which feeds
+ * `$can`. Production code should never see this id.
  */
 export declare const ALL_ACCESS_USER: Actor;
 
@@ -58,6 +61,17 @@ declare type BenchCompleteEffectArgs = Omit<
   actor?: Actor;
 };
 
+declare type BenchEditFieldArgs = Omit<
+  EditFieldArgs,
+  "client" | "tag" | "workflowResource" | "access"
+> & {
+  access?: WorkflowAccess;
+  /** Shortcut for `access.actor`. */
+  actor?: Actor;
+  /** Shortcut for `access.grants`. */
+  grants?: Grant[];
+};
+
 declare type BenchEvaluateArgs = Omit<
   EvaluateArgs,
   "client" | "tag" | "workflowResource" | "access"
@@ -271,6 +285,7 @@ declare type EngineWrappers = {
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
+  editField: (args: BenchEditFieldArgs) => Promise<DispatchResult>;
   completeEffect: (args: BenchCompleteEffectArgs) => Promise<DispatchResult>;
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
@@ -554,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,6 +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 { 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";
@@ -35,11 +36,13 @@ declare interface ActionResult {
 export declare const ALL_ACCESS: WorkflowAccess;
 
 /**
- * The default actor used when tests don't specify one. Has the
- * conventional `"*"` wildcard role — `Action.roles` checks treat
- * `"*"` as matching any required role, and `Task.assignees` of
- * `{kind: "role"}` are satisfied by it too. Production code should
- * never see this id.
+ * The default actor used when tests don't specify one. Its `"*"` role is an
+ * inert placeholder, NOT a wildcard: role matching is literal membership, so
+ * this actor satisfies no `Action.roles` gate or `{kind: "role"}` assignee on
+ * its own — a test that exercises a role gate passes an actor carrying the
+ * real role (and the definition's `roleAliases` decide what fulfills it). The
+ * bench's all-access default is really {@link WILDCARD_GRANTS}, which feeds
+ * `$can`. Production code should never see this id.
  */
 export declare const ALL_ACCESS_USER: Actor;
 
@@ -58,6 +61,17 @@ declare type BenchCompleteEffectArgs = Omit<
   actor?: Actor;
 };
 
+declare type BenchEditFieldArgs = Omit<
+  EditFieldArgs,
+  "client" | "tag" | "workflowResource" | "access"
+> & {
+  access?: WorkflowAccess;
+  /** Shortcut for `access.actor`. */
+  actor?: Actor;
+  /** Shortcut for `access.grants`. */
+  grants?: Grant[];
+};
+
 declare type BenchEvaluateArgs = Omit<
   EvaluateArgs,
   "client" | "tag" | "workflowResource" | "access"
@@ -271,6 +285,7 @@ declare type EngineWrappers = {
   ) => Promise<DeployDefinitionsResult>;
   startInstance: (args: BenchStartInstanceArgs) => Promise<WorkflowInstance>;
   fireAction: (args: BenchFireActionArgs) => Promise<DispatchResult>;
+  editField: (args: BenchEditFieldArgs) => Promise<DispatchResult>;
   completeEffect: (args: BenchCompleteEffectArgs) => Promise<DispatchResult>;
   tick: (args: BenchTickArgs) => Promise<DispatchResult>;
   evaluate: (args: BenchEvaluateArgs) => Promise<WorkflowEvaluation>;
@@ -554,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,6 +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)),
+    editField: (args) => workflow.editField(withAccess(args)),
     completeEffect: (args) => workflow.completeEffect(withAccess(args)),
     tick: (args) => workflow.tick(withAccess(args)),
     evaluate: (args) => workflow.evaluate(withAccess(args)),
@@ -5156,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 }
       )