@sanity/workflow-engine 0.21.0 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sanity/workflow-engine
 
+## 0.22.0
+
+### Patch Changes
+
+- 88ba4ba: Allow stale reader-model acknowledgements to reach the runtime gate, which provides readers-first rollout guidance before any client access.
+
 ## 0.21.0
 
 ### Minor Changes

package/dist/_chunks-cjs/invariants.cjs

@@ -150,7 +150,7 @@ function parentRef(instance) {
     return instance.ancestors.at(-1);
 }
 
-const DATA_MODEL_VERSION = 4, DATA_MODEL_MIN_READER = 4, READER_MODEL_ROLLOUT_URL = "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+const DATA_MODEL_VERSION = 4, DATA_MODEL_MIN_READER = 4, READER_MODEL_ROLLOUT_URL = "https://www.sanity.io/docs/editorial-workflows/prerelease";
 
 class ReaderModelAcknowledgementError extends WorkflowError {
     code="WORKFLOW_READER_MODEL_ACKNOWLEDGEMENT_MISMATCH";
@@ -160,7 +160,7 @@ class ReaderModelAcknowledgementError extends WorkflowError {
     documentationUrl=READER_MODEL_ROLLOUT_URL;
     constructor(expectedMinReaderModel, context = "Deployment") {
         const expected = expectedMinReaderModel === void 0 ? "missing" : String(expectedMinReaderModel);
-        super("reader-model-acknowledgement", `${context} expected reader floor ${expected}; the installed engine requires acknowledgement ${DATA_MODEL_MIN_READER}. Dependency upgrades can change writer compatibility. Upgrade all readers and Functions before accepting a higher floor; after verifying the rollout, change the literal in deployment configuration. Instances written before the new floor may stop matching user-identity queries, and older readers refuse documents this engine touches — a prerelease deployment with no data worth migrating can reset every engine-owned document with \`sanity-workflows nuke\` and start fresh. ${READER_MODEL_ROLLOUT_URL}`), 
+        super("reader-model-acknowledgement", `${context} expected reader floor ${expected}; the installed engine requires acknowledgement ${DATA_MODEL_MIN_READER}. Do not change the acknowledgement yet: accepting ${DATA_MODEL_MIN_READER} authorizes this engine to write documents that older readers will refuse. Upgrade every Studio, CLI, MCP server, Function, and other runtime that reads engine-owned documents; verify that rollout in every environment sharing the workflow resource; then change the literal in deployment configuration and deploy the writer. Rollout guide: ${READER_MODEL_ROLLOUT_URL}`), 
         this.name = "ReaderModelAcknowledgementError", this.expectedMinReaderModel = expectedMinReaderModel;
     }
 }

package/dist/_chunks-es/invariants.js

@@ -136,7 +136,7 @@ function parentRef(instance) {
     return instance.ancestors.at(-1);
 }
 
-const DATA_MODEL_VERSION = 4, DATA_MODEL_MIN_READER = 4, READER_MODEL_ROLLOUT_URL = "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+const DATA_MODEL_VERSION = 4, DATA_MODEL_MIN_READER = 4, READER_MODEL_ROLLOUT_URL = "https://www.sanity.io/docs/editorial-workflows/prerelease";
 
 class ReaderModelAcknowledgementError extends WorkflowError {
     code="WORKFLOW_READER_MODEL_ACKNOWLEDGEMENT_MISMATCH";
@@ -146,7 +146,7 @@ class ReaderModelAcknowledgementError extends WorkflowError {
     documentationUrl=READER_MODEL_ROLLOUT_URL;
     constructor(expectedMinReaderModel, context = "Deployment") {
         const expected = expectedMinReaderModel === void 0 ? "missing" : String(expectedMinReaderModel);
-        super("reader-model-acknowledgement", `${context} expected reader floor ${expected}; the installed engine requires acknowledgement ${DATA_MODEL_MIN_READER}. Dependency upgrades can change writer compatibility. Upgrade all readers and Functions before accepting a higher floor; after verifying the rollout, change the literal in deployment configuration. Instances written before the new floor may stop matching user-identity queries, and older readers refuse documents this engine touches — a prerelease deployment with no data worth migrating can reset every engine-owned document with \`sanity-workflows nuke\` and start fresh. ${READER_MODEL_ROLLOUT_URL}`), 
+        super("reader-model-acknowledgement", `${context} expected reader floor ${expected}; the installed engine requires acknowledgement ${DATA_MODEL_MIN_READER}. Do not change the acknowledgement yet: accepting ${DATA_MODEL_MIN_READER} authorizes this engine to write documents that older readers will refuse. Upgrade every Studio, CLI, MCP server, Function, and other runtime that reads engine-owned documents; verify that rollout in every environment sharing the workflow resource; then change the literal in deployment configuration and deploy the writer. Rollout guide: ${READER_MODEL_ROLLOUT_URL}`), 
         this.name = "ReaderModelAcknowledgementError", this.expectedMinReaderModel = expectedMinReaderModel;
     }
 }

package/dist/define.d.cts

@@ -983,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 = 4;
-
 export declare function defineAction(action: AuthoringAction): AuthoringAction;
 
 export declare function defineActivity(
@@ -1954,7 +1945,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<4, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -2241,7 +2232,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2302,7 +2293,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2361,7 +2352,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2422,7 +2413,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2481,7 +2472,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2585,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

@@ -983,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 = 4;
-
 export declare function defineAction(action: AuthoringAction): AuthoringAction;
 
 export declare function defineActivity(
@@ -1954,7 +1945,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<4, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -2241,7 +2232,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2302,7 +2293,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2361,7 +2352,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2422,7 +2413,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -2481,7 +2472,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -2585,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/index.d.cts

@@ -2693,8 +2693,13 @@ export declare interface DeployDefinitionResult {
 export declare interface DeployDefinitionsArgs<
   T extends WorkflowDefinitionInput<T> = WorkflowDefinition,
 > {
-  /** Reviewed literal acknowledging the installed writer's maximum reader-floor capability. */
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /**
+   * Reviewed numeric literal acknowledging the installed writer's maximum reader-floor capability.
+   * The deploy gate checks the exact installed value and links the readers-first rollout; do not
+   * import {@link DATA_MODEL_MIN_READER}, because that would auto-advance this acknowledgement on
+   * upgrade.
+   */
+  expectedMinReaderModel: number;
   /**
    * Resource-alias bindings for this deploy (alias name → physical resource).
    * A deploy-time abstraction ONLY: every `@<alias>:` reference in a
@@ -2764,7 +2769,8 @@ export declare function deployStageGuards(args: StageGuardArgs): Promise<void>;
  *  definitions themselves — carrying `resourceAliases` here is what keeps a diff
  *  fingerprinting the same physical content `deployDefinitions` would. */
 export declare interface DeployTarget {
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /** Reviewed numeric literal, checked against the exact installed floor before client access. */
+  expectedMinReaderModel: number;
   tag: string;
   workflowResource: WorkflowResource;
   resourceAliases?: ResourceAliases;
@@ -6773,7 +6779,7 @@ export declare interface QueryInScopeArgs extends InstanceRefArgs, QueryArgs {}
 export { quoted };
 
 export declare const READER_MODEL_ROLLOUT_URL =
-  "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+  "https://www.sanity.io/docs/editorial-workflows/prerelease";
 
 /** A producer has not explicitly acknowledged this engine's writer capability. */
 export declare class ReaderModelAcknowledgementError extends WorkflowError<"reader-model-acknowledgement"> {
@@ -6782,7 +6788,7 @@ export declare class ReaderModelAcknowledgementError extends WorkflowError<"read
   readonly engineMinReaderModel = 4;
   readonly engineModelVersion = 4;
   readonly documentationUrl =
-    "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+    "https://www.sanity.io/docs/editorial-workflows/prerelease";
   constructor(expectedMinReaderModel: unknown, context?: string);
 }
 
@@ -9500,7 +9506,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<4, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -9787,7 +9793,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -9848,7 +9854,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -9907,7 +9913,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -9968,7 +9974,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -10027,7 +10033,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -10194,7 +10200,11 @@ export 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;
 };
 
 export declare const WorkflowEffectCompleted: WorkflowTelemetryEvent<WorkflowEffectCompletedData>;

package/dist/index.d.ts

@@ -2693,8 +2693,13 @@ export declare interface DeployDefinitionResult {
 export declare interface DeployDefinitionsArgs<
   T extends WorkflowDefinitionInput<T> = WorkflowDefinition,
 > {
-  /** Reviewed literal acknowledging the installed writer's maximum reader-floor capability. */
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /**
+   * Reviewed numeric literal acknowledging the installed writer's maximum reader-floor capability.
+   * The deploy gate checks the exact installed value and links the readers-first rollout; do not
+   * import {@link DATA_MODEL_MIN_READER}, because that would auto-advance this acknowledgement on
+   * upgrade.
+   */
+  expectedMinReaderModel: number;
   /**
    * Resource-alias bindings for this deploy (alias name → physical resource).
    * A deploy-time abstraction ONLY: every `@<alias>:` reference in a
@@ -2764,7 +2769,8 @@ export declare function deployStageGuards(args: StageGuardArgs): Promise<void>;
  *  definitions themselves — carrying `resourceAliases` here is what keeps a diff
  *  fingerprinting the same physical content `deployDefinitions` would. */
 export declare interface DeployTarget {
-  expectedMinReaderModel: typeof DATA_MODEL_MIN_READER;
+  /** Reviewed numeric literal, checked against the exact installed floor before client access. */
+  expectedMinReaderModel: number;
   tag: string;
   workflowResource: WorkflowResource;
   resourceAliases?: ResourceAliases;
@@ -6773,7 +6779,7 @@ export declare interface QueryInScopeArgs extends InstanceRefArgs, QueryArgs {}
 export { quoted };
 
 export declare const READER_MODEL_ROLLOUT_URL =
-  "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+  "https://www.sanity.io/docs/editorial-workflows/prerelease";
 
 /** A producer has not explicitly acknowledged this engine's writer capability. */
 export declare class ReaderModelAcknowledgementError extends WorkflowError<"reader-model-acknowledgement"> {
@@ -6782,7 +6788,7 @@ export declare class ReaderModelAcknowledgementError extends WorkflowError<"read
   readonly engineMinReaderModel = 4;
   readonly engineModelVersion = 4;
   readonly documentationUrl =
-    "https://github.com/sanity-io/workflows/blob/main/docs/reader-model-rollout.md";
+    "https://www.sanity.io/docs/editorial-workflows/prerelease";
   constructor(expectedMinReaderModel: unknown, context?: string);
 }
 
@@ -9500,7 +9506,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
                 ]
               >;
               readonly expectedMinReaderModel: v.OptionalSchema<
-                v.CustomSchema<4, undefined>,
+                v.CustomSchema<number, undefined>,
                 undefined
               >;
               readonly tag: v.SchemaWithPipe<
@@ -9787,7 +9793,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.MinLengthAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -9848,7 +9854,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -9907,7 +9913,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -9968,7 +9974,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
         v.CheckAction<
           {
             name: string;
-            expectedMinReaderModel?: 4 | undefined;
+            expectedMinReaderModel?: number | undefined;
             tag: string;
             workflowResource:
               | {
@@ -10027,7 +10033,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
             issue: v.CheckIssue<
               {
                 name: string;
-                expectedMinReaderModel?: 4 | undefined;
+                expectedMinReaderModel?: number | undefined;
                 tag: string;
                 workflowResource:
                   | {
@@ -10194,7 +10200,11 @@ export 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;
 };
 
 export declare const WorkflowEffectCompleted: WorkflowTelemetryEvent<WorkflowEffectCompletedData>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-engine",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "Workflow / BPM engine for Sanity content — define workflows as data, run them as instances against a Sanity client.",
   "keywords": [
     "bpm",