@sanity/workflow-studio-plugin 0.5.0 → 0.20.0

package/dist/_chunks-es/workflows-tool-root.js

@@ -1,18 +1,18 @@
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
 
-import { Flex, Spinner, Stack, Box, Text, Button, Card, TextInput, Dialog, Badge, useTheme_v2, Container, TabPanel } from "@sanity/ui";
+import { Stack, Box, Flex, Text, Button, Card, TextInput, Dialog, Badge, useTheme_v2, Container, TabPanel } from "@sanity/ui";
 
 import { useState, useEffect, useMemo, useRef } from "react";
 
 import { useRouter } from "sanity/router";
 
-import { instanceNotice, StaleLock, ActivitiesList, TodoItemsList, isEvaluationStale, useWorkflowInstanceEntry, InvalidDocNotice, LoadingRow, useDefinition, openActivityGone, GroupHeading, ActivityDetailDialog, instanceBreadcrumb, HoverHint, instanceTitle, formatDate, StageChip, stageTitle, AbortedBadge, DocPreviewLink, useWorkflowContext, readDeployedDefinitions, describeError, DismissablePopover, definitionSnapshotOf, findActivity, stateByActivity, findActivityNode, rowDateControlState, rowAssignControlState, isActivityAssignedTo, assigneeUserIdsOf, isOpenActivityStatus, committedRowFace, activityRowProps, parseStoredDateValue, gdrLocality, useUserDisplays, useProjectMembers, DocRefFace, useSaveField, dateControlValue, stopRowMouseDown, stopRowClick, parseDateFieldValue, serializeDateFieldValue, dateControlKind, editTargetOf, CollapsibleBand, LinkChip, BreadcrumbTail, StageFace, TrailingHairline, ActivityRow, UnreadableDocsNote, useAssignmentIdentity, TabSwitch, workflowsTabCodec } from "./index.js";
+import { instanceNotice, StaleLock, ActivitiesList, TodoItemsList, isEvaluationStale, useWorkflowInstanceEntry, InvalidDocNotice, LoadingRow, useDefinition, openActivityGone, GroupHeading, ActivityDetailDialog, instanceBreadcrumb, HoverHint, instanceTitle, formatDate, StageChip, stageTitle, AbortedBadge, SpinnerSlot, DocPreviewLink, useWorkflowContext, readDeployedDefinitions, describeError, DismissablePopover, definitionSnapshotOf, findActivity, stateByActivity, findActivityNode, rowDateControlState, rowAssignControlState, isActivityAssignedTo, assigneeUserIdsOf, isOpenActivityStatus, committedRowFace, activityRowProps, parseStoredDateValue, gdrLocality, useUserDisplays, useProjectMembers, DocRefFace, useSaveField, dateControlValue, stopRowMouseDown, stopRowClick, parseDateFieldValue, serializeDateFieldValue, dateControlKind, editTargetOf, CollapsibleBand, LinkChip, BreadcrumbTail, StageFace, TrailingHairline, ActivityRow, UnreadableDocsNote, useAssignmentIdentity, TabSwitch, workflowsTabCodec } from "./index.js";
 
 import { ArrowLeftIcon } from "@sanity/icons/ArrowLeft";
 
 import { WorkflowDiagram } from "@sanity/workflow-diagram";
 
-import { entryDocRefs, terminalState, latestDeployedDefinitions, isStartableDefinition, extractDocumentId, findOpenStageEntry } from "@sanity/workflow-engine";
+import { entryDocRefs, terminalState, latestDeployedDefinitions, isStartableDefinition, toBareId, findOpenStageEntry } from "@sanity/workflow-engine";
 
 import { AddIcon } from "@sanity/icons/Add";
 
@@ -36,22 +36,6 @@ import { CalendarIcon } from "@sanity/icons/Calendar";
 
 import { useWorkflowInstances } from "@sanity/workflow-studio";
 
