@vizzly-testing/cli 0.39.1 → 0.39.2

package/dist/types/sdk.d.ts

@@ -1,186 +0,0 @@
-/**
- * Vizzly SDK Type Definitions
- * Full SDK for custom integrations
- * @module @vizzly-testing/cli/sdk
- */
-
-import { EventEmitter } from 'node:events';
-
-// Re-export common types
-export {
-  BaselineData,
-  ComparisonResult,
-  OutputUtils,
-  ScreenshotOptions,
-  TddResults,
-  TddService,
-  Uploader,
-  UploadOptions,
-  UploadResult,
-  VizzlyConfig,
-} from './index';
-
-/**
- * VizzlySDK class - Full SDK for custom integrations
- *
- * @example
- * import { createVizzly } from '@vizzly-testing/cli/sdk';
- *
- * const vizzly = await createVizzly({
- *   apiKey: process.env.VIZZLY_TOKEN,
- *   server: { port: 3003 }
- * });
- *
- * await vizzly.start();
- * await vizzly.screenshot('test', buffer);
- * await vizzly.upload();
- * await vizzly.stop();
- */
-export class VizzlySDK extends EventEmitter {
-  config: import('./index').VizzlyConfig;
-
-  constructor(config: import('./index').VizzlyConfig, services: unknown);
-
-  /**
-   * Reload file config and re-apply current in-memory overrides.
-   */
-  init(): Promise<import('./index').VizzlyConfig>;
-
-  /**
-   * Merge new config values into the active SDK config.
-   */
-  updateConfig(
-    newConfig: Partial<import('./index').VizzlyConfig>
-  ): import('./index').VizzlyConfig;
-
-  /**
-   * Start the Vizzly server
-   * @returns Server information including port and URL
-   */
-  start(): Promise<{ port: number; url: string }>;
-
-  /**
-   * Stop the Vizzly server
-   */
-  stop(): Promise<void>;
-
-  /**
-   * Get current configuration
-   */
-  getConfig(): import('./index').VizzlyConfig;
-
-  /**
-   * Capture a screenshot
-   * @param name - Screenshot name
-   * @param imageBuffer - Image data as a Buffer, or a file path to an image
-   * @param options - Screenshot options
-   * @throws VizzlyError when server is not running
-   * @throws VizzlyError when file path is provided but file doesn't exist
-   */
-  screenshot(
-    name: string,
-    imageBuffer: Buffer | string,
-    options?: import('./index').ScreenshotOptions
-  ): Promise<void>;
-
-  /**
-   * Upload all captured screenshots
-   * @param options - Upload options
-   * @returns Upload result with build URL and stats
-   */
-  upload(
-    options?: import('./index').UploadOptions
-  ): Promise<import('./index').UploadResult>;
-
-  /**
-   * Run local comparison in TDD mode
-   * @param name - Screenshot name
-   * @param imageBuffer - Current image as a Buffer, or a file path to an image
-   * @returns Comparison result
-   */
-  compare(
-    name: string,
-    imageBuffer: Buffer | string
-  ): Promise<import('./index').ComparisonResult>;
-
-  /**
-   * Create an uploader using the SDK config.
-   */
-  createUploader(options?: {
-    upload?: import('./index').UploadConfig;
-    signal?: AbortSignal;
-    batchSize?: number;
-    timeout?: number;
-  }): import('./index').Uploader;
-
-  /**
-   * Create a local TDD service using the SDK config.
-   */
-  createTDDService(options?: {
-    workingDir?: string;
-    setBaseline?: boolean;
-    authService?: unknown;
-  }): import('./index').TddService;
-
-  /**
-   * Start a local TDD service.
-   */
-  startTDD(options?: {
-    workingDir?: string;
-    setBaseline?: boolean;
-    authService?: unknown;
-  }): Promise<unknown>;
-}
-
-/**
- * Create a new Vizzly SDK instance
- *
- * @param config - Configuration options
- * @param options - Additional options
- * @returns Configured Vizzly SDK instance
- *
- * @example
- * const vizzly = await createVizzly({
- *   apiKey: process.env.VIZZLY_TOKEN,
- *   apiUrl: 'https://app.vizzly.dev',
- *   server: { port: 3003 }
- * });
- */
-export function createVizzly(
-  config?: import('./index').VizzlyConfig,
-  options?: { verbose?: boolean }
-): Promise<VizzlySDK>;
-
-/** Load configuration from file and environment */
-export function loadConfig(options?: {
-  cwd?: string;
-}): Promise<import('./index').VizzlyConfig>;
-
-/** Output utilities */
-export const output: import('./index').OutputUtils;
-
-/** Create an uploader instance */
-export function createUploader(
-  config?: {
-    apiKey?: string;
-    apiUrl?: string;
-    userAgent?: string;
-    command?: string;
-    upload?: import('./index').UploadConfig;
-  },
-  options?: {
-    signal?: AbortSignal;
-    batchSize?: number;
-    timeout?: number;
-  }
-): import('./index').Uploader;
-
-/** Create a TDD service instance */
-export function createTDDService(
-  config: import('./index').VizzlyConfig,
-  options?: {
-    workingDir?: string;
-    setBaseline?: boolean;
-    authService?: unknown;
-  }
-): import('./index').TddService;

