@sanity/workflow-cli 0.8.1 → 0.10.0

package/dist/commands/move-stage.js

@@ -1,86 +0,0 @@
-import { styleText } from 'node:util';
-import { Args, Command, Flags } from '@oclif/core';
-import { workflow } from '@sanity/workflow-engine';
-import ora from 'ora';
-import { loadClient } from "../lib/client.js";
-import { loadWorkflowConfig } from "../lib/config.js";
-import { fail } from "../lib/fail.js";
-import { tagFlags } from "../lib/flags.js";
-import { buildOperationArgs } from "../lib/operation-args.js";
-import { emitWriteReport, opsAppliedLines } from "../lib/ops-report.js";
-export default class MoveStage extends Command {
-    static description = 'Move an instance to a new stage. Guards + transition effects run as if the transition fired normally.';
-    static examples = [
-        '<%= config.bin %> move-stage wf-instance.abc123 --to ready',
-        "<%= config.bin %> move-stage wf-instance.abc123 --to ready --reason 'unblock for demo'",
-    ];
-    static args = {
-        instanceId: Args.string({
-            required: true,
-            description: 'Workflow instance id to move.',
-        }),
-    };
-    static flags = {
-        ...tagFlags,
-        to: Flags.string({
-            required: true,
-            description: 'Target stage name.',
-        }),
-        reason: Flags.string({
-            description: 'Free-text reason — recorded on the history entry for audit.',
-        }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(MoveStage);
-        const config = loadWorkflowConfig(flags.tag);
-        const client = loadClient();
-        const spinner = ora(`Moving ${args.instanceId} → ${flags.to}…`).start();
-        try {
-            const result = await workflow.setStage({
-                client,
-                ...buildSetStageArgs({
-                    config,
-                    instanceId: args.instanceId,
-                    targetStage: flags.to,
-                    reason: flags.reason,
-                }),
-            });
-            emitWriteReport({
-                spinner,
-                report: moveStageReport(result, flags.to),
-                log: (line) => this.log(line),
-            });
-        }
-        catch (error) {
-            spinner.fail('Move rejected');
-            const message = error instanceof Error ? error.message : String(error);
-            fail('setStage error:', message);
-        }
-    }
-}
-/** The shared operation args ({@link buildOperationArgs}) plus the
- *  setStage-specific target. */
-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
- * the fired / not-fired / cascaded / ops permutations can be asserted
- * without driving a real transition.
- */
-export function moveStageReport(result, to) {
-    const stage = styleText('bold', result.instance.currentStage);
-    if (!result.fired) {
-        return {
-            fired: false,
-            message: `setStage returned without firing — instance is already at ${stage}`,
-            opsLines: [],
-        };
-    }
-    const tail = result.cascaded > 0 ? `, then cascaded ${result.cascaded} auto-transition(s)` : '';
-    return {
-        fired: true,
-        message: `Now at ${stage} (was → ${to}${tail})`,
-        opsLines: opsAppliedLines(result.ranOps),
-    };
-}

package/dist/lib/config.d.ts

@@ -1,18 +0,0 @@
-import type { WorkflowResource } from '@sanity/workflow-engine';
-export interface WorkflowConfig {
-    workflowResource: WorkflowResource;
-    tag: string;
-}
-/**
- * {@link readWorkflowConfig} but funnel a thrown env-validation error
- * through the standard {@link fail} path so commands don't each have to wrap.
- */
-export declare function loadWorkflowConfig(tagOverride?: string): WorkflowConfig;
-/**
- * Resolve the `deploy` command's definitions source — a module specifier
- * (a path like `./src/workflows.ts`, or a package name) whose
- * `allDefinitions` export holds the batch to deploy. Required and with no
- * default: the CLI is agnostic about *which* definitions it ships, so an
- * unset source is an error rather than a silent fall back to a built-in set.
- */
-export declare function loadDefinitionsSource(): string;

package/dist/lib/config.js

@@ -1,50 +0,0 @@
-import { ENV } from "./env.js";
-import { fail, failOnThrow } from "./fail.js";
-const VALID_RESOURCE_TYPES = ['dataset', 'canvas', 'media-library', 'dashboard'];
-function isResourceType(value) {
-    return VALID_RESOURCE_TYPES.includes(value);
-}
-/**
- * Resolve the engine's `workflowResource` + tag from env vars (and an
- * optional `tagOverride`, e.g. the `--tag` flag).
- *
- * - `WORKFLOW_RESOURCE_TYPE` — one of "dataset" / "canvas" / "media-library" /
- *   "dashboard". Defaults to "dataset".
- * - `WORKFLOW_RESOURCE_ID` — the resource id (e.g. "test.test" for a
- *   dataset). Defaults to "test.test".
- * - `WORKFLOW_TAG` — the single environment tag (e.g. "prod"). Required;
- *   `tagOverride` takes precedence when supplied.
- */
-function readWorkflowConfig(tagOverride) {
-    const rawType = process.env[ENV.WORKFLOW_RESOURCE_TYPE] ?? 'dataset';
-    if (!isResourceType(rawType)) {
-        throw new Error(`WORKFLOW_RESOURCE_TYPE must be one of: ${VALID_RESOURCE_TYPES.join(', ')} (got "${rawType}")`);
-    }
-    const id = process.env[ENV.WORKFLOW_RESOURCE_ID] ?? 'test.test';
-    const tag = (tagOverride ?? process.env[ENV.WORKFLOW_TAG] ?? '').trim();
-    if (!tag) {
-        throw new Error('Workflow tag is required - pass --tag or set WORKFLOW_TAG (e.g. prod)');
-    }
-    return { workflowResource: { type: rawType, id }, tag };
-}
-/**
- * {@link readWorkflowConfig} but funnel a thrown env-validation error
- * through the standard {@link fail} path so commands don't each have to wrap.
- */
-export function loadWorkflowConfig(tagOverride) {
-    return failOnThrow('Invalid workflow config:', () => readWorkflowConfig(tagOverride));
-}
-/**
- * Resolve the `deploy` command's definitions source — a module specifier
- * (a path like `./src/workflows.ts`, or a package name) whose
- * `allDefinitions` export holds the batch to deploy. Required and with no
- * default: the CLI is agnostic about *which* definitions it ships, so an
- * unset source is an error rather than a silent fall back to a built-in set.
- */
-export function loadDefinitionsSource() {
-    const source = process.env[ENV.WORKFLOW_DEFS]?.trim();
-    if (source === undefined || source === '') {
-        fail('No definitions source configured.', 'Set WORKFLOW_DEFS to a module that exports `allDefinitions` — a path like ./src/workflows.ts, or a package name.');
-    }
-    return source;
-}