@sanity/workflow-studio 0.7.1 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @sanity/workflow-studio
 
+## 0.8.0
+
+### Minor Changes
+
+- 5a1a9fe: The observers validate every engine-owned stream (instance doc, guards, instance lists) at the store boundary — the engine's read discipline (data-model gate + shape parse) instead of a cast, with a failure surfaced as the session's explicit `invalid` state. Content-doc streams are foreign and pass through unvalidated, as before.
+
+### Patch Changes
+
+- Updated dependencies [f9389e5]
+- Updated dependencies [d0c62ea]
+- Updated dependencies [c3eed2e]
+- Updated dependencies [df4bd80]
+- Updated dependencies [092a0d4]
+- Updated dependencies [5a1a9fe]
+- Updated dependencies [5a1a9fe]
+- Updated dependencies [5a1a9fe]
+- Updated dependencies [e3a7ba2]
+- Updated dependencies [30fed9e]
+- Updated dependencies [c3eed2e]
+- Updated dependencies [1321ba5]
+- Updated dependencies [e683875]
+- Updated dependencies [a8ace4d]
+  - @sanity/workflow-engine@0.17.0
+  - @sanity/workflow-sdk@0.9.0
+  - @sanity/workflow-react@0.12.0
+
 ## 0.7.1
 
 ### Patch Changes

package/README.md

@@ -10,14 +10,23 @@ Studio source context (`useDocumentStore` / `useSource` / `useClient`).
   exported) as the default per-resource routing that reaches any `dataset:`
   GDR by rebinding the same client, pinned to the engine version too. A custom `resourceClients` replaces the default — delegate
   to `studioResourceClients` for the dataset arm; schemes it returns
-  `undefined` for (media-library, canvas) are routed by the engine itself,
+  `undefined` for (media-library, canvas) are READ by the engine itself,
   which derives a sibling client from the engine client's credentials.
+  Writing a runtime-supplied ref to such a scheme into field state
+  additionally needs the resolver to SERVE that resource — serving is what
+  declares it on the engine's written-ref surface; an undeclared
+  media-library/canvas ref is rejected at the write with
+  `RefResourceUndeclaredError`. (Definition content is unaffected — deploy
+  vets it.)
 - `useWorkflowSession` — drives an engine session for one instance and
   returns
-  `{evaluation, ready, guards, tick, fireAction, editField, previewField, discardFieldPreview}`.
+  `{evaluation, ready, invalid, guards, tick, fireAction, editField, previewField, discardFieldPreview}`.
+  The observer validates every engine-owned stream, so a model-ahead or
+  corrupt doc surfaces as the explicit `invalid` state (never `ready` while
+  set) instead of an eternal spinner.
 - `useWorkflowInstances` / `useDocumentWorkflows` — live instance lists
   (filterable collection / per-document discovery), each returning
-  `{instances, loading}`. The list observes `documentStore.listenQuery` when
+  `{instances, loading, invalid}`. The list observes `documentStore.listenQuery` when
   the engine dataset is the workspace's own, else the App SDK store — same
   routing (and same `sdk` rules) as the instance doc below. On multi-hook
   surfaces (a board with per-row `useWorkflowSession`), pass one shared

package/dist/index.cjs

