@vizzly-testing/cli 0.16.0 → 0.16.2

package/dist/types/sdk.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Vizzly SDK Type Definitions
+ * Full SDK for custom integrations
+ * @module @vizzly-testing/cli/sdk
+ */
+
+import { EventEmitter } from 'events';
+
+// Re-export common types
+export {
+  VizzlyConfig,
+  ScreenshotOptions,
+  UploadOptions,
+  UploadResult,
+  ComparisonResult,
+  TddResults,
+  BaselineData,
+  Uploader,
+  TddService,
+  OutputUtils,
+} 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);
+
+  /**
+   * 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 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/utils/config-helpers.js

@@ -1,7 +1,7 @@
 /**
  * Define Vizzly configuration with type hints
- * @param {import('../types/index.js').VizzlyConfig} config
- * @returns {import('../types/index.js').VizzlyConfig}
+ * @param {Object} config - Vizzly configuration object
+ * @returns {Object} The same configuration object (passthrough for type hints)
  */
 export function defineConfig(config) {
   return config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly-testing/cli",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "Visual review platform for UI developers and designers",
   "keywords": [
     "visual-testing",
@@ -16,25 +16,29 @@
   "bugs": "https://github.com/vizzly-testing/cli/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/vizzly-testing/cli.git"
+    "url": "git+https://github.com/vizzly-testing/cli.git"
   },
   "license": "MIT",
   "author": "Stubborn Mule Software <support@vizzly.dev>",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.js"
     },
     "./client": {
+      "types": "./dist/types/client.d.ts",
       "import": "./dist/client/index.js",
       "require": "./dist/client/index.js"
     },
     "./sdk": {
+      "types": "./dist/types/sdk.d.ts",
       "import": "./dist/sdk/index.js",
       "require": "./dist/sdk/index.js"
     },
     "./config": {
+      "types": "./dist/types/config.d.ts",
       "import": "./dist/utils/config-helpers.js",
       "require": "./dist/utils/config-helpers.js"
     }
@@ -42,7 +46,7 @@
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",
   "bin": {
-    "vizzly": "./bin/vizzly.js"
+    "vizzly": "bin/vizzly.js"
   },
   "files": [
     "bin",
@@ -54,14 +58,15 @@
   ],
   "scripts": {
     "start": "node src/index.js",
-    "build": "npm run clean && npm run compile && npm run copy-assets && npm run build:reporter && npm run types",
+    "build": "npm run clean && npm run compile && npm run copy-assets && npm run build:reporter && npm run copy-types",
     "clean": "rimraf dist",
     "compile": "babel src --out-dir dist --ignore '**/*.test.js'",
     "copy-assets": "cp src/services/report-generator/report.css dist/services/report-generator/",
+    "copy-types": "mkdir -p dist/types && cp src/types/*.d.ts dist/types/",
     "build:reporter": "cd src/reporter && vite build",
     "dev:reporter": "cd src/reporter && vite --config vite.dev.config.js",
-    "types": "tsc --emitDeclarationOnly --outDir dist/types",
-    "prepublishOnly": "npm test && npm run build",
+    "test:types": "tsd",
+    "prepublishOnly": "npm run build",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:reporter": "playwright test --config=tests/reporter/playwright.config.js",
@@ -79,7 +84,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@vizzly-testing/honeydiff": "^0.3.1",
+    "@vizzly-testing/honeydiff": "^0.4.3",
     "commander": "^14.0.0",
     "cosmiconfig": "^9.0.0",
     "dotenv": "^17.2.1",
@@ -87,6 +92,16 @@
     "glob": "^13.0.0",
     "zod": "^4.1.12"
   },
