@vizzly-testing/cli 0.15.1 → 0.16.1

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

@@ -1,110 +0,0 @@
-/**
- * Create a new Vizzly instance with custom configuration
- *
- * @param {import('../types').VizzlyConfig} [config] - Configuration options
- * @returns {Promise<VizzlySDK>} Configured Vizzly SDK instance
- *
- * @example
- * // Create with custom config
- * import { createVizzly } from '@vizzly-testing/cli/sdk';
- *
- * const vizzly = await createVizzly({
- *   apiKey: process.env.VIZZLY_TOKEN,
- *   apiUrl: 'https://app.vizzly.dev',
- *   server: {
- *     port: 3003,
- *     enabled: true
- *   }
- * });
- *
- * // Start the server
- * await vizzly.start();
- *
- * // Take screenshots
- * const screenshot = await getScreenshotSomehow();
- * await vizzly.screenshot('my-test', screenshot);
- *
- * // Upload results
- * const result = await vizzly.upload();
- * console.log(`Build URL: ${result.url}`);
- *
- * // Cleanup
- * await vizzly.stop();
- */
-export function createVizzly(config?: any, options?: {}): Promise<VizzlySDK>;
-/**
- * @typedef {Object} VizzlySDK
- * @property {Function} start - Start the Vizzly server
- * @property {Function} stop - Stop the Vizzly server
- * @property {Function} screenshot - Capture a screenshot
- * @property {Function} upload - Upload screenshots to Vizzly
- * @property {Function} compare - Run local comparison (TDD mode)
- * @property {Function} getConfig - Get current configuration
- * @property {Function} on - Subscribe to events
- * @property {Function} off - Unsubscribe from events
- */
-/**
- * VizzlySDK class implementation
- * @class
- * @extends {EventEmitter}
- */
-export class VizzlySDK {
-    /**
-     * @param {import('../types').VizzlyConfig} config - Configuration
-     * @param {Object} services - Service instances
-     */
-    constructor(config: any, services: any);
-    config: any;
-    services: any;
-    server: ScreenshotServer;
-    currentBuildId: any;
-    /**
-     * Stop the Vizzly server
-     * @returns {Promise<void>}
-     */
-    stop(): Promise<void>;
-    /**
-     * Get current configuration
-     * @returns {Object} Current config
-     */
-    getConfig(): any;
-    /**
-     * Start the Vizzly server
-     * @returns {Promise<{port: number, url: string}>} Server information
-     */
-    start(): Promise<{
-        port: number;
-        url: string;
-    }>;
-    /**
-     * Capture a screenshot
-     * @param {string} name - Screenshot name
-     * @param {Buffer|string} imageBuffer - Image data as a Buffer, or a file path to an image
-     * @param {import('../types').ScreenshotOptions} [options] - Options
-     * @returns {Promise<void>}
-     * @throws {VizzlyError} When server is not running
-     * @throws {VizzlyError} When file path is provided but file doesn't exist
-     * @throws {VizzlyError} When file cannot be read due to permissions or I/O errors
-     */
-    screenshot(name: string, imageBuffer: Buffer | string, options?: any): Promise<void>;
-    /**
-     * Upload all captured screenshots
-     * @param {import('../types').UploadOptions} [options] - Upload options
-     * @returns {Promise<import('../types').UploadResult>} Upload result
-     */
-    upload(options?: any): Promise<any>;
-    /**
-     * Run local comparison in TDD mode
-     * @param {string} name - Screenshot name
-     * @param {Buffer|string} imageBuffer - Current image as a Buffer, or a file path to an image
-     * @returns {Promise<import('../types').ComparisonResult>} Comparison result
-     * @throws {VizzlyError} When file path is provided but file doesn't exist
-     * @throws {VizzlyError} When file cannot be read due to permissions or I/O errors
-     */
-    compare(name: string, imageBuffer: Buffer | string): Promise<any>;
-}
-export { loadConfig } from "../utils/config-loader.js";
-export * as output from "../utils/output.js";
-export { createUploader } from "../services/uploader.js";
-export { createTDDService } from "../services/tdd-service.js";
-import { ScreenshotServer } from '../services/screenshot-server.js';

package/dist/types/server/handlers/api-handler.d.ts

