@sanity/workflow-cli 0.11.0 → 0.13.0

package/dist/lib/share-definitions.js

@@ -1,21 +1,23 @@
 import { styleText } from 'node:util';
-import { getUserConfig, isInteractive } from '@sanity/cli-core';
-import { confirm } from '@sanity/cli-core/ux';
-import { definitionDeployedData, errorMessage, isTelemetryEnvDenied, } from '@sanity/workflow-engine';
+import { getUserConfig } from '@sanity/cli-core';
+import { assertReadableModel, definitionDeployedData, errorMessage, } from '@sanity/workflow-engine';
 import { buildDefinitionShowQuery } from "./definitions.js";
+import { canPromptOnStderr } from "./prompt.js";
 import { cliTelemetry, WorkflowDefinitionShared, WorkflowDefinitionSharingDecided, } from "./telemetry.js";
 export const SHARE_ENDPOINT_URI = '/workflow/definition-feedback';
 const SHARE_TAG = 'definition.share';
 const SHARE_DECISION_KEY = 'workflowCliDefinitionSharing';
-export const SHARE_CONSENT_PROMPT = `${styleText('bold', 'Share the workflow definitions this deploy creates with Sanity?')}\n` +
+export const SHARE_FIRST_RUN_NOTICE = `${styleText('bold', 'Sharing new workflow definitions with Sanity')} to improve Editorial Workflows.\n` +
     'They are sent verbatim (structure, names, filters, effect configuration,\n' +
