@sanity/workflow-studio 0.29.0 → 0.31.0

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @sanity/workflow-studio
 
+## 0.31.0
+
+### Patch Changes
+
+- Updated dependencies [ff72ece]
+  - @sanity/workflow-engine@0.31.0
+  - @sanity/workflow-react@0.31.0
+  - @sanity/workflow-sdk@0.31.0
+
+## 0.30.0
+
+### Minor Changes
+
+- a3a8dc0: **BREAKING:** the exported `WorkflowObserver` contract (workflow-react) gains two required members, `fetchInstancePreviews` and `listenInstanceChanges` — a custom observer no longer compiles until it implements both; the shipped SDK and Studio adapters already do, so their consumers need no action.
+
+  The reactive layer gains a progressively-hydrated preview list. `useInstancePreviews` (workflow-react) drains the engine's preview projection page by page until the whole filtered set is held — `drained: true` means counts over it are totals — then keeps every row fresh from ONE shared change listener per engine tag: an event refetches the touched previews alone, so update cost is per commit, never per list size. Page size is caller-supplied. The engine adds `instanceChangesQuery` (the tag partition as a listen filter), and the `WorkflowObserver` contract adds `fetchInstancePreviews` and `listenInstanceChanges`, implemented by the SDK observer (the Studio adapter inherits them). A change-feed failure never silently freezes a list: the SDK observer reconnects with exponential backoff and then emits a `reset` event, on which `useInstancePreviews` re-drains the whole partition — gap-missed additions, edits, and deletions all land.
+
+  **Docs impact:** The reactive-core reference documents `useInstancePreviews` and the observer contract's two new required members in this release's pass — the Workflows tool ships reading them in the same release, and the custom-adapter guidance must name both members beside the BREAKING note.
+
+- a3a8dc0: The Workflows tool now reaches every run. The Overview table, the board, and the Definitions catalog read the progressively-hydrated preview stream instead of a 200-instance capped read: lists fill page by page until the whole partition is held (a "Loading workflows…" note discloses the gap while counts are still a floor), then stay fresh from the shared change feed. Display strings join from the deployed catalog rather than each run's pinned snapshot, so a workflow absent from the catalog shows raw names. The board cuts the shared stream client-side, retiring its per-workflow capped read and cap note. `workflowStudioPlugin` accepts `previewHydration: {pageSize?, interPageDelayMs?}` to tune or simulate hydration, `@sanity/workflow-studio` exports the `useWorkflowInstancePreviews` wrapper, and `useInstancePreviews` (workflow-react) accepts `interPageDelayMs`, a development throttle between hydration pages. No upgrade action required.
+
+  **Docs impact:** The Workflows-tool guide should drop the capped-read caveat and describe progressive hydration (counts grow until the stream drains); the plugin configuration reference gains `previewHydration`; the Studio adapter reference gains `useWorkflowInstancePreviews`; the reactive-core reference gains `interPageDelayMs` beside `useInstancePreviews`.
+
+- b0b1550: **BREAKING:** Product-prefixed telemetry events now use `Workflows <event>` instead of `Editorial Workflows <event>`; `EditorialWorkflowsResource` is replaced by `WorkflowsResource`; and `defineWorkflows` now generates `workflows-<deployment name>` resource names instead of `editorial-workflows-<deployment name>`. Telemetry consumers matching the previous literals stop receiving events until updated, TypeScript consumers importing the previous Blueprint interface no longer compile, and an existing Blueprint stack that relies on the generated name treats the new default as a different resource identity.
+
+  Update telemetry dashboards, schemas, alerts, and queries to match the `Workflows` prefix; event suffixes, payloads, and versions are unchanged. Replace Blueprint imports with `WorkflowsResource`. Before deploying an existing Blueprint stack, either pass its recorded resource name explicitly or plan the detach-and-create migration to the new default. Workflows request-tag families and billing classification are unchanged.
+
+  Other user-facing package copy now uses the Workflows product name. No upgrade action is required for consumers that do not match telemetry event names or use the Blueprint package.
+
+  **Docs impact:** Rename the product throughout the public documentation, move the docs section to `/docs/workflows/*` with permanent redirects from every `/docs/editorial-workflows/*` path, and document the telemetry-prefix, `WorkflowsResource`, and Blueprint resource-name migrations in the telemetry reference, Blueprint guide, and release notes.
+
+### Patch Changes
+
+- Updated dependencies [210ca63]
+- Updated dependencies [a3a8dc0]
+- Updated dependencies [a3a8dc0]
+- Updated dependencies [a3a8dc0]
+- Updated dependencies [90207dc]
+- Updated dependencies [a3a8dc0]
+- Updated dependencies [b0b1550]
+  - @sanity/workflow-engine@0.30.0
+  - @sanity/workflow-react@0.30.0
+  - @sanity/workflow-sdk@0.30.0
+
 ## 0.29.0
 
 ### Patch Changes