@@ -1,88 +0,0 @@
-export function createApiHandler(apiService: any): {
-    handleScreenshot: (buildId: any, name: any, image: any, properties?: {}) => Promise<{
-        statusCode: number;
-        body: {
-            success: boolean;
-            disabled: boolean;
-            count: number;
-            message: string;
-            error?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            name?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            success?: undefined;
-            disabled?: undefined;
-            count?: undefined;
-            message?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            name?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            originalPath: any;
-            success?: undefined;
-            disabled?: undefined;
-            count?: undefined;
-            message?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            name?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            filePath: any;
-            success?: undefined;
-            disabled?: undefined;
-            count?: undefined;
-            message?: undefined;
-            originalPath?: undefined;
-            receivedType?: undefined;
-            name?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            receivedType: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-            success?: undefined;
-            disabled?: undefined;
-            count?: undefined;
-            message?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            name?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            success: boolean;
-            name: any;
-            count: number;
-            disabled?: undefined;
-            message?: undefined;
-            error?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-        };
-    }>;
-    getScreenshotCount: () => number;
-    flush: () => Promise<{
-        uploaded: number;
-        failed: number;
-        total: number;
-    }>;
-    cleanup: () => void;
-};

package/dist/types/server/handlers/tdd-handler.d.ts

@@ -1,162 +0,0 @@
-export function createTddHandler(config: any, workingDir: any, baselineBuild: any, baselineComparison: any, setBaseline?: boolean): {
-    initialize: () => Promise<void>;
-    handleScreenshot: (buildId: any, name: any, image: any, properties?: {}) => Promise<{
-        statusCode: number;
-        body: {
-            error: string;
-            details: any;
-            tddMode: boolean;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            comparison?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            originalPath: any;
-            tddMode: boolean;
-            details?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            comparison?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            filePath: any;
-            tddMode: boolean;
-            details?: undefined;
-            originalPath?: undefined;
-            receivedType?: undefined;
-            comparison?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            tddMode: boolean;
-            details?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            comparison?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            receivedType: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-            tddMode: boolean;
-            details?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            comparison?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            error: string;
-            details: string;
-            comparison: {
-                name: any;
-                status: string;
-                baseline: any;
-                current: any;
-                diff: any;
-                diffPercentage: any;
-                threshold: any;
-            };
-            tddMode: boolean;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            status?: undefined;
-            message?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            status: string;
-            message: string;
-            comparison: {
-                name: any;
-                status: string;
-                baseline: any;
-                current: any;
-                diff?: undefined;
-                diffPercentage?: undefined;
-                threshold?: undefined;
-            };
-            tddMode: boolean;
-            error?: undefined;
-            details?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            success?: undefined;
-        };
-    } | {
-        statusCode: number;
-        body: {
-            success: boolean;
-            comparison: {
-                name: any;
-                status: string;
-                baseline?: undefined;
-                current?: undefined;
-                diff?: undefined;
-                diffPercentage?: undefined;
-                threshold?: undefined;
-            };
-            tddMode: boolean;
-            error?: undefined;
-            details?: undefined;
-            originalPath?: undefined;
-            filePath?: undefined;
-            receivedType?: undefined;
-            status?: undefined;
-            message?: undefined;
-        };
-    }>;
-    getResults: () => Promise<{
-        total: number;
-        passed: number;
-        failed: number;
-        new: number;
-        errors: number;
-        comparisons: any[];
-        baseline: any;
-    }>;
-    acceptBaseline: (comparisonId: any) => Promise<any>;
-    acceptAllBaselines: () => Promise<{
-        count: number;
-    }>;
-    resetBaselines: () => Promise<{
-        success: boolean;
-        deletedBaselines: number;
-        deletedCurrents: number;
-        deletedDiffs: number;
-    }>;
-    cleanup: () => void;
-    tddService: TddService;
-};
-import { TddService } from '../../services/tdd-service.js';

package/dist/types/server/http-server.d.ts

@@ -1,6 +0,0 @@
-export function createHttpServer(port: any, screenshotHandler: any, services?: {}): {
-    start: () => Promise<any>;
-    stop: () => Promise<any>;
-    finishBuild: (_buildId: any) => Promise<any>;
-    getServer: () => any;
-};

package/dist/types/server/middleware/cors.d.ts

@@ -1,11 +0,0 @@
-/**
- * CORS Middleware
- * Handles cross-origin requests and preflight OPTIONS
- */
-/**
- * Apply CORS headers and handle OPTIONS preflight
- * @param {http.IncomingMessage} req
- * @param {http.ServerResponse} res
- * @returns {boolean} True if request was handled (OPTIONS), false to continue
- */
-export function corsMiddleware(req: http.IncomingMessage, res: http.ServerResponse): boolean;

package/dist/types/server/middleware/json-parser.d.ts

@@ -1,10 +0,0 @@
-/**
- * JSON Body Parser Middleware
- * Parses JSON request bodies for POST requests
- */
-/**
- * Parse JSON body from request
- * @param {http.IncomingMessage} req
- * @returns {Promise<Object|null>} Parsed JSON body or null for non-POST
- */
-export function parseJsonBody(req: http.IncomingMessage): Promise<any | null>;

