@vizzly-testing/cli 0.3.1 → 0.4.0

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';

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

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

package/dist/types/utils/diagnostics.d.ts

@@ -1,69 +0,0 @@
-/**
- * Check if required dependencies are available
- */
-export function checkDependencies(): Promise<{
-    all_ok: boolean;
-    details: {
-        node: {
-            available: boolean;
-            version: string;
-            supported: boolean;
-            message: string;
-            error?: undefined;
-        } | {
-            available: boolean;
-            error: any;
-            version?: undefined;
-            supported?: undefined;
-            message?: undefined;
-        };
-        npm: any;
-        git: any;
-        odiff: {
-            available: boolean;
-            path: any;
-            message: string;
-            error?: undefined;
-        } | {
-            available: boolean;
-            error: any;
-            message: string;
-            path?: undefined;
-        };
-    };
-}>;
-/**
- * Check API connectivity
- */
-export function checkApiConnectivity(config: any): Promise<{
-    url: any;
-    has_token: boolean;
-    reachable: boolean;
-    authenticated: boolean;
-} | {
-    error: any;
-    reachable: boolean;
-    authenticated: boolean;
-}>;
-/**
- * Check terminal capabilities
- */
-export function checkTerminalCapabilities(): {
-    stdout_is_tty: boolean;
-    stdin_is_tty: boolean;
-    supports_color: boolean;
-    terminal_type: string;
-    columns: number;
-    rows: number;
-};
-/**
- * Get system information
- */
-export function getSystemInfo(): {
-    platform: NodeJS.Platform;
-    arch: NodeJS.Architecture;
-    node_version: string;
-    memory_usage: NodeJS.MemoryUsage;
-    uptime: number;
-    working_directory: string;
-};