@sanity/workflow-cli 0.9.0 → 0.10.0

package/dist/lib/telemetry.js

@@ -0,0 +1,89 @@
+import { createBatchedStore, createSessionId, defineEvent, defineTrace, } from '@sanity/telemetry';
+import { createTelemetryIntake, isTelemetryEnvDenied, noopTelemetry, } from '@sanity/workflow-engine';
+export const WorkflowCliCommandExecuted = defineTrace({
+    name: 'Editorial Workflows CLI Command Executed',
+    version: 1,
+    description: 'A workflow CLI command was executed — payload is the command id, the names of declared flags used (never their values), and a success flag',
+});
+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.',
+});
+const OFF = { kind: 'off', logger: noopTelemetry };
+let current = OFF;
+let activeTrace;
+export function cliTelemetry() {
+    return current;
+}
+export function setCliTelemetry(telemetry) {
+    current = telemetry;
+    if (telemetry.kind === 'builtin') {
+        activeTrace = telemetry.store.logger.trace(WorkflowCliCommandExecuted);
+        activeTrace.start();
+    }
+}
+export function clearCliTelemetry() {
+    current = OFF;
+    activeTrace = undefined;
+}
+export function createBuiltinTelemetry(args) {
+    const { client, projectId, env } = args;
+    const envDenied = isTelemetryEnvDenied(env);
+    const store = createBatchedStore(createSessionId(), createTelemetryIntake({ client, projectId, denied: envDenied }));
+    return { kind: 'builtin', logger: store.logger, store, envDenied };
+}
+function traceAsLogEvent(trace) {
+    const { name, version, description } = trace;
+    return { type: 'log', name, version, description };
+}
+const FLUSH_DEADLINE_MS = 3_000;
+export async function raceWithDeadline(work, deadlineMs) {
+    let deadline;
+    try {
+        return await Promise.race([
+            work,
+            new Promise((resolve) => {
+                deadline = setTimeout(() => resolve(undefined), deadlineMs);
+            }),
+        ]);
+    }
+    finally {
+        clearTimeout(deadline);
+    }
+}
+export async function finishCliTelemetry(data) {
+    if (current.kind === 'provided') {
+        current.logger.log(traceAsLogEvent(WorkflowCliCommandExecuted), data);
+        return;
+    }
+    if (current.kind !== 'builtin')
+        return;
+    if (activeTrace !== undefined) {
+        activeTrace.log(data);
+        activeTrace.complete();
+        activeTrace = undefined;
+    }
+    const { store } = current;
+    try {
+        await raceWithDeadline(store.flush(), FLUSH_DEADLINE_MS);
+    }
+    finally {
+        store.end();
+    }
+}
+export function usedFlagNames(argv, flagDefs) {
+    const terminator = argv.indexOf('--');
+    const tokens = argv.slice(0, terminator === -1 ? argv.length : terminator);
+    return Object.entries(flagDefs ?? {})
+        .filter(([name, def]) => tokens.some((token) => matchesFlag({ token, name, char: def.char })))
+        .map(([name]) => name)
+        .sort();
+}
+function matchesFlag(args) {
+    const { token, name, char } = args;
+    if (token === `--${name}` || token.startsWith(`--${name}=`) || token === `--no-${name}`) {
+        return true;
+    }
+    return char !== undefined && (token === `-${char}` || token.startsWith(`-${char}=`));
+}

package/dist/lib/ui.d.ts

@@ -1,4 +1,4 @@
-import type { ActivityStatus } from '@sanity/workflow-engine';
+import type { ActivityStatus, WorkflowResource } from '@sanity/workflow-engine';
 /**
  * A bold `Title:` section heading. Mirrors the Sanity CLI's `sectionHeader`
  * (name + shape) so it folds into the shared helper when this CLI merges in.
@@ -15,6 +15,38 @@ export declare function formatKeyValue({ key, value, indent, padTo, }: {
     indent?: number;
     padTo?: number;
 }): string;
+/**
+ * A borderless column table as printable lines: cyan header row, every
+ * column padded to its widest cell, columns joined by three spaces.
+ * Mirrors the Sanity CLI's list-table shape (see `projects list`) so it
+ * folds into the shared helper when this CLI merges in. Widths count
+ * visible characters, so a pre-styled (ANSI) cell still pads correctly.
+ */
+export declare function formatTable(headers: string[], rows: string[][]): string[];
+/**
+ * Clip a probe-fetched result back to `limit`. The list query builders
+ * fetch one row past the display limit; when that probe row comes back,
+ * `note` carries the dim "showing the first N" hint to print under the table.
+ */
+export declare function clipToLimit<T>(rows: T[], limit: number): {
+    rows: T[];
+    note?: string;
+};
+/**
+ * The `▸ label` banner printed above a group's output when a run spans
+ * several groups (deployments for deploy, resources for fanned-out reads),
+ * so each block is attributable. `undefined` for a lone group — it keeps its
+ * original unprefixed output. A leading blank line separates every group
+ * after the first.
+ */
+export declare function groupBanner({ label, index, total, }: {
+    label: string;
+    index: number;
+    total: number;
+}): string | undefined;
+/** A workflow resource as a display label: a dataset's `project.dataset` id
+ *  reads naturally bare; other resource types keep their type for clarity. */
+export declare function resourceLabel(resource: WorkflowResource): string;
 /** Status glyph per activity state. log-symbols ship pre-colored (green ✔, red ✖),
  *  so those need no extra wrap; the rest carry their own state color. */
 export declare const activityIcon: Record<ActivityStatus, string>;