package/dist/types/server/middleware/response.d.ts

@@ -1,50 +0,0 @@
-/**
- * Response Helpers
- * Standardized response utilities for consistent API responses
- */
-/**
- * Send JSON response
- * @param {http.ServerResponse} res
- * @param {number} statusCode
- * @param {Object} data
- */
-export function sendJson(res: http.ServerResponse, statusCode: number, data: any): void;
-/**
- * Send success response
- * @param {http.ServerResponse} res
- * @param {Object} data
- */
-export function sendSuccess(res: http.ServerResponse, data?: any): void;
-/**
- * Send error response
- * @param {http.ServerResponse} res
- * @param {number} statusCode
- * @param {string} message
- */
-export function sendError(res: http.ServerResponse, statusCode: number, message: string): void;
-/**
- * Send 404 Not Found
- * @param {http.ServerResponse} res
- * @param {string} message
- */
-export function sendNotFound(res: http.ServerResponse, message?: string): void;
-/**
- * Send 503 Service Unavailable
- * @param {http.ServerResponse} res
- * @param {string} serviceName
- */
-export function sendServiceUnavailable(res: http.ServerResponse, serviceName: string): void;
-/**
- * Send HTML response
- * @param {http.ServerResponse} res
- * @param {number} statusCode
- * @param {string} html
- */
-export function sendHtml(res: http.ServerResponse, statusCode: number, html: string): void;
-/**
- * Send file response with specified content type
- * @param {http.ServerResponse} res
- * @param {Buffer|string} content
- * @param {string} contentType
- */
-export function sendFile(res: http.ServerResponse, content: Buffer | string, contentType: string): void;

package/dist/types/server/routers/assets.d.ts

@@ -1,6 +0,0 @@
-/**
- * Create assets router
- * @param {Object} context - Router context
- * @returns {Function} Route handler
- */
-export function createAssetsRouter(): Function;

package/dist/types/server/routers/auth.d.ts

@@ -1,9 +0,0 @@
-/**
- * Create auth router
- * @param {Object} context - Router context
- * @param {Object} context.authService - Auth service
- * @returns {Function} Route handler
- */
-export function createAuthRouter({ authService }: {
-    authService: any;
-}): Function;

package/dist/types/server/routers/baseline.d.ts

@@ -1,13 +0,0 @@
-/**
- * Create baseline router
- * @param {Object} context - Router context
- * @param {Object} context.screenshotHandler - Screenshot handler
- * @param {Object} context.tddService - TDD service for baseline downloads
- * @param {Object} context.authService - Auth service for OAuth requests
- * @returns {Function} Route handler
- */
-export function createBaselineRouter({ screenshotHandler, tddService, authService, }: {
-    screenshotHandler: any;
-    tddService: any;
-    authService: any;
-}): Function;

package/dist/types/server/routers/cloud-proxy.d.ts

@@ -1,11 +0,0 @@
-/**
- * Create cloud proxy router
- * @param {Object} context - Router context
- * @param {Object} context.authService - Auth service for token management
- * @param {string} context.apiUrl - Base API URL (default: https://app.vizzly.dev)
- * @returns {Function} Route handler
- */
-export function createCloudProxyRouter({ authService, apiUrl: _apiUrl, }: {
-    authService: any;
-    apiUrl: string;
-}): Function;

package/dist/types/server/routers/config.d.ts

@@ -1,9 +0,0 @@
-/**
- * Create config router
- * @param {Object} context - Router context
- * @param {Object} context.configService - Config service
- * @returns {Function} Route handler
- */
-export function createConfigRouter({ configService }: {
-    configService: any;
-}): Function;

package/dist/types/server/routers/dashboard.d.ts

@@ -1,6 +0,0 @@
-/**
- * Create dashboard router
- * @param {Object} context - Router context
- * @returns {Function} Route handler
- */
-export function createDashboardRouter(): Function;

package/dist/types/server/routers/health.d.ts

@@ -1,11 +0,0 @@
-/**
- * Create health router
- * @param {Object} context - Router context
- * @param {number} context.port - Server port
- * @param {Object} context.screenshotHandler - Screenshot handler
- * @returns {Function} Route handler
- */
-export function createHealthRouter({ port, screenshotHandler }: {
-    port: number;
-    screenshotHandler: any;
-}): Function;

package/dist/types/server/routers/projects.d.ts

@@ -1,9 +0,0 @@
-/**
- * Create projects router
- * @param {Object} context - Router context
- * @param {Object} context.projectService - Project service
- * @returns {Function} Route handler
- */
-export function createProjectsRouter({ projectService }: {
-    projectService: any;
-}): Function;