+  "tsd": {
+    "directory": "test-d",
+    "typingsFile": "src/types/index.d.ts",
+    "compilerOptions": {
+      "esModuleInterop": true,
+      "module": "ESNext",
+      "moduleResolution": "node",
+      "strict": true
+    }
+  },
   "devDependencies": {
     "@babel/cli": "^7.28.0",
     "@babel/core": "^7.23.6",
@@ -99,6 +114,7 @@
     "@playwright/test": "^1.55.1",
     "@tailwindcss/postcss": "^4.1.13",
     "@tanstack/react-query": "^5.90.11",
+    "@types/node": "^24.10.1",
     "@vitejs/plugin-react": "^5.0.3",
     "@vitest/coverage-v8": "^4.0.3",
     "autoprefixer": "^10.4.21",
@@ -114,6 +130,7 @@
     "react-dom": "^19.1.1",
     "rimraf": "^6.0.1",
     "tailwindcss": "^4.1.13",
+    "tsd": "^0.33.0",
     "typescript": "^5.0.4",
     "vite": "^7.1.7",
     "vitest": "^4.0.3",

package/dist/types/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

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

@@ -1,80 +0,0 @@
-/**
- * Take a screenshot for visual regression testing
- *
- * @param {string} name - Unique name for the screenshot
- * @param {Buffer|string} imageBuffer - PNG image data as a Buffer, or a file path to an image
- * @param {Object} [options] - Optional configuration
- * @param {Record<string, any>} [options.properties] - Additional properties to attach to the screenshot
- * @param {number} [options.threshold=0] - Pixel difference threshold (0-100)
- * @param {boolean} [options.fullPage=false] - Whether this is a full page screenshot
- *
- * @returns {Promise<void>}
- *
- * @example
- * // Basic usage with Buffer
- * import { vizzlyScreenshot } from '@vizzly-testing/cli/client';
- *
- * const screenshot = await page.screenshot();
- * await vizzlyScreenshot('homepage', screenshot);
- *
- * @example
- * // Basic usage with file path
- * await vizzlyScreenshot('homepage', './screenshots/homepage.png');
- *
- * @example
- * // With properties and threshold
- * await vizzlyScreenshot('checkout-form', screenshot, {
- *   properties: {
- *     browser: 'chrome',
- *     viewport: '1920x1080'
- *   },
- *   threshold: 5
- * });
- *
- * @throws {VizzlyError} When screenshot capture fails or client is not initialized
- * @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
- */
-export function vizzlyScreenshot(name: string, imageBuffer: Buffer | string, options?: {
-    properties?: Record<string, any>;
-    threshold?: number;
-    fullPage?: boolean;
-}): Promise<void>;
-/**
- * Wait for all queued screenshots to be processed
- *
- * @returns {Promise<void>}
- *
- * @example
- * afterAll(async () => {
- *   await vizzlyFlush();
- * });
- */
-export function vizzlyFlush(): Promise<void>;
-/**
- * Check if the Vizzly client is initialized and ready
- *
- * @returns {boolean} True if client is ready, false otherwise
- */
-export function isVizzlyReady(): boolean;
-/**
- * Configure the client with custom settings
- *
- * @param {Object} config - Configuration options
- * @param {string} [config.serverUrl] - Server URL override
- * @param {boolean} [config.enabled] - Enable/disable screenshots
- */
-export function configure(config?: {
-    serverUrl?: string;
-    enabled?: boolean;
-}): void;
-/**
- * Enable or disable screenshot capture
- * @param {boolean} enabled - Whether to enable screenshots
- */
-export function setEnabled(enabled: boolean): void;
-/**
- * Get information about Vizzly client state
- * @returns {Object} Client information
- */
-export function getVizzlyInfo(): any;

package/dist/types/commands/doctor.d.ts

@@ -1,11 +0,0 @@
-/**
- * Doctor command implementation - Run diagnostics to check environment
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function doctorCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate doctor options (no specific validation needed)
- * @param {Object} options - Command options
- */
-export function validateDoctorOptions(): any[];

package/dist/types/commands/finalize.d.ts

@@ -1,13 +0,0 @@
-/**
- * Finalize command implementation
- * @param {string} parallelId - Parallel ID to finalize
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function finalizeCommand(parallelId: string, options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate finalize options
- * @param {string} parallelId - Parallel ID to finalize
- * @param {Object} options - Command options
- */
-export function validateFinalizeOptions(parallelId: string, _options: any): string[];

package/dist/types/commands/init.d.ts

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-export function createInitCommand(options: any): () => Promise<void>;
-export function init(options?: {}): Promise<void>;
-/**
- * Simple configuration setup for Vizzly CLI
- */
-export class InitCommand {
-    constructor(plugins?: any[]);
-    plugins: any[];
-    run(options?: {}): Promise<void>;
-    generateConfigFile(configPath: any): Promise<void>;
-    /**
-     * Generate configuration sections for plugins
-     * @returns {string} Plugin config sections as formatted string
-     */
-    generatePluginConfigs(): string;
-    /**
-     * Format a plugin's config schema as JavaScript code
-     * @param {Object} plugin - Plugin with configSchema
-     * @returns {string} Formatted config string
-     */
-    formatPluginConfig(plugin: any): string;
-    /**
-     * Format a JavaScript value with proper indentation
-     * @param {*} value - Value to format
-     * @param {number} depth - Current indentation depth
-     * @returns {string} Formatted value
-     */
-    formatValue(value: any, depth?: number): string;
-    showNextSteps(): void;
-    fileExists(filePath: any): Promise<boolean>;
-}

package/dist/types/commands/login.d.ts

@@ -1,11 +0,0 @@
-/**
- * Login command implementation using OAuth device flow
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function loginCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate login options
- * @param {Object} options - Command options
- */
-export function validateLoginOptions(): any[];

package/dist/types/commands/logout.d.ts

@@ -1,11 +0,0 @@
-/**
- * Logout command implementation
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function logoutCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate logout options
- * @param {Object} options - Command options
- */
-export function validateLogoutOptions(): any[];

package/dist/types/commands/project.d.ts

@@ -1,28 +0,0 @@
-/**
- * Project select command - configure project for current directory
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function projectSelectCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Project list command - show all configured projects
- * @param {Object} _options - Command options (unused)
- * @param {Object} globalOptions - Global CLI options
- */
-export function projectListCommand(_options?: any, globalOptions?: any): Promise<void>;
-/**
- * Project token command - show/regenerate token for current directory
- * @param {Object} _options - Command options (unused)
- * @param {Object} globalOptions - Global CLI options
- */
-export function projectTokenCommand(_options?: any, globalOptions?: any): Promise<void>;
-/**
- * Project remove command - remove project configuration for current directory
- * @param {Object} _options - Command options (unused)
- * @param {Object} globalOptions - Global CLI options
- */
-export function projectRemoveCommand(_options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate project command options
- */
-export function validateProjectOptions(): any[];

package/dist/types/commands/run.d.ts

@@ -1,16 +0,0 @@
-/**
- * Run command implementation
- * @param {string} testCommand - Test command to execute
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function runCommand(testCommand: string, options?: any, globalOptions?: any): Promise<{
-    success: boolean;
-    exitCode: number;
-}>;
-/**
- * Validate run options
- * @param {string} testCommand - Test command to execute
- * @param {Object} options - Command options
- */
-export function validateRunOptions(testCommand: string, options: any): string[];

package/dist/types/commands/status.d.ts

@@ -1,13 +0,0 @@
-/**
- * Status command implementation
- * @param {string} buildId - Build ID to check status for
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function statusCommand(buildId: string, options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate status options
- * @param {string} buildId - Build ID to check
- * @param {Object} options - Command options
- */
-export function validateStatusOptions(buildId: string): string[];

package/dist/types/commands/tdd-daemon.d.ts

@@ -1,24 +0,0 @@
-/**
- * Start TDD server in daemon mode
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function tddStartCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Internal function to run server in child process
- * This is called when --daemon-child flag is present
- * @private
- */
-export function runDaemonChild(options?: {}, globalOptions?: {}): Promise<void>;
-/**
- * Stop TDD daemon server
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function tddStopCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Check TDD daemon server status
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function tddStatusCommand(options: any, globalOptions?: any): Promise<void>;

package/dist/types/commands/tdd.d.ts

@@ -1,17 +0,0 @@
-/**
- * TDD command implementation
- * @param {string} testCommand - Test command to execute
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- * @returns {Promise<{result: Object, cleanup: Function}>} Result and cleanup function
- */
-export function tddCommand(testCommand: string, options?: any, globalOptions?: any): Promise<{
-    result: any;
-    cleanup: Function;
-}>;
-/**
- * Validate TDD options
- * @param {string} testCommand - Test command to execute
- * @param {Object} options - Command options
- */
-export function validateTddOptions(testCommand: string, options: any): string[];

package/dist/types/commands/upload.d.ts

@@ -1,13 +0,0 @@
-/**
- * Upload command implementation
- * @param {string} screenshotsPath - Path to screenshots
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function uploadCommand(screenshotsPath: string, options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate upload options
- * @param {string} screenshotsPath - Path to screenshots
- * @param {Object} options - Command options
- */
-export function validateUploadOptions(screenshotsPath: string, options: any): string[];

package/dist/types/commands/whoami.d.ts

@@ -1,11 +0,0 @@
-/**
- * Whoami command implementation
- * @param {Object} options - Command options
- * @param {Object} globalOptions - Global CLI options
- */
-export function whoamiCommand(options?: any, globalOptions?: any): Promise<void>;
-/**
- * Validate whoami options
- * @param {Object} options - Command options
- */
-export function validateWhoamiOptions(): any[];

package/dist/types/errors/vizzly-error.d.ts

@@ -1,75 +0,0 @@
-/**
- * Base error class for all Vizzly errors
- * Provides consistent error structure and helpful debugging information
- */
-export class VizzlyError extends Error {
-    constructor(message: any, code?: string, context?: {});
-    code: string;
-    context: {};
-    timestamp: string;
-    /**
-     * Get a user-friendly error message
-     */
-    getUserMessage(): string;
-    /**
-     * Get error details for logging
-     */
-    toJSON(): {
-        name: string;
-        code: string;
-        message: string;
-        context: {};
-        timestamp: string;
-        stack: string;
-    };
-}
-/**
- * Configuration-related errors
- */
-export class ConfigError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Authentication/authorization errors
- */
-export class AuthError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Network/connection errors
- */
-export class NetworkError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Upload-related errors
- */
-export class UploadError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Screenshot-related errors
- */
-export class ScreenshotError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Build-related errors
- */
-export class BuildError extends VizzlyError {
-    constructor(message: any, context?: {});
-}
-/**
- * Timeout errors
- */
-export class TimeoutError extends VizzlyError {
-    constructor(message: any, duration: any, context?: {});
-    duration: any;
-}
-/**
- * Validation errors
- */
-export class ValidationError extends VizzlyError {
-    constructor(message: any, errors?: any[], context?: {});
-    errors: any[];
-}

package/dist/types/plugin-loader.d.ts

@@ -1,7 +0,0 @@
-/**
- * Load and register plugins from node_modules and config
- * @param {string|null} configPath - Path to config file
- * @param {Object} config - Loaded configuration
- * @returns {Promise<Array>} Array of loaded plugins
- */
-export function loadPlugins(configPath: string | null, config: any): Promise<any[]>;