package/dist/lib/ui.js

@@ -1,26 +1,46 @@
-import { styleText } from 'node:util';
+import { stripVTControlCharacters, styleText } from 'node:util';
 import { formatDistanceToNow } from 'date-fns/formatDistanceToNow';
 import { lightFormat } from 'date-fns/lightFormat';
 import { parseISO } from 'date-fns/parseISO';
 import logSymbols from 'log-symbols';
-/**
- * A bold `Title:` section heading. Mirrors the Sanity CLI's `sectionHeader`
- * (name + shape) so it folds into the shared helper when this CLI merges in.
- */
 export function sectionHeader(title) {
     return styleText('bold', `${title}:`);
 }
-/**
- * A `  key:   value` detail row — a dim, padded key then the value. Mirrors
- * 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, indent = 2, padTo = 0, }) {
     const paddedKey = `${key}:`.padEnd(padTo > 0 ? padTo + 1 : key.length + 1);
     return `${' '.repeat(indent)}${styleText('dim', paddedKey)} ${value}`;
 }
-/** Status glyph per activity state. log-symbols ship pre-colored (green ✔, red ✖),
- *  so those need no extra wrap; the rest carry their own state color. */
+export function formatTable(headers, rows) {
+    const width = (cell) => stripVTControlCharacters(cell).length;
+    const widths = headers.map((header, i) => Math.max(width(header), ...rows.map((row) => width(row[i] ?? ''))));
+    const formatRow = (row) => widths
+        .map((columnWidth, i) => {
+        const cell = row[i] ?? '';
+        return cell + ' '.repeat(columnWidth - width(cell));
+    })
+        .join('   ')
+        .trimEnd();
+    return [styleText('cyan', formatRow(headers)), ...rows.map(formatRow)];
+}
+export function clipToLimit(rows, limit) {
+    if (rows.length <= limit) {
+        return { rows };
+    }
+    return {
+        rows: rows.slice(0, limit),
+        note: styleText('dim', `showing the first ${limit} — raise --limit to see more`),
+    };
+}
+export function groupBanner({ label, index, total, }) {
+    if (total <= 1) {
+        return undefined;
+    }
+    const gap = index > 0 ? '\n' : '';
+    return `${gap}${styleText('bold', `▸ ${label}`)}`;
+}
+export function resourceLabel(resource) {
+    return resource.type === 'dataset' ? resource.id : `${resource.type}:${resource.id}`;
+}
 export const activityIcon = {
     done: logSymbols.success,
     active: styleText('cyan', '●'),
@@ -28,25 +48,16 @@ export const activityIcon = {
     failed: logSymbols.error,
     skipped: styleText('dim', '⊘'),
 };
-/** Parse an engine ISO-8601 timestamp, or `undefined` when it's missing or
- *  unparseable. The engine writes valid ISO, but the lake is the only
- *  enforcement boundary — a legacy or raw-client-written doc can carry a bad
- *  or absent timestamp, and `parseISO`/`lightFormat` throw on those. Callers
- *  fall back to the raw value so one bad field never crashes a whole command. */
 function parseTimestamp(iso) {
     if (!iso)
         return undefined;
     const date = parseISO(iso);
     return Number.isNaN(date.getTime()) ? undefined : date;
 }
-/** An engine ISO-8601 timestamp as an absolute `yyyy-MM-dd HH:mm:ss` — the
- *  Sanity CLI's audit-log format (see `backups/list`). For detail views. */
 export function formatTimestamp(iso) {
     const date = parseTimestamp(iso);
     return date ? lightFormat(date, 'yyyy-MM-dd HH:mm:ss') : iso;
 }
-/** An engine ISO-8601 timestamp as a relative `… ago` — the Sanity CLI's
- *  job-list format (see `datasets/copy`). For scannable overview tables. */
 export function formatAge(iso) {
     const date = parseTimestamp(iso);
     return date ? `${formatDistanceToNow(date)} ago` : iso;

package/oclif.manifest.json

@@ -37,7 +37,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -91,6 +90,12 @@
           "hasDynamicHelp": false,
           "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,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -100,7 +105,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -145,7 +149,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -162,11 +165,10 @@
           "required": true
         }
       },