package/dist/types/server/routers/screenshot.d.ts

@@ -1,11 +0,0 @@
-/**
- * Create screenshot router
- * @param {Object} context - Router context
- * @param {Object} context.screenshotHandler - Screenshot handler
- * @param {string|null} context.defaultBuildId - Default build ID
- * @returns {Function} Route handler
- */
-export function createScreenshotRouter({ screenshotHandler, defaultBuildId }: {
-    screenshotHandler: any;
-    defaultBuildId: string | null;
-}): Function;

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

@@ -1,100 +0,0 @@
-/**
- * ApiService class for direct API communication
- */
-export class ApiService {
-    constructor(options?: {});
-    baseUrl: any;
-    token: any;
-    uploadAll: any;
-    userAgent: string;
-    /**
-     * Make an API request
-     * @param {string} endpoint - API endpoint
-     * @param {Object} options - Fetch options
-     * @param {boolean} isRetry - Internal flag to prevent infinite retry loops
-     * @returns {Promise<Object>} Response data
-     */
-    request(endpoint: string, options?: any, isRetry?: boolean): Promise<any>;
-    /**
-     * Get build information
-     * @param {string} buildId - Build ID
-     * @param {string} include - Optional include parameter (e.g., 'screenshots')
-     * @returns {Promise<Object>} Build data
-     */
-    getBuild(buildId: string, include?: string): Promise<any>;
-    /**
-     * Get comparison information
-     * @param {string} comparisonId - Comparison ID
-     * @returns {Promise<Object>} Comparison data
-     */
-    getComparison(comparisonId: string): Promise<any>;
-    /**
-     * Search for comparisons by name across builds
-     * @param {string} name - Screenshot name to search for
-     * @param {Object} filters - Optional filters (branch, limit, offset)
-     * @param {string} [filters.branch] - Filter by branch name
-     * @param {number} [filters.limit=50] - Maximum number of results (default: 50)
-     * @param {number} [filters.offset=0] - Pagination offset (default: 0)
-     * @returns {Promise<Object>} Search results with comparisons and pagination
-     */
-    searchComparisons(name: string, filters?: {
-        branch?: string;
-        limit?: number;
-        offset?: number;
-    }): Promise<any>;
-    /**
-     * Get builds for a project
-     * @param {Object} filters - Filter options
-     * @returns {Promise<Array>} List of builds
-     */
-    getBuilds(filters?: any): Promise<any[]>;
-    /**
-     * Create a new build
-     * @param {Object} metadata - Build metadata
-     * @returns {Promise<Object>} Created build data
-     */
-    createBuild(metadata: any): Promise<any>;
-    /**
-     * Check if SHAs already exist on the server
-     * @param {string[]|Object[]} shas - Array of SHA256 hashes to check, or array of screenshot objects with metadata
-     * @param {string} buildId - Build ID for screenshot record creation
-     * @returns {Promise<Object>} Response with existing SHAs and screenshot data
-     */
-    checkShas(shas: string[] | any[], buildId: string): Promise<any>;
-    /**
-     * Upload a screenshot with SHA checking
-     * @param {string} buildId - Build ID
-     * @param {string} name - Screenshot name
-     * @param {Buffer} buffer - Screenshot data
-     * @param {Object} metadata - Additional metadata
-     * @returns {Promise<Object>} Upload result
-     */
-    uploadScreenshot(buildId: string, name: string, buffer: Buffer, metadata?: any): Promise<any>;
-    /**
-     * Update build status
-     * @param {string} buildId - Build ID
-     * @param {string} status - Build status (pending|running|completed|failed)
-     * @param {number} executionTimeMs - Execution time in milliseconds
-     * @returns {Promise<Object>} Updated build data
-     */
-    updateBuildStatus(buildId: string, status: string, executionTimeMs?: number): Promise<any>;
-    /**
-     * Finalize a build (convenience method)
-     * @param {string} buildId - Build ID
-     * @param {boolean} success - Whether the build succeeded
-     * @param {number} executionTimeMs - Execution time in milliseconds
-     * @returns {Promise<Object>} Finalized build data
-     */
-    finalizeBuild(buildId: string, success?: boolean, executionTimeMs?: number): Promise<any>;
-    /**
-     * Get token context (organization and project info)
-     * @returns {Promise<Object>} Token context data
-     */
-    getTokenContext(): Promise<any>;
-    /**
-     * Finalize a parallel build
-     * @param {string} parallelId - Parallel ID to finalize
-     * @returns {Promise<Object>} Finalization result
-     */
-    finalizeParallelBuild(parallelId: string): Promise<any>;
-}