@vizzly-testing/cli 0.39.1 → 0.39.2

package/dist/domains/uploads/upload-files.js

@@ -0,0 +1,32 @@
+import crypto from 'node:crypto';
+
+/**
+ * Compute SHA256 hash of a buffer
+ * @param {Buffer} buffer - File buffer
+ * @returns {string} Hex-encoded SHA256 hash
+ */
+export function computeSha256(buffer) {
+  return crypto.createHash('sha256').update(buffer).digest('hex');
+}
+
+/**
+ * Partition files into those that need upload and those that exist
+ * @param {Array} fileMetadata - All file metadata
+ * @param {Set} existingShas - Set of SHAs that already exist
+ * @returns {{ toUpload: Array, existing: Array }}
+ */
+export function partitionFilesByExistence(fileMetadata, existingShas) {
+  return {
+    toUpload: fileMetadata.filter(f => !existingShas.has(f.sha256)),
+    existing: fileMetadata.filter(f => existingShas.has(f.sha256))
+  };
+}
+
+/**
+ * Build glob pattern for screenshots
+ * @param {string} directory - Base directory
+ * @returns {string} Glob pattern
+ */
+export function buildScreenshotPattern(directory) {
+  return `${directory}/**/*.png`;
+}

package/dist/domains/uploads/upload-settings.js

@@ -0,0 +1,21 @@
+import { DEFAULT_BATCH_SIZE, DEFAULT_TIMEOUT } from './upload-defaults.js';
+
+/**
+ * Resolve batch size from options and config
+ * @param {Object} options - Runtime options
+ * @param {Object} uploadConfig - Upload configuration
+ * @returns {number} Resolved batch size
+ */
+export function resolveBatchSize(options, uploadConfig) {
+  return Number(options?.batchSize ?? uploadConfig?.batchSize ?? DEFAULT_BATCH_SIZE);
+}
+
+/**
+ * Resolve timeout from options and config
+ * @param {Object} options - Runtime options
+ * @param {Object} uploadConfig - Upload configuration
+ * @returns {number} Resolved timeout in ms
+ */
+export function resolveTimeout(options, uploadConfig) {
+  return Number(options?.timeout ?? uploadConfig?.timeout ?? DEFAULT_TIMEOUT);
+}

package/dist/domains/uploads/upload-timing.js

@@ -0,0 +1,18 @@
+/**
+ * Check if timeout has been exceeded
+ * @param {number} startTime - Start timestamp
+ * @param {number} timeout - Timeout in ms
+ * @returns {boolean} True if timed out
+ */
+export function isTimedOut(startTime, timeout, now = Date.now()) {
+  return now - startTime >= timeout;
+}
+
+/**
+ * Get elapsed time since start
+ * @param {number} startTime - Start timestamp
+ * @returns {number} Elapsed time in ms
+ */
+export function getElapsedTime(startTime, now = Date.now()) {
+  return now - startTime;
+}

package/dist/{commands/upload.js → domains/uploads/upload.commands.js}

