@sanity/workflow-engine-test 0.6.1 → 0.8.0

package/README.md

@@ -20,7 +20,7 @@ that lock the documents it governs while the stage is active, and lift when it
 exits. There are two distinct things you test, and the bench gives you a helper
 for each:
 
-- **Write-time enforcement** — `bench.editDocument(id, patch)` writes through the
+- **Write-time enforcement** — `bench.editDocument({documentId, patch})` writes through the
   bench client, which **simulates the lake's server-side guard rejection**: a
   write a deployed guard denies throws `MutationGuardDeniedError`. In production
   the lake enforces this for _any_ client; the bench reproduces it on the
@@ -41,7 +41,7 @@ const bench = createBench({documents: [{_id: 'doc-1', _type: 'article', body: 'b
 const active = await bench.activeGuardsForDocument('doc-1')
 
 // Enforcement: a guard-violating write is rejected.
-await expect(bench.editDocument('doc-1', {body: 'edited'})).rejects.toThrow(
+await expect(bench.editDocument({documentId: 'doc-1', patch: {body: 'edited'}})).rejects.toThrow(
   MutationGuardDeniedError,
 )
 ```

package/dist/index.cjs

@@ -5073,7 +5073,11 @@ function resolveBenchAccess(options) {
     grants: options.grants ?? WILDCARD_GRANTS
   };
 }
-function accessFor(access, args, canTokenResolve) {
+function accessFor({
+  access,
+  args,
+  canTokenResolve
+}) {
   if (args.access !== void 0) return args.access;
   if (args.actor === void 0 && args.grants === void 0) return access;
   const inheritedGrants = canTokenResolve ? void 0 : access.grants, grants = args.grants ?? inheritedGrants;
@@ -5086,10 +5090,14 @@ function stripAccessShortcuts(args) {
   const rest = { ...args };
   return delete rest.access, delete rest.actor, delete rest.grants, rest;
 }
-function createEngineWrappers(scope, access, clock) {
+function createEngineWrappers({
+  scope,
+  access,
+  clock
+}) {
   const canTokenResolve = "request" in scope.client, withAccess = (args) => ({
     ...scope,
-    access: accessFor(access, args, canTokenResolve),
+    access: accessFor({ access, args, canTokenResolve }),
     clock,
     ...stripAccessShortcuts(args)
   });
@@ -5121,8 +5129,8 @@ function createGuardHelpers(client) {
         ...as ? { identity: as.id } : {}
       });
     },
-    editDocument: async (documentId, patch, editOptions) => {
-      const action = editOptions?.action ?? "update", as = editOptions?.as, writer = as ? client.withConfig({
+    editDocument: async ({ documentId, patch, action: editAction, as }) => {
+      const action = editAction ?? "update", writer = as ? client.withConfig({
         accessControl: { currentUser: { id: as.id }, grants: WILDCARD_GRANTS }
       }) : client;
       return action === "delete" ? await writer.delete(documentId) : await writer.patch(documentId).set(patch).commit(), await client.getDocument(documentId);
@@ -5133,7 +5141,11 @@ function createQueryHelpers(scope) {
   const withParams = (params) => params !== void 0 ? { params } : {};
   return {
     query: (groq, params) => workflowEngine.workflow.query({ ...scope, groq, ...withParams(params) }),
-    queryInScope: (instanceId, groq, params) => workflowEngine.workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
+    queryInScope: ({
+      instanceId,
+      groq,
+      params
+    }) => workflowEngine.workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
   };
 }
 function createReadHelpers(scope) {
@@ -5148,17 +5160,17 @@ function createReadHelpers(scope) {
     getInstance,
     currentStage: async (instanceId) => (await getInstance(instanceId)).currentStage,
     pendingEffects: async (instanceId) => (await getInstance(instanceId)).pendingEffects,
-    taskStatus: async (instanceId, task) => {
+    activityStatus: async (instanceId, activity) => {
       const instance = await getInstance(instanceId);
       return instance.stages.find(
         (s) => s.name === instance.currentStage && s.exitedAt === void 0
-      )?.tasks.find((t) => t.name === task)?.status;
+      )?.activities.find((t) => t.name === activity)?.status;
     },
     effectsContextMap: async (instanceId) => workflowEngine.effectsContextMap(await getInstance(instanceId)),
-    children: async (parentInstanceId, task) => workflowEngine.workflow.children({
+    children: async (parentInstanceId, activity) => workflowEngine.workflow.children({
       ...scope,
       instanceId: parentInstanceId,
-      ...task !== void 0 ? { task } : {}
+      ...activity !== void 0 ? { activity } : {}
     }),
     instancesForSubject: async (subjectRef, entryName = "subject") => (
       // Subjects live on a workflow-scope `doc.ref` field entry. Match
@@ -5172,21 +5184,26 @@ function createReadHelpers(scope) {
         { ref: subjectRef, entry: entryName, tag }
       )
     ),
-    instancesByStage: async (workflowName, stage, queryOptions) => {
-      const filter = queryOptions?.openOnly ? " && completedAt == null" : "";
+    instancesByStage: async ({ workflowName, stage, openOnly }) => {
+      const filter = openOnly ? " && completedAt == null" : "";
       return client.fetch(
         `*[_type == "${workflowEngine.WORKFLOW_INSTANCE_TYPE}" && definition == $wf && currentStage == $stage && ${workflowEngine.tagScopeFilter()}${filter}]
           | order(startedAt asc)`,
         { wf: workflowName, stage, tag }
       );
     },
+    instancesForDocument: async (document2) => workflowEngine.workflow.instancesForDocument({ ...scope, document: document2 }),
     snapshot: () => client.snapshot()
   };
 }
 function createBench(options = {}) {
   const tag = options.tag ?? "bench";
   workflowEngine.validateTag(tag);
-  const workflowResource = options.workflowResource ?? DEFAULT_WORKFLOW_RESOURCE, client = resolveBenchClient(options), scope = { client, tag, workflowResource }, access = resolveBenchAccess(options);
+  const workflowResource = options.workflowResource ?? DEFAULT_WORKFLOW_RESOURCE, client = resolveBenchClient(options), scope = {
+    client,
+    tag,
+    workflowResource
+  }, access = resolveBenchAccess(options);
   let frozenNow = options.now !== void 0 ? assertIsoInstant(options.now) : void 0;
   const clock = () => frozenNow ?? (/* @__PURE__ */ new Date()).toISOString();
   return {
@@ -5204,7 +5221,7 @@ function createBench(options = {}) {
         throw new Error(`bench.advance: ms must be a finite number, got ${ms2}`);
       frozenNow = new Date(Date.parse(frozenNow ?? (/* @__PURE__ */ new Date()).toISOString()) + ms2).toISOString();
     },
-    ...createEngineWrappers(scope, access, clock),
+    ...createEngineWrappers({ scope, access, clock }),
     ...createReadHelpers(scope),
     ...createGuardHelpers(client),
     ...createQueryHelpers(scope)