package/dist/uploader/core.js

@@ -1,432 +0,0 @@
-/**
- * Uploader Core - Pure functions for upload logic
- *
- * No I/O, no side effects - just data transformations.
- */
-
-import crypto from 'node:crypto';
-import { basename } from 'node:path';
-
-// ============================================================================
-// Constants
-// ============================================================================
-
-export const DEFAULT_BATCH_SIZE = 50;
-export const DEFAULT_SHA_CHECK_BATCH_SIZE = 100;
-export const DEFAULT_TIMEOUT = 30000; // 30 seconds
-export const DEFAULT_BUILD_POLL_INTERVAL = 1000; // 1 second
-
-// ============================================================================
-// Validation
-// ============================================================================
-
-/**
- * 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
-  };
-}
-
-// ============================================================================
-// Browser Extraction
-// ============================================================================
-
-const 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 Info Construction
-// ============================================================================
-
-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;
-}
-
-// ============================================================================
-// File Metadata Processing
-// ============================================================================
-
-/**
- * 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');
-}
-
-/**
- * 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
-    } : {}
-  };
-}
-
-/**
- * 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))
-  };
-}
-
-// ============================================================================
-// Progress Reporting
-// ============================================================================
-
-/**
- * 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
-  };
-}
-
-// ============================================================================
-// Result Building
-// ============================================================================
-
-/**
- * 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;
-}
-
-// ============================================================================
-// Configuration
-// ============================================================================
-
-/**
- * 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);
-}
-
-/**
- * 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;
-}
-
-/**
- * Build glob pattern for screenshots
- * @param {string} directory - Base directory
- * @returns {string} Glob pattern
- */
-export function buildScreenshotPattern(directory) {
-  return `${directory}/**/*.png`;
-}
-
-/**
- * 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/uploader/index.js

@@ -1,88 +0,0 @@
-/**
- * Uploader Module
- *
- * Exports pure functions (core), I/O operations, and the public uploader
- * factory for screenshot uploading.
- */
-
-import { readFile, stat } from 'node:fs/promises';
-import { glob } from 'glob';
-import { checkShas, createApiClient, createBuild } from '../api/index.js';
-import { TimeoutError, UploadError, ValidationError } from '../errors/vizzly-error.js';
-import { getDefaultBranch } from '../utils/git.js';
-import * as output from '../utils/output.js';
-import { resolveBatchSize, resolveTimeout } from './core.js';
-import { upload as uploadOperation, waitForBuild as waitForBuildOperation } from './operations.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 upload(uploadOptions) {
-    return uploadOperation({
-      uploadOptions,
-      config: {
-        apiKey,
-        apiUrl
-      },
-      signal,
-      batchSize,
-      deps: {
-        ...deps,
-        client: deps.client || client
-      }
-    });
-  }
-  async function waitForBuild(buildId, waitTimeout = timeout) {
-    return waitForBuildOperation({
-      buildId,
-      timeout: waitTimeout,
-      signal,
-      client: deps.client || client,
-      deps: {
-        createError: deps.createError,
-        createTimeoutError: deps.createTimeoutError
-      }
-    });
-  }
-  return {
-    upload,
-    waitForBuild
-  };
-}
-
-// Core - pure functions
-export { buildBuildInfo, buildCompletedProgress, buildDeduplicationProgress, buildFileMetadata, buildProcessingProgress, buildScanningProgress, buildScreenshotPattern, buildUploadingProgress, buildUploadResult, buildWaitResult, computeSha256, DEFAULT_BATCH_SIZE, DEFAULT_BUILD_POLL_INTERVAL, DEFAULT_SHA_CHECK_BATCH_SIZE, DEFAULT_TIMEOUT, extractBrowserFromFilename, extractStatusCodeFromError, fileToScreenshotFormat, getElapsedTime, isTimedOut, partitionFilesByExistence, resolveBatchSize, resolveTimeout, validateApiKey, validateDirectoryStats, validateFilesFound, validateScreenshotsDir } from './core.js';
-
-// Operations - I/O with dependency injection
-export { checkExistingFiles, findScreenshots, processFiles, upload, uploadFiles, waitForBuild } from './operations.js';