@sanity/workflow-studio-plugin 0.3.0 → 0.4.0

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

@@ -1,18 +1,18 @@
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
 
-import { Box, Text, Flex, Button, Badge, Stack, Card, useTheme_v2, Spinner, TextInput, Dialog, MenuButton, Menu, MenuItem, TabList, Tab, Container } from "@sanity/ui";
+import { Box, Text, Flex, Button, Badge, Stack, Card, useTheme_v2, Spinner, TextInput, Dialog, Menu, MenuItem, TabList, Tab, Container } from "@sanity/ui";
 
 import { useMemo, useState, useEffect, useRef } from "react";
 
 import { useRouter } from "sanity/router";
 
-import { DocPreviewLink, findActivity, definitionSnapshotOf, instanceTitle, stateByActivity, isActivityAssignedTo, assigneeUserIdsOf, isOpenActivityStatus, stageTitle, formatDate, parseStoredDateValue, useWorkflowContext, isLocalContentResource, useUserDisplays, useProjectMembers, DismissablePopover, DocRefFace, MemberAvatar, DatePicker, useAssignmentIdentity, LoadingRow, InstanceStatusBadge, PendingWorkBadge, instanceNotice, StaleLock, ActivitiesList, TodoItemsList, isEvaluationStale, useWorkflowInstanceEntry, InvalidDocNotice, useDefinition, openActivityGone, GroupHeading, ActivityDetailDialog, instanceBreadcrumb, StageChip, readDeployedDefinitions, describeError, StageGlyph, HoverHint, ActivityStatusIcon, UserAvatarGroup } from "./index.js";
+import { DocPreviewLink, findActivity, definitionSnapshotOf, instanceTitle, stateByActivity, isActivityAssignedTo, assigneeUserIdsOf, isOpenActivityStatus, stageTitle, formatDate, parseStoredDateValue, useWorkflowContext, gdrLocality, useUserDisplays, useProjectMembers, DismissablePopover, HoverHint, DocRefFace, useAssignmentIdentity, LoadingRow, AbortedBadge, instanceNotice, StaleLock, ActivitiesList, TodoItemsList, isEvaluationStale, useWorkflowInstanceEntry, InvalidDocNotice, useDefinition, openActivityGone, GroupHeading, ActivityDetailDialog, instanceBreadcrumb, StageChip, readDeployedDefinitions, describeError, StageGlyph, useDocLink, HintedMenuButton, ActivityStatusIcon, UserAvatarGroup } from "./index.js";
 
 import { ChevronDownIcon } from "@sanity/icons/ChevronDown";
 
 import { ChevronRightIcon } from "@sanity/icons/ChevronRight";
 
-import { entryDocRefs, extractDocumentId, findOpenStageEntry, terminalState, tryParseGdr, resourceFromParsed, latestDeployedDefinitions, isStartableDefinition } from "@sanity/workflow-engine";
+import { entryDocRefs, extractDocumentId, findOpenStageEntry, terminalState, latestDeployedDefinitions, isStartableDefinition } from "@sanity/workflow-engine";
 
 import { CheckmarkIcon } from "@sanity/icons/Checkmark";
 
@@ -20,6 +20,8 @@ import { CloseIcon } from "@sanity/icons/Close";
 
 import { FilterIcon } from "@sanity/icons/Filter";
 
+import { MemberAvatar, DatePicker } from "@sanity/workflow-components";
+
 import { endOfDay } from "date-fns/endOfDay";
 
 import { useDocumentPreviewStore, useSchema } from "sanity";
