@sanity/workflow-engine-test 0.6.1 → 0.8.0

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import { ActivityStatus } from "@sanity/workflow-engine";
 import { Actor } from "@sanity/workflow-engine";
 import type { CompleteEffectArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsArgs } from "@sanity/workflow-engine";
@@ -6,13 +7,13 @@ 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 { GdrUri } from "@sanity/workflow-engine";
 import type { Grant } from "@sanity/workflow-engine";
 import { MutationGuardAction } from "@sanity/workflow-engine";
 import { MutationGuardDoc } from "@sanity/workflow-engine";
 import type { OperationArgs } from "@sanity/workflow-engine";
 import { PendingEffect } from "@sanity/workflow-engine";
 import type { StartInstanceArgs } from "@sanity/workflow-engine";
-import { TaskStatus } from "@sanity/workflow-engine";
 import type { WorkflowAccess } from "@sanity/workflow-engine";
 import { WorkflowEvaluation } from "@sanity/workflow-engine";
 import { WorkflowInstance } from "@sanity/workflow-engine";
@@ -399,14 +400,12 @@ declare type GuardHelpers = {
    * `as` routes the write through a token-scoped sibling so `identity()`
    * resolves to that actor.
    */
-  editDocument: (
-    documentId: string,
-    patch: Record<string, unknown>,
-    options?: {
-      action?: MutationGuardAction;
-      as?: Actor;
-    },
-  ) => Promise<StoreDocument>;
+  editDocument: (opts: {
+    documentId: string;
+    patch: Record<string, unknown>;
+    action?: MutationGuardAction;
+    as?: Actor;
+  }) => Promise<StoreDocument>;
 };
 
 /** Result of a mutation when ids are requested for all affected documents. */
