@vizzly-testing/cli 0.3.2 → 0.5.0

package/dist/services/service-utils.js

@@ -1,171 +0,0 @@
-/**
- * Service Utilities
- *
- * Provides utilities for service composition using higher-order functions
- * and event-based architecture patterns.
- */
-
-import { EventEmitter } from 'events';
-
-/**
- * Create an event emitter with enhanced functionality
- * @returns {EventEmitter} Enhanced event emitter
- */
-export function createEventEmitter() {
-  const emitter = new EventEmitter();
-
-  // Add helper methods
-  emitter.emitProgress = (stage, message, data = {}) => {
-    const progressData = {
-      stage,
-      message,
-      timestamp: new Date().toISOString(),
-      ...data
-    };
-    emitter.emit('progress', progressData);
-  };
-  emitter.emitError = (error, context = {}) => {
-    emitter.emit('error', {
-      error: error.message,
-      stack: error.stack,
-      context,
-      timestamp: new Date().toISOString()
-    });
-  };
-  return emitter;
-}
-
-/**
- * Create a cleanup manager
- * @returns {Object} Cleanup manager with add/execute methods
- */
-export function createCleanupManager() {
-  const cleanupFunctions = [];
-  return {
-    add: fn => cleanupFunctions.push(fn),
-    execute: async () => {
-      for (const fn of cleanupFunctions) {
-        try {
-          await fn();
-        } catch (error) {
-          console.error('Cleanup error:', error);
-        }
-      }
-      cleanupFunctions.length = 0;
-    }
-  };
-}
-
-/**
- * Create signal handlers for graceful shutdown
- * @param {Function} onSignal - Function to call on signal
- * @returns {Function} Cleanup function to remove handlers
- */
-export function createSignalHandlers(onSignal) {
-  const handleSignal = async signal => {
-    await onSignal(signal);
-    process.exit(signal === 'SIGINT' ? 130 : 1);
-  };
-  process.once('SIGINT', () => handleSignal('SIGINT'));
-  process.once('SIGTERM', () => handleSignal('SIGTERM'));
-  return () => {
-    process.removeAllListeners('SIGINT');
-    process.removeAllListeners('SIGTERM');
-  };
-}
-
-/**
- * Higher-order function to add error handling to any function
- * @param {Function} fn - Function to wrap
- * @param {Object} options - Error handling options
- * @returns {Function} Wrapped function with error handling
- */
-export function withErrorHandling(fn, options = {}) {
-  return async (...args) => {
-    try {
-      return await fn(...args);
-    } catch (error) {
-      if (options.onError) {
-        options.onError(error);
-      }
-      if (options.rethrow !== false) {
-        throw error;
-      }
-      return options.defaultReturn;
-    }
-  };
-}
-
-/**
- * Higher-order function to add logging to any function
- * @param {Function} fn - Function to wrap
- * @param {Object} logger - Logger instance
- * @param {string} operation - Operation name for logging
- * @returns {Function} Wrapped function with logging
- */
-export function withLogging(fn, logger, operation) {
-  return async (...args) => {
-    logger.debug(`Starting ${operation}`);
-    const start = Date.now();
-    try {
-      const result = await fn(...args);
-      const duration = Date.now() - start;
-      logger.debug(`Completed ${operation} in ${duration}ms`);
-      return result;
-    } catch (error) {
-      const duration = Date.now() - start;
-      logger.error(`Failed ${operation} after ${duration}ms:`, error.message);
-      throw error;
-    }
-  };
-}
-
-/**
- * Compose multiple functions together
- * @param {...Function} fns - Functions to compose
- * @returns {Function} Composed function
- */
-export function compose(...fns) {
-  return value => fns.reduceRight((acc, fn) => fn(acc), value);
-}
-
-/**
- * Create a service context with shared functionality
- * @param {Object} config - Service configuration
- * @param {Object} options - Service options
- * @returns {Object} Service context
- */
-export function createServiceContext(config, options = {}) {
-  const emitter = createEventEmitter(options);
-  const cleanup = createCleanupManager();
-  let isRunning = false;
-  const context = {
-    config,
-    emitter,
-    cleanup,
-    get isRunning() {
-      return isRunning;
-    },
-    set isRunning(value) {
-      isRunning = value;
-    },
-    // Convenience methods
-    emitProgress: emitter.emitProgress,
-    emitError: emitter.emitError,
-    emit: emitter.emit.bind(emitter),
-    on: emitter.on.bind(emitter),
-    off: emitter.off.bind(emitter),
-    once: emitter.once.bind(emitter),
-    // Signal handling
-    setupSignalHandlers: () => {
-      const removeHandlers = createSignalHandlers(async signal => {
-        if (isRunning) {
-          emitter.emitProgress('cleanup', `Received ${signal}, cleaning up...`);
-          await cleanup.execute();
-        }
-      });
-      cleanup.add(removeHandlers);
-    }
-  };
-  return context;
-}

package/dist/types/index.js