package/README.md

@@ -31,9 +31,13 @@ Studio source context (`useSource` / `useClient`).
   in `unreadable`. Hooks under one Studio source share the auto-bootstrapped
   SDK instance; callers can instead pass a shared `sdk` explicitly. SDK store
   errors surface reactively through `error`.
+- `useWorkflowInstancePreviews` — `useInstancePreviews` (workflow-react) bound
+  to the auto-bootstrapped observer: the whole tag partition as light preview
+  rows, drained page by page and kept fresh from the shared change feed.
+  Returns `{previews, loading, drained, unreadable, error}`.
 - `useStudioProjectUsers` — the shared Studio project-user directory used by
   actor resolution and member pickers. It returns the upstream membership and
-  profile records without an Editorial Workflows projection, the project's
+  profile records without a Workflows projection, the project's
   assignable `roles`, and the engine's `ProjectUserDirectory` integration. The
   role catalog is read alongside the memberships and is the only account of a
   role nobody currently holds; it is filtered to roles a person can be assigned,
@@ -97,7 +101,7 @@ This adapter composes `@sanity/workflow-sdk`'s store layer through its headless
 
 - **`@sanity/sdk` is required** (peer) — it addresses every observed resource.
 - **`@sanity/workflow-engine` is required** (peer) — the host and adapter share one engine runtime.
-- **`@sanity/workflow-react` and `@sanity/workflow-sdk` are required** (exact-version peers) — install the matching Editorial Workflows release stack so the reactive context and SDK store are single-sourced.
+- **`@sanity/workflow-react` and `@sanity/workflow-sdk` are required** (exact-version peers) — install the matching Workflows release stack so the reactive context and SDK store are single-sourced.
 - **`@sanity/sdk-react` is NOT required** — nothing here touches the App
   SDK's React binding.
 

package/dist/index.cjs

@@ -187,6 +187,26 @@ function useDocumentWorkflows({engine: engine, document: document, sdk: sdk2}) {
     });
 }
 
