@sanity/workflow-studio 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sanity, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: !0 });
+var workflowReact = require("@sanity/workflow-react"), react = require("react"), sanity = require("sanity"), workflowEngine = require("@sanity/workflow-engine");
+function makeStudioObserver(documentStore) {
+  const docStore = (id, type, release) => {
+    const observable = documentStore.pair.editState(id, type, release);
+    let latest;
+    return {
+      subscribe(onChange) {
+        const subscription = observable.subscribe((editState) => {
+          latest = resolveEditState(editState), onChange();
+        });
+        return () => subscription.unsubscribe();
+      },
+      getSnapshot: () => latest
+    };
+  };
+  return {
+    observeInstance: (instanceId) => docStore(instanceId, "workflow.instance", void 0),
+    observeDocs: (documents, perspective) => workflowReact.combineDocStores(
+      documents.map((ref) => ({
+        key: ref.globalDocumentId,
+        store: docStore(ref.documentId, ref.type, workflowEngine.contentReleaseName({ ref, perspective }))
+      }))
+    )
+  };
+}
+function resolveEditState(editState) {
+  if (editState.ready)
+    return editState.version ?? editState.draft ?? editState.published;
+}
+function useWorkflowInstance(engine, instanceId, opts) {
+  const documentStore = sanity.useDocumentStore(), observer = react.useMemo(() => makeStudioObserver(documentStore), [documentStore]);
+  return workflowReact.useWorkflowSession(engine, instanceId, observer, opts);
+}
+exports.useWorkflowInstance = useWorkflowInstance;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/studio-observer.ts","../src/use-workflow-instance.tsx"],"sourcesContent":["import {contentReleaseName} from '@sanity/workflow-engine'\nimport {\n  combineDocStores,\n  type DocStore,\n  type ObservedDoc,\n  type WorkflowObserver,\n} from '@sanity/workflow-react'\nimport type {DocumentStore, EditStateFor} from 'sanity'\n\n/**\n * A {@link WorkflowObserver} backed by Studio's optimistic document store\n * (`documentStore.pair.editState` — a replayed RxJS observable, so a fresh\n * subscriber gets the current value synchronously). Content docs resolve under\n * the perspective's release via the `editState` version arg; instance /\n * ancestor / `system.release` docs read raw. The fan-out/snapshot machinery\n * lives in {@link combineDocStores}.\n */\nexport function makeStudioObserver(documentStore: DocumentStore): WorkflowObserver {\n  const docStore = (\n    id: string,\n    type: string,\n    release: string | undefined,\n  ): DocStore<ObservedDoc> => {\n    const observable = documentStore.pair.editState(id, type, release)\n    let latest: ObservedDoc\n    return {\n      subscribe(onChange) {\n        const subscription = observable.subscribe((editState) => {\n          latest = resolveEditState(editState)\n          onChange()\n        })\n        return () => subscription.unsubscribe()\n      },\n      getSnapshot: () => latest,\n    }\n  }\n  return {\n    observeInstance: (instanceId) => docStore(instanceId, 'workflow.instance', undefined),\n    observeDocs: (documents, perspective) =>\n      combineDocStores(\n        documents.map((ref) => ({\n          key: ref.globalDocumentId,\n          store: docStore(ref.documentId, ref.type, contentReleaseName({ref, perspective})),\n        })),\n      ),\n  }\n}\n\n/**\n * Resolve an `editState` emission to a single observed value: `undefined` while\n * not ready (gates the session feed), otherwise the version / draft / published\n * doc in precedence order (`null` when the doc doesn't exist).\n */\nfunction resolveEditState(editState: EditStateFor): ObservedDoc {\n  if (!editState.ready) return undefined\n  return (editState.version ?? editState.draft ?? editState.published) as ObservedDoc\n}\n","import type {Engine, WorkflowAccessOverride} from '@sanity/workflow-engine'\nimport {useWorkflowSession, type WorkflowInstanceController} from '@sanity/workflow-react'\nimport {useMemo} from 'react'\nimport {useDocumentStore} from 'sanity'\n\nimport {makeStudioObserver} from './studio-observer.ts'\n\n/**\n * Drive a workflow instance reactively from the Studio document store: observes\n * the instance and its watch-set through `documentStore.pair.editState` and\n * feeds the engine's session. Returns `{evaluation, ready, tick, fireAction}`;\n * the consumer decides when to advance. Must render inside Studio source context\n * (so `useDocumentStore` resolves).\n */\nexport function useWorkflowInstance(\n  engine: Engine,\n  instanceId: string,\n  opts?: {access?: WorkflowAccessOverride; grantsFromPath?: string},\n): WorkflowInstanceController {\n  const documentStore = useDocumentStore()\n  const observer = useMemo(() => makeStudioObserver(documentStore), [documentStore])\n  return useWorkflowSession(engine, instanceId, observer, opts)\n}\n"],"names":["combineDocStores","contentReleaseName","useDocumentStore","useMemo","useWorkflowSession"],"mappings":";;;AAiBO,SAAS,mBAAmB,eAAgD;AACjF,QAAM,WAAW,CACf,IACA,MACA,YAC0B;AAC1B,UAAM,aAAa,cAAc,KAAK,UAAU,IAAI,MAAM,OAAO;AACjE,QAAI;AACJ,WAAO;AAAA,MACL,UAAU,UAAU;AAClB,cAAM,eAAe,WAAW,UAAU,CAAC,cAAc;AACvD,mBAAS,iBAAiB,SAAS,GACnC,SAAA;AAAA,QACF,CAAC;AACD,eAAO,MAAM,aAAa,YAAA;AAAA,MAC5B;AAAA,MACA,aAAa,MAAM;AAAA,IAAA;AAAA,EAEvB;AACA,SAAO;AAAA,IACL,iBAAiB,CAAC,eAAe,SAAS,YAAY,qBAAqB,MAAS;AAAA,IACpF,aAAa,CAAC,WAAW,gBACvBA,cAAAA;AAAAA,MACE,UAAU,IAAI,CAAC,SAAS;AAAA,QACtB,KAAK,IAAI;AAAA,QACT,OAAO,SAAS,IAAI,YAAY,IAAI,MAAMC,kCAAmB,EAAC,KAAK,aAAY,CAAC;AAAA,MAAA,EAChF;AAAA,IAAA;AAAA,EACJ;AAEN;AAOA,SAAS,iBAAiB,WAAsC;AAC9D,MAAK,UAAU;AACf,WAAQ,UAAU,WAAW,UAAU,SAAS,UAAU;AAC5D;AC1CO,SAAS,oBACd,QACA,YACA,MAC4B;AAC5B,QAAM,gBAAgBC,wBAAA,GAChB,WAAWC,MAAAA,QAAQ,MAAM,mBAAmB,aAAa,GAAG,CAAC,aAAa,CAAC;AACjF,SAAOC,cAAAA,mBAAmB,QAAQ,YAAY,UAAU,IAAI;AAC9D;;"}

