@sanity/workflow-engine-test 0.6.0 → 0.7.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";
@@ -546,27 +547,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
@@ -590,6 +591,13 @@ declare type ReadHelpers = {
       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";
@@ -546,27 +547,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
@@ -590,6 +591,13 @@ declare type ReadHelpers = {
       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

@@ -5144,17 +5144,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
@@ -5176,6 +5176,7 @@ function createReadHelpers(scope) {
         { wf: workflowName, stage, tag }
       );
     },
+    instancesForDocument: async (document2) => workflow.instancesForDocument({ ...scope, document: document2 }),
     snapshot: () => client.snapshot()
   };
 }