@sanity/workflow-engine 0.17.0 → 0.19.0

package/dist/define.cjs

@@ -17,11 +17,16 @@ function defineWorkflow(definition) {
 }
 
 function defineWorkflowConfig(config) {
-    return invariants.parseOrThrow({
+    const parsed = invariants.parseOrThrow({
         schema: invariants.WorkflowConfigSchema,
         input: config,
         label: "defineWorkflowConfig"
     });
+    return assertDeploymentAcknowledgements(parsed), parsed;
+}
+
+function assertDeploymentAcknowledgements(config) {
+    for (const [index, deployment] of config.deployments.entries()) invariants.assertReaderModelAcknowledgement(deployment.expectedMinReaderModel, `Deployment ${deployment.name || `at deployments[${index}]`}`);
 }
 
 function defineStage(stage) {

package/dist/define.d.cts

@@ -4,10 +4,16 @@ declare type Action = ActionFields<Op, string[]> & {
   roles?: string[] | undefined;
 };
 
+declare const ACTION_SEMANTICS: readonly [
+  "decision.accept",
+  "decision.decline",
+];
+
 /** Type-mirror of {@link actionFields}, parameterised over the op and
  *  group-membership grammars. */
 declare type ActionFields<TOp, TGroup> = {
   name: string;
+  semantics?: ActionSemantic[] | undefined;
   title?: string | undefined;
   description?: string | undefined;
   group?: TGroup | undefined;
@@ -27,38 +33,135 @@ declare type ActionParam = v.InferOutput<typeof ActionParamSchema>;
  * effects: missing required params → ActionParamsInvalidError, action
  * does not commit. Resolved values feed `ValueExpr.param` lookups.
  */
-declare const ActionParamSchema: v.StrictObjectSchema<
-  {
-    readonly type: v.PicklistSchema<
-      readonly [
-        "string",
-        "number",
-        "boolean",
-        "url",
-        "dateTime",
-        "actor",
-        "doc.ref",
-        "doc.refs",
-        "json",
-      ],
-      `Invalid option: expected one of ${string}`
-    >;
-    readonly name: v.SchemaWithPipe<
-      readonly [
-        v.StringSchema<undefined>,
-        v.MinLengthAction<string, 1, "must be a non-empty string">,
-      ]
-    >;
-    readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly description: v.OptionalSchema<
-      v.StringSchema<undefined>,
+declare const ActionParamSchema: v.SchemaWithPipe<
+  readonly [
+    v.StrictObjectSchema<
+      {
+        readonly type: v.PicklistSchema<
+          readonly [
+            "string",
+            "number",
+            "boolean",
+            "url",
+            "dateTime",
+            "actor",
+            "doc.ref",
+            "doc.refs",
+            "json",
+          ],
+          `Invalid option: expected one of ${string}`
+        >;
+        readonly name: v.SchemaWithPipe<
+          readonly [
+            v.StringSchema<undefined>,
+            v.MinLengthAction<string, 1, "must be a non-empty string">,
+          ]
+        >;
+        readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly description: v.OptionalSchema<
+          v.StringSchema<undefined>,
+          undefined
+        >;
+        readonly required: v.OptionalSchema<
+          v.BooleanSchema<undefined>,
+          undefined
+        >;
+        readonly options: v.OptionalSchema<
+          v.GenericSchema<ChoiceOptions>,
+          undefined
+        >;
+        readonly validation: v.OptionalSchema<
+          v.GenericSchema<ScalarValidation>,
+          undefined
+        >;
+      },
       undefined
-    >;
-    readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-  },
-  undefined
+    >,
+    v.CheckAction<
+      {
+        type:
+          | "string"
+          | "number"
+          | "boolean"
+          | "doc.ref"
+          | "doc.refs"
+          | "url"
+          | "actor"
+          | "dateTime"
+          | "json";
+        name: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        required?: boolean | undefined;
+        options?: ChoiceOptions | undefined;
+        validation?: ScalarValidation | undefined;
+      },
+      (
+        issue: v.CheckIssue<{
+          type:
+            | "string"
+            | "number"
+            | "boolean"
+            | "doc.ref"
+            | "doc.refs"
+            | "url"
+            | "actor"
+            | "dateTime"
+            | "json";
+          name: string;
+          title?: string | undefined;
+          description?: string | undefined;
+          required?: boolean | undefined;
+          options?: ChoiceOptions | undefined;
+          validation?: ScalarValidation | undefined;
+        }>,
+      ) => string
+    >,
+    v.CheckAction<
+      {
+        type:
+          | "string"
+          | "number"
+          | "boolean"
+          | "doc.ref"
+          | "doc.refs"
+          | "url"
+          | "actor"
+          | "dateTime"
+          | "json";
+        name: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        required?: boolean | undefined;
+        options?: ChoiceOptions | undefined;
+        validation?: ScalarValidation | undefined;
+      },
+      (
+        issue: v.CheckIssue<{
+          type:
+            | "string"
+            | "number"
+            | "boolean"
+            | "doc.ref"
+            | "doc.refs"
+            | "url"
+            | "actor"
+            | "dateTime"
+            | "json";
+          name: string;
+          title?: string | undefined;
+          description?: string | undefined;
+          required?: boolean | undefined;
+          options?: ChoiceOptions | undefined;
+          validation?: ScalarValidation | undefined;
+        }>,
+      ) => string
+    >,
+  ]
 >;
 
+declare type ActionSemantic = (typeof ACTION_SEMANTICS)[number];
+
 declare type Activity = ActivityFields<
   FieldEntry,
   Action,
@@ -770,6 +873,17 @@ declare type AuthoringWorkflow = WorkflowFields<
   AuthoringStartBlock
 >;
 
+declare interface ChoiceOption {
+  title: string;
+  value: ChoiceValue;
+}
+
+declare interface ChoiceOptions {
+  list: ChoiceOption[];
+}
+
+declare type ChoiceValue = string | number;
+
 /**
  * The action half of the mirrored claim pair. `field` references an
  * author-declared actor-valued entry (the pair's other half), resolved
@@ -871,6 +985,15 @@ export declare interface ConditionVar {
  */
 export declare type ConditionVarBinding = "always" | "caller" | "spawn";
 
+/**
+ * The maximum reader floor this writer can emit. Individual documents derive
+ * their `minReaderModel` from the compatibility-bearing features actually
+ * present; a document written at {@link DATA_MODEL_VERSION} may therefore
+ * carry a lower floor. Raising this maximum is a declared, DATAMODEL.md-logged
+ * decision that requires readers-first fleet sequencing.
+ */
+declare const DATA_MODEL_MIN_READER = 2;
+
 export declare function defineAction(action: AuthoringAction): AuthoringAction;
 
 export declare function defineActivity(
@@ -1028,10 +1151,12 @@ declare const EffectSchema: v.StrictObjectSchema<
 declare const FIELD_VALUE_KINDS: readonly [
   "doc.ref",
   "doc.refs",
+  "subject",
   "release.ref",
   "string",
   "text",
   "number",
+  "progress",
   "boolean",
   "date",
   "datetime",
@@ -1064,6 +1189,8 @@ declare type FieldEntryFields<TEditable, TGroup> = FieldBase<
   TGroup
 > & {
   type: FieldValueKind;
+  options?: ChoiceOptions | undefined;
+  validation?: ScalarValidation | undefined;
   types?: string[] | undefined;
   fields?: FieldShape[] | undefined;
   of?: FieldShape[] | undefined;
@@ -1081,6 +1208,8 @@ declare interface FieldShape {
   name: string;
   title?: string | undefined;
   description?: string | undefined;
+  options?: ChoiceOptions | undefined;
+  validation?: ScalarValidation | undefined;
   fields?: FieldShape[] | undefined;
   of?: FieldShape[] | undefined;
 }
@@ -1297,12 +1426,11 @@ declare type NotesField = FieldBase<AuthoringEditable, GroupMembership> & {
 
 declare type Op = v.InferOutput<typeof StoredOpSchema>;
 
-/**
- * Names an author's predicate may not use — engine-owned and author names
- * share one namespace, so a predicate redefining a binding would silently
- * shadow engine behaviour. Rejected at deploy; derived from
- * {@link CONDITION_VARS}.
- */
+declare type ParsedWorkflowConfig = v.InferOutput<typeof WorkflowConfigSchema>;
+
+declare type ParsedWorkflowDeployment =
+  ParsedWorkflowConfig["deployments"][number];
+
 export declare const RESERVED_CONDITION_VARS: readonly string[];
 
 declare type RoleAliases = v.InferOutput<typeof RoleAliasesSchema>;
@@ -1362,6 +1490,13 @@ declare const RoleAliasesSchema: v.RecordSchema<
   undefined
 >;
 
+/** Inclusive scalar bounds. String/text bounds measure character length;
+ * number bounds measure the numeric value. */
+declare interface ScalarValidation {
+  min?: number | undefined;
+  max?: number | undefined;
+}
+
 declare type Stage = StageFields<
   FieldEntry,
   Activity,
@@ -1779,7 +1914,9 @@ declare type ValueExprInternal =
 
 declare const WORKFLOW_LIFECYCLES: readonly ["standalone", "child"];
 
-declare type WorkflowConfig = v.InferOutput<typeof WorkflowConfigSchema>;
+declare type WorkflowConfig = Omit<ParsedWorkflowConfig, "deployments"> & {
+  deployments: WorkflowDeployment[];
+};
 
 declare const WorkflowConfigSchema: v.ObjectSchema<
   {
@@ -1791,16 +1928,24 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
               readonly name: v.SchemaWithPipe<
                 readonly [
                   v.StringSchema<undefined>,
-                  v.NonEmptyAction<string, "must not be empty">,
+                  v.NonEmptyAction<string, undefined>,
+                  v.CheckAction<
+                    string,
+                    `invalid ${string} \u2014 ASCII lowercase + digits + dashes, no leading dash, no dots`
+                  >,
                 ]
               >;
+              readonly expectedMinReaderModel: v.OptionalSchema<
+                v.CustomSchema<2, undefined>,
+                undefined
+              >;
               readonly tag: v.SchemaWithPipe<
                 readonly [
                   v.StringSchema<undefined>,
                   v.NonEmptyAction<string, undefined>,
                   v.CheckAction<
                     string,
-                    "invalid tag — lowercase letters, digits and dashes only, no leading dash, no dots"
+                    `invalid ${string} \u2014 ASCII lowercase + digits + dashes, no leading dash, no dots`
                   >,
                 ]
               >;
@@ -2001,7 +2146,30 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                               id: string;
                             };
                       }[],
-                      "duplicate resource handle name — each binding name must be unique within a deployment"
+                      (
+                        issue: v.CheckIssue<
+                          {
+                            name: string;
+                            resource:
+                              | {
+                                  type: "dataset";
+                                  id: string;
+                                }
+                              | {
+                                  type: "canvas";
+                                  id: string;
+                                }
+                              | {
+                                  type: "media-library";
+                                  id: string;
+                                }
+                              | {
+                                  type: "dashboard";
+                                  id: string;
+                                };
+                          }[]
+                        >,
+                      ) => string
                     >,
                   ]
                 >,
@@ -2055,6 +2223,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
+            expectedMinReaderModel?: 2 | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2115,6 +2284,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
+            expectedMinReaderModel?: 2 | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2169,7 +2339,187 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
               roleAliases?: RoleAliases | undefined;
             }[];
           }[],
-          "duplicate deployment tag — each deployment must use a unique tag"
+          (
+            issue: v.CheckIssue<
+              {
+                name: string;
+                expectedMinReaderModel?: 2 | undefined;
+                tag: string;
+                workflowResource:
+                  | {
+                      type: "dataset";
+                      id: string;
+                    }
+                  | {
+                      type: "canvas";
+                      id: string;
+                    }
+                  | {
+                      type: "media-library";
+                      id: string;
+                    }
+                  | {
+                      type: "dashboard";
+                      id: string;
+                    };
+                resourceAliases?:
+                  | {
+                      name: string;
+                      resource:
+                        | {
+                            type: "dataset";
+                            id: string;
+                          }
+                        | {
+                            type: "canvas";
+                            id: string;
+                          }
+                        | {
+                            type: "media-library";
+                            id: string;
+                          }
+                        | {
+                            type: "dashboard";
+                            id: string;
+                          };
+                    }[]
+                  | undefined;
+                definitions: {
+                  name: string;
+                  title: string;
+                  description?: string | undefined;
+                  groups?: Group[] | undefined;
+                  lifecycle?: WorkflowLifecycle | undefined;
+                  start?: StartBlock | undefined;
+                  initialStage: string;
+                  fields?: FieldEntry[] | undefined;
+                  stages: Stage[];
+                  predicates?: Record<string, string> | undefined;
+                  roleAliases?: RoleAliases | undefined;
+                }[];
+              }[]
+            >,
+          ) => string
+        >,
+        v.CheckAction<
+          {
+            name: string;
+            expectedMinReaderModel?: 2 | undefined;
+            tag: string;
+            workflowResource:
+              | {
+                  type: "dataset";
+                  id: string;
+                }
+              | {
+                  type: "canvas";
+                  id: string;
+                }
+              | {
+                  type: "media-library";
+                  id: string;
+                }
+              | {
+                  type: "dashboard";
+                  id: string;
+                };
+            resourceAliases?:
+              | {
+                  name: string;
+                  resource:
+                    | {
+                        type: "dataset";
+                        id: string;
+                      }
+                    | {
+                        type: "canvas";
+                        id: string;
+                      }
+                    | {
+                        type: "media-library";
+                        id: string;
+                      }
+                    | {
+                        type: "dashboard";
+                        id: string;
+                      };
+                }[]
+              | undefined;
+            definitions: {
+              name: string;
+              title: string;
+              description?: string | undefined;
+              groups?: Group[] | undefined;
+              lifecycle?: WorkflowLifecycle | undefined;
+              start?: StartBlock | undefined;
+              initialStage: string;
+              fields?: FieldEntry[] | undefined;
+              stages: Stage[];
+              predicates?: Record<string, string> | undefined;
+              roleAliases?: RoleAliases | undefined;
+            }[];
+          }[],
+          (
+            issue: v.CheckIssue<
+              {
+                name: string;
+                expectedMinReaderModel?: 2 | undefined;
+                tag: string;
+                workflowResource:
+                  | {
+                      type: "dataset";
+                      id: string;
+                    }
+                  | {
+                      type: "canvas";
+                      id: string;
+                    }
+                  | {
+                      type: "media-library";
+                      id: string;
+                    }
+                  | {
+                      type: "dashboard";
+                      id: string;
+                    };
+                resourceAliases?:
+                  | {
+                      name: string;
+                      resource:
+                        | {
+                            type: "dataset";
+                            id: string;
+                          }
+                        | {
+                            type: "canvas";
+                            id: string;
+                          }
+                        | {
+                            type: "media-library";
+                            id: string;
+                          }
+                        | {
+                            type: "dashboard";
+                            id: string;
+                          };
+                    }[]
+                  | undefined;
+                definitions: {
+                  name: string;
+                  title: string;
+                  description?: string | undefined;
+                  groups?: Group[] | undefined;
+                  lifecycle?: WorkflowLifecycle | undefined;
+                  start?: StartBlock | undefined;
+                  initialStage: string;
+                  fields?: FieldEntry[] | undefined;
+                  stages: Stage[];
+                  predicates?: Record<string, string> | undefined;
+                  roleAliases?: RoleAliases | undefined;
+                }[];
+              }[]
+            >,
+          ) => string
         >,
       ]
     >;
@@ -2213,6 +2563,13 @@ declare const WorkflowDefinitionSchema: v.GenericSchema<
   WorkflowFields<FieldEntry, Stage, StartBlock>
 >;
 
+declare type WorkflowDeployment = Omit<
+  ParsedWorkflowDeployment,
+  "expectedMinReaderModel"
+> & {
+  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+};
+
 /** Type-mirror of {@link workflowFields}, parameterised over field/stage/start. */
 declare type WorkflowFields<TField, TStage, TStart> = {
   /**