package/dist/index.d.cts

@@ -0,0 +1,23 @@
+import type { Engine } from "@sanity/workflow-engine";
+import type { WorkflowAccessOverride } from "@sanity/workflow-engine";
+import { WorkflowInstanceController } from "@sanity/workflow-react";
+
+/**
+ * Drive a workflow instance reactively from the Studio document store: observes
+ * the instance and its watch-set through `documentStore.pair.editState` and
+ * feeds the engine's session. Returns `{evaluation, ready, tick, fireAction}`;
+ * the consumer decides when to advance. Must render inside Studio source context
+ * (so `useDocumentStore` resolves).
+ */
+export declare function useWorkflowInstance(
+  engine: Engine,
+  instanceId: string,
+  opts?: {
+    access?: WorkflowAccessOverride;
+    grantsFromPath?: string;
+  },
+): WorkflowInstanceController;
+
+export { WorkflowInstanceController };
+
+export {};

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import type { Engine } from "@sanity/workflow-engine";
+import type { WorkflowAccessOverride } from "@sanity/workflow-engine";
+import { WorkflowInstanceController } from "@sanity/workflow-react";
+
+/**
+ * Drive a workflow instance reactively from the Studio document store: observes
+ * the instance and its watch-set through `documentStore.pair.editState` and
+ * feeds the engine's session. Returns `{evaluation, ready, tick, fireAction}`;
+ * the consumer decides when to advance. Must render inside Studio source context
+ * (so `useDocumentStore` resolves).
+ */
+export declare function useWorkflowInstance(
+  engine: Engine,
+  instanceId: string,
+  opts?: {
+    access?: WorkflowAccessOverride;
+    grantsFromPath?: string;
+  },
+): WorkflowInstanceController;
+
+export { WorkflowInstanceController };
+
+export {};

