@sanity/workflow-cli 0.10.0 → 0.12.0

package/dist/lib/telemetry.d.ts

@@ -23,7 +23,9 @@
  * never flag values, arguments, or error text. `Editorial Workflows
  * Definition Shared` is a content-free marker (hash + structural counts); the shared
  * document itself rides the first-party feedback endpoint, never
- * telemetry (see `share-definitions.ts`).
+ * telemetry (see `share-definitions.ts`). `Editorial Workflows Definition
+ * Sharing Decided` records the per-invocation consent outcome (default /
+ * opt-in / opt-out and whether anything was donated) — also content-free.
  */
 import { type DefinedTelemetryTrace, type TelemetryStore } from '@sanity/telemetry';
 import { type TelemetryIntakeClient, type WorkflowDefinitionDeployedData, type WorkflowTelemetryLogger } from '@sanity/workflow-engine';
@@ -42,6 +44,26 @@ export declare const WorkflowCliCommandExecuted: DefinedTelemetryTrace<WorkflowC
  *  are ever shared, so status carries nothing. */
 export type WorkflowDefinitionSharedData = Omit<WorkflowDefinitionDeployedData, 'status'>;
 export declare const WorkflowDefinitionShared: import("@sanity/telemetry").DefinedTelemetryLog<WorkflowDefinitionSharedData>;
+/**
+ * How the donation decision was reached, and what it was. Paired with `shared`
+ * (whether it actually reached the endpoint) this keeps every case distinct —
+ * an explicit decline vs a run that couldn't ask, and a chosen share vs a
+ * failed POST:
+ * - `opt-in` / `opt-out` — an explicit `--share-defs` / `--no-share-defs`.
+ * - `prompt-accepted` / `prompt-declined` — the first-run consent prompt.
+ * - `remembered-share` / `remembered-decline` — a persisted earlier answer.
+ * - `unattended` — CI / `DO_NOT_TRACK` / non-TTY: never asked, never shares.
+ */
+export type DefinitionSharingDecision = 'opt-in' | 'opt-out' | 'prompt-accepted' | 'prompt-declined' | 'remembered-share' | 'remembered-decline' | 'unattended';
+export interface WorkflowDefinitionSharingDecidedData {
+    decision: DefinitionSharingDecision;
+    /** Whether the donation actually reached the feedback endpoint — `false` for
+     *  any non-sharing decision, and also for a chosen share whose POST failed. */
+    shared: boolean;
+    /** Newly created definition versions this invocation could have donated. */
+    definitionCount: number;
+}
+export declare const WorkflowDefinitionSharingDecided: import("@sanity/telemetry").DefinedTelemetryLog<WorkflowDefinitionSharingDecidedData>;
 /**
  * The shell for one CLI invocation. `builtin` is the Sanity-intake store;
  * `provided` is a config-supplied logger that replaces the shell and its
@@ -53,6 +75,10 @@ export type CliTelemetry = {
     logger: WorkflowTelemetryLogger;
     store: TelemetryStore<unknown>;
     envDenied: boolean;
+    /** The environment denial was overridden ({@link createBuiltinTelemetry}):
+     *  the store sends despite CI / `DO_NOT_TRACK`, subject only to
+     *  account consent. */
+    forceSend: boolean;
 } | {
     kind: 'provided';
     logger: WorkflowTelemetryLogger;
@@ -66,11 +92,16 @@ export declare function cliTelemetry(): CliTelemetry;
 export declare function setCliTelemetry(telemetry: CliTelemetry): void;
 export declare function clearCliTelemetry(): void;
 /** Build the built-in Sanity-intake shell over an authenticated,
- *  project-bound client. */
+ *  project-bound client. `forceSend` overrides the environment denial
+ *  (CI / `DO_NOT_TRACK`) — an explicit `--share-defs` opts the deploy
+ *  invocation's telemetry in regardless (a command-line arg beats env
+ *  vars). Account-level consent is unaffected: the intake still fetches
+ *  `/intake/telemetry-status`, so `sanity telemetry disable` still mutes. */
 export declare function createBuiltinTelemetry(args: {
     client: TelemetryIntakeClient;
     projectId: string;
     env: Record<string, string | undefined>;
+    forceSend?: boolean;
 }): Extract<CliTelemetry, {
     kind: 'builtin';
 }>;

