@sanity/workflow-cli 0.22.0 → 0.23.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sanity/workflow-cli
 
+## 0.23.0
+
+### Minor Changes
+
+- 795b4bb: `set-stage` now makes `--to` optional: omit it on an interactive terminal and the command presents a picker of the instance's declared stages, with the current stage marked and the cursor opened on it. Because `set-stage` is an admin override, every declared stage is offered — not just reachable transitions. The candidates come from the instance's pinned definition snapshot (the same model the engine validates the move against), so the menu can never offer a stage the move would reject. Off a non-interactive terminal `--to` stays required, so scripted use is unaffected. The engine now exports `parseDefinitionSnapshotValue` for reading a definition snapshot from a minimal instance shape.
+
+### Patch Changes
+
+- Updated dependencies [94d311e]
+- Updated dependencies [795b4bb]
+  - @sanity/workflow-engine@0.23.0
+
 ## 0.22.0
 
 ### Minor Changes

package/dist/commands/editorial-workflows/set-stage.d.ts

@@ -1,4 +1,4 @@
-import { type SetStageArgs, type WorkflowInstance } from '@sanity/workflow-engine';
+import { type SetStageArgs, type Stage, type WorkflowInstance } from '@sanity/workflow-engine';
 import { WorkflowCommand } from '../../lib/base-command.ts';
 import { type EngineScope } from '../../lib/operation-args.ts';
 import { type WriteOutcome, type WriteReport } from '../../lib/ops-report.ts';