package/dist/index.js

@@ -0,0 +1,40 @@
+import { combineDocStores, useWorkflowSession } from "@sanity/workflow-react";
+import { useMemo } from "react";
+import { useDocumentStore } from "sanity";
+import { contentReleaseName } from "@sanity/workflow-engine";
+function makeStudioObserver(documentStore) {
+  const docStore = (id, type, release) => {
+    const observable = documentStore.pair.editState(id, type, release);
+    let latest;
+    return {
+      subscribe(onChange) {
+        const subscription = observable.subscribe((editState) => {
+          latest = resolveEditState(editState), onChange();
+        });
+        return () => subscription.unsubscribe();
+      },
+      getSnapshot: () => latest
+    };
+  };
+  return {
+    observeInstance: (instanceId) => docStore(instanceId, "workflow.instance", void 0),
+    observeDocs: (documents, perspective) => combineDocStores(
+      documents.map((ref) => ({
+        key: ref.globalDocumentId,
+        store: docStore(ref.documentId, ref.type, contentReleaseName({ ref, perspective }))
+      }))
+    )
+  };
+}
+function resolveEditState(editState) {
+  if (editState.ready)
+    return editState.version ?? editState.draft ?? editState.published;
+}
+function useWorkflowInstance(engine, instanceId, opts) {
+  const documentStore = useDocumentStore(), observer = useMemo(() => makeStudioObserver(documentStore), [documentStore]);
+  return useWorkflowSession(engine, instanceId, observer, opts);
+}
+export {
+  useWorkflowInstance
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/studio-observer.ts","../src/use-workflow-instance.tsx"],"sourcesContent":["import {contentReleaseName} from '@sanity/workflow-engine'\nimport {\n  combineDocStores,\n  type DocStore,\n  type ObservedDoc,\n  type WorkflowObserver,\n} from '@sanity/workflow-react'\nimport type {DocumentStore, EditStateFor} from 'sanity'\n\n/**\n * A {@link WorkflowObserver} backed by Studio's optimistic document store\n * (`documentStore.pair.editState` — a replayed RxJS observable, so a fresh\n * subscriber gets the current value synchronously). Content docs resolve under\n * the perspective's release via the `editState` version arg; instance /\n * ancestor / `system.release` docs read raw. The fan-out/snapshot machinery\n * lives in {@link combineDocStores}.\n */\nexport function makeStudioObserver(documentStore: DocumentStore): WorkflowObserver {\n  const docStore = (\n    id: string,\n    type: string,\n    release: string | undefined,\n  ): DocStore<ObservedDoc> => {\n    const observable = documentStore.pair.editState(id, type, release)\n    let latest: ObservedDoc\n    return {\n      subscribe(onChange) {\n        const subscription = observable.subscribe((editState) => {\n          latest = resolveEditState(editState)\n          onChange()\n        })\n        return () => subscription.unsubscribe()\n      },\n      getSnapshot: () => latest,\n    }\n  }\n  return {\n    observeInstance: (instanceId) => docStore(instanceId, 'workflow.instance', undefined),\n    observeDocs: (documents, perspective) =>\n      combineDocStores(\n        documents.map((ref) => ({\n          key: ref.globalDocumentId,\n          store: docStore(ref.documentId, ref.type, contentReleaseName({ref, perspective})),\n        })),\n      ),\n  }\n}\n\n/**\n * Resolve an `editState` emission to a single observed value: `undefined` while\n * not ready (gates the session feed), otherwise the version / draft / published\n * doc in precedence order (`null` when the doc doesn't exist).\n */\nfunction resolveEditState(editState: EditStateFor): ObservedDoc {\n  if (!editState.ready) return undefined\n  return (editState.version ?? editState.draft ?? editState.published) as ObservedDoc\n}\n","import type {Engine, WorkflowAccessOverride} from '@sanity/workflow-engine'\nimport {useWorkflowSession, type WorkflowInstanceController} from '@sanity/workflow-react'\nimport {useMemo} from 'react'\nimport {useDocumentStore} from 'sanity'\n\nimport {makeStudioObserver} from './studio-observer.ts'\n\n/**\n * Drive a workflow instance reactively from the Studio document store: observes\n * the instance and its watch-set through `documentStore.pair.editState` and\n * feeds the engine's session. Returns `{evaluation, ready, tick, fireAction}`;\n * the consumer decides when to advance. Must render inside Studio source context\n * (so `useDocumentStore` resolves).\n */\nexport function useWorkflowInstance(\n  engine: Engine,\n  instanceId: string,\n  opts?: {access?: WorkflowAccessOverride; grantsFromPath?: string},\n): WorkflowInstanceController {\n  const documentStore = useDocumentStore()\n  const observer = useMemo(() => makeStudioObserver(documentStore), [documentStore])\n  return useWorkflowSession(engine, instanceId, observer, opts)\n}\n"],"names":[],"mappings":";;;;AAiBO,SAAS,mBAAmB,eAAgD;AACjF,QAAM,WAAW,CACf,IACA,MACA,YAC0B;AAC1B,UAAM,aAAa,cAAc,KAAK,UAAU,IAAI,MAAM,OAAO;AACjE,QAAI;AACJ,WAAO;AAAA,MACL,UAAU,UAAU;AAClB,cAAM,eAAe,WAAW,UAAU,CAAC,cAAc;AACvD,mBAAS,iBAAiB,SAAS,GACnC,SAAA;AAAA,QACF,CAAC;AACD,eAAO,MAAM,aAAa,YAAA;AAAA,MAC5B;AAAA,MACA,aAAa,MAAM;AAAA,IAAA;AAAA,EAEvB;AACA,SAAO;AAAA,IACL,iBAAiB,CAAC,eAAe,SAAS,YAAY,qBAAqB,MAAS;AAAA,IACpF,aAAa,CAAC,WAAW,gBACvB;AAAA,MACE,UAAU,IAAI,CAAC,SAAS;AAAA,QACtB,KAAK,IAAI;AAAA,QACT,OAAO,SAAS,IAAI,YAAY,IAAI,MAAM,mBAAmB,EAAC,KAAK,aAAY,CAAC;AAAA,MAAA,EAChF;AAAA,IAAA;AAAA,EACJ;AAEN;AAOA,SAAS,iBAAiB,WAAsC;AAC9D,MAAK,UAAU;AACf,WAAQ,UAAU,WAAW,UAAU,SAAS,UAAU;AAC5D;AC1CO,SAAS,oBACd,QACA,YACA,MAC4B;AAC5B,QAAM,gBAAgB,iBAAA,GAChB,WAAW,QAAQ,MAAM,mBAAmB,aAAa,GAAG,CAAC,aAAa,CAAC;AACjF,SAAO,mBAAmB,QAAQ,YAAY,UAAU,IAAI;AAC9D;"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@sanity/workflow-studio",
+  "version": "0.1.0",
+  "description": "React adapter that drives the @sanity/workflow-engine reactive session from the Sanity Studio document store.",
+  "keywords": [
+    "sanity",
+    "sanity-io",
+    "studio",
+    "workflow",
+    "workflows"
+  ],
+  "homepage": "https://github.com/sanity-io/workflows/tree/main/packages/workflow-studio#readme",
+  "bugs": {
+    "url": "https://github.com/sanity-io/workflows/issues"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sanity-io/workflows.git",
+    "directory": "packages/workflow-studio"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "dependencies": {
+    "@sanity/workflow-react": "0.1.0",
+    "@sanity/workflow-engine": "0.2.0"
+  },
+  "devDependencies": {
+    "@sanity/pkg-utils": "^10.5.2",
+    "@types/react": "^19.2.17",
+    "react": "^19.2.7",
+    "sanity": "^5.30.0",
+    "vitest": "^4.1.8"
+  },
+  "peerDependencies": {
+    "react": "^19.2.7",
+    "sanity": "^5.30.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "pkg-utils build --clean",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  }
+}