@@ -532,11 +531,15 @@ declare type QueryHelpers = {
    * workflow?" — useful for filter debugging, UIs that mirror engine
    * state, etc.
    */
-  queryInScope: <T = unknown>(
-    instanceId: string,
-    groq: string,
-    params?: Record<string, unknown>,
-  ) => Promise<T>;
+  queryInScope: <T = unknown>({
+    instanceId,
+    groq,
+    params,
+  }: {
+    instanceId: string;
+    groq: string;
+    params?: Record<string, unknown>;
+  }) => Promise<T>;
 };
 
 declare type ReadHelpers = {
@@ -546,27 +549,27 @@ declare type ReadHelpers = {
   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: (
+  /** Status of a single activity on an instance, or undefined if missing. */
+  activityStatus: (
     instanceId: string,
-    task: string,
-  ) => Promise<TaskStatus | undefined>;
+    activity: string,
+  ) => Promise<ActivityStatus | undefined>;
   /** 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 `task` is provided,
-   * only children spawned by that specific task on the parent.
+   * Spawned children of `parentInstanceId`. If `activity` is provided,
+   * only children spawned by that specific activity on the parent.
    *
    * Walks `history.spawned` entries on the parent — this is the durable
-   * record. (The per-task `spawnedInstances` field only lives on the
-   * open StageEntry's tasks; history survives transitions.)
+   * record. (The per-activity `spawnedInstances` field only lives on the
+   * open StageEntry's activities; history survives transitions.)
    *
    * Returns children ordered by `startedAt` ascending.
    */
   children: (
     parentInstanceId: string,
-    task?: string,
+    activity?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
    * All workflow instances whose `doc.ref` field entry named
@@ -583,13 +586,18 @@ declare type ReadHelpers = {
    * completed instances (`completedAt != null`) by default; set
    * `{ openOnly: true }` to filter to in-flight only.
    */
-  instancesByStage: (
-    workflowName: string,
-    stage: string,
-    options?: {
-      openOnly?: boolean;
-    },
-  ) => Promise<WorkflowInstance[]>;
+  instancesByStage: (options: {
+    workflowName: string;
+    stage: string;
+    openOnly?: boolean;
+  }) => Promise<WorkflowInstance[]>;
+  /**
+   * Every in-flight instance whose reactive watch-set includes `document`
+   * (a resource-qualified GDR URI) — the reverse of the forward watch-set.
+   * Answers "which instances should this changed doc `tick`?" the way a
+   * non-reactive content forwarder needs. Sorted by `startedAt` ascending.
+   */
+  instancesForDocument: (document: GdrUri) => Promise<WorkflowInstance[]>;
   /** Snapshot of all documents in the store — for inspecting the world. */
   snapshot: () => readonly StoreDocument[];
 };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ActivityStatus } from "@sanity/workflow-engine";
 import { Actor } from "@sanity/workflow-engine";
 import type { CompleteEffectArgs } from "@sanity/workflow-engine";
 import { DeployDefinitionsArgs } from "@sanity/workflow-engine";
@@ -6,13 +7,13 @@ 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 { GdrUri } from "@sanity/workflow-engine";
 import type { Grant } from "@sanity/workflow-engine";
 import { MutationGuardAction } from "@sanity/workflow-engine";
 import { MutationGuardDoc } from "@sanity/workflow-engine";
 import type { OperationArgs } from "@sanity/workflow-engine";
 import { PendingEffect } from "@sanity/workflow-engine";
 import type { StartInstanceArgs } from "@sanity/workflow-engine";
-import { TaskStatus } from "@sanity/workflow-engine";
 import type { WorkflowAccess } from "@sanity/workflow-engine";
 import { WorkflowEvaluation } from "@sanity/workflow-engine";
 import { WorkflowInstance } from "@sanity/workflow-engine";
@@ -399,14 +400,12 @@ declare type GuardHelpers = {
    * `as` routes the write through a token-scoped sibling so `identity()`
    * resolves to that actor.
    */
-  editDocument: (
-    documentId: string,
-    patch: Record<string, unknown>,
-    options?: {
-      action?: MutationGuardAction;
-      as?: Actor;
-    },
-  ) => Promise<StoreDocument>;
+  editDocument: (opts: {
+    documentId: string;
+    patch: Record<string, unknown>;
+    action?: MutationGuardAction;
+    as?: Actor;
+  }) => Promise<StoreDocument>;
 };
 
 /** Result of a mutation when ids are requested for all affected documents. */
@@ -532,11 +531,15 @@ declare type QueryHelpers = {
    * workflow?" — useful for filter debugging, UIs that mirror engine
    * state, etc.
    */
-  queryInScope: <T = unknown>(
-    instanceId: string,
-    groq: string,
-    params?: Record<string, unknown>,
-  ) => Promise<T>;
+  queryInScope: <T = unknown>({
+    instanceId,
+    groq,
+    params,
+  }: {
+    instanceId: string;
+    groq: string;
+    params?: Record<string, unknown>;
+  }) => Promise<T>;
 };
 
 declare type ReadHelpers = {
@@ -546,27 +549,27 @@ declare type ReadHelpers = {
   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: (
+  /** Status of a single activity on an instance, or undefined if missing. */
+  activityStatus: (
     instanceId: string,
-    task: string,
-  ) => Promise<TaskStatus | undefined>;
+    activity: string,
+  ) => Promise<ActivityStatus | undefined>;
   /** 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 `task` is provided,
-   * only children spawned by that specific task on the parent.
+   * Spawned children of `parentInstanceId`. If `activity` is provided,
+   * only children spawned by that specific activity on the parent.
    *
    * Walks `history.spawned` entries on the parent — this is the durable
-   * record. (The per-task `spawnedInstances` field only lives on the
-   * open StageEntry's tasks; history survives transitions.)
+   * record. (The per-activity `spawnedInstances` field only lives on the
+   * open StageEntry's activities; history survives transitions.)
    *
    * Returns children ordered by `startedAt` ascending.
    */
   children: (
     parentInstanceId: string,
-    task?: string,
+    activity?: string,
   ) => Promise<WorkflowInstance[]>;
   /**
    * All workflow instances whose `doc.ref` field entry named
@@ -583,13 +586,18 @@ declare type ReadHelpers = {
    * completed instances (`completedAt != null`) by default; set
    * `{ openOnly: true }` to filter to in-flight only.
    */
-  instancesByStage: (
-    workflowName: string,
-    stage: string,
-    options?: {
-      openOnly?: boolean;
-    },
-  ) => Promise<WorkflowInstance[]>;
+  instancesByStage: (options: {
+    workflowName: string;
+    stage: string;
+    openOnly?: boolean;
+  }) => Promise<WorkflowInstance[]>;
+  /**
+   * Every in-flight instance whose reactive watch-set includes `document`
+   * (a resource-qualified GDR URI) — the reverse of the forward watch-set.
+   * Answers "which instances should this changed doc `tick`?" the way a
+   * non-reactive content forwarder needs. Sorted by `startedAt` ascending.
+   */
+  instancesForDocument: (document: GdrUri) => Promise<WorkflowInstance[]>;
   /** Snapshot of all documents in the store — for inspecting the world. */
   snapshot: () => readonly StoreDocument[];
 };

package/dist/index.js

@@ -5069,7 +5069,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;
@@ -5082,10 +5086,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)
   });
@@ -5117,8 +5125,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);
@@ -5129,7 +5137,11 @@ function createQueryHelpers(scope) {
   const withParams = (params) => params !== void 0 ? { params } : {};
   return {
     query: (groq, params) => workflow.query({ ...scope, groq, ...withParams(params) }),
-    queryInScope: (instanceId, groq, params) => workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
+    queryInScope: ({
+      instanceId,
+      groq,
+      params
+    }) => workflow.queryInScope({ ...scope, instanceId, groq, ...withParams(params) })
   };
 }
 function createReadHelpers(scope) {
@@ -5144,17 +5156,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) => effectsContextMap(await getInstance(instanceId)),
-    children: async (parentInstanceId, task) => workflow.children({
+    children: async (parentInstanceId, activity) => 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
@@ -5168,21 +5180,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 == "${WORKFLOW_INSTANCE_TYPE}" && definition == $wf && currentStage == $stage && ${tagScopeFilter()}${filter}]
           | order(startedAt asc)`,
         { wf: workflowName, stage, tag }
       );
     },
+    instancesForDocument: async (document2) => workflow.instancesForDocument({ ...scope, document: document2 }),
     snapshot: () => client.snapshot()
   };
 }
 function createBench(options = {}) {
   const tag = options.tag ?? "bench";
   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 {
@@ -5200,7 +5217,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)