@@ -43,16 +43,16 @@ function makeStudioObserver(documentStore, options) {
         throw new Error(`@sanity/workflow-studio: ${what} — Studio's document store is bound to ${mounted.projectId}.${mounted.dataset} and cannot observe it. Pass an App SDK instance via the hook's \`sdk\` option (e.g. \`useWorkflowSession({engine, instanceId, sdk})\`) to observe foreign resources.`);
     };
     return {
-        observeInstance: instanceId => engineIsMounted ? editStateStore({
+        observeInstance: instanceId => engineIsMounted ? observer.validatedInstanceStore(editStateStore({
             id: instanceId,
             type: workflowEngine.WORKFLOW_INSTANCE_TYPE,
             release: void 0,
             draftFallback: !0
-        }) : observer$1.sdkInstanceDocStore({
+        })) : observer.validatedInstanceStore(observer$1.sdkInstanceDocStore({
             sdk: requireSdk(`instance "${instanceId}" lives in the engine dataset ${engineResource.projectId}.${engineResource.dataset}`),
             instanceId: instanceId,
             engineResource: engineResource
-        }),
+        })),
         observeDocs: (documents, perspective) => observer.combineDocStores(documents.map(ref => observer.classifyRef(ref, mounted) === "mounted-dataset" ? {
             key: ref.globalDocumentId,
             store: editStateStore({
@@ -75,7 +75,7 @@ function makeStudioObserver(documentStore, options) {
                 perspective: perspective
             })
         })),
-        observeGuards: (instanceId, resources) => observer.combineGuardStores(resources.map(resource => {
+        observeGuards: (instanceId, resources) => observer.validatedGuardsStore(observer.combineGuardStores(resources.map(resource => {
             if (observer.sameDataset(resource, mounted)) {
                 const {query: query, params: params} = workflowEngine.instanceGuardQuery(instanceId);
                 return observableStore({
@@ -90,17 +90,17 @@ function makeStudioObserver(documentStore, options) {
                 instanceId: instanceId,
                 resource: resource
             });
-        })),
-        observeInstances: query => engineIsMounted ? observableStore({
+        }))),
+        observeInstances: query => engineIsMounted ? observer.validatedInstancesStore(observableStore({
             observable: documentStore.listenQuery(query.query, query.params, {}),
             resolve: docs => docs,
             initial: void 0,
             name: "the instance list"
-        }) : observer$1.sdkInstancesStore({
+        })) : observer.validatedInstancesStore(observer$1.sdkInstancesStore({
             sdk: requireSdk(`the instance list lives in the engine dataset ${engineResource.projectId}.${engineResource.dataset}`),
             query: query,
             resource: engineResource
-        }),
+        })),
         ensureDocumentExists: args => observer.ensureDocumentExists(client, args)
     };
 }

package/dist/index.js

@@ -1,6 +1,6 @@
 import { instanceGuardQuery, contentDraftFallback, contentReleaseName, WORKFLOW_INSTANCE_TYPE, ENGINE_API_VERSION, createEngine, EXECUTION_KINDS } from "@sanity/workflow-engine";
 
-import { sameDataset, ensureDocumentExists, combineGuardStores, combineDocStores, classifyRef, datasetResourceId, useKeyed } from "@sanity/workflow-react/observer";
+import { sameDataset, ensureDocumentExists, validatedInstancesStore, validatedGuardsStore, combineGuardStores, combineDocStores, classifyRef, validatedInstanceStore, datasetResourceId, useKeyed } from "@sanity/workflow-react/observer";
 
 import { sdkInstancesStore, sdkGuardStore, sdkContentDocStore, sdkInstanceDocStore } from "@sanity/workflow-sdk/observer";
 
@@ -49,16 +49,16 @@ function makeStudioObserver(documentStore, options) {
         throw new Error(`@sanity/workflow-studio: ${what} — Studio's document store is bound to ${mounted.projectId}.${mounted.dataset} and cannot observe it. Pass an App SDK instance via the hook's \`sdk\` option (e.g. \`useWorkflowSession({engine, instanceId, sdk})\`) to observe foreign resources.`);
     };
     return {
-        observeInstance: instanceId => engineIsMounted ? editStateStore({
+        observeInstance: instanceId => engineIsMounted ? validatedInstanceStore(editStateStore({
             id: instanceId,
             type: WORKFLOW_INSTANCE_TYPE,
             release: void 0,
             draftFallback: !0
-        }) : sdkInstanceDocStore({
+        })) : validatedInstanceStore(sdkInstanceDocStore({
             sdk: requireSdk(`instance "${instanceId}" lives in the engine dataset ${engineResource.projectId}.${engineResource.dataset}`),
             instanceId: instanceId,
             engineResource: engineResource
-        }),
+        })),
         observeDocs: (documents, perspective) => combineDocStores(documents.map(ref => classifyRef(ref, mounted) === "mounted-dataset" ? {
             key: ref.globalDocumentId,
             store: editStateStore({
@@ -81,7 +81,7 @@ function makeStudioObserver(documentStore, options) {
                 perspective: perspective
             })
         })),
-        observeGuards: (instanceId, resources) => combineGuardStores(resources.map(resource => {
+        observeGuards: (instanceId, resources) => validatedGuardsStore(combineGuardStores(resources.map(resource => {
             if (sameDataset(resource, mounted)) {
                 const {query: query, params: params} = instanceGuardQuery(instanceId);
                 return observableStore({
@@ -96,17 +96,17 @@ function makeStudioObserver(documentStore, options) {
                 instanceId: instanceId,
                 resource: resource
             });
-        })),
-        observeInstances: query => engineIsMounted ? observableStore({
+        }))),
+        observeInstances: query => engineIsMounted ? validatedInstancesStore(observableStore({
             observable: documentStore.listenQuery(query.query, query.params, {}),
             resolve: docs => docs,
             initial: void 0,
             name: "the instance list"
-        }) : sdkInstancesStore({
+        })) : validatedInstancesStore(sdkInstancesStore({
             sdk: requireSdk(`the instance list lives in the engine dataset ${engineResource.projectId}.${engineResource.dataset}`),
             query: query,
             resource: engineResource
-        }),
+        })),
         ensureDocumentExists: args => ensureDocumentExists(client, args)
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-studio",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "React adapter that drives the @sanity/workflow-engine reactive session from the Sanity Studio document store.",
   "keywords": [
     "sanity",
@@ -41,9 +41,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@sanity/workflow-engine": "0.16.0",
-    "@sanity/workflow-react": "0.11.0",
-    "@sanity/workflow-sdk": "0.8.0"
+    "@sanity/workflow-engine": "0.17.0",
+    "@sanity/workflow-react": "0.12.0",
+    "@sanity/workflow-sdk": "0.9.0"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.5.2",
@@ -54,7 +54,8 @@
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
     "sanity": "^5.30.0",
-    "vitest": "^4.1.8"
+    "vitest": "^4.1.8",
+    "@sanity/workflow-engine-test": "0.12.0"
   },
   "peerDependencies": {
     "@sanity/sdk": "^2.12.0",