@sanity/workflow-engine 0.20.0 → 0.22.0

package/dist/define.d.cts

@@ -178,7 +178,7 @@ declare type ActivityFields<TField, TAction, TTarget, TGroup> = {
   group?: TGroup | undefined;
   target?: TTarget | undefined;
   filter?: string | undefined;
-  requirements?: Record<string, string> | undefined;
+  requirements?: GroqRequirement[] | undefined;
   actions?: TAction[] | undefined;
   fields?: TField[] | undefined;
 };
@@ -956,14 +956,15 @@ export declare interface ConditionVar {
  *    the rest evaluate to `undefined` — and deploy rejects them at these
  *    sites; a cascade-fired action's per-token gate is `roles`, never its
  *    conditions.
- * 3. **The start contexts** — a definition's `start.filter` and
- *    `start.allowed` evaluate against a CANDIDATE (no instance exists yet):
- *    `*[...]` reads the WORKFLOW resource's dataset and none of the rendered
+ * 3. **The start contexts** — a definition's `start.filter` and start GROQ
+ *    requirements evaluate against a CANDIDATE (no instance exists yet):
+ *    `*[...]` reads the engine-owned `{definition, subject, completedAt}`
+ *    projection of the tag's instances and none of the rendered
  *    condition vars exist. The two split on what a surface can know:
  *    `filter` is browse-time-pure (candidate document as root,
  *    {@link START_FILTER_VARS} — no `$fields`, which cannot exist before
- *    inputs do), `allowed` is the start-time permission predicate
- *    ({@link START_ALLOWED_VARS} — `$fields` bound, never a root).
+ *    inputs do), a `groq` requirement is the start-time readiness predicate
+ *    ({@link START_REQUIREMENT_VARS} — `$fields` bound, never a root).
  * 4. **Guard predicates** — NOT conditions. A lake mutation guard's
  *    `predicate` is groq-js **delta-mode** GROQ over a document mutation:
  *    `before()`/`after()`/`identity()` are dialect natives, and the wire