@@ -384,7 +386,7 @@ function useDocPreviewTitles(documents) {
             titles: new Map(titles),
             resolved: new Set(resolved)
         }), subscriptions = documents.flatMap(doc => {
-            const parsedRef = tryParseGdr(doc.id), resource = parsedRef ? resourceFromParsed(parsedRef) : void 0, local = isLocalContentResource(resource, binding.contentResource), schemaType = schema.get(doc.type);
+            const {parsed: parsedRef, local: local} = gdrLocality(doc.id, binding.contentResource), schemaType = schema.get(doc.type);
             return !parsedRef || !local || !schemaType ? (resolved.add(doc.id), []) : [ previewStore.observeForPreview({
                 _type: "reference",
                 _ref: parsedRef.documentId
@@ -418,14 +420,18 @@ function TaskFilterMenu({filters: filters, options: options, onChange: onChange}
         onDismiss: () => setOpen(!1),
         open: open,
         overflow: "visible",
-        children: /* @__PURE__ */ jsx(Button, {
-            "aria-label": "Filter",
-            fontSize: 1,
-            icon: FilterIcon,
-            mode: "bleed",
-            onClick: () => setOpen(v => !v),
-            padding: 2,
-            selected: active || open
+        children: /* @__PURE__ */ jsx(HoverHint, {
+            disabled: open,
+            text: "Filter",
+            children: /* @__PURE__ */ jsx(Button, {
+                "aria-label": "Filter",
+                fontSize: 1,
+                icon: FilterIcon,
+                mode: "bleed",
+                onClick: () => setOpen(v => !v),
+                padding: 2,
+                selected: active || open
+            })
         })
     });
 }
@@ -555,7 +561,7 @@ function FilterField({label: label, placeholder: placeholder, pills: pills, onCl
     });
 }
 
-function TagField({label: label, placeholder: placeholder, rows: rows, activeKeys: activeKeys, onToggle: onToggle, pillLabel: pillLabel, open: open, onOpen: onOpen, emptyNote: emptyNote = "Nothing matches."}) {
+function TagField({label: label, placeholder: placeholder, rows: rows, activeKeys: activeKeys, onToggle: onToggle, pillLabel: pillLabel, open: open, onOpen: onOpen, emptyNote: emptyNote = "Nothing matches"}) {
     const [query, setQuery] = useState(""), q = query.trim().toLowerCase(), hits = q ? rows.filter(row => row.text.toLowerCase().includes(q)) : rows, shown = shownHits(hits, HITS_CAP);
     /* @__PURE__ */
     return jsx(FilterField, {
@@ -772,7 +778,7 @@ function DocumentField({documents: documents, activeIds: activeIds, onToggle: on
     /* @__PURE__ */
     return jsx(TagField, {
         activeKeys: activeIds,
-        emptyNote: "No documents match.",
+        emptyNote: "No documents match",
         label: "Document",
         onOpen: onOpen,
         onToggle: onToggle,
@@ -929,7 +935,7 @@ function WorkflowsDashboard({instances: instances, onOpenInstance: onOpenInstanc
     return loading ? /* @__PURE__ */ jsx(LoadingRow, {
         label: "Loading workflows…"
     }) : inFlight.length === 0 && settled.length === 0 ? /* @__PURE__ */ jsx(MutedNote, {
-        text: "No workflows yet — start one with “New workflow”."
+        text: "No workflows yet — start one with “New workflow”"
     }) : /* @__PURE__ */ jsxs(Stack, {
         gap: 2,
         children: [ 
@@ -949,7 +955,7 @@ function WorkflowsDashboard({instances: instances, onOpenInstance: onOpenInstanc
                 options: options
             }) ]
         }), visibleInFlight.length === 0 ? /* @__PURE__ */ jsx(MutedNote, {
-            text: "No running workflows match."
+            text: "No running workflows match"
         }) : /* @__PURE__ */ jsx(InstanceRows, {
             instances: visibleInFlight,
             onOpenInstance: onOpenInstance
@@ -1031,11 +1037,7 @@ function InstanceRow({instance: instance, onOpen: onOpen}) {
                 /* @__PURE__ */ jsx(Flex, {
                     flex: 1
                 }), 
-                /* @__PURE__ */ jsx(InstanceStatusBadge, {
-                    definition: definition,
-                    instance: instance
-                }), 
-                /* @__PURE__ */ jsx(PendingWorkBadge, {
+                /* @__PURE__ */ jsx(AbortedBadge, {
                     instance: instance
                 }) ]
             })
@@ -1190,13 +1192,16 @@ function DetailHeader({entry: entry, definition: definition, onBack: onBack}) {
             gap: 3,
             wrap: "wrap",
             children: [ 
-            /* @__PURE__ */ jsx(Button, {
-                "aria-label": "Back to workflows",
-                fontSize: 1,
-                icon: ArrowLeftIcon,
-                mode: "bleed",
-                onClick: onBack,
-                padding: 2
+            /* @__PURE__ */ jsx(HoverHint, {
+                text: "Back to workflows",
+                children: /* @__PURE__ */ jsx(Button, {
+                    "aria-label": "Back to workflows",
+                    fontSize: 1,
+                    icon: ArrowLeftIcon,
+                    mode: "bleed",
+                    onClick: onBack,
+                    padding: 2
+                })
             }), 
             /* @__PURE__ */ jsxs(Stack, {
                 gap: 2,
@@ -1213,11 +1218,7 @@ function DetailHeader({entry: entry, definition: definition, onBack: onBack}) {
                 }) ]
             }), terminalState(instance) === "in-flight" ? /* @__PURE__ */ jsx(StageChip, {
                 title: stageTitle(definition, instance.currentStage)
-            }) : /* @__PURE__ */ jsx(InstanceStatusBadge, {
-                definition: definition,
-                instance: instance
-            }), 
-            /* @__PURE__ */ jsx(PendingWorkBadge, {
+            }) : /* @__PURE__ */ jsx(AbortedBadge, {
                 instance: instance
             }), 
             /* @__PURE__ */ jsx(SpinnerSlot, {
@@ -1268,7 +1269,7 @@ function StageDiagramSection({entry: entry, definition: definition}) {
         children: /* @__PURE__ */ jsx(Text, {
             muted: !0,
             size: 1,
-            children: "Couldn’t load this workflow’s definition — the stage diagram is unavailable and titles fall back to raw names."
+            children: "Couldn’t load this workflow’s full details — the stage diagram is unavailable, and technical names show instead of titles."
         })
     });
 }
@@ -1347,9 +1348,9 @@ function DefinitionPickerPanel({onPick: onPick}) {
             }) : null, !definitions && !error ? /* @__PURE__ */ jsx(LoadingRow, {
                 label: "Loading workflows…"
             }) : null, definitions && definitions.length === 0 ? /* @__PURE__ */ jsx(MutedNote, {
-                text: "No startable workflows are deployed."
+                text: "No startable workflows are deployed"
             }) : null, definitions && definitions.length > 0 && visible.length === 0 ? /* @__PURE__ */ jsx(MutedNote, {
-                text: "No workflows match."
+                text: "No workflows match"
             }) : null, 
             /* @__PURE__ */ jsx(Stack, {
                 gap: 1,
@@ -1427,7 +1428,7 @@ function ToolActivityDialog({target: target, onClose: onClose}) {
 
 function TaskGroupList({groups: groups, onOpenTask: onOpenTask, onOpenWorkflow: onOpenWorkflow}) {
     return groups.withDocuments.length === 0 && groups.withoutDocuments.length === 0 ? /* @__PURE__ */ jsx(MutedNote, {
-        text: "No tasks match — adjust the filters, or start a workflow."
+        text: "No tasks match — adjust the filters, or start a workflow"
     }) : /* @__PURE__ */ jsxs(Stack, {
         gap: 2,
         children: [ groups.withDocuments.map(group => /* @__PURE__ */ jsx(DocumentTaskGroup, {
@@ -1554,9 +1555,9 @@ function DocumentTaskGroup({group: group, onOpenTask: onOpenTask, onOpenWorkflow
 }
 
 function GroupMenu({group: group, document: document, onOpenWorkflow: onOpenWorkflow}) {
-    const router = useRouter();
+    const router = useRouter(), state = useDocLink(document);
     /* @__PURE__ */
-    return jsx(MenuButton, {
+    return jsx(HintedMenuButton, {
         button: /* @__PURE__ */ jsx(Button, {
             "aria-label": "Group actions",
             fontSize: 1,
@@ -1564,16 +1565,16 @@ function GroupMenu({group: group, document: document, onOpenWorkflow: onOpenWork
             mode: "bleed",
             padding: 2
         }),
+        hint: "Group actions",
         id: `task-group-menu-${group.key}`,
         menu: /* @__PURE__ */ jsxs(Menu, {
             children: [ 
             /* @__PURE__ */ jsx(MenuItem, {
                 onClick: () => onOpenWorkflow(group.instanceId),
                 text: "View workflow"
-            }), document ? /* @__PURE__ */ jsx(MenuItem, {
+            }), state.kind === "linked" ? /* @__PURE__ */ jsx(MenuItem, {
                 onClick: () => router.navigateIntent("edit", {
-                    id: extractDocumentId(document.id),
-                    type: document.type
+                    id: state.bareId
                 }),
                 text: "Open document"
             }) : null ]

package/dist/index.d.cts

@@ -6,10 +6,39 @@ 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(
@@ -44,22 +73,8 @@ export declare function workflowDocTypes(
 export declare interface WorkflowMapping {
   /** Studio schema type. */
   readonly docType: string;
-  /**
-   * The document type must have a workflow: the editor form is gated until
-   * an instance references the document. Doctype-level: the flag on ANY
-   * mapping row for a docType gates the form, and starting any mapped
-   * workflow satisfies the gate. Advisory, UI-only enforcement — any raw
-   * API client can still write; the Content Lake is the only enforcement
-   * point.
-   */
-  readonly mandatory?: boolean;
   /** The definition `name` the engine deployed under. */
   readonly definition: string;
-  /** Logical role of the doc — sets the GDR `type` discriminator in the
-   *  builders. Subject lives on a field `doc.ref` entry, not an envelope. */
-  readonly subjectKind: "document" | "release";
-  /** Schema type stamped into the `doc.ref` field entry's `value.type`. */
-  readonly subjectGdrType: string;
   /** Human-readable label for menus and dialogs. */
   readonly label: string;
   /** Optional initial workflow field entries to seed on Start. */
@@ -104,7 +119,7 @@ export declare interface WorkflowPluginConfig {
    * each committed action; anything unregistered stays pending for another
    * runtime to claim.
    */
-  readonly effectHandlers?: Record<string, EffectHandler>;
+  readonly effectHandlers?: Record<string, EffectHandler<SanityClient>>;
   /**
    * Routing override for cross-resource reads, replacing the Studio's
    * default per-dataset routing — see `useWorkflowEngine`. A served resource
@@ -114,6 +129,16 @@ 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 {

package/dist/index.d.ts

@@ -6,10 +6,39 @@ 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(
@@ -44,22 +73,8 @@ export declare function workflowDocTypes(
 export declare interface WorkflowMapping {
   /** Studio schema type. */
   readonly docType: string;
-  /**
-   * The document type must have a workflow: the editor form is gated until
-   * an instance references the document. Doctype-level: the flag on ANY
-   * mapping row for a docType gates the form, and starting any mapped
-   * workflow satisfies the gate. Advisory, UI-only enforcement — any raw
-   * API client can still write; the Content Lake is the only enforcement
-   * point.
-   */
-  readonly mandatory?: boolean;
   /** The definition `name` the engine deployed under. */
   readonly definition: string;
-  /** Logical role of the doc — sets the GDR `type` discriminator in the
-   *  builders. Subject lives on a field `doc.ref` entry, not an envelope. */
-  readonly subjectKind: "document" | "release";
-  /** Schema type stamped into the `doc.ref` field entry's `value.type`. */
-  readonly subjectGdrType: string;
   /** Human-readable label for menus and dialogs. */
   readonly label: string;
   /** Optional initial workflow field entries to seed on Start. */
@@ -104,7 +119,7 @@ export declare interface WorkflowPluginConfig {
    * each committed action; anything unregistered stays pending for another
    * runtime to claim.
    */
-  readonly effectHandlers?: Record<string, EffectHandler>;
+  readonly effectHandlers?: Record<string, EffectHandler<SanityClient>>;
   /**
    * Routing override for cross-resource reads, replacing the Studio's
    * default per-dataset routing — see `useWorkflowEngine`. A served resource
@@ -114,6 +129,16 @@ 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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-studio-plugin",
-  "version": "0.3.0",
+  "version": "0.4.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",
@@ -44,32 +44,35 @@
   "dependencies": {
     "@sanity/client": "^7.23.0",
     "@sanity/icons": "^4.1.0",
+    "@sanity/types": "^6",
     "@sanity/ui": "^3.3.0",
     "@sanity/util": "^6.3.0",
     "date-fns": "^4.4.0",
     "pluralize-esm": "^9.0.5",
-    "@sanity/workflow-diagram": "0.3.0",
-    "@sanity/workflow-engine": "0.17.0",
-    "@sanity/workflow-react": "0.12.0",
-    "@sanity/workflow-studio": "0.8.0"
+    "@sanity/workflow-diagram": "0.4.0",
+    "@sanity/workflow-engine": "0.18.0",
+    "@sanity/workflow-react": "0.13.0",
+    "@sanity/workflow-components": "0.1.0",
+    "@sanity/workflow-studio": "0.9.0"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.5.3",
+    "@sanity/schema": "^6",
     "@sanity/sdk": "^2.12.0",
     "@testing-library/react": "^16.3.2",
     "@types/react": "^19.2.17",
     "jsdom": "^29.1.1",
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
-    "sanity": "^5.30.0",
+    "sanity": "^6",
     "styled-components": "^6.4.2",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine-test": "0.12.0"
+    "@sanity/workflow-engine-test": "0.13.0"
   },
   "peerDependencies": {
     "@sanity/sdk": "^2.12.0",
     "react": "^19.2.7",
-    "sanity": "^5.30.0",
+    "sanity": "^6",
     "styled-components": "^6.4.2"
   },
   "engines": {