@@ -10,13 +10,38 @@ export default class SetStage extends WorkflowCommand {
         instanceId: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
     static flags: {
-        to: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        to: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         reason: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         deployment: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         tag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }
+/** Picks a target stage; injected in tests to drive the selection without a TTY. */
+type ChooseTargetStage = (stages: readonly Stage[], currentStage: string) => Promise<string>;
+/**
+ * The picker choices for the admin override: every declared stage, with the
+ * current one labelled so it reads as "here" wherever the cursor sits. `value`
+ * stays the bare stage name — what {@link workflow.setStage} receives.
+ */
+export declare function stageChoices(stages: readonly Stage[], currentStage: string): {
+    name: string;
+    value: string;
+}[];
+/**
+ * The stage to move to: the explicit `--to`, else — on an interactive terminal
+ * — a pick from the instance's declared stages, else a fail asking for `--to`.
+ * Every declared stage is offered (set-stage is an admin override, not a
+ * transition), sourced from the instance's pinned snapshot: the same model the
+ * engine validates the move against, so the menu can't offer a stage it would
+ * reject. Parsed only here on the prompt path — a `--to` move never touches it.
+ */
+export declare function resolveTargetStage({ to, instance, interactive, choose, }: {
+    to: string | undefined;
+    instance: Pick<WorkflowInstance, '_id' | 'definitionSnapshot' | 'currentStage'>;
+    interactive?: boolean | undefined;
+    choose?: ChooseTargetStage;
+}): Promise<string>;
 /** The shared operation args ({@link buildOperationArgs}) plus the
  *  setStage-specific target. */
 export declare function buildSetStageArgs({ scope, instanceId, targetStage, reason, }: {

package/dist/commands/editorial-workflows/set-stage.js

@@ -1,16 +1,19 @@
 import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
-import { workflow } from '@sanity/workflow-engine';
+import { parseDefinitionSnapshotValue, workflow, } from '@sanity/workflow-engine';
 import { WorkflowCommand } from "../../lib/base-command.js";
 import { resolveInstanceContext } from "../../lib/context.js";
+import { fail } from "../../lib/fail.js";
 import { instanceFlags } from "../../lib/flags.js";
 import { buildOperationArgs } from "../../lib/operation-args.js";
 import { cascadeTail, opsAppliedLines, runWriteVerb, } from "../../lib/ops-report.js";
+import { canPromptOnStderr, selectOnStderr } from "../../lib/prompt.js";
 export default class SetStage extends WorkflowCommand {
     static aliases = ['set-stage'];
     static description = "Force an instance into a stage, regardless of its declared transitions and filters — the engine's setStage admin override. The target stage's enter lifecycle still runs (auto-activities start, stage guards reconcile), and the post-move cascade can immediately auto-transition the instance onward.";
     static examples = [
         '<%= config.bin %> set-stage wf-instance.abc123 --to ready',
+        '<%= config.bin %> set-stage wf-instance.abc123',
         "<%= config.bin %> set-stage wf-instance.abc123 --to ready --reason 'unblock for demo'",
     ];
     static args = {
@@ -22,8 +25,7 @@ export default class SetStage extends WorkflowCommand {
     static flags = {
         ...instanceFlags,
         to: Flags.string({
-            required: true,
-            description: 'Target stage name.',
+            description: 'Target stage name. Omit on an interactive terminal to pick from the workflow’s stages.',
         }),
         reason: Flags.string({
             description: 'Free-text reason — recorded on the history entry for audit.',
@@ -31,9 +33,10 @@ export default class SetStage extends WorkflowCommand {
     };
     async run() {
         const { args, flags } = await this.parse(SetStage);
-        const { client, scope } = await resolveInstanceContext(flags, args.instanceId);
+        const { client, scope, instance } = await resolveInstanceContext(flags, args.instanceId);
+        const targetStage = await resolveTargetStage({ to: flags.to, instance });
         await runWriteVerb({
-            startLabel: `Setting ${args.instanceId} → ${flags.to}…`,
+            startLabel: `Setting ${args.instanceId} → ${targetStage}…`,
             failLabel: 'Stage move rejected',
             failHeadline: 'set-stage error:',
             run: () => workflow.setStage({
@@ -41,15 +44,37 @@ export default class SetStage extends WorkflowCommand {
                 ...buildSetStageArgs({
                     scope,
                     instanceId: args.instanceId,
-                    targetStage: flags.to,
+                    targetStage,
                     reason: flags.reason,
                 }),
             }),
-            report: (result) => setStageReport(result, flags.to),
+            report: (result) => setStageReport(result, targetStage),
             log: (line) => this.log(line),
         });
     }
 }
+export function stageChoices(stages, currentStage) {
+    return stages.map((stage) => ({
+        name: stage.name === currentStage ? `${stage.name} (current)` : stage.name,
+        value: stage.name,
+    }));
+}
+function chooseTargetStage(stages, currentStage) {
+    return selectOnStderr({
+        message: 'Select target stage (admin override — any stage allowed)',
+        choices: stageChoices(stages, currentStage),
+        default: currentStage,
+    });
+}
+export async function resolveTargetStage({ to, instance, interactive, choose = chooseTargetStage, }) {
+    if (to !== undefined) {
+        return to;
+    }
+    if (!(interactive ?? canPromptOnStderr())) {
+        fail('set-stage needs a target stage — pass --to <stage>.');
+    }
+    return choose(parseDefinitionSnapshotValue(instance).stages, instance.currentStage);
+}
 export function buildSetStageArgs({ scope, instanceId, targetStage, reason, }) {
     return { ...buildOperationArgs({ scope, instanceId, reason }), targetStage };
 }

package/dist/lib/context.d.ts

@@ -10,6 +10,10 @@ export interface InstanceContext {
     /** The engine scope derived from the instance itself — `{tag, workflowResource}`
      *  ready to pass straight to an engine verb, so callers never re-assemble it. */
     scope: EngineScope;
+    /** The located instance. Already fetched by the fan-out to derive the scope,
+     *  so a command that needs its state (set-stage's stage picker reads the
+     *  pinned definition snapshot and `currentStage`) reuses it, not re-fetch. */
+    instance: WorkflowInstance;
 }
 /**
  * The resolution a WRITE shares: discover the config, pick the deployment for

package/dist/lib/context.js

@@ -38,7 +38,11 @@ export async function resolveInstanceContext(flags, instanceId) {
     if (hit === undefined) {
         fail(`Workflow instance ${instanceId} not found`);
     }
-    return { client: hit.client, scope: { tag: hit.instance.tag, workflowResource: hit.resource } };
+    return {
+        client: hit.client,
+        scope: { tag: hit.instance.tag, workflowResource: hit.resource },
+        instance: hit.instance,
+    };
 }
 async function locateInstance({ config, flags, instanceId, token, }) {
     const resources = await instanceCandidateResources(config, flags);

package/dist/lib/prompt.d.ts

@@ -22,4 +22,7 @@ export declare function selectOnStderr(config: {
         value: string;
         description?: string;
     }[];
+    /** The value the cursor starts on — e.g. an instance's current stage, so the
+     *  picker opens where it already is. */
+    default?: string;
 }): Promise<string>;

package/oclif.manifest.json

@@ -492,6 +492,7 @@
       "description": "Force an instance into a stage, regardless of its declared transitions and filters — the engine's setStage admin override. The target stage's enter lifecycle still runs (auto-activities start, stage guards reconcile), and the post-move cascade can immediately auto-transition the instance onward.",
       "examples": [
         "<%= config.bin %> set-stage wf-instance.abc123 --to ready",
+        "<%= config.bin %> set-stage wf-instance.abc123",
         "<%= config.bin %> set-stage wf-instance.abc123 --to ready --reason 'unblock for demo'"
       ],
       "flags": {
@@ -516,9 +517,8 @@
           "type": "option"
         },
         "to": {
-          "description": "Target stage name.",
+          "description": "Target stage name. Omit on an interactive terminal to pick from the workflow’s stages.",
           "name": "to",
-          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -970,5 +970,5 @@
       ]
     }
   },
-  "version": "0.22.0"
+  "version": "0.23.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -62,12 +62,12 @@
     "@types/node": "^24.12.4",
     "oclif": "^4.23.16",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine": "0.22.0",
-    "@sanity/workflow-engine-test": "0.22.0",
-    "@sanity/workflow-examples": "0.10.1"
+    "@sanity/workflow-engine": "0.23.0",
+    "@sanity/workflow-engine-test": "0.23.0",
+    "@sanity/workflow-examples": "0.10.2"
   },
   "peerDependencies": {
-    "@sanity/workflow-engine": "0.22.0"
+    "@sanity/workflow-engine": "0.23.0"
   },
   "oclif": {
     "bin": "sanity-workflows",