@vizzly-testing/cli 0.35.3-beta.1 → 0.35.3-beta.3

package/dist/commands/review.js

@@ -2,6 +2,7 @@
  * Review commands - approve, reject, and comment on comparisons/builds
  */
 
+import { randomUUID as defaultRandomUUID } from 'node:crypto';
 import { createApiClient as defaultCreateApiClient } from '../api/index.js';
 import { loadConfig as defaultLoadConfig } from '../utils/config-loader.js';
 import { getAccessToken as defaultGetAccessToken } from '../utils/global-config.js';
@@ -11,6 +12,7 @@ function createReviewDeps(deps = {}) {
     loadConfig: deps.loadConfig || defaultLoadConfig,
     createApiClient: deps.createApiClient || defaultCreateApiClient,
     getAccessToken: deps.getAccessToken || defaultGetAccessToken,
+    randomUUID: deps.randomUUID || defaultRandomUUID,
     output: deps.output || defaultOutput,
     exit: deps.exit || (code => process.exit(code))
   };
@@ -144,12 +146,12 @@ async function runReviewMutation({
 }
 export function createApprovalBody(options = {}) {
   return options.comment ? {
-    comment: options.comment
+    annotation: options.comment.trim()
   } : {};
 }
 export function createRejectionBody(options = {}) {
   return {
-    reason: options.reason
+    annotation: options.reason.trim()
   };
 }
 export function createCommentBody(message, options = {}) {
@@ -158,6 +160,116 @@ export function createCommentBody(message, options = {}) {
     type: options.type || 'general'
   };
 }
+function requireReviewLocator(response) {
+  let locator = response?.review_locator;
+  if (!locator?.comparison_id || !locator?.build_id || !locator?.organization_slug) {
+    let error = new Error('Comparison response did not include review location details');
+    error.code = 'INVALID_REVIEW_CONTEXT';
+    throw error;
+  }
+  return locator;
+}
+async function runComparisonDecision({
+  command,
+  comparisonId,
+  decision,
+  annotation,
+  failureMessage,
+  globalOptions,
+  options,
+  spinnerMessage,
+  writeHumanSuccess,
+  deps,
+  configure = true
+}) {
+  let {
+    loadConfig,
+    createApiClient,
+    getAccessToken,
+    randomUUID,
+    output,
+    exit
+  } = createReviewDeps(deps);
+  if (configure) {
+    configureOutput(output, globalOptions);
+  }
+  try {
+    let config = await loadReviewConfig({
+      loadConfig,
+      options,
+      globalOptions
+    });
+    let token = await getReviewToken(config, getAccessToken);
+    if (!token) {
+      output.error('User login required for review actions');
+      output.hint('Run "vizzly login" to approve, reject, or comment');
+      output.cleanup();
+      exit(1);
+      return;
+    }
+    output.startSpinner(spinnerMessage);
+    let client = createReviewClient({
+      createApiClient,
+      config,
+      command,
+      token
+    });
+    let comparisonResponse = await client.request(`/api/sdk/comparisons/${comparisonId}`);
+    let locator = requireReviewLocator(comparisonResponse);
+    if (locator.comparison_id !== comparisonId) {
+      let error = new Error('Comparison response did not match the requested comparison');
+      error.code = 'INVALID_REVIEW_CONTEXT';
+      throw error;
+    }
+    let organizationHeaders = {
+      'X-Organization': locator.organization_slug
+    };
+    let commandId = randomUUID();
+    let response = await client.request(`/api/visual-review/builds/${locator.build_id}/comparisons/${comparisonId}/decision`, {
+      method: 'POST',
+      headers: {
+        ...organizationHeaders,
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify({
+        commandId,
+        decision,
+        ...(annotation ? {
+          annotation
+        } : {})
+      })
+    });
+    output.stopSpinner();
+    if (globalOptions.json) {
+      output.data({
+        eventId: response.eventId,
+        idempotent: response.idempotent,
+        review: response.review
+      });
+      output.cleanup();
+      return;
+    }
+    writeHumanSuccess(output);
+    output.cleanup();
+  } catch (error) {
+    output.stopSpinner();
+    if (globalOptions.json) {
+      output.data({
+        comparisonId,
+        error: {
+          message: error.message,
+          code: error.code
+        }
+      });
+      output.cleanup();
+      exit(1);
+      return;
+    }
+    output.error(failureMessage, error);
+    output.cleanup();
+    exit(1);
+  }
+}
 
 /**
  * Approve a comparison
@@ -167,27 +279,15 @@ export function createCommentBody(message, options = {}) {
  * @param {Object} deps - Dependencies for testing
  */
 export async function approveCommand(comparisonId, options = {}, globalOptions = {}, deps = {}) {
-  return await runReviewMutation({
+  return await runComparisonDecision({
     command: 'approve',
-    endpoint: `/api/sdk/comparisons/${comparisonId}/approve`,
+    comparisonId,
+    decision: 'approved',
+    annotation: createApprovalBody(options).annotation,
     failureMessage: 'Failed to approve comparison',
     globalOptions,
     options,
-    requestBody: createApprovalBody(options),
     spinnerMessage: 'Approving comparison...',
-    writeJsonError: (output, error) => output.data({
-      approved: false,
-      comparisonId,
-      error: {
-        message: error.message,
-        code: error.code
-      }
-    }),
-    writeJsonSuccess: (output, response) => output.data({
-      approved: true,
-      comparisonId,
-      comparison: response.comparison
-    }),
     writeHumanSuccess: output => {
       output.complete(`Comparison ${comparisonId} approved`);
       if (options.comment) {
@@ -218,28 +318,15 @@ export async function rejectCommand(comparisonId, options = {}, globalOptions =
     exit(1);
     return;
   }
-  return await runReviewMutation({
+  return await runComparisonDecision({
     command: 'reject',
-    endpoint: `/api/sdk/comparisons/${comparisonId}/reject`,
+    comparisonId,
+    decision: 'rejected',
+    annotation: createRejectionBody(options).annotation,
     failureMessage: 'Failed to reject comparison',
     globalOptions,
     options,
-    requestBody: createRejectionBody(options),
     spinnerMessage: 'Rejecting comparison...',
-    writeJsonError: (output, error) => output.data({
-      rejected: false,
-      comparisonId,
-      error: {
-        message: error.message,
-        code: error.code
-      }
-    }),
-    writeJsonSuccess: (output, response) => output.data({
-      rejected: true,
-      comparisonId,
-      reason: options.reason,
-      comparison: response.comparison
-    }),
     writeHumanSuccess: output => {
       output.complete(`Comparison ${comparisonId} rejected`);
       output.hint(`Reason: "${options.reason}"`);

package/dist/commands/run.js

@@ -493,9 +493,7 @@ export async function runCommand(testCommand, options = {}, globalOptions = {},
           if (Object.keys(comparisons).length > 0) {
             jsonResult.comparisons = comparisons;
           }
-          if (buildResult.approvalStatus !== undefined) {
-            jsonResult.approvalStatus = buildResult.approvalStatus;
-          }
+          jsonResult.visual_review = buildResult.visual_review;
           if (buildResult.build?.conclusion !== undefined) {
             jsonResult.conclusion = buildResult.build.conclusion;
           }

package/dist/commands/status.js

@@ -49,67 +49,38 @@ async function fetchOptionalPreviewInfo(getPreviewInfo, client, buildId) {
   }
 }
 export function normalizeBuildStatus(buildStatus) {
-  return buildStatus.build || buildStatus;
+  return buildStatus.build;
 }
 
 /**
- * Read exact processing counts from canonical or legacy status responses.
+ * Read the processing counts from the status response.
  *
- * Legacy `pending_screenshots` is review state, not queue state, so it is
- * deliberately excluded. Missing processing fields remain missing instead of
- * becoming client-authored zeroes.
- *
- * @param {Object} status - Canonical status bundle or legacy build record.
- * @returns {Object|undefined} API-provided processing facts when available.
+ * @param {Object} status - Status response.
+ * @returns {Object} API-provided processing facts.
  */
 export function getProcessingStatus(status = {}) {
-  if (status.processing) {
-    return status.processing;
-  }
-  let build = normalizeBuildStatus(status);
-  let processing = {};
-  let fields = [['total', build.screenshot_count], ['completed', build.completed_jobs], ['failed', build.failed_jobs], ['active', build.processing_screenshots]];
-  for (let [name, value] of fields) {
-    if (value != null) {
-      processing[name] = value;
-    }
-  }
-  return Object.keys(processing).length > 0 ? processing : undefined;
+  return status.processing;
 }
 
 /**
  * Read comparison totals without deriving them from screenshot counts.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
- * @returns {Object|undefined} API-provided comparison facts when available.
+ * @param {Object} status - Status response.
+ * @returns {Object} API-provided comparison facts.
  */
 export function getComparisonStatus(status = {}) {
-  if (status.comparisons) {
-    return status.comparisons;
-  }
-  let build = normalizeBuildStatus(status);
-  let comparisons = {};
-  let fields = [['total', build.total_comparisons], ['new', build.new_comparisons], ['changed', build.changed_comparisons], ['identical', build.identical_comparisons]];
-  for (let [name, value] of fields) {
-    if (value != null) {
-      comparisons[name] = value;
-    }
-  }
-  return Object.keys(comparisons).length > 0 ? comparisons : undefined;
+  return status.comparisons;
 }
 
 /**
- * Prefer canonical Cricket review state while retaining the legacy fallback.
- *
- * Processing status stays separate: a pending review never means a screenshot
- * is still being processed.
+ * Read the build review state without mixing it with processing status.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
+ * @param {Object} status - Status response.
  * @returns {string|null} API-provided review state when available.
  */
 export function getBuildReviewState(status = {}) {
   let build = normalizeBuildStatus(status);
-  return getVisualReviewState(build) || getVisualReviewState(status.visualReview?.build || status.visual_review) || null;
+  return getVisualReviewState(build);
 }
 
 /**
@@ -132,13 +103,10 @@ export function createStatusSuggestedCommands(build = {}) {
 }
 
 /**
- * Preserve the established JSON fields while exposing canonical status facts.
- *
  * Every lifecycle, processing, comparison, and review value comes directly
- * from the API. Undefined values intentionally disappear during JSON encoding
- * rather than being presented as false certainty.
+ * from the API.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
+ * @param {Object} status - Status response.
  * @param {Object|null} previewInfo - Optional preview response.
  * @returns {Object} Machine-readable status payload.
  */
@@ -146,7 +114,6 @@ export function createStatusData(status, previewInfo = null) {
   let build = normalizeBuildStatus(status);
   let processing = getProcessingStatus(status);
   let comparisons = getComparisonStatus(status);
-  let visualReview = build.visual_review || status.visualReview?.build || status.visual_review;
   return {
     resource: status.resource,
     schemaVersion: status.schema_version,
@@ -161,18 +128,14 @@ export function createStatusData(status, previewInfo = null) {
     branch: build.branch,
     commit: build.commit_sha,
     commitMessage: build.commit_message,
-    screenshotsTotal: processing?.total ?? build.screenshot_count,
+    screenshotsTotal: processing.total,
     processing,
-    comparisonsTotal: comparisons?.total ?? build.total_comparisons,
+    comparisonsTotal: comparisons.total,
     comparisons,
-    newComparisons: comparisons?.new ?? build.new_comparisons,
-    changedComparisons: comparisons?.changed ?? build.changed_comparisons,
-    identicalComparisons: comparisons?.identical ?? build.identical_comparisons,
-    reviewState: getBuildReviewState(status),
-    review: status.review,
-    reviewFlow: status.reviewFlow,
-    visualReview,
-    approvalStatus: build.approval_status,
+    newComparisons: comparisons.new,
+    changedComparisons: comparisons.changed,
+    identicalComparisons: comparisons.identical,
+    visual_review: build.visual_review || null,
     executionTime: build.execution_time_ms,
     isBaseline: build.is_baseline,
     userAgent: build.user_agent,
@@ -203,19 +166,18 @@ export function createBuildInfo(build) {
 }
 
 /**
- * Format API comparison outcomes without filling missing buckets with zeroes.
+ * Format API comparison outcomes.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
+ * @param {Object} status - Status response.
  * @param {Object} colors - Output color helpers.
  * @returns {string} Human-readable comparison summary.
  */
 export function createComparisonStats(status, colors) {
-  let build = normalizeBuildStatus(status);
-  let comparisons = getComparisonStatus(status) || {};
+  let comparisons = getComparisonStatus(status);
   let stats = [];
-  let newCount = comparisons.new ?? build.new_comparisons;
-  let changedCount = comparisons.changed ?? build.changed_comparisons;
-  let identicalCount = comparisons.identical ?? build.identical_comparisons;
+  let newCount = comparisons.new;
+  let changedCount = comparisons.changed;
+  let identicalCount = comparisons.identical;
   if (newCount > 0) {
     stats.push(`${colors.brand.info(newCount)} new`);
   }
@@ -229,45 +191,39 @@ export function createComparisonStats(status, colors) {
 }
 
 /**
- * Build the best available legacy link when the API did not return one.
- *
- * Slug routes match the current app, while the project-ID route remains as a
- * compatibility fallback for older build responses.
+ * Build the scoped app link when the API did not return one.
  *
  * @param {string} baseUrl - API or app base URL.
  * @param {Object} build - Build record.
- * @param {Object|null} scope - Canonical organization and project scope.
+ * @param {Object|null} scope - Organization and project details.
  * @returns {string|null} Build URL when the response has enough identity.
  */
 export function createBuildUrl(baseUrl, build, scope = null) {
   if (!baseUrl) {
     return null;
   }
-  let organizationSlug = scope?.organization?.slug || build.organization_slug || build.org_slug;
-  let projectSlug = scope?.project?.slug || build.project_slug;
+  let organizationSlug = scope?.organization?.slug;
+  let projectSlug = scope?.project?.slug;
   let appBaseUrl = getAppBaseUrl(baseUrl);
   if (organizationSlug && projectSlug) {
     return `${appBaseUrl}/${organizationSlug}/${projectSlug}/builds/${build.id}`;
   }
-  if (build.project_id) {
-    return `${appBaseUrl}/projects/${build.project_id}/builds/${build.id}`;
-  }
   return null;
 }
 
 /**
- * Preserve status failure behavior while accepting the canonical conclusion.
+ * Preserve status failure behavior while using the server's conclusion.
  *
  * Review-required and rejected builds keep their existing successful command
  * exit behavior. Only build or processing failures produce a failing status.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
+ * @param {Object} status - Status response.
  * @returns {boolean} Whether human status should exit non-zero.
  */
 export function shouldFailStatus(status) {
   let build = normalizeBuildStatus(status);
   let processing = getProcessingStatus(status);
-  return build.status === 'failed' || ['build_failed', 'processing_failed'].includes(status.conclusion) || (processing?.failed ?? 0) > 0;
+  return build.status === 'failed' || ['build_failed', 'processing_failed'].includes(status.conclusion) || processing.failed > 0;
 }
 function writeStatusTiming({
   build,
@@ -314,7 +270,7 @@ function writeSuggestedCommands({
 /**
  * Add optional API facts without inventing placeholders for missing metadata.
  *
- * @param {Object} status - Canonical status bundle or legacy build record.
+ * @param {Object} status - Status response.
  * @returns {Object} Available verbose fields.
  */
 function createVerboseInfo(status) {
@@ -348,7 +304,7 @@ function createVerboseInfo(status) {
 /**
  * Format only the processing facts supplied by the API.
  *
- * @param {Object|undefined} processing - Canonical processing counts.
+ * @param {Object|undefined} processing - Processing counts.
  * @returns {string} Human-readable processing summary.
  */
 function formatProcessingStatus(processing) {
@@ -387,7 +343,7 @@ function writeHumanStatus({
   let colors = output.getColors();
   let comparisonStats = createComparisonStats(status, colors);
   let processing = getProcessingStatus(status);
-  let screenshotsTotal = processing?.total ?? build.screenshot_count;
+  let screenshotsTotal = processing.total;
   let processingSummary = formatProcessingStatus(processing);
   if (screenshotsTotal != null) {
     output.labelValue('Screenshots', String(screenshotsTotal));

package/dist/commands/upload.js

@@ -262,7 +262,7 @@ export async function uploadCommand(screenshotsPath, options = {}, globalOptions
             failed: buildResult.failedComparisons || 0,
             new: buildResult.newComparisons || 0
           },
-          approvalStatus: buildResult.approvalStatus || 'pending',
+          visual_review: buildResult.visual_review,
           executionTimeMs
         });
         output.cleanup();