@sanity/workflow-cli 0.8.0 → 0.8.1

package/dist/commands/abort.js

@@ -28,7 +28,7 @@ export default class Abort extends Command {
         try {
             const result = await workflow.abortInstance({
                 client,
-                ...buildOperationArgs(config, args.instanceId, flags.reason),
+                ...buildOperationArgs({ config, instanceId: args.instanceId, reason: flags.reason }),
             });
             const report = abortReport(result);
             if (!report.fired) {

package/dist/commands/definition/delete.d.ts

@@ -21,10 +21,14 @@ export default class DefinitionDelete extends Command {
  * engine's optionals reject an explicit `undefined` under
  * `exactOptionalPropertyTypes`.
  */
-export declare function buildDeleteArgs(config: WorkflowConfig, name: string, flags: {
-    version?: number | undefined;
-    cascade: boolean;
-    reason?: string | undefined;
+export declare function buildDeleteArgs({ config, name, flags, }: {
+    config: WorkflowConfig;
+    name: string;
+    flags: {
+        version?: number | undefined;
+        cascade: boolean;
+        reason?: string | undefined;
+    };
 }): Omit<DeleteDefinitionArgs, 'client'>;
 /** What the spinner names: the workflow, or one pinned version of it. */
 export declare function deleteTargetLabel(args: Pick<DeleteDefinitionArgs, 'definition' | 'version'>): string;

package/dist/commands/definition/delete.js

@@ -36,7 +36,7 @@ export default class DefinitionDelete extends Command {
         const { args, flags } = await this.parse(DefinitionDelete);
         const config = loadWorkflowConfig(flags.tag);
         const client = loadClient();
-        const deleteArgs = buildDeleteArgs(config, args.name, flags);
+        const deleteArgs = buildDeleteArgs({ config, name: args.name, flags });
         const spinner = ora(`Deleting definition ${deleteTargetLabel(deleteArgs)}…`).start();
         try {
             const result = await workflow.deleteDefinition({ client, ...deleteArgs });
@@ -55,7 +55,7 @@ export default class DefinitionDelete extends Command {
  * engine's optionals reject an explicit `undefined` under
  * `exactOptionalPropertyTypes`.
  */
-export function buildDeleteArgs(config, name, flags) {
+export function buildDeleteArgs({ config, name, flags, }) {
     return {
         ...baseEngineArgs(config),
         definition: name,

package/dist/commands/definition/diff.js

@@ -29,14 +29,19 @@ export default class DefinitionDiff extends Command {
         const spinner = ora(`Diffing ${args.definition} against deployed…`).start();
         let deployed;
         try {
-            deployed = await fetchDeployedDefinition(client, args.definition, config, flags.version);
+            deployed = await fetchDeployedDefinition({
+                client,
+                name: args.definition,
+                config,
+                version: flags.version,
+            });
             spinner.succeed(`Diffed ${args.definition}`);
         }
         catch (error) {
             spinner.fail('Diff failed');
             throw error;
         }
-        for (const line of diffReport([diffEntry(def, deployed, config)]))
+        for (const line of diffReport([diffEntry({ def, latestRaw: deployed, target: config })]))
             this.log(line);
     }
 }
@@ -47,7 +52,7 @@ export default class DefinitionDiff extends Command {
  * superseded — latest unless pinned via `version`. An absent latest is a
  * legitimate "create" diff, but an absent *pinned* version is an error.
  */
-async function fetchDeployedDefinition(client, name, config, version) {
+async function fetchDeployedDefinition({ client, name, config, version, }) {
     const { groq, params } = buildDefinitionShowQuery({ name, tag: config.tag, version });
     const deployed = await client.fetch(groq, params);
     if (deployed === null && version !== undefined) {

package/dist/commands/definition/show.js

@@ -57,11 +57,15 @@ const HEADER_PAD = 11; // "Description" — the longest label in the block
  *  authored definition, so it's passed separately and omitted when unknown. */
 export function definitionHeader(def, tag) {
     const rows = [
-        formatKeyValue('Title', def.title, { padTo: HEADER_PAD }),
-        formatKeyValue('Description', def.description ?? styleText('dim', '—'), { padTo: HEADER_PAD }),
+        formatKeyValue({ key: 'Title', value: def.title, padTo: HEADER_PAD }),
+        formatKeyValue({
+            key: 'Description',
+            value: def.description ?? styleText('dim', '—'),
+            padTo: HEADER_PAD,
+        }),
     ];
     if (tag !== undefined) {
-        rows.push(formatKeyValue('Tag', tag, { padTo: HEADER_PAD }));
+        rows.push(formatKeyValue({ key: 'Tag', value: tag, padTo: HEADER_PAD }));
     }
     return [styleText('bold', `${def.name} v${def.version}`), ...rows].join('\n');
 }

package/dist/commands/deploy.js

@@ -41,12 +41,12 @@ export default class Deploy extends Command {
         }
         const client = loadClient();
         if (flags['dry-run']) {
-            await this.runDryRun(client, selected, config);
+            await this.runDryRun({ client, defs: selected, config });
             return;
         }
-        await this.executeDeploy(client, selected, config);
+        await this.executeDeploy({ client, defs: selected, config });
     }
-    async executeDeploy(client, defs, config) {
+    async executeDeploy({ client, defs, config, }) {
         const spinner = ora(`Deploying ${defs.length} definition(s)…`).start();
         try {
             const { results } = await workflow.deployDefinitions({
@@ -64,10 +64,10 @@ export default class Deploy extends Command {
             throw error;
         }
     }
-    async runDryRun(client, defs, config) {
+    async runDryRun({ client, defs, config, }) {
         const spinner = ora(`Diffing ${defs.length} definition(s) against dataset…`).start();
         try {
-            const entries = await computeDiffEntries(client, defs, config);
+            const entries = await computeDiffEntries({ client, defs, target: config });
             spinner.succeed(`Diffed ${defs.length} definition(s)`);
             for (const line of diffReport(entries))
                 this.log(line);

package/dist/commands/diagnose.d.ts

@@ -8,7 +8,11 @@ import { type Diagnosis, type DiagnoseInput, type SuggestedRemediation } from '@
  * {@link SuggestedRemediation}s rather than re-deriving them, so the rendered
  * fix block and the `--json` output stay one computation.
  */
-export declare function renderDiagnosis(diagnosis: Diagnosis, input: DiagnoseInput, remediations: SuggestedRemediation[]): string[];
+export declare function renderDiagnosis({ diagnosis, input, remediations, }: {
+    diagnosis: Diagnosis;
+    input: DiagnoseInput;
+    remediations: SuggestedRemediation[];
+}): string[];
 export default class Diagnose extends Command {
     static description: string;
     static examples: string[];

package/dist/commands/diagnose.js

@@ -179,7 +179,7 @@ function statusLine(diagnosis) {
  * {@link SuggestedRemediation}s rather than re-deriving them, so the rendered
  * fix block and the `--json` output stay one computation.
  */
-export function renderDiagnosis(diagnosis, input, remediations) {
+export function renderDiagnosis({ diagnosis, input, remediations, }) {
     const lines = [statusLine(diagnosis)];
     const inFlight = diagnosis.state === 'progressing' ||
         diagnosis.state === 'waiting' ||
@@ -255,7 +255,7 @@ export default class Diagnose extends Command {
         }
         this.log(instanceHeader(evaluation.instance));
         this.log('');
-        for (const line of renderDiagnosis(diagnosis, input, remediations)) {
+        for (const line of renderDiagnosis({ diagnosis, input, remediations })) {
             this.log(line);
         }
     }

package/dist/commands/fire-action.d.ts

@@ -14,7 +14,11 @@ export declare function parseParams(pairs: string[]): Record<string, unknown>;
  * flags to fire one. Pure so the populated/empty permutations assert
  * without a live evaluation.
  */
-export declare function renderAvailableActions(actions: AvailableAction[], stage: string, instanceId: string): string[];
+export declare function renderAvailableActions({ actions, stage, instanceId, }: {
+    actions: AvailableAction[];
+    stage: string;
+    instanceId: string;
+}): string[];
 interface FireOutcome {
     fired: boolean;
     cascaded: number;
@@ -40,7 +44,11 @@ export interface FireActionReport {
  * the fired / no-op / cascaded / ops permutations assert without a live
  * fire.
  */
-export declare function fireActionReport(result: FireOutcome, activity: string, action: string): FireActionReport;
+export declare function fireActionReport({ result, activity, action, }: {
+    result: FireOutcome;
+    activity: string;
+    action: string;
+}): FireActionReport;
 export default class FireAction extends Command {
     static description: string;
     static examples: string[];

package/dist/commands/fire-action.js

@@ -79,7 +79,7 @@ function actionLines(a) {
  * flags to fire one. Pure so the populated/empty permutations assert
  * without a live evaluation.
  */
-export function renderAvailableActions(actions, stage, instanceId) {
+export function renderAvailableActions({ actions, stage, instanceId, }) {
     if (actions.length === 0) {
         return [`No actions on the activities of the current stage ('${stage}').`];
     }
@@ -108,7 +108,7 @@ export function fireResultJson(result, ids) {
  * the fired / no-op / cascaded / ops permutations assert without a live
  * fire.
  */
-export function fireActionReport(result, activity, action) {
+export function fireActionReport({ result, activity, action, }) {
     const stage = styleText('bold', result.instance.currentStage);
     if (!result.fired) {
         return {
@@ -167,7 +167,7 @@ export default class FireAction extends Command {
         const client = loadClient();
         const actor = failOnThrow('fire-action usage error:', () => resolveActor(flags.as, flags['as-role']));
         if (flags.action === undefined) {
-            await this.listActions(client, config, args.instanceId, actor, flags.json);
+            await this.listActions({ client, config, instanceId: args.instanceId, actor, json: flags.json });
             return;
         }
         if (flags.activity === undefined) {
@@ -184,7 +184,7 @@ export default class FireAction extends Command {
             json: flags.json,
         });
     }
-    async listActions(client, config, instanceId, actor, json) {
+    async listActions({ client, config, instanceId, actor, json, }) {
         const { evaluation, actions } = await workflow
             .availableActions({
             client,
@@ -201,7 +201,7 @@ export default class FireAction extends Command {
         }
         this.log(instanceHeader(evaluation.instance));
         this.log('');
-        for (const line of renderAvailableActions(actions, stage, instanceId)) {
+        for (const line of renderAvailableActions({ actions, stage, instanceId })) {
             this.log(line);
         }
     }
@@ -228,7 +228,11 @@ export default class FireAction extends Command {
         const spinner = ora(`Firing ${action} on ${activity}…`).start();
         try {
             const result = await workflow.fireAction(fireArgs);
-            emitWriteReport(spinner, fireActionReport(result, activity, action), (line) => this.log(line));
+            emitWriteReport({
+                spinner,
+                report: fireActionReport({ result, activity, action }),
+                log: (line) => this.log(line),
+            });
         }
         catch (error) {
             spinner.fail('Action rejected');

package/dist/commands/move-stage.d.ts

@@ -17,7 +17,12 @@ export default class MoveStage extends Command {
 }
 /** The shared operation args ({@link buildOperationArgs}) plus the
  *  setStage-specific target. */
-export declare function buildSetStageArgs(config: WorkflowConfig, instanceId: string, targetStage: string, reason: string | undefined): Omit<SetStageArgs, 'client'>;
+export declare function buildSetStageArgs({ config, instanceId, targetStage, reason, }: {
+    config: WorkflowConfig;
+    instanceId: string;
+    targetStage: string;
+    reason: string | undefined;
+}): Omit<SetStageArgs, 'client'>;
 interface SetStageOutcome {
     fired: boolean;
     cascaded: number;

package/dist/commands/move-stage.js

@@ -38,9 +38,18 @@ export default class MoveStage extends Command {
         try {
             const result = await workflow.setStage({
                 client,
-                ...buildSetStageArgs(config, args.instanceId, flags.to, flags.reason),
+                ...buildSetStageArgs({
+                    config,
+                    instanceId: args.instanceId,
+                    targetStage: flags.to,
+                    reason: flags.reason,
+                }),
+            });
+            emitWriteReport({
+                spinner,
+                report: moveStageReport(result, flags.to),
+                log: (line) => this.log(line),
             });
-            emitWriteReport(spinner, moveStageReport(result, flags.to), (line) => this.log(line));
         }
         catch (error) {
             spinner.fail('Move rejected');
@@ -51,8 +60,8 @@ export default class MoveStage extends Command {
 }
 /** The shared operation args ({@link buildOperationArgs}) plus the
  *  setStage-specific target. */
-export function buildSetStageArgs(config, instanceId, targetStage, reason) {
-    return { ...buildOperationArgs(config, instanceId, reason), targetStage };
+export function buildSetStageArgs({ config, instanceId, targetStage, reason, }) {
+    return { ...buildOperationArgs({ config, instanceId, reason }), targetStage };
 }
 /**
  * Turn a `setStage` result into the spinner message + ops block. Pure so

package/dist/commands/show.js

@@ -46,8 +46,8 @@ const HEADER_PAD = 9; // "Completed" — the longest label in the block
 export function instanceHeader(instance) {
     const title = `${styleText('bold', `${instance.definition} v${instance.pinnedVersion}`)}  ${styleText('cyan', instance._id)}`;
     const rows = [
-        formatKeyValue('Stage', instance.currentStage, { padTo: HEADER_PAD }),
-        formatKeyValue('Started', formatTimestamp(instance.startedAt), { padTo: HEADER_PAD }),
+        formatKeyValue({ key: 'Stage', value: instance.currentStage, padTo: HEADER_PAD }),
+        formatKeyValue({ key: 'Started', value: formatTimestamp(instance.startedAt), padTo: HEADER_PAD }),
     ];
     // Aborted instances also carry a completedAt stamped at the abort, so the
     // abort line stands in for completion — showing a green "Completed" too would
@@ -56,15 +56,15 @@ export function instanceHeader(instance) {
         const reason = abortReason(instance);
         const tail = reason ? ` — ${reason}` : '';
         const value = styleText('yellow', `${formatTimestamp(instance.abortedAt)}${tail}`);
-        rows.push(formatKeyValue('Aborted', value, { padTo: HEADER_PAD }));
+        rows.push(formatKeyValue({ key: 'Aborted', value, padTo: HEADER_PAD }));
     }
     else {
         const completed = instance.completedAt
             ? styleText('green', formatTimestamp(instance.completedAt))
             : styleText('dim', '—');
-        rows.push(formatKeyValue('Completed', completed, { padTo: HEADER_PAD }));
+        rows.push(formatKeyValue({ key: 'Completed', value: completed, padTo: HEADER_PAD }));
     }
-    rows.push(formatKeyValue('Tag', instance.tag, { padTo: HEADER_PAD }));
+    rows.push(formatKeyValue({ key: 'Tag', value: instance.tag, padTo: HEADER_PAD }));
     return [title, ...rows].join('\n');
 }
 /**

package/dist/commands/tail.js

@@ -33,7 +33,7 @@ export default class Tail extends Command {
             .subscribe({
             next: async () => {
                 try {
-                    seen = await this.printNewEntries(client, args.instanceId, seen);
+                    seen = await this.printNewEntries({ client, instanceId: args.instanceId, seen });
                 }
                 catch (err) {
                     const message = err instanceof Error ? err.message : String(err);
@@ -61,7 +61,7 @@ export default class Tail extends Command {
      * given high-water mark, return the new mark. Pulled out so the
      * async work in the subscription's `next` handler stays tidy.
      */
-    async printNewEntries(client, instanceId, seen) {
+    async printNewEntries({ client, instanceId, seen, }) {
         const next = await client.getDocument(instanceId);
         if (!next)
             return seen;

package/dist/lib/operation-args.d.ts

@@ -20,6 +20,10 @@ export declare function resolveActor(as: string | undefined, roles: string[]): A
  * conditionally because the engine's optional field rejects an explicit
  * `undefined` under `exactOptionalPropertyTypes`.
  */
-export declare function buildOperationArgs(config: WorkflowConfig, instanceId: string, reason: string | undefined): Omit<OperationArgs, 'client'> & {
+export declare function buildOperationArgs({ config, instanceId, reason, }: {
+    config: WorkflowConfig;
+    instanceId: string;
+    reason: string | undefined;
+}): Omit<OperationArgs, 'client'> & {
     reason?: string;
 };

package/dist/lib/operation-args.js

@@ -39,7 +39,7 @@ export function resolveActor(as, roles) {
  * conditionally because the engine's optional field rejects an explicit
  * `undefined` under `exactOptionalPropertyTypes`.
  */
-export function buildOperationArgs(config, instanceId, reason) {
+export function buildOperationArgs({ config, instanceId, reason, }) {
     return {
         ...baseEngineArgs(config),
         instanceId,

package/dist/lib/ops-report.d.ts

@@ -27,4 +27,8 @@ export interface WriteReport {
  * Shared by every write command so the fired / not-fired branches stay
  * consistent.
  */
-export declare function emitWriteReport(spinner: Ora, report: WriteReport, log: (line: string) => void): void;
+export declare function emitWriteReport({ spinner, report, log, }: {
+    spinner: Ora;
+    report: WriteReport;
+    log: (line: string) => void;
+}): void;

package/dist/lib/ops-report.js

@@ -18,7 +18,7 @@ export function opsAppliedLines(ranOps) {
  * Shared by every write command so the fired / not-fired branches stay
  * consistent.
  */
-export function emitWriteReport(spinner, report, log) {
+export function emitWriteReport({ spinner, report, log, }) {
     if (!report.fired) {
         spinner.warn(report.message);
         return;

package/dist/lib/ui.d.ts

@@ -9,7 +9,9 @@ export declare function sectionHeader(title: string): string;
  * the Sanity CLI's `formatKeyValue` so it folds into the shared helper on
  * merge; pass `padTo` (the longest key's length) to align a block of rows.
  */
-export declare function formatKeyValue(key: string, value: string, options?: {
+export declare function formatKeyValue({ key, value, indent, padTo, }: {
+    key: string;
+    value: string;
     indent?: number;
     padTo?: number;
 }): string;

package/dist/lib/ui.js

@@ -15,9 +15,7 @@ export function sectionHeader(title) {
  * the Sanity CLI's `formatKeyValue` so it folds into the shared helper on
  * merge; pass `padTo` (the longest key's length) to align a block of rows.
  */
-export function formatKeyValue(key, value, options) {
-    const indent = options?.indent ?? 2;
-    const padTo = options?.padTo ?? 0;
+export function formatKeyValue({ key, value, indent = 2, padTo = 0, }) {
     const paddedKey = `${key}:`.padEnd(padTo > 0 ? padTo + 1 : key.length + 1);
     return `${' '.repeat(indent)}${styleText('dim', paddedKey)} ${value}`;
 }

package/oclif.manifest.json

@@ -681,5 +681,5 @@
       ]
     }
   },
-  "version": "0.8.0"
+  "version": "0.8.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -53,15 +53,15 @@
     "diff": "^9.0.0",
     "log-symbols": "^7.0.1",
     "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.12.0"
+    "@sanity/workflow-engine": "0.13.0"
   },
   "devDependencies": {
     "@types/diff": "^8.0.0",
     "@types/node": "^24.12.4",
     "oclif": "^4.23.16",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine-test": "0.7.0",
-    "@sanity/workflow-examples": "0.2.0"
+    "@sanity/workflow-engine-test": "0.8.0",
+    "@sanity/workflow-examples": "0.3.0"
   },
   "oclif": {
     "bin": "sanity-workflows",