-function SpinnerSlot({busy: busy}) {
-    /* @__PURE__ */
-    return jsx(Flex, {
-        align: "center",
-        flex: "none",
-        justify: "center",
-        style: {
-            width: 19,
-            height: 19
-        },
-        children: busy ? /* @__PURE__ */ jsx(Spinner, {
-            muted: !0
-        }) : null
-    });
-}
-
 function documentRefsOf(instance) {
     const seen = /* @__PURE__ */ new Map;
     for (const ref of entryDocRefs(instance.fields)) seen.has(ref.id) || seen.set(ref.id, ref);
@@ -438,7 +422,7 @@ function datesOf(state) {
 
 function spawnOrigins(instances) {
     const origins = /* @__PURE__ */ new Map;
-    for (const parent of instances) for (const row of parent.subworkflows ?? []) origins.set(extractDocumentId(row.ref.id), {
+    for (const parent of instances) for (const row of parent.subworkflows ?? []) origins.set(toBareId(row.ref.id), {
         parent: parent,
         activityName: row.activity,
         cohortStage: row.cohortStage
@@ -448,7 +432,7 @@ function spawnOrigins(instances) {
 
 function rootOf(instance, byId) {
     const rootRef = instance.ancestors[0];
-    return rootRef ? byId.get(extractDocumentId(rootRef.id)) ?? instance : instance;
+    return rootRef ? byId.get(toBareId(rootRef.id)) ?? instance : instance;
 }
 
 function taskRowsOf(args) {
@@ -1122,7 +1106,7 @@ function DocumentField({documents: documents, activeIds: activeIds, onToggle: on
     if (documents.length === 0) return null;
     const rows = documents.map(doc => ({
         key: doc.id,
-        text: `${titles.get(doc.id) ?? ""} ${doc.type} ${extractDocumentId(doc.id)}`,
+        text: `${titles.get(doc.id) ?? ""} ${doc.type} ${toBareId(doc.id)}`,
         node: /* @__PURE__ */ jsx(DocRefFace, {
             gdr: doc
         })
@@ -1207,7 +1191,7 @@ function useDocumentChipLabels(documentIds, documents) {
     const schema = useSchema(), activeDocs = documents.filter(doc => documentIds.includes(doc.id)), {titles: titles, resolved: resolved} = useDocPreviewTitles(activeDocs), labels = /* @__PURE__ */ new Map;
     for (const doc of activeDocs) {
         if (!resolved.has(doc.id)) continue;
-        const label = titles.get(doc.id) ?? schemaTypeTitle(schema, doc.type) ?? extractDocumentId(doc.id);
+        const label = titles.get(doc.id) ?? schemaTypeTitle(schema, doc.type) ?? toBareId(doc.id);
         labels.set(doc.id, label);
     }
     return labels;
@@ -1334,6 +1318,28 @@ function ActivityDateControl({instanceId: instanceId, state: state, dates: dates
     });
 }
 
+const PREWARM_MARGIN = "600px 0px";
+
+function useNearViewport() {
+    const [element, setElement] = useState(null), [near, setNear] = useState(!1);
+    return useEffect(() => {
+        if (element === null) return;
+        if (typeof IntersectionObserver > "u") {
+            setNear(!0);
+            return;
+        }
+        const observer = new IntersectionObserver(entries => {
+            setNear(entries.at(-1)?.isIntersecting ?? !1);
+        }, {
+            rootMargin: PREWARM_MARGIN
+        });
+        return observer.observe(element), () => observer.disconnect();
+    }, [ element ]), {
+        ref: setElement,
+        near: near
+    };
+}
+
 function RefChips({refs: refs, max: max = 2}) {
     if (refs.length === 0) return null;
     const shown = refs.slice(0, max), overflow = refs.length - shown.length;
@@ -1363,7 +1369,7 @@ function TaskGroupList({groups: groups, onOpenTask: onOpenTask, onOpenWorkflow:
         children: [ groups.withDocuments.map(group => /* @__PURE__ */ jsx(CollapsibleBand, {
             background: !0,
             sticky: !0,
-            title: extractDocumentId(group.document.id),
+            title: toBareId(group.document.id),
             header: /* @__PURE__ */ jsx(Flex, {
                 align: "center",
                 flex: "none",
@@ -1486,22 +1492,27 @@ function TaskRows({rows: rows, onOpenTask: onOpenTask, showTerminalActions: show
 }
 
 function TaskActivityRow({row: row, onOpen: onOpen, showTerminalActions: showTerminalActions}) {
-    const entry = useWorkflowInstanceEntry(row.instanceId), render = taskRowRender(row, entry);
+    const {ref: ref, near: near} = useNearViewport(), entry = useWorkflowInstanceEntry(row.instanceId, {
+        evaluate: near
+    }), render = taskRowRender(row, entry);
     /* @__PURE__ */
-    return jsx(StaleLock, {
-        stale: render.stale,
-        children: /* @__PURE__ */ jsx(ActivityRow, {
-            assignState: render.assignState,
-            assigneeIds: render.assigneeIds,
-            dateControl: /* @__PURE__ */ jsx(ActivityDateControl, {
-                dates: render.dates,
+    return jsx(Box, {
+        ref: ref,
+        children: /* @__PURE__ */ jsx(StaleLock, {
+            stale: render.stale,
+            children: /* @__PURE__ */ jsx(ActivityRow, {
+                assignState: render.assignState,
+                assigneeIds: render.assigneeIds,
+                dateControl: /* @__PURE__ */ jsx(ActivityDateControl, {
+                    dates: render.dates,
+                    instanceId: row.instanceId,
+                    state: render.dateState
+                }),
+                face: render.face,
                 instanceId: row.instanceId,
-                state: render.dateState
-            }),
-            face: render.face,
-            instanceId: row.instanceId,
-            onOpen: onOpen,
-            terminalActions: showTerminalActions ? render.terminalActions : []
+                onOpen: onOpen,
+                terminalActions: showTerminalActions ? render.terminalActions : []
+            })
         })
     });
 }

package/dist/index.cjs

@@ -6,14 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 
 var index = require("./_chunks-cjs/index.cjs");
 
-exports.WorkflowStagePreview = index.WorkflowStagePreview;
-
-exports.mappingForDocType = index.mappingForDocType;
-
 exports.workflowDefaultDocumentNode = index.workflowDefaultDocumentNode;
 
-exports.workflowDocTypes = index.workflowDocTypes;
-
 exports.workflowStudioPlugin = index.workflowStudioPlugin;
 
 exports.workflowsView = index.workflowsView;

package/dist/index.d.cts

@@ -2,73 +2,28 @@ import type { DefaultDocumentNodeResolver } from "sanity/structure";
 import { EffectHandler } from "@sanity/workflow-engine";
 import { GlobalDocumentReference } from "@sanity/workflow-engine";
 import { InitialFieldValue } from "@sanity/workflow-engine";
-import { JSX } from "react";
 import { Plugin as Plugin_2 } from "sanity";
-import { PreviewProps } from "sanity";
 import { ResourceClientResolver } from "@sanity/workflow-engine";
 import type { SanityClient } from "sanity";
-import type { Schema } from "sanity";
 import { StartContext } from "@sanity/workflow-engine";
 import type { StructureBuilder } from "sanity/structure";
 import type { ViewBuilder } from "sanity/structure";
 
 /**
- * The auto-start map, or a function computing it from the workspace at
- * runtime (so it can vary by workspace name or schema). Resolved and
- * validated in the plugin layout; see {@link resolveAutoStart}.
- */
-declare type AutoStart =
-  | AutoStartMap
-  | ((context: AutoStartContext) => AutoStartMap);
-
-/** What the plugin layout hands the function form of {@link AutoStart}. */
-declare interface AutoStartContext {
-  /** The Studio workspace name. */
-  readonly workspaceName: string;
-  /** The workspace schema — to derive or gate on document types. */
-  readonly schema: Schema;
-}
-
-/**
- * Document `_type` → the deployed workflow definition name(s) to auto-start on
- * a fresh document of that type. Several names ⇒ all start together: one
- * dialog collects the union of their required inputs, and the fresh document
- * is the shared subject of each. Naming a workflow here does not require a
- * {@link WorkflowMapping} entry — the required inputs come from the deployed
- * definition itself.
- */
-declare type AutoStartMap = Record<string, string | readonly string[]>;
-
-/** The first mapping row for a document type — the tie-break wherever a
- *  surface binds to exactly one row. */
-export declare function mappingForDocType(
-  mappings: readonly WorkflowMapping[],
-  docType: string,
-): WorkflowMapping | undefined;
-
-/**
- * Convenience `defaultDocumentNode`: mapped document types get the form view
- * plus the Workflows view; everything else keeps the structure default.
+ * Convenience `defaultDocumentNode`: every content-document type gets the
+ * form view plus the Workflows view. Runtime definition discovery determines
+ * which workflows apply after the Studio mounts.
  *
  * ```ts
- * structureTool({defaultDocumentNode: workflowDefaultDocumentNode({mappings})})
+ * structureTool({defaultDocumentNode: workflowDefaultDocumentNode()})
  * ```
  */
-export declare function workflowDefaultDocumentNode(options: {
-  mappings: readonly WorkflowMapping[];
-}): DefaultDocumentNodeResolver;
-
-/** The schema types the plugin contributes workflow surfaces to. */
-export declare function workflowDocTypes(
-  mappings: readonly WorkflowMapping[],
-): ReadonlySet<string>;
+export declare function workflowDefaultDocumentNode(): DefaultDocumentNodeResolver;
 
 /**
- * Doctype → workflow binding. Drives every per-doctype contribution the
- * plugin makes: which document actions and badges to add, which document
- * view to offer, what to project as the subject when starting an instance.
- * Adding a workflow-driven doctype to a studio is one entry in the host's
- * mapping table.
+ * Studio-specific behavior for one `(docType, definition)` binding. A row may
+ * customize an automatically discovered subject binding or explicitly bind a
+ * definition modeled with a plain `doc.ref`.
  */
 export declare interface WorkflowMapping {
   /** Studio schema type. */
@@ -77,6 +32,8 @@ export declare interface WorkflowMapping {
   readonly definition: string;
   /** Human-readable label for menus and dialogs. */
   readonly label: string;
+  /** Start this workflow when a fresh document of {@link docType} is created. */
+  readonly autoStart?: boolean;
   /** Optional initial workflow field entries to seed on Start. */
   readonly initialStateBuilder?: (
     subjectGdr: GlobalDocumentReference,
@@ -111,8 +68,12 @@ export declare interface WorkflowPluginConfig {
   /** Dataset holding workflow definitions + instances. Defaults to the
    *  workspace's own dataset (single-dataset setup). */
   readonly workflowDataset?: string;
-  /** Document type → workflow definition bindings. */
-  readonly mappings: readonly WorkflowMapping[];
+  /**
+   * Studio-specific bindings. Rows customize discovered first-class subjects
+   * or explicitly register definitions that use the `doc.ref` subject
+   * convention.
+   */
+  readonly mappings?: readonly WorkflowMapping[];
   /**
    * Browser-side effect handlers keyed by effect name (the engine's
    * {@link EffectHandler}). Registered handlers drain in the Studio after
@@ -129,27 +90,8 @@ export declare interface WorkflowPluginConfig {
    * stable (module scope or memoized).
    */
   readonly resourceClients?: ResourceClientResolver;
-  /**
-   * Auto-start workflows when a FRESH document of a configured type is created
-   * in this Studio — the plugin takes over the form until they've started
-   * (collecting any inputs the workflows need beyond the subject), so the
-   * document is born with its workflow. A starting *convenience*, not
-   * enforcement: a raw client or any non-Studio surface bypasses it entirely,
-   * and pre-existing documents are never touched. Studio-only. See
-   * {@link AutoStart}.
-   */
-  readonly autoStart?: AutoStart;
-}
-
-declare interface WorkflowPreviewProps extends PreviewProps {
-  readonly _id?: string;
-  readonly documentId?: string;
 }
 
-export declare function WorkflowStagePreview(
-  props: WorkflowPreviewProps,
-): JSX.Element;
-
 export declare const workflowStudioPlugin: Plugin_2<WorkflowPluginConfig>;
 
 /** The Workflows view for one document — append it to any `views([...])`. */

package/dist/index.d.ts

@@ -2,73 +2,28 @@ import type { DefaultDocumentNodeResolver } from "sanity/structure";
 import { EffectHandler } from "@sanity/workflow-engine";
 import { GlobalDocumentReference } from "@sanity/workflow-engine";
 import { InitialFieldValue } from "@sanity/workflow-engine";
-import { JSX } from "react";
 import { Plugin as Plugin_2 } from "sanity";
-import { PreviewProps } from "sanity";
 import { ResourceClientResolver } from "@sanity/workflow-engine";
 import type { SanityClient } from "sanity";
-import type { Schema } from "sanity";
 import { StartContext } from "@sanity/workflow-engine";
 import type { StructureBuilder } from "sanity/structure";
 import type { ViewBuilder } from "sanity/structure";
 
 /**
- * The auto-start map, or a function computing it from the workspace at
- * runtime (so it can vary by workspace name or schema). Resolved and
- * validated in the plugin layout; see {@link resolveAutoStart}.
- */
-declare type AutoStart =
-  | AutoStartMap
-  | ((context: AutoStartContext) => AutoStartMap);
-
-/** What the plugin layout hands the function form of {@link AutoStart}. */
-declare interface AutoStartContext {
-  /** The Studio workspace name. */
-  readonly workspaceName: string;
-  /** The workspace schema — to derive or gate on document types. */
-  readonly schema: Schema;
-}
-
-/**
- * Document `_type` → the deployed workflow definition name(s) to auto-start on
- * a fresh document of that type. Several names ⇒ all start together: one
- * dialog collects the union of their required inputs, and the fresh document
- * is the shared subject of each. Naming a workflow here does not require a
- * {@link WorkflowMapping} entry — the required inputs come from the deployed
- * definition itself.
- */
-declare type AutoStartMap = Record<string, string | readonly string[]>;
-
-/** The first mapping row for a document type — the tie-break wherever a
- *  surface binds to exactly one row. */
-export declare function mappingForDocType(
-  mappings: readonly WorkflowMapping[],
-  docType: string,
-): WorkflowMapping | undefined;
-
-/**
- * Convenience `defaultDocumentNode`: mapped document types get the form view
- * plus the Workflows view; everything else keeps the structure default.
+ * Convenience `defaultDocumentNode`: every content-document type gets the
+ * form view plus the Workflows view. Runtime definition discovery determines
+ * which workflows apply after the Studio mounts.
  *
  * ```ts
- * structureTool({defaultDocumentNode: workflowDefaultDocumentNode({mappings})})
+ * structureTool({defaultDocumentNode: workflowDefaultDocumentNode()})
  * ```
  */
-export declare function workflowDefaultDocumentNode(options: {
-  mappings: readonly WorkflowMapping[];
-}): DefaultDocumentNodeResolver;
-
-/** The schema types the plugin contributes workflow surfaces to. */
-export declare function workflowDocTypes(
-  mappings: readonly WorkflowMapping[],
-): ReadonlySet<string>;
+export declare function workflowDefaultDocumentNode(): DefaultDocumentNodeResolver;
 
 /**
- * Doctype → workflow binding. Drives every per-doctype contribution the
- * plugin makes: which document actions and badges to add, which document
- * view to offer, what to project as the subject when starting an instance.
- * Adding a workflow-driven doctype to a studio is one entry in the host's
- * mapping table.
+ * Studio-specific behavior for one `(docType, definition)` binding. A row may
+ * customize an automatically discovered subject binding or explicitly bind a
+ * definition modeled with a plain `doc.ref`.
  */
 export declare interface WorkflowMapping {
   /** Studio schema type. */
@@ -77,6 +32,8 @@ export declare interface WorkflowMapping {
   readonly definition: string;
   /** Human-readable label for menus and dialogs. */
   readonly label: string;
+  /** Start this workflow when a fresh document of {@link docType} is created. */
+  readonly autoStart?: boolean;
   /** Optional initial workflow field entries to seed on Start. */
   readonly initialStateBuilder?: (
     subjectGdr: GlobalDocumentReference,
@@ -111,8 +68,12 @@ export declare interface WorkflowPluginConfig {
   /** Dataset holding workflow definitions + instances. Defaults to the
    *  workspace's own dataset (single-dataset setup). */
   readonly workflowDataset?: string;
-  /** Document type → workflow definition bindings. */
-  readonly mappings: readonly WorkflowMapping[];
+  /**
+   * Studio-specific bindings. Rows customize discovered first-class subjects
+   * or explicitly register definitions that use the `doc.ref` subject
+   * convention.
+   */
+  readonly mappings?: readonly WorkflowMapping[];
   /**
    * Browser-side effect handlers keyed by effect name (the engine's
    * {@link EffectHandler}). Registered handlers drain in the Studio after
@@ -129,27 +90,8 @@ export declare interface WorkflowPluginConfig {
    * stable (module scope or memoized).
    */
   readonly resourceClients?: ResourceClientResolver;
-  /**
-   * Auto-start workflows when a FRESH document of a configured type is created
-   * in this Studio — the plugin takes over the form until they've started
-   * (collecting any inputs the workflows need beyond the subject), so the
-   * document is born with its workflow. A starting *convenience*, not
-   * enforcement: a raw client or any non-Studio surface bypasses it entirely,
-   * and pre-existing documents are never touched. Studio-only. See
-   * {@link AutoStart}.
-   */
-  readonly autoStart?: AutoStart;
-}
-
-declare interface WorkflowPreviewProps extends PreviewProps {
-  readonly _id?: string;
-  readonly documentId?: string;
 }
 
-export declare function WorkflowStagePreview(
-  props: WorkflowPreviewProps,
-): JSX.Element;
-
 export declare const workflowStudioPlugin: Plugin_2<WorkflowPluginConfig>;
 
 /** The Workflows view for one document — append it to any `views([...])`. */

package/dist/index.js

@@ -1,3 +1,3 @@
-import { WorkflowStagePreview, mappingForDocType, workflowDefaultDocumentNode, workflowDocTypes, workflowStudioPlugin, workflowsView } from "./_chunks-es/index.js";
+import { workflowDefaultDocumentNode, workflowStudioPlugin, workflowsView } from "./_chunks-es/index.js";
 
-export { WorkflowStagePreview, mappingForDocType, workflowDefaultDocumentNode, workflowDocTypes, workflowStudioPlugin, workflowsView };
+export { workflowDefaultDocumentNode, workflowStudioPlugin, workflowsView };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-studio-plugin",
-  "version": "0.5.0",
+  "version": "0.20.0",
   "description": "Sanity Studio plugin for @sanity/workflow-engine: the form strip, a Workflows document view, stage badges, and the document-action lock.",
   "keywords": [
     "sanity",
@@ -48,12 +48,7 @@
     "@sanity/ui": "^3.3.0",
     "@sanity/util": "^6.3.0",
     "date-fns": "^4.4.0",
-    "pluralize-esm": "^9.0.5",
-    "@sanity/workflow-components": "0.2.0",
-    "@sanity/workflow-diagram": "0.4.1",
-    "@sanity/workflow-engine": "0.19.0",
-    "@sanity/workflow-react": "0.14.0",
-    "@sanity/workflow-studio": "0.10.0"
+    "pluralize-esm": "^9.0.5"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.5.3",
@@ -68,14 +63,24 @@
     "sanity": "^6",
     "styled-components": "^6.4.2",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine-test": "0.13.1"
+    "@sanity/workflow-diagram": "0.20.0",
+    "@sanity/workflow-engine": "0.20.0",
+    "@sanity/workflow-components": "0.20.0",
+    "@sanity/workflow-react": "0.20.0",
+    "@sanity/workflow-engine-test": "0.20.0",
+    "@sanity/workflow-studio": "0.20.0"
   },
   "peerDependencies": {
     "@sanity/sdk": "^2.12.0",
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
     "sanity": "^6",
-    "styled-components": "^6.4.2"
+    "styled-components": "^6.4.2",
+    "@sanity/workflow-components": "0.20.0",
+    "@sanity/workflow-diagram": "0.20.0",
+    "@sanity/workflow-engine": "0.20.0",
+    "@sanity/workflow-react": "0.20.0",
+    "@sanity/workflow-studio": "0.20.0"
   },
   "engines": {
     "node": ">=20"