@@ -1,153 +0,0 @@
-/**
- * @fileoverview Vizzly CLI type definitions
- * Comprehensive JSDoc type definitions for IDE support
- */
-
-/**
- * @typedef {Object} VizzlyConfig
- * @property {string} [apiKey] - API key for authentication
- * @property {string} [apiUrl='https://vizzly.dev'] - API base URL
- * @property {ServerConfig} [server] - Server configuration
- * @property {BuildConfig} [build] - Build configuration
- * @property {UploadConfig} [upload] - Upload configuration
- * @property {ComparisonConfig} [comparison] - Comparison configuration
- */
-
-/**
- * @typedef {Object} ServerConfig
- * @property {number} [port=3001] - Server port
- * @property {string} [host='localhost'] - Server host
- * @property {boolean} [https=false] - Use HTTPS
- * @property {string} [certPath] - Path to SSL certificate
- * @property {string} [keyPath] - Path to SSL key
- * @property {string} [screenshotPath='/screenshot'] - Screenshot POST endpoint path
- */
-
-/**
- * @typedef {Object} BuildConfig
- * @property {string} [name] - Build name
- * @property {string} [branch] - Git branch
- * @property {string} [commit] - Git commit SHA
- * @property {string} [message] - Commit message
- * @property {string} [environment='production'] - Environment name
- * @property {Object.<string, any>} [metadata] - Additional metadata
- */
-
-/**
- * @typedef {Object} UploadConfig
- * @property {string} [screenshotsDir='screenshots'] - Directory containing screenshots
- * @property {number} [batchSize=50] - Upload batch size
- * @property {number} [timeout=300000] - Upload timeout in ms
- * @property {number} [retries=3] - Number of retries
- * @property {boolean} [deduplication=true] - Enable deduplication
- */
-
-/**
- * @typedef {Object} ComparisonConfig
- * @property {number} [threshold=0.1] - Default comparison threshold (0-1)
- * @property {boolean} [ignoreAntialiasing=true] - Ignore antialiasing differences
- * @property {boolean} [ignoreColors=false] - Ignore color differences
- * @property {string} [diffColor='#ff0000'] - Color for diff highlighting
- */
-
-/**
- * @typedef {Object} Screenshot
- * @property {string} name - Screenshot name
- * @property {Buffer} image - Image buffer data
- * @property {Object.<string, any>} [properties] - Additional properties
- * @property {number} [threshold] - Comparison threshold override
- * @property {string} [group] - Screenshot group/category
- * @property {string[]} [tags] - Screenshot tags
- */
-
-/**
- * @typedef {Object} UploadOptions
- * @property {string} screenshotsDir - Directory containing screenshots
- * @property {string} [buildName] - Name for this build
- * @property {string} [branch] - Git branch name
- * @property {string} [commit] - Git commit SHA
- * @property {string} [message] - Commit message
- * @property {string} [environment='production'] - Environment name
- * @property {number} [threshold] - Default comparison threshold
- * @property {ProgressCallback} [onProgress] - Progress callback
- */
-
-/**
- * @typedef {Object} UploadResult
- * @property {boolean} success - Whether upload succeeded
- * @property {string} [buildId] - Build ID if successful
- * @property {string} [url] - Build URL if available
- * @property {UploadStats} stats - Upload statistics
- * @property {string} [error] - Error message if failed
- */
-
-/**
- * @typedef {Object} UploadStats
- * @property {number} total - Total files found
- * @property {number} uploaded - Files uploaded
- * @property {number} skipped - Files skipped (duplicates)
- * @property {number} failed - Files failed to upload
- */
-
-/**
- * @typedef {Object} ProgressEvent
- * @property {'scanning'|'processing'|'deduplication'|'uploading'|'completed'|'error'} phase - Current phase
- * @property {number} [current] - Current item being processed
- * @property {number} [total] - Total items to process
- * @property {string} [message] - Progress message
- * @property {number} [toUpload] - Files to upload (deduplication phase)
- * @property {number} [existing] - Existing files (deduplication phase)
- * @property {string} [buildId] - Build ID (completed phase)
- * @property {string} [url] - Build URL (completed phase)
- */
-
-/**
- * @callback ProgressCallback
- * @param {ProgressEvent} event - Progress event
- * @returns {void}
- */
-
-/**
- * @typedef {Object} TDDOptions
- * @property {string} [baselineDir='baseline'] - Baseline screenshots directory
- * @property {string} [currentDir='screenshots'] - Current screenshots directory
- * @property {string} [diffDir='diffs'] - Diff output directory
- * @property {number} [threshold=0.1] - Comparison threshold
- * @property {boolean} [failOnDifference=true] - Fail on any difference
- * @property {boolean} [updateBaseline=false] - Update baseline on difference
- */
-
-/**
- * @typedef {Object} ComparisonResult
- * @property {string} name - Screenshot name
- * @property {boolean} passed - Whether comparison passed
- * @property {number} [difference] - Difference percentage (0-1)
- * @property {string} [diffPath] - Path to diff image
- * @property {string} [error] - Error message if comparison failed
- */
-
-/**
- * @typedef {Object} BuildInfo
- * @property {string} id - Build ID
- * @property {string} name - Build name
- * @property {'pending'|'processing'|'completed'|'failed'} status - Build status
- * @property {string} branch - Git branch
- * @property {string} [commit] - Git commit SHA
- * @property {string} environment - Environment name
- * @property {Date} createdAt - Creation timestamp
- * @property {Date} [completedAt] - Completion timestamp
- * @property {number} screenshotCount - Number of screenshots
- * @property {Object.<string, any>} [metadata] - Additional metadata
- */
-
-/**
- * @typedef {Object} CLIOptions
- * @property {boolean} [verbose=false] - Enable verbose logging
- * @property {string} [logLevel='info'] - Log level
- * @property {boolean} [quiet=false] - Suppress all output
- * @property {boolean} [json=false] - Output JSON instead of text
- * @property {string} [config] - Path to config file
- */
-
-// Export types for use in other files
-export default {};