-    'seeded values) with their deployment coordinates, and kept to improve\n' +
-    'Editorial Workflows — never your content documents, workflow instances, or\n' +
-    'your Sanity auth token. Your answer is remembered for future deploys on\n' +
-    `this machine; override any run with ${styleText('cyan', '--share-defs')} / ${styleText('cyan', '--no-share-defs')}.`;
-export const SHARE_REMINDER_ON = `${styleText('bold', 'Sharing new workflow definitions with Sanity')} to improve Editorial Workflows` +
-    ` — opt out with ${styleText('cyan', '--no-share-defs')}.\n`;
-export const SHARE_REMINDER_OFF = `Not sharing workflow definitions with Sanity — share with ${styleText('cyan', '--share-defs')}.\n`;
+    'seeded values) with their deployment coordinates, and kept — never your\n' +
+    'content documents, workflow instances, or Sanity auth token. This notice is\n' +
+    `shown once on this machine; opt out of any run with ${styleText('cyan', '--no-share-defs')}.\n`;
+export const SHARE_REMINDER = `${styleText('bold', 'Definition sharing: ON (default)')}\n` +
+    'New workflow definition versions are being shared with Sanity to improve Editorial Workflows.\n' +
+    'Examples:\n' +
+    `  ${styleText('dim', '$')} sanity-workflows deploy                 ${styleText('dim', '# share by default')}\n` +
+    `  ${styleText('dim', '$')} sanity-workflows deploy ${styleText('cyan', '--share-defs')}    ${styleText('dim', '# share explicitly; hide this warning')}\n` +
+    `  ${styleText('dim', '$')} sanity-workflows deploy ${styleText('cyan', '--no-share-defs')} ${styleText('dim', '# opt out')}\n`;
 export function definitionShareMarker(args) {
     const { status: _status, ...structural } = definitionDeployedData(args.definition, {
         contentHash: args.contentHash,
@@ -26,7 +28,7 @@ export function definitionShareMarker(args) {
 }
 export function shouldForceShareTelemetry(args) {
     const { commandId, argv } = args;
-    if (commandId !== 'deploy') {
+    if (commandId !== 'editorial-workflows:deploy') {
         return false;
     }
     const terminator = argv.indexOf('--');
@@ -34,7 +36,8 @@ export function shouldForceShareTelemetry(args) {
     if (tokens.includes('--dry-run') || tokens.includes('--check')) {
         return false;
     }
-    return tokens.lastIndexOf('--share-defs') > tokens.lastIndexOf('--no-share-defs');
+    return (tokens.lastIndexOf('--share-defs') > tokens.lastIndexOf('--no-share-defs') ||
+        !tokens.includes('--no-share-defs'));
 }
 async function loadShareEntry(args) {
     const { candidate, result, warn } = args;
@@ -70,6 +73,7 @@ async function loadDeployedForShare(args) {
             warn(`Could not read back ${result.name} v${result.version} — not shared.`);
             return undefined;
         }
+        assertReadableModel(deployed);
         return deployed;
     }
     catch (error) {
@@ -82,43 +86,32 @@ function collectCreated(candidates) {
         .filter((result) => result.status === 'created')
         .map((result) => ({ candidate, result })));
 }
-function readShareDecision(userConfig) {
+function wasShareNoticeShown(userConfig) {
     const value = userConfig.get(SHARE_DECISION_KEY);
-    return typeof value === 'boolean' ? value : undefined;
+    return typeof value === 'boolean';
 }
-async function promptFirstRun(args) {
-    let share;
+function rememberShareNotice(userConfig) {
     try {
-        share = await args.confirmShare();
-    }
-    catch {
-        return false;
-    }
-    try {
-        args.userConfig.set(SHARE_DECISION_KEY, share);
+        userConfig.set(SHARE_DECISION_KEY, true);
     }
     catch {
     }
-    return share;
 }
-async function resolveShareIntent(args) {
+function resolveShareIntent(args) {
     if (args.flag === true) {
         return { share: true, decision: 'opt-in' };
     }
     if (args.flag === false) {
         return { share: false, decision: 'opt-out' };
     }
-    const unattended = args.envDenied || !args.interactive;
-    if (unattended) {
-        return { share: false, decision: 'unattended' };
+    if (args.interactive && !wasShareNoticeShown(args.userConfig)) {
+        args.writeStderr(SHARE_FIRST_RUN_NOTICE);
+        rememberShareNotice(args.userConfig);
     }
-    const remembered = readShareDecision(args.userConfig);
-    if (remembered !== undefined) {
-        args.writeStderr(remembered ? SHARE_REMINDER_ON : SHARE_REMINDER_OFF);
-        return { share: remembered, decision: remembered ? 'remembered-share' : 'remembered-decline' };
+    else {
+        args.writeStderr(SHARE_REMINDER);
     }
-    const accepted = await promptFirstRun(args);
-    return { share: accepted, decision: accepted ? 'prompt-accepted' : 'prompt-declined' };
+    return { share: true, decision: 'default' };
 }
 async function donate(args) {
     const shared = [];
@@ -169,14 +162,11 @@ export async function shareDefinitionsAfterDeploy(args) {
         return;
     }
     try {
-        const { share, decision } = await resolveShareIntent({
+        const { share, decision } = resolveShareIntent({
             flag: args.flag,
-            interactive: args.interactive ?? (isInteractive() && process.stderr.isTTY === true),
-            envDenied: args.envDenied ?? isTelemetryEnvDenied(process.env),
+            interactive: args.interactive ?? canPromptOnStderr(),
             userConfig: args.userConfig ?? getUserConfig(),
             writeStderr: args.writeStderr ?? ((message) => void process.stderr.write(message)),
-            confirmShare: args.confirmShare ??
-                (() => confirm({ message: SHARE_CONSENT_PROMPT, default: true }, { output: process.stderr })),
         });
         const shared = share ? await donate({ created, warn: args.warn }) : false;
         emitSharingDecided({ decision, shared, definitionCount: created.length });

package/dist/lib/telemetry-setup.d.ts

@@ -40,8 +40,8 @@ export declare function setupCliTelemetry(args?: {
     /** The oclif config's version — the prerun hook supplies it. */
     cliVersion?: string;
     /** Override the environment denial (CI / `DO_NOT_TRACK`) — the prerun hook
-     *  sets this for a deploy that explicitly opts into definition sharing with
-     *  `--share-defs`. */
+     *  sets this for a deploy that may share definitions, either by default or
+     *  through `--share-defs`. */
     forceSend?: boolean;
     /** Intake client override — tests inject a fake here, like the other
      *  hook dependencies above; omitted, the real project client applies. */

package/dist/lib/telemetry.d.ts

@@ -24,7 +24,7 @@
  * 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`). `Editorial Workflows Definition
- * Sharing Decided` records the per-invocation consent outcome (default /
+ * Sharing Decided` records the per-invocation sharing decision (default /
  * opt-in / opt-out and whether anything was donated) — also content-free.
  */
 import { type DefinedTelemetryTrace, type TelemetryStore } from '@sanity/telemetry';
@@ -47,14 +47,11 @@ export declare const WorkflowDefinitionShared: import("@sanity/telemetry").Defin
 /**
  * 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:
+ * an explicit opt-out vs default sharing, 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.
+ * - `default` — no sharing flag; definitions are donated in every environment.
  */
-export type DefinitionSharingDecision = 'opt-in' | 'opt-out' | 'prompt-accepted' | 'prompt-declined' | 'remembered-share' | 'remembered-decline' | 'unattended';
+export type DefinitionSharingDecision = 'opt-in' | 'opt-out' | 'default';
 export interface WorkflowDefinitionSharingDecidedData {
     decision: DefinitionSharingDecision;
     /** Whether the donation actually reached the feedback endpoint — `false` for
@@ -93,9 +90,8 @@ 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. `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
+ *  (CI / `DO_NOT_TRACK`) when a deploy may share definitions—flagless by
+ *  default or explicitly enabled. 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;
@@ -119,6 +115,18 @@ export declare function raceWithDeadline<T>(work: Promise<T>, deadlineMs: number
  * the same payload through its `log` seam and owns its own delivery.
  */
 export declare function finishCliTelemetry(data: WorkflowCliCommandData): Promise<void>;
+/**
+ * The command id a trace reports: the resolved class's canonical id when
+ * oclif supplies it, else the id as typed. An alias invocation must report
+ * under the same name as the canonical form — one command, one telemetry
+ * identity.
+ */
+export declare function traceCommandId(options: {
+    id: string;
+    Command?: {
+        id: string;
+    } | undefined;
+}): string;
 /**
  * The names of declared flags present in `argv` — long form (`--name`,
  * `--name=value`), negated booleans (`--no-name`), and short chars

package/dist/lib/telemetry.js

@@ -12,8 +12,8 @@ export const WorkflowDefinitionShared = defineEvent({
 });
 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.',
+    version: 2,
+    description: 'One per deploy invocation that created new definition versions: whether donation followed the default or an explicit flag, whether anything reached the endpoint, and how many versions were eligible. Content-free — measures the true opt-out rate without ever carrying the document.',
 });
 const OFF = { kind: 'off', logger: noopTelemetry };
 let current = OFF;
@@ -77,6 +77,9 @@ export async function finishCliTelemetry(data) {
         store.end();
     }
 }
+export function traceCommandId(options) {
+    return options.Command?.id ?? options.id;
+}
 export function usedFlagNames(argv, flagDefs) {
     const terminator = argv.indexOf('--');
     const tokens = argv.slice(0, terminator === -1 ? argv.length : terminator);

package/dist/lib/ui.d.ts

@@ -32,6 +32,18 @@ export declare function clipToLimit<T>(rows: T[], limit: number): {
     rows: T[];
     note?: string;
 };
+/**
+ * The shared tail of a list command: {@link clipToLimit} the probe-fetched
+ * rows, render them through {@link formatTable}, print every line, and print
+ * the clip note (when present) beneath the table.
+ */
+export declare function logClippedTable<T>({ rows, limit, headers, toCells, log, }: {
+    rows: T[];
+    limit: number;
+    headers: string[];
+    toCells: (row: T) => string[];
+    log: (line: string) => void;
+}): void;
 /**
  * The `▸ label` banner printed above a group's output when a run spans
  * several groups (deployments for deploy, resources for fanned-out reads),

package/dist/lib/ui.js

@@ -31,6 +31,15 @@ export function clipToLimit(rows, limit) {
         note: styleText('dim', `showing the first ${limit} — raise --limit to see more`),
     };
 }
+export function logClippedTable({ rows, limit, headers, toCells, log, }) {
+    const { rows: clipped, note } = clipToLimit(rows, limit);
+    for (const line of formatTable(headers, clipped.map(toCells))) {
+        log(line);
+    }
+    if (note) {
+        log(note);
+    }
+}
 export function groupBanner({ label, index, total, }) {
     if (total <= 1) {
         return undefined;