package/dist/lib/telemetry.js

@@ -8,7 +8,12 @@ export const WorkflowCliCommandExecuted = defineTrace({
 export const WorkflowDefinitionShared = defineEvent({
     name: 'Editorial Workflows Definition Shared',
     version: 1,
-    description: 'A newly created workflow definition version was donated through the explicit definition-sharing opt-in. Content-free marker: the content hash plus the same structural counts Editorial Workflows Definition Deployed carries — the document itself goes to the first-party definition-feedback endpoint, never through telemetry.',
+    description: 'A newly created workflow definition version was donated to Sanity. Content-free marker: the content hash plus the same structural counts Editorial Workflows Definition Deployed carries — the document itself goes to the first-party definition-feedback endpoint, never through telemetry.',
+});
+export const WorkflowDefinitionSharingDecided = defineEvent({
+    name: 'Editorial Workflows Definition Sharing Decided',
+    version: 1,
+    description: 'One per deploy invocation that created new definition versions: how the donation decision was reached and what it was (explicit flag / prompt accept-or-decline / remembered / unattended), whether anything reached the endpoint, and how many versions were eligible. Content-free — lets adoption dashboards separate explicit opt-outs, prompt declines, and unattended runs, and measure the true opt-out rate, without ever carrying the document.',
 });
 const OFF = { kind: 'off', logger: noopTelemetry };
 let current = OFF;
@@ -28,10 +33,10 @@ export function clearCliTelemetry() {
     activeTrace = undefined;
 }
 export function createBuiltinTelemetry(args) {
-    const { client, projectId, env } = args;
+    const { client, projectId, env, forceSend = false } = args;
     const envDenied = isTelemetryEnvDenied(env);
-    const store = createBatchedStore(createSessionId(), createTelemetryIntake({ client, projectId, denied: envDenied }));
-    return { kind: 'builtin', logger: store.logger, store, envDenied };
+    const store = createBatchedStore(createSessionId(), createTelemetryIntake({ client, projectId, denied: forceSend ? false : envDenied }));
+    return { kind: 'builtin', logger: store.logger, store, envDenied, forceSend };
 }
 function traceAsLogEvent(trace) {
     const { name, version, description } = trace;

package/dist/lib/ui.js

@@ -44,7 +44,6 @@ export function resourceLabel(resource) {
 export const activityIcon = {
     done: logSymbols.success,
     active: styleText('cyan', '●'),
-    pending: styleText('dim', '○'),
     failed: logSymbols.error,
     skipped: styleText('dim', '⊘'),
 };

package/oclif.manifest.json

@@ -91,10 +91,10 @@
           "multiple": false,
           "type": "option"
         },
-        "share-definitions-with-sanity": {
-          "description": "Share the definition documents newly created by this deploy with Sanity — the full document, verbatim (structure, names, filters, effect configuration, seeded values), plus its deployment coordinates (project and dataset, or resource id); never content documents, instances, or your Sanity auth token. Opt-in for this invocation only; the CLI never prompts. Independent of telemetry consent.",
-          "name": "share-definitions-with-sanity",
-          "allowNo": false,
+        "share-defs": {
+          "description": "Share the definition documents newly created by this deploy with Sanity — the full document, verbatim (structure, names, filters, effect configuration, seeded values), plus its deployment coordinates (project and dataset, or resource id); never content documents, instances, or your Sanity auth token. Opt-out: an interactive terminal is asked once (the answer is remembered), while unattended runs (CI / non-TTY / DO_NOT_TRACK) share nothing unless --share-defs is passed. Use --no-share-defs to opt out. An explicit --share-defs also sends telemetry for this deploy regardless of CI / DO_NOT_TRACK.",
+          "name": "share-defs",
+          "allowNo": true,
           "type": "boolean"
         }
       },
@@ -225,11 +225,12 @@
     "list": {
       "aliases": [],
       "args": {},
-      "description": "List workflow instances in the configured dataset.",
+      "description": "List workflow instances in the configured dataset (in-flight by default).",
       "examples": [
         "<%= config.bin %> list",
-        "<%= config.bin %> list --in-flight",
+        "<%= config.bin %> list --include-completed",
         "<%= config.bin %> list --definition productLaunch",
+        "<%= config.bin %> list --document dataset:proj:ds:article-1",
         "<%= config.bin %> list --tag prod"
       ],
       "flags": {
@@ -240,9 +241,9 @@
           "multiple": false,
           "type": "option"
         },
-        "in-flight": {
-          "description": "Only instances that have not completed.",
-          "name": "in-flight",
+        "include-completed": {
+          "description": "Include completed/aborted instances (default: in-flight only).",
+          "name": "include-completed",
           "allowNo": false,
           "type": "boolean"
         },
@@ -259,6 +260,13 @@
           "multiple": false,
           "type": "option"
         },
+        "document": {
+          "description": "Only instances that reference this document (resource-qualified GDR URI, e.g. \"dataset:proj:ds:article-1\").",
+          "name": "document",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "limit": {
           "description": "Maximum rows to return.",
           "name": "limit",
@@ -282,6 +290,45 @@
         "list.js"
       ]
     },
+    "nuke": {
+      "aliases": [],
+      "args": {},
+      "description": "The reset for a dataset holding engine documents the versioned upgrade framework cannot yet migrate: deletes the tag's instances, definitions, and guards (across every alias-bound resource). Content documents are never touched. Prints a dry-run plan, then requires you to type back every involved dataset (--force skips the prompt; the plan still prints).",
+      "examples": [
+        "<%= config.bin %> nuke --tag plugin-dev",
+        "<%= config.bin %> nuke --tag plugin-dev --force"
+      ],
+      "flags": {
+        "tag": {
+          "description": "The deployment tag to reset. Required — a destructive reset never guesses the environment.",
+          "name": "tag",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "description": "Skip the confirmation prompt (for scripts/CI). The plan still prints.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "nuke",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Delete every engine-owned document for a deployment tag — the dev-period big red button.",
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "nuke.js"
+      ]
+    },
     "reset-activity": {
       "aliases": [],
       "args": {
@@ -426,7 +473,8 @@
       "examples": [
         "<%= config.bin %> start productLaunch",
         "<%= config.bin %> start article-review --field subject='{\"id\":\"dataset:proj:ds:article-1\",\"type\":\"article\"}'",
-        "<%= config.bin %> start productLaunch --version 2 --tag prod"
+        "<%= config.bin %> start productLaunch --version 2 --tag prod",
+        "<%= config.bin %> start productLaunch --instance-id prod.wf-instance.a1b2c3d4e5f6"
       ],
       "flags": {
         "tag": {
@@ -451,6 +499,13 @@
           "multiple": true,
           "type": "option"
         },
+        "instance-id": {
+          "description": "Start under this instance id — for retries. The id is the start's idempotency key: pass the id of a start that failed partway and the engine resumes it instead of creating a duplicate (an already-settled start replays as a no-op). Omit to mint a fresh id.",
+          "name": "instance-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "json": {
           "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
@@ -701,5 +756,5 @@
       ]
     }
   },
-  "version": "0.10.0"
+  "version": "0.12.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -56,15 +56,15 @@
     "jiti": "^2.7.0",
     "log-symbols": "^7.0.1",
     "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.15.0"
+    "@sanity/workflow-engine": "0.17.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.10.0",
-    "@sanity/workflow-examples": "0.5.0"
+    "@sanity/workflow-engine-test": "0.12.0",
+    "@sanity/workflow-examples": "0.7.0"
   },
   "oclif": {
     "bin": "sanity-workflows",