+function useWorkflowInstancePreviews({engine: engine, filter: filter, interPageDelayMs: interPageDelayMs, pageSize: pageSize, sdk: sdk2}) {
+    const observer2 = useStudioObserver({
+        engine: engine,
+        sdk: sdk2
+    });
+    return workflowReact.useInstancePreviews({
+        engine: engine,
+        observer: observer2,
+        ...filter !== void 0 ? {
+            filter: filter
+        } : {},
+        ...interPageDelayMs !== void 0 ? {
+            interPageDelayMs: interPageDelayMs
+        } : {},
+        ...pageSize !== void 0 ? {
+            pageSize: pageSize
+        } : {}
+    });
+}
+
 const PROJECT_USERS_RETRY_MS = 3e4;
 
 function isRecord(value) {
@@ -353,6 +373,8 @@ exports.useStudioProjectUsers = useStudioProjectUsers;
 
 exports.useWorkflowEngine = useWorkflowEngine;
 
+exports.useWorkflowInstancePreviews = useWorkflowInstancePreviews;
+
 exports.useWorkflowInstances = useWorkflowInstances;
 
 exports.useWorkflowSession = useWorkflowSession;

package/dist/index.d.cts

@@ -3,6 +3,8 @@ import { EffectHandler } from "@sanity/workflow-engine";
 import { Engine } from "@sanity/workflow-engine";
 import { EnsureDocumentClient } from "@sanity/workflow-react/observer";
 import type { GdrUri } from "@sanity/workflow-engine";
+import { InstancePreviewList } from "@sanity/workflow-react";
+import { InstancePreviewsFilter } from "@sanity/workflow-react";
 import type { InstancesQueryFilter } from "@sanity/workflow-engine";
 import { MissingHandlerPolicy } from "@sanity/workflow-engine";
 import { MutationGuardDoc } from "@sanity/workflow-react";
@@ -17,6 +19,10 @@ import { WorkflowObserver } from "@sanity/workflow-react/observer";
 import { WorkflowResource } from "@sanity/workflow-engine";
 import { WorkflowSession } from "@sanity/workflow-react";
 
+export { InstancePreviewList };
+
+export { InstancePreviewsFilter };
+
 /**
  * A Studio {@link WorkflowObserver} backed entirely by the App SDK store.
  * Document and query observation therefore share the SDK's resource-scoped
@@ -158,6 +164,24 @@ export declare function useWorkflowEngine({
   missingHandler?: MissingHandlerPolicy;
 }): Engine;
 
+/** A live, progressively-hydrated instance-preview list observed from Sanity
+ *  Studio — the drained store behind list surfaces that hold every run. Same
+ *  routing and `sdk` rules as {@link useWorkflowInstances}. */
+export declare function useWorkflowInstancePreviews({
+  engine,
+  filter,
+  interPageDelayMs,
+  pageSize,
+  sdk,
+}: {
+  engine: Engine;
+  filter?: InstancePreviewsFilter;
+  /** A development throttle between hydration pages; leave unset in production. */
+  interPageDelayMs?: number;
+  pageSize?: number;
+  sdk?: SanityInstance;
+}): InstancePreviewList;
+
 /** A live, filterable workflow-instance list observed from Sanity Studio
  *  through an App SDK instance (auto-bootstrapped, or supply `sdk`). Must
  *  render inside Studio source context. */

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import { EffectHandler } from "@sanity/workflow-engine";
 import { Engine } from "@sanity/workflow-engine";
 import { EnsureDocumentClient } from "@sanity/workflow-react/observer";
 import type { GdrUri } from "@sanity/workflow-engine";
+import { InstancePreviewList } from "@sanity/workflow-react";
+import { InstancePreviewsFilter } from "@sanity/workflow-react";
 import type { InstancesQueryFilter } from "@sanity/workflow-engine";
 import { MissingHandlerPolicy } from "@sanity/workflow-engine";
 import { MutationGuardDoc } from "@sanity/workflow-react";
@@ -17,6 +19,10 @@ import { WorkflowObserver } from "@sanity/workflow-react/observer";
 import { WorkflowResource } from "@sanity/workflow-engine";
 import { WorkflowSession } from "@sanity/workflow-react";
 
+export { InstancePreviewList };
+
+export { InstancePreviewsFilter };
+
 /**
  * A Studio {@link WorkflowObserver} backed entirely by the App SDK store.
  * Document and query observation therefore share the SDK's resource-scoped
@@ -158,6 +164,24 @@ export declare function useWorkflowEngine({
   missingHandler?: MissingHandlerPolicy;
 }): Engine;
 
+/** A live, progressively-hydrated instance-preview list observed from Sanity
+ *  Studio — the drained store behind list surfaces that hold every run. Same
+ *  routing and `sdk` rules as {@link useWorkflowInstances}. */
+export declare function useWorkflowInstancePreviews({
+  engine,
+  filter,
+  interPageDelayMs,
+  pageSize,
+  sdk,
+}: {
+  engine: Engine;
+  filter?: InstancePreviewsFilter;
+  /** A development throttle between hydration pages; leave unset in production. */
+  interPageDelayMs?: number;
+  pageSize?: number;
+  sdk?: SanityInstance;
+}): InstancePreviewList;
+
 /** A live, filterable workflow-instance list observed from Sanity Studio
  *  through an App SDK instance (auto-bootstrapped, or supply `sdk`). Must
  *  render inside Studio source context. */

package/dist/index.js

@@ -10,7 +10,7 @@ import { useMemo, useEffect, useSyncExternalStore } from "react";
 
 import { useSource, useClient } from "sanity";
 
-import { useWorkflowTelemetry, useWorkflowSession as useWorkflowSession$1, useDocumentWorkflows as useDocumentWorkflows$1, useWorkflowInstances as useWorkflowInstances$1 } from "@sanity/workflow-react";
+import { useWorkflowTelemetry, useWorkflowSession as useWorkflowSession$1, useDocumentWorkflows as useDocumentWorkflows$1, useInstancePreviews, useWorkflowInstances as useWorkflowInstances$1 } from "@sanity/workflow-react";
 
 import { loadProjectRolesOrNone, loadProjectUserProfiles } from "@sanity/workflow-sdk/project-users";
 
@@ -195,6 +195,26 @@ function useDocumentWorkflows({engine: engine, document: document, sdk: sdk}) {
     });
 }
 