@@ -982,15 +983,6 @@ 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(
@@ -1253,6 +1245,11 @@ export declare function groq(
   ...values: unknown[]
 ): string;
 
+declare type GroqRequirement = RequirementBase & {
+  type: "groq";
+  query: string;
+};
+
 /** Type-mirror of {@link GroupSchema} — one declared group. */
 declare type Group = {
   name: string;
@@ -1428,6 +1425,18 @@ declare type ParsedWorkflowConfig = v.InferOutput<typeof WorkflowConfigSchema>;
 declare type ParsedWorkflowDeployment =
   ParsedWorkflowConfig["deployments"][number];
 
+declare type RequirementBase = {
+  name: string;
+  title?: string | undefined;
+  description?: string | undefined;
+};
+
+/**
+ * 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 the condition
+ * inventory.
+ */
 export declare const RESERVED_CONDITION_VARS: readonly string[];
 
 declare type RoleAliases = v.InferOutput<typeof RoleAliasesSchema>;
@@ -1494,6 +1503,10 @@ declare interface ScalarValidation {
   max?: number | undefined;
 }
 
+declare type SingleSubjectRequirement = RequirementBase & {
+  type: "singleSubject";
+};
+
 declare type Stage = StageFields<
   FieldEntry,
   Activity,
@@ -1526,7 +1539,7 @@ declare type StartBlock = StartFields & {
  *  authoring may omit it — so each variant declares it. */
 declare type StartFields = {
   filter?: string | undefined;
-  allowed?: string | undefined;
+  requirements?: StartRequirement[] | undefined;
 };
 
 /**
@@ -1540,6 +1553,8 @@ declare type StartFields = {
  */
 declare type StartKind = (typeof START_KINDS)[number];
 
+declare type StartRequirement = GroqRequirement | SingleSubjectRequirement;
+
 /**
  * Declared editability of a field — the generic edit seam's gate. Default
  * (absent) is NOT editable: a field is op-only engine working memory unless the
@@ -1930,7 +1945,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<2, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -2217,7 +2232,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2278,7 +2293,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2337,7 +2352,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 2 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2398,7 +2413,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2457,7 +2472,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 2 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2561,7 +2576,11 @@ declare type WorkflowDeployment = Omit<
   ParsedWorkflowDeployment,
   "expectedMinReaderModel"
 > & {
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /**
+   * Reviewed numeric literal. Runtime validation owns the exact installed-floor check so a stale
+   * acknowledgement reaches the readers-first rollout guidance instead of becoming a type error.
+   */
+  expectedMinReaderModel: number;
 };
 
 /** Type-mirror of {@link workflowFields}, parameterised over field/stage/start. */

package/dist/define.d.ts

@@ -178,7 +178,7 @@ declare type ActivityFields<TField, TAction, TTarget, TGroup> = {
   group?: TGroup | undefined;
   target?: TTarget | undefined;
   filter?: string | undefined;
-  requirements?: Record<string, string> | undefined;
+  requirements?: GroqRequirement[] | undefined;
   actions?: TAction[] | undefined;
   fields?: TField[] | undefined;
 };
@@ -956,14 +956,15 @@ export declare interface ConditionVar {
  *    the rest evaluate to `undefined` — and deploy rejects them at these
  *    sites; a cascade-fired action's per-token gate is `roles`, never its
  *    conditions.
- * 3. **The start contexts** — a definition's `start.filter` and
- *    `start.allowed` evaluate against a CANDIDATE (no instance exists yet):
- *    `*[...]` reads the WORKFLOW resource's dataset and none of the rendered
+ * 3. **The start contexts** — a definition's `start.filter` and start GROQ
+ *    requirements evaluate against a CANDIDATE (no instance exists yet):
+ *    `*[...]` reads the engine-owned `{definition, subject, completedAt}`
+ *    projection of the tag's instances and none of the rendered
  *    condition vars exist. The two split on what a surface can know:
  *    `filter` is browse-time-pure (candidate document as root,
  *    {@link START_FILTER_VARS} — no `$fields`, which cannot exist before
- *    inputs do), `allowed` is the start-time permission predicate
- *    ({@link START_ALLOWED_VARS} — `$fields` bound, never a root).
+ *    inputs do), a `groq` requirement is the start-time readiness predicate
+ *    ({@link START_REQUIREMENT_VARS} — `$fields` bound, never a root).
  * 4. **Guard predicates** — NOT conditions. A lake mutation guard's
  *    `predicate` is groq-js **delta-mode** GROQ over a document mutation:
  *    `before()`/`after()`/`identity()` are dialect natives, and the wire
@@ -982,15 +983,6 @@ 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(
@@ -1253,6 +1245,11 @@ export declare function groq(
   ...values: unknown[]
 ): string;
 
+declare type GroqRequirement = RequirementBase & {
+  type: "groq";
+  query: string;
+};
+
 /** Type-mirror of {@link GroupSchema} — one declared group. */
 declare type Group = {
   name: string;
@@ -1428,6 +1425,18 @@ declare type ParsedWorkflowConfig = v.InferOutput<typeof WorkflowConfigSchema>;
 declare type ParsedWorkflowDeployment =
   ParsedWorkflowConfig["deployments"][number];
 
+declare type RequirementBase = {
+  name: string;
+  title?: string | undefined;
+  description?: string | undefined;
+};
+
+/**
+ * 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 the condition
+ * inventory.
+ */
 export declare const RESERVED_CONDITION_VARS: readonly string[];
 
 declare type RoleAliases = v.InferOutput<typeof RoleAliasesSchema>;
@@ -1494,6 +1503,10 @@ declare interface ScalarValidation {
   max?: number | undefined;
 }
 
+declare type SingleSubjectRequirement = RequirementBase & {
+  type: "singleSubject";
+};
+
 declare type Stage = StageFields<
   FieldEntry,
   Activity,
@@ -1526,7 +1539,7 @@ declare type StartBlock = StartFields & {
  *  authoring may omit it — so each variant declares it. */
 declare type StartFields = {
   filter?: string | undefined;
-  allowed?: string | undefined;
+  requirements?: StartRequirement[] | undefined;
 };
 
 /**
@@ -1540,6 +1553,8 @@ declare type StartFields = {
  */
 declare type StartKind = (typeof START_KINDS)[number];
 
+declare type StartRequirement = GroqRequirement | SingleSubjectRequirement;
+
 /**
  * Declared editability of a field — the generic edit seam's gate. Default
  * (absent) is NOT editable: a field is op-only engine working memory unless the
@@ -1930,7 +1945,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<2, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -2217,7 +2232,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2278,7 +2293,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2337,7 +2352,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 2 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2398,7 +2413,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 2 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2457,7 +2472,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 2 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2561,7 +2576,11 @@ declare type WorkflowDeployment = Omit<
   ParsedWorkflowDeployment,
   "expectedMinReaderModel"
 > & {
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /**
+   * Reviewed numeric literal. Runtime validation owns the exact installed-floor check so a stale
+   * acknowledgement reaches the readers-first rollout guidance instead of becoming a type error.
+   */
+  expectedMinReaderModel: number;
 };
 
 /** Type-mirror of {@link workflowFields}, parameterised over field/stage/start. */