-      "description": "Fire an action on an instance — act on a user's behalf to unstick a waiting activity. Omit --action to list what can be fired.",
+      "description": "Fire an action on an instance to unstick a waiting activity — the write acts as the configured token. Omit --action to list what can be fired.",
       "examples": [
         "<%= config.bin %> fire-action wf-instance.abc123",
         "<%= config.bin %> fire-action wf-instance.abc123 --activity approve --action approve",
-        "<%= config.bin %> fire-action wf-instance.abc123 --activity approve --action approve --as user.xyz --as-role editor",
         "<%= config.bin %> fire-action wf-instance.abc123 --activity publish --action publish --param note=shipping"
       ],
       "flags": {
@@ -199,21 +201,6 @@
           "multiple": true,
           "type": "option"
         },
-        "as": {
-          "description": "Attribute the write to this Sanity user id (default: a workflow-cli system actor).",
-          "name": "as",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "as-role": {
-          "description": "Role to attribute to the --as user (repeatable), so role-gated filters pass.",
-          "name": "as-role",
-          "default": [],
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
         "json": {
           "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
@@ -228,7 +215,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -289,7 +275,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -373,7 +358,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -422,7 +406,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -443,7 +426,6 @@
       "examples": [
         "<%= config.bin %> start productLaunch",
         "<%= config.bin %> start article-review --field subject='{\"id\":\"dataset:proj:ds:article-1\",\"type\":\"article\"}'",
-        "<%= config.bin %> start article-review --as user.xyz --as-role editor",
         "<%= config.bin %> start productLaunch --version 2 --tag prod"
       ],
       "flags": {
@@ -469,21 +451,6 @@
           "multiple": true,
           "type": "option"
         },
-        "as": {
-          "description": "Attribute the write to this Sanity user id (default: a workflow-cli system actor).",
-          "name": "as",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "as-role": {
-          "description": "Role to attribute to the --as user (repeatable), so role-gated filters pass.",
-          "name": "as-role",
-          "default": [],
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
         "json": {
           "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
@@ -498,7 +465,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -535,7 +501,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -594,7 +559,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -640,7 +604,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -688,7 +651,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -730,7 +692,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -740,5 +701,5 @@
       ]
     }
   },
-  "version": "0.9.0"
+  "version": "0.10.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -27,7 +27,8 @@
   "files": [
     "dist",
     "bin/run.js",
-    "oclif.manifest.json"
+    "oclif.manifest.json",
+    "CHANGELOG.md"
   ],
   "type": "module",
   "sideEffects": false,
@@ -41,34 +42,38 @@
     "./package.json": "./package.json"
   },
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
   "dependencies": {
     "@oclif/core": "^4.11.4",
     "@oclif/plugin-help": "^6.2.50",
     "@sanity/cli-core": "^2.1.1",
     "@sanity/client": "^7.22.1",
+    "@sanity/telemetry": "^1.1.0",
     "boxen": "^8.0.1",
-    "console-table-printer": "^2.16.0",
     "date-fns": "^4.4.0",
     "diff": "^9.0.0",
     "jiti": "^2.7.0",
     "log-symbols": "^7.0.1",
     "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.14.0"
+    "@sanity/workflow-engine": "0.15.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.9.0",
-    "@sanity/workflow-examples": "0.4.0"
+    "@sanity/workflow-engine-test": "0.10.0",
+    "@sanity/workflow-examples": "0.5.0"
   },
   "oclif": {
     "bin": "sanity-workflows",
     "commands": "./dist/commands",
     "dirname": "sanity-workflows",
+    "hooks": {
+      "finally": "./dist/hooks/finally/telemetry",
+      "prerun": "./dist/hooks/prerun/telemetry"
+    },
     "plugins": [
       "@oclif/plugin-help"
     ],
@@ -86,9 +91,10 @@
     "node": ">=20.12"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && tsc -p tsconfig.declarations.json",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "test": "vitest run",
+    "test:packaging": "vitest run --config vitest.packaging.config.ts",
     "test:watch": "vitest",
     "dev": "NODE_OPTIONS='--conditions=development' tsx --env-file-if-exists=../../.env bin/dev.js",
     "cli": "NODE_OPTIONS='--conditions=development' tsx --env-file-if-exists=../../.env bin/dev.js"