+function useWorkflowInstancePreviews({engine: engine, filter: filter, interPageDelayMs: interPageDelayMs, pageSize: pageSize, sdk: sdk}) {
+    const observer = useStudioObserver({
+        engine: engine,
+        sdk: sdk
+    });
+    return useInstancePreviews({
+        engine: engine,
+        observer: observer,
+        ...filter !== void 0 ? {
+            filter: filter
+        } : {},
+        ...interPageDelayMs !== void 0 ? {
+            interPageDelayMs: interPageDelayMs
+        } : {},
+        ...pageSize !== void 0 ? {
+            pageSize: pageSize
+        } : {}
+    });
+}
+
 const PROJECT_USERS_RETRY_MS = 3e4;
 
 function isRecord(value) {
@@ -347,4 +367,4 @@ function useStudioProjectUsers() {
     };
 }
 
-export { makeStudioObserver, studioProjectUserDirectory, studioResourceClients, useDocumentWorkflows, useStudioObserver, useStudioProjectUsers, useWorkflowEngine, useWorkflowInstances, useWorkflowSession };
+export { makeStudioObserver, studioProjectUserDirectory, studioResourceClients, useDocumentWorkflows, useStudioObserver, useStudioProjectUsers, useWorkflowEngine, useWorkflowInstancePreviews, useWorkflowInstances, useWorkflowSession };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-studio",
-  "version": "0.29.0",
+  "version": "0.31.0",
   "description": "React adapter that drives the @sanity/workflow-engine reactive session in Sanity Studio through the App SDK store.",
   "keywords": [
     "sanity",
@@ -50,17 +50,17 @@
     "react-dom": "^19.2.7",
     "sanity": "^6",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine": "0.29.0",
-    "@sanity/workflow-react": "0.29.0",
-    "@sanity/workflow-sdk": "0.29.0"
+    "@sanity/workflow-engine": "0.31.0",
+    "@sanity/workflow-react": "0.31.0",
+    "@sanity/workflow-sdk": "0.31.0"
   },
   "peerDependencies": {
     "@sanity/sdk": "^2.12.0",
     "react": "^19.2.7",
     "sanity": "^6",
-    "@sanity/workflow-react": "0.29.0",
-    "@sanity/workflow-engine": "0.29.0",
-    "@sanity/workflow-sdk": "0.29.0"
+    "@sanity/workflow-engine": "0.31.0",
+    "@sanity/workflow-react": "0.31.0",
+    "@sanity/workflow-sdk": "0.31.0"
   },
   "engines": {
     "node": ">=20"