package/dist/types/screenshot-wrapper.d.ts

@@ -1,27 +0,0 @@
-/**
- * Create a factory that pre-configures Vizzly instances
- *
- * @param {Object} config - Shared configuration
- * @param {Object} [config.defaultProperties] - Default metadata for all screenshots
- * @param {number} [config.defaultThreshold] - Default comparison threshold
- *
- * @example
- * // test-setup.js - Configure once
- * export const createVizzly = vizzlyFactory({
- *   defaultProperties: {
- *     framework: 'playwright',
- *     project: 'web-app'
- *   }
- * });
- *
- * // my-test.spec.js - Use everywhere
- * const vizzly = createVizzly();
- *
- * const screenshot = await page.screenshot({ fullPage: true }); // Your method
- * await vizzly.screenshot({
- *   name: 'homepage',
- *   image: screenshot, // Your buffer
- *   properties: { browser: 'chrome' } // Merges with defaults
- * });
- */
-export function vizzlyFactory(globalConfig: any): (overrideConfig?: {}) => any;

package/dist/types/server/index.d.ts

@@ -1,38 +0,0 @@
-export class VizzlyServer {
-    constructor({ port, config, tddMode, baselineBuild, baselineComparison, workingDir, buildId, vizzlyApi, buildInfo, emitter, }: {
-        port: any;
-        config: any;
-        tddMode?: boolean;
-        baselineBuild: any;
-        baselineComparison: any;
-        workingDir: any;
-        buildId?: any;
-        vizzlyApi?: any;
-        buildInfo?: any;
-        emitter?: any;
-    });
-    port: any;
-    config: any;
-    builds: Map<any, any>;
-    server: import("http").Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
-    tddMode: boolean;
-    baselineBuild: any;
-    baselineComparison: any;
-    tddService: TddService;
-    buildId: any;
-    vizzlyApi: any;
-    buildInfo: any;
-    emitter: any;
-    vizzlyDisabled: boolean;
-    start(): Promise<any>;
-    handleRequest(req: any, res: any): Promise<void>;
-    handleScreenshot(req: any, res: any): Promise<void>;
-    parseRequestBody(req: any): Promise<any>;
-    stop(): Promise<any>;
-    createBuild(options: any): Promise<`${string}-${string}-${string}-${string}-${string}`>;
-    getScreenshotCount(buildId: any): any;
-    getTotalScreenshotCount(): number;
-    finishBuild(buildId: any): Promise<any>;
-    cleanupBuild(buildId: any): Promise<void>;
-}
-import { TddService } from '../services/tdd-service.js';

package/dist/types/services/service-utils.d.ts

@@ -1,45 +0,0 @@
-/**
- * Create an event emitter with enhanced functionality
- * @returns {EventEmitter} Enhanced event emitter
- */
-export function createEventEmitter(): EventEmitter;
-/**
- * Create a cleanup manager
- * @returns {Object} Cleanup manager with add/execute methods
- */
-export function createCleanupManager(): any;
-/**
- * Create signal handlers for graceful shutdown
- * @param {Function} onSignal - Function to call on signal
- * @returns {Function} Cleanup function to remove handlers
- */
-export function createSignalHandlers(onSignal: Function): Function;
-/**
- * Higher-order function to add error handling to any function
- * @param {Function} fn - Function to wrap
- * @param {Object} options - Error handling options
- * @returns {Function} Wrapped function with error handling
- */
-export function withErrorHandling(fn: Function, options?: any): Function;
-/**
- * Higher-order function to add logging to any function
- * @param {Function} fn - Function to wrap
- * @param {Object} logger - Logger instance
- * @param {string} operation - Operation name for logging
- * @returns {Function} Wrapped function with logging
- */
-export function withLogging(fn: Function, logger: any, operation: string): Function;
-/**
- * Compose multiple functions together
- * @param {...Function} fns - Functions to compose
- * @returns {Function} Composed function
- */
-export function compose(...fns: Function[]): Function;
-/**
- * Create a service context with shared functionality
- * @param {Object} config - Service configuration
- * @param {Object} options - Service options
- * @returns {Object} Service context
- */
-export function createServiceContext(config: any, options?: any): any;
-import { EventEmitter } from 'events';