@sanity/workflow-studio-plugin 0.2.0 → 0.4.0

package/dist/index.d.cts

@@ -5,10 +5,40 @@ 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(
@@ -43,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. */
@@ -103,7 +119,26 @@ 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
+   * is also part of the declared surface for written refs, so this is how a
+   * plugin setup admits runtime-supplied `doc.ref` values to a foreign
+   * resource (media-library, canvas, another dataset). Keep the value
+   * 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

@@ -5,10 +5,40 @@ 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(
@@ -43,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. */
@@ -103,7 +119,26 @@ 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
+   * is also part of the declared surface for written refs, so this is how a
+   * plugin setup admits runtime-supplied `doc.ref` values to a foreign
+   * resource (media-library, canvas, another dataset). Keep the value
+   * 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 {