@@ -1,11 +1,13 @@
-import { createApiClient as defaultCreateApiClient, finalizeBuild as defaultFinalizeBuild, getTokenContext as defaultGetTokenContext } from '../api/index.js';
-import { CONFIG_DEFAULTS } from '../config/core.js';
-import { createUploader as defaultCreateUploader } from '../uploader/index.js';
-import { getAppBaseUrl } from '../utils/api-url.js';
-import { loadConfig as defaultLoadConfig } from '../utils/config-loader.js';
-import { detectBranch as defaultDetectBranch, detectCommit as defaultDetectCommit, detectCommitAuthor as defaultDetectCommitAuthor, detectCommitMessage as defaultDetectCommitMessage, detectPullRequestNumber as defaultDetectPullRequestNumber, generateBuildNameWithGit as defaultGenerateBuildNameWithGit } from '../utils/git.js';
-import * as defaultOutput from '../utils/output.js';
-import { writeSession as defaultWriteSession } from '../utils/session.js';
+import { getAppBaseUrl } from '../../shared/api-url.js';
+import { detectBranch as defaultDetectBranch, detectCommit as defaultDetectCommit, detectCommitAuthor as defaultDetectCommitAuthor, detectCommitMessage as defaultDetectCommitMessage, detectPullRequestNumber as defaultDetectPullRequestNumber, generateBuildNameWithGit as defaultGenerateBuildNameWithGit } from '../../shared/git.js';
+import * as defaultOutput from '../../shared/output.js';
+import { createApiClient as defaultCreateApiClient } from '../auth/cloud-client.js';
+import { finalizeBuild as defaultFinalizeBuild } from '../builds/build.service.js';
+import { CONFIG_DEFAULTS } from '../config/config-defaults.js';
+import { loadConfig as defaultLoadConfig } from '../config/config-loader.js';
+import { getTokenContext as defaultGetTokenContext } from '../context/context.service.js';
+import { writeSession as defaultWriteSession } from '../runs/session-store.js';
+import { createUploader as defaultCreateUploader } from './upload.service.js';
 
 /**
  * Construct proper build URL with org/project context
@@ -380,7 +382,7 @@ export async function uploadCommand(screenshotsPath, options = {}, globalOptions
  * @param {Object} options - Command options
  */
 export function validateUploadOptions(screenshotsPath, options) {
-  const errors = [];
+  let errors = [];
   if (!screenshotsPath) {
     errors.push('Screenshots path is required');
   }

package/dist/domains/uploads/upload.normalizers.js

@@ -0,0 +1,60 @@
+import { basename } from 'node:path';
+import { computeSha256 } from './upload-files.js';
+let KNOWN_BROWSERS = ['chrome', 'firefox', 'safari', 'edge', 'webkit'];
+
+/**
+ * Extract browser name from filename
+ * @param {string} filename - The screenshot filename
+ * @returns {string|null} Browser name or null if not found
+ */
+export function extractBrowserFromFilename(filename) {
+  let lowerFilename = filename.toLowerCase();
+  for (let browser of KNOWN_BROWSERS) {
+    if (lowerFilename.includes(browser)) {
+      return browser;
+    }
+  }
+  return null;
+}
+
+/**
+ * Build file metadata object
+ * @param {string} filePath - Path to file
+ * @param {Buffer} buffer - File contents
+ * @returns {Object} File metadata
+ */
+export function buildFileMetadata(filePath, buffer) {
+  return {
+    path: filePath,
+    filename: basename(filePath),
+    buffer,
+    sha256: computeSha256(buffer)
+  };
+}
+
+/**
+ * Convert file metadata to screenshot check format
+ * @param {Object} file - File metadata
+ * @returns {Object} Screenshot format for SHA check
+ */
+export function fileToScreenshotFormat(file) {
+  let browser = extractBrowserFromFilename(file.filename);
+  return {
+    sha256: file.sha256,
+    name: file.filename.replace(/\.png$/, ''),
+    filename: file.filename,
+    properties: browser ? {
+      browser
+    } : {}
+  };
+}
+
+/**
+ * Extract status code from error message
+ * @param {string} errorMessage - Error message
+ * @returns {string} Status code or 'unknown'
+ */
+export function extractStatusCodeFromError(errorMessage) {
+  let match = String(errorMessage || '').match(/API request failed: (\d+)/);
+  return match ? match[1] : 'unknown';
+}

package/dist/domains/uploads/upload.serializers.js

@@ -0,0 +1,179 @@
+function buildUploadMetadata(options) {
+  let metadata = {
+    ...(options.metadata || {})
+  };
+  let comparison = {
+    ...(metadata.comparison || {})
+  };
+  if (options.threshold !== undefined) {
+    comparison.threshold = options.threshold;
+  }
+  if (options.minClusterSize !== undefined) {
+    comparison.minClusterSize = options.minClusterSize;
+  }
+  if (Object.keys(comparison).length > 0) {
+    metadata.comparison = comparison;
+  }
+  return Object.keys(metadata).length > 0 ? metadata : undefined;
+}
+
+/**
+ * Build API build info payload
+ * @param {Object} options - Upload options
+ * @param {string} [defaultBranch] - Default branch to use
+ * @returns {Object} Build info payload
+ */
+export function buildBuildInfo(options, defaultBranch = 'main') {
+  let buildInfo = {
+    name: options.buildName || `Upload ${new Date().toISOString()}`,
+    branch: options.branch || defaultBranch || 'main',
+    commit_sha: options.commit,
+    commit_message: options.message,
+    commit_author_name: options.commitAuthorName,
+    commit_author_email: options.commitAuthorEmail,
+    environment: options.environment || 'production',
+    threshold: options.threshold,
+    github_pull_request_number: options.pullRequestNumber,
+    parallel_id: options.parallelId
+  };
+  let metadata = buildUploadMetadata(options);
+  if (metadata) {
+    buildInfo.metadata = metadata;
+  }
+  return buildInfo;
+}
+
+/**
+ * Build scanning phase progress
+ * @param {number} total - Total files found
+ * @returns {Object} Progress object
+ */
+export function buildScanningProgress(total) {
+  return {
+    phase: 'scanning',
+    message: `Found ${total} screenshots`,
+    total
+  };
+}
+
+/**
+ * Build processing phase progress
+ * @param {number} current - Current file number
+ * @param {number} total - Total files
+ * @returns {Object} Progress object
+ */
+export function buildProcessingProgress(current, total) {
+  return {
+    phase: 'processing',
+    message: 'Processing files',
+    current,
+    total
+  };
+}
+
+/**
+ * Build deduplication phase progress
+ * @param {number} toUpload - Files to upload
+ * @param {number} existing - Existing files
+ * @param {number} total - Total files
+ * @returns {Object} Progress object
+ */
+export function buildDeduplicationProgress(toUpload, existing, total) {
+  return {
+    phase: 'deduplication',
+    message: `Checking for duplicates (${toUpload} to upload, ${existing} existing)`,
+    toUpload,
+    existing,
+    total
+  };
+}
+
+/**
+ * Build uploading phase progress
+ * @param {number} current - Current upload number
+ * @param {number} total - Total to upload
+ * @returns {Object} Progress object
+ */
+export function buildUploadingProgress(current, total) {
+  return {
+    phase: 'uploading',
+    message: 'Uploading screenshots',
+    current,
+    total
+  };
+}
+
+/**
+ * Build completed phase progress
+ * @param {string} buildId - Build ID
+ * @param {string|null} url - Build URL
+ * @returns {Object} Progress object
+ */
+export function buildCompletedProgress(buildId, url) {
+  return {
+    phase: 'completed',
+    message: 'Upload completed',
+    buildId,
+    url
+  };
+}
+
+/**
+ * Build successful upload result
+ * @param {Object} options - Options
+ * @param {string} options.buildId - Build ID
+ * @param {string|null} options.url - Build URL
+ * @param {number} options.total - Total files
+ * @param {number} options.uploaded - Files uploaded
+ * @param {number} options.skipped - Files skipped
+ * @returns {Object} Upload result
+ */
+export function buildUploadResult({
+  buildId,
+  url,
+  total,
+  uploaded,
+  skipped
+}) {
+  return {
+    success: true,
+    buildId,
+    url,
+    stats: {
+      total,
+      uploaded,
+      skipped
+    }
+  };
+}
+
+/**
+ * Build wait result from build response
+ * @param {Object} build - Build object from API
+ * @returns {Object} Wait result
+ */
+export function buildWaitResult(build) {
+  let totalComparisons = build.total_comparisons;
+  let passedComparisons = build.identical_comparisons;
+  let failedComparisons = build.changed_comparisons;
+  let newComparisons = build.new_comparisons;
+  let identicalComparisons = build.identical_comparisons;
+  let hasComparisonCounts = build.total_comparisons !== undefined || build.new_comparisons !== undefined || build.changed_comparisons !== undefined || build.identical_comparisons !== undefined;
+  let result = {
+    status: build.status,
+    build,
+    passedComparisons,
+    failedComparisons,
+    newComparisons,
+    identicalComparisons,
+    visual_review: build.visual_review || null,
+    totalComparisons
+  };
+  if (hasComparisonCounts) {
+    result.comparisons = totalComparisons;
+  }
+  if (build.url) {
+    result.url = build.url;
+  }
+  return result;
+}

package/dist/{uploader/operations.js → domains/uploads/upload.service.js}

@@ -1,10 +1,91 @@
+import { readFile, stat } from 'node:fs/promises';
+import { glob } from 'glob';
+import { getDefaultBranch } from '../../shared/git.js';
+import * as output from '../../shared/output.js';
+import { TimeoutError, UploadError, ValidationError } from '../../shared/vizzly-error.js';
+import { createApiClient } from '../auth/cloud-client.js';
+import { createBuild } from '../builds/build.service.js';
+import { checkShas } from '../screenshots/cloud-screenshots.js';
+import { buildFileMetadata, extractStatusCodeFromError, fileToScreenshotFormat } from './upload.normalizers.js';
+import { buildBuildInfo, buildCompletedProgress, buildDeduplicationProgress, buildProcessingProgress, buildScanningProgress, buildUploadingProgress, buildUploadResult, buildWaitResult } from './upload.serializers.js';
+import { validateApiKey, validateDirectoryStats, validateFilesFound, validateScreenshotsDir } from './upload.validations.js';
+import { DEFAULT_BUILD_POLL_INTERVAL, DEFAULT_SHA_CHECK_BATCH_SIZE } from './upload-defaults.js';
+import { buildScreenshotPattern, partitionFilesByExistence } from './upload-files.js';
+import { resolveBatchSize, resolveTimeout } from './upload-settings.js';
+import { getElapsedTime, isTimedOut } from './upload-timing.js';
+
 /**
- * Uploader Operations - I/O operations with dependency injection
- *
- * Each operation takes its dependencies as parameters for testability.
+ * Screenshot upload operations and the public uploader factory.
+ * Dependencies are explicit so callers can choose external integrations.
  */
 
-import { buildBuildInfo, buildCompletedProgress, buildDeduplicationProgress, buildFileMetadata, buildProcessingProgress, buildScanningProgress, buildScreenshotPattern, buildUploadingProgress, buildUploadResult, buildWaitResult, DEFAULT_BUILD_POLL_INTERVAL, DEFAULT_SHA_CHECK_BATCH_SIZE, extractStatusCodeFromError, fileToScreenshotFormat, getElapsedTime, isTimedOut, partitionFilesByExistence, validateApiKey, validateDirectoryStats, validateFilesFound, validateScreenshotsDir } from './core.js';
+export function createUploader({
+  apiKey,
+  apiUrl,
+  userAgent,
+  command,
+  upload: uploadConfig = {}
+} = {}, options = {}) {
+  let signal = options.signal || new AbortController().signal;
+  let client = createApiClient({
+    baseUrl: apiUrl,
+    token: apiKey,
+    command: command || 'upload',
+    sdkUserAgent: userAgent,
+    allowNoToken: true
+  });
+  let batchSize = resolveBatchSize(options, uploadConfig);
+  let timeout = resolveTimeout(options, uploadConfig);
+  let deps = options.deps || {
+    client,
+    createBuild,
+    getDefaultBranch,
+    glob,
+    readFile,
+    stat,
+    checkShas,
+    createError: (message, code, context) => {
+      let error = new UploadError(message, context);
+      error.code = code;
+      return error;
+    },
+    createValidationError: (message, context) => new ValidationError(message, context),
+    createUploadError: (message, context) => new UploadError(message, context),
+    createTimeoutError: (message, context) => new TimeoutError(message, context),
+    output
+  };
+  async function uploadScreenshots(uploadOptions) {
+    return upload({
+      uploadOptions,
+      config: {
+        apiKey,
+        apiUrl
+      },
+      signal,
+      batchSize,
+      deps: {
+        ...deps,
+        client: deps.client || client
+      }
+    });
+  }
+  async function waitForUploadedBuild(buildId, waitTimeout = timeout) {
+    return waitForBuild({
+      buildId,
+      timeout: waitTimeout,
+      signal,
+      client: deps.client || client,
+      deps: {
+        createError: deps.createError,
+        createTimeoutError: deps.createTimeoutError
+      }
+    });
+  }
+  return {
+    upload: uploadScreenshots,
+    waitForBuild: waitForUploadedBuild
+  };
+}
 function delay(ms, signal) {
   if (ms <= 0) {
     return Promise.resolve();
@@ -33,10 +114,6 @@ function delay(ms, signal) {
   });
 }
 
-// ============================================================================
-// File Discovery
-// ============================================================================
-
 /**
  * Find all PNG screenshots in a directory
  * @param {Object} options - Options
@@ -58,10 +135,6 @@ export async function findScreenshots({
   });
 }
 
-// ============================================================================
-// File Processing
-// ============================================================================
-
 /**
  * Process files to extract metadata and compute hashes
  * @param {Object} options - Options
@@ -100,10 +173,6 @@ export async function processFiles({
   return results;
 }
 
-// ============================================================================
-// SHA Checking / Deduplication
-// ============================================================================
-
 /**
  * Check which files already exist on the server
  * @param {Object} options - Options
@@ -161,10 +230,6 @@ export async function checkExistingFiles({
   };
 }
 
-// ============================================================================
-// File Upload
-// ============================================================================
-
 /**
  * Upload files to Vizzly
  * @param {Object} options - Options
@@ -230,10 +295,6 @@ export async function uploadFiles({
   };
 }
 
-// ============================================================================
-// Build Waiting
-// ============================================================================
-
 /**
  * Wait for a build to complete
  * @param {Object} options - Options
@@ -299,10 +360,6 @@ export async function waitForBuild({
   });
 }
 
-// ============================================================================
-// Main Upload Operation
-// ============================================================================
-
 /**
  * Upload screenshots to Vizzly
  * @param {Object} options - Options

package/dist/domains/uploads/upload.validations.js

@@ -0,0 +1,77 @@
+/**
+ * Validate API key is present
+ * @param {string|undefined} apiKey - API key to validate
+ * @returns {{ valid: boolean, error: string|null }}
+ */
+export function validateApiKey(apiKey) {
+  if (!apiKey) {
+    return {
+      valid: false,
+      error: 'API key is required'
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}
+
+/**
+ * Validate screenshots directory path
+ * @param {string|undefined} screenshotsDir - Directory path
+ * @returns {{ valid: boolean, error: string|null }}
+ */
+export function validateScreenshotsDir(screenshotsDir) {
+  if (!screenshotsDir) {
+    return {
+      valid: false,
+      error: 'Screenshots directory is required'
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}
+
+/**
+ * Validate directory stats
+ * @param {Object} stats - fs.stat result
+ * @param {string} path - Directory path for error message
+ * @returns {{ valid: boolean, error: string|null }}
+ */
+export function validateDirectoryStats(stats, path) {
+  if (!stats.isDirectory()) {
+    return {
+      valid: false,
+      error: `${path} is not a directory`
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}
+
+/**
+ * Validate files were found
+ * @param {Array} files - Array of file paths
+ * @param {string} directory - Directory that was searched
+ * @returns {{ valid: boolean, error: string|null, context?: Object }}
+ */
+export function validateFilesFound(files, directory) {
+  if (!files || files.length === 0) {
+    return {
+      valid: false,
+      error: 'No screenshot files found',
+      context: {
+        directory,
+        pattern: '**/*.png'
+      }
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}

package/dist/index.js

@@ -9,18 +9,18 @@ import 'dotenv/config';
  */
 
 // Client exports for convenience
-export { configure, setEnabled, vizzlyScreenshot } from './client/index.js';
-// Errors
-export { AuthError, BuildError, ConfigError, NetworkError, ScreenshotError, TimeoutError, UploadError, ValidationError, VizzlyError } from './errors/vizzly-error.js';
-export { createPluginServices } from './plugin-api.js';
+export { configure, setEnabled, vizzlyScreenshot } from './adapters/client/index.js';
+export { createPluginServices } from './adapters/plugins/plugin-api.js';
+export { createServices } from './adapters/plugins/services.js';
 // Primary SDK export
-export { createVizzly, VizzlySDK } from './sdk/index.js';
-export { createServices } from './services/index.js';
-export { createTDDService } from './tdd/tdd-service.js';
-// Core services (for advanced usage)
-export { createUploader } from './uploader/index.js';
+export { createVizzly, VizzlySDK } from './adapters/sdk/index.js';
 // Configuration helper
-export { defineConfig } from './utils/config-helpers.js';
+export { defineConfig } from './domains/config/config.js';
 // Utilities
-export { loadConfig } from './utils/config-loader.js';
-export * as output from './utils/output.js';
+export { loadConfig } from './domains/config/config-loader.js';
+export { createTDDService } from './domains/tdd/tdd.service.js';
+// Core services (for advanced usage)
+export { createUploader } from './domains/uploads/upload.service.js';
+export * as output from './shared/output.js';
+// Errors
+export { AuthError, BuildError, ConfigError, NetworkError, ScreenshotError, TimeoutError, UploadError, ValidationError, VizzlyError } from './shared/vizzly-error.js';