@vizzly-testing/cli 0.10.2 → 0.11.0

package/dist/types/utils/config-schema.d.ts

@@ -21,197 +21,31 @@ export let vizzlyConfigSchema: z.ZodDefault<z.ZodObject<{
     server: z.ZodDefault<z.ZodObject<{
         port: z.ZodDefault<z.ZodNumber>;
         timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        port?: number;
-        timeout?: number;
-    }, {
-        port?: number;
-        timeout?: number;
-    }>>;
+    }, z.core.$strip>>;
     build: z.ZodDefault<z.ZodObject<{
         name: z.ZodDefault<z.ZodString>;
         environment: z.ZodDefault<z.ZodString>;
         branch: z.ZodOptional<z.ZodString>;
         commit: z.ZodOptional<z.ZodString>;
         message: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }>>;
+    }, z.core.$strip>>;
     upload: z.ZodDefault<z.ZodObject<{
-        screenshotsDir: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        screenshotsDir: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
         batchSize: z.ZodDefault<z.ZodNumber>;
         timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }>>;
+    }, z.core.$strip>>;
     comparison: z.ZodDefault<z.ZodObject<{
         threshold: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        threshold?: number;
-    }, {
-        threshold?: number;
-    }>>;
+    }, z.core.$strip>>;
     tdd: z.ZodDefault<z.ZodObject<{
         openReport: z.ZodDefault<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        openReport?: boolean;
-    }, {
-        openReport?: boolean;
-    }>>;
-    plugins: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    }, z.core.$strip>>;
+    plugins: z.ZodDefault<z.ZodArray<z.ZodString>>;
     parallelId: z.ZodOptional<z.ZodString>;
     baselineBuildId: z.ZodOptional<z.ZodString>;
     baselineComparisonId: z.ZodOptional<z.ZodString>;
     eager: z.ZodOptional<z.ZodBoolean>;
     wait: z.ZodOptional<z.ZodBoolean>;
     allowNoToken: z.ZodOptional<z.ZodBoolean>;
-}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-    apiKey: z.ZodOptional<z.ZodString>;
-    apiUrl: z.ZodOptional<z.ZodString>;
-    server: z.ZodDefault<z.ZodObject<{
-        port: z.ZodDefault<z.ZodNumber>;
-        timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        port?: number;
-        timeout?: number;
-    }, {
-        port?: number;
-        timeout?: number;
-    }>>;
-    build: z.ZodDefault<z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-        environment: z.ZodDefault<z.ZodString>;
-        branch: z.ZodOptional<z.ZodString>;
-        commit: z.ZodOptional<z.ZodString>;
-        message: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }>>;
-    upload: z.ZodDefault<z.ZodObject<{
-        screenshotsDir: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
-        batchSize: z.ZodDefault<z.ZodNumber>;
-        timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }>>;
-    comparison: z.ZodDefault<z.ZodObject<{
-        threshold: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        threshold?: number;
-    }, {
-        threshold?: number;
-    }>>;
-    tdd: z.ZodDefault<z.ZodObject<{
-        openReport: z.ZodDefault<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        openReport?: boolean;
-    }, {
-        openReport?: boolean;
-    }>>;
-    plugins: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    parallelId: z.ZodOptional<z.ZodString>;
-    baselineBuildId: z.ZodOptional<z.ZodString>;
-    baselineComparisonId: z.ZodOptional<z.ZodString>;
-    eager: z.ZodOptional<z.ZodBoolean>;
-    wait: z.ZodOptional<z.ZodBoolean>;
-    allowNoToken: z.ZodOptional<z.ZodBoolean>;
-}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-    apiKey: z.ZodOptional<z.ZodString>;
-    apiUrl: z.ZodOptional<z.ZodString>;
-    server: z.ZodDefault<z.ZodObject<{
-        port: z.ZodDefault<z.ZodNumber>;
-        timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        port?: number;
-        timeout?: number;
-    }, {
-        port?: number;
-        timeout?: number;
-    }>>;
-    build: z.ZodDefault<z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-        environment: z.ZodDefault<z.ZodString>;
-        branch: z.ZodOptional<z.ZodString>;
-        commit: z.ZodOptional<z.ZodString>;
-        message: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }, {
-        name?: string;
-        message?: string;
-        environment?: string;
-        branch?: string;
-        commit?: string;
-    }>>;
-    upload: z.ZodDefault<z.ZodObject<{
-        screenshotsDir: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
-        batchSize: z.ZodDefault<z.ZodNumber>;
-        timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }, {
-        timeout?: number;
-        screenshotsDir?: string | string[];
-        batchSize?: number;
-    }>>;
-    comparison: z.ZodDefault<z.ZodObject<{
-        threshold: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        threshold?: number;
-    }, {
-        threshold?: number;
-    }>>;
-    tdd: z.ZodDefault<z.ZodObject<{
-        openReport: z.ZodDefault<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        openReport?: boolean;
-    }, {
-        openReport?: boolean;
-    }>>;
-    plugins: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    parallelId: z.ZodOptional<z.ZodString>;
-    baselineBuildId: z.ZodOptional<z.ZodString>;
-    baselineComparisonId: z.ZodOptional<z.ZodString>;
-    eager: z.ZodOptional<z.ZodBoolean>;
-    wait: z.ZodOptional<z.ZodBoolean>;
-    allowNoToken: z.ZodOptional<z.ZodBoolean>;
-}, z.ZodTypeAny, "passthrough">>>;
+}, z.core.$loose>>;
 import { z } from 'zod';

package/dist/types/utils/file-helpers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Resolve image buffer from file path or return buffer as-is
+ * Handles both Buffer inputs and file path strings, with proper validation and error handling
+ *
+ * @param {Buffer|string} imageBufferOrPath - Image data as Buffer or file path
+ * @param {string} contextName - Context for error messages (e.g., 'screenshot', 'compare')
+ * @returns {Buffer} The image buffer
+ * @throws {VizzlyError} When file not found, unreadable, or invalid input type
+ *
+ * @example
+ * // With Buffer
+ * const buffer = resolveImageBuffer(myBuffer, 'screenshot');
+ *
+ * @example
+ * // With file path
+ * const buffer = resolveImageBuffer('./my-image.png', 'screenshot');
+ */
+export function resolveImageBuffer(imageBufferOrPath: Buffer | string, contextName: string): Buffer;

package/dist/types/utils/global-config.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Get the path to the global Vizzly directory
+ * @returns {string} Path to ~/.vizzly
+ */
+export function getGlobalConfigDir(): string;
+/**
+ * Get the path to the global config file
+ * @returns {string} Path to ~/.vizzly/config.json
+ */
+export function getGlobalConfigPath(): string;
+/**
+ * Load the global configuration
+ * @returns {Promise<Object>} Global config object
+ */
+export function loadGlobalConfig(): Promise<any>;
+/**
+ * Save the global configuration
+ * @param {Object} config - Configuration object to save
+ * @returns {Promise<void>}
+ */
+export function saveGlobalConfig(config: any): Promise<void>;
+/**
+ * Clear all global configuration
+ * @returns {Promise<void>}
+ */
+export function clearGlobalConfig(): Promise<void>;
+/**
+ * Get authentication tokens from global config
+ * @returns {Promise<Object|null>} Token object with accessToken, refreshToken, expiresAt, user, or null if not found
+ */
+export function getAuthTokens(): Promise<any | null>;
+/**
+ * Save authentication tokens to global config
+ * @param {Object} auth - Auth object with accessToken, refreshToken, expiresAt, user
+ * @returns {Promise<void>}
+ */
+export function saveAuthTokens(auth: any): Promise<void>;
+/**
+ * Clear authentication tokens from global config
+ * @returns {Promise<void>}
+ */
+export function clearAuthTokens(): Promise<void>;
+/**
+ * Check if authentication tokens exist and are not expired
+ * @returns {Promise<boolean>} True if valid tokens exist
+ */
+export function hasValidTokens(): Promise<boolean>;
+/**
+ * Get the access token from global config if available
+ * @returns {Promise<string|null>} Access token or null
+ */
+export function getAccessToken(): Promise<string | null>;
+/**
+ * Get project mapping for a directory
+ * Walks up the directory tree to find the closest mapping
+ * @param {string} directoryPath - Absolute path to project directory
+ * @returns {Promise<Object|null>} Project data or null
+ */
+export function getProjectMapping(directoryPath: string): Promise<any | null>;
+/**
+ * Save project mapping for a directory
+ * @param {string} directoryPath - Absolute path to project directory
+ * @param {Object} projectData - Project configuration
+ * @param {string} projectData.token - Project API token (vzt_...)
+ * @param {string} projectData.projectSlug - Project slug
+ * @param {string} projectData.organizationSlug - Organization slug
+ * @param {string} projectData.projectName - Project name
+ */
+export function saveProjectMapping(directoryPath: string, projectData: {
+    token: string;
+    projectSlug: string;
+    organizationSlug: string;
+    projectName: string;
+}): Promise<void>;
+/**
+ * Get all project mappings
+ * @returns {Promise<Object>} Map of directory paths to project data
+ */
+export function getProjectMappings(): Promise<any>;
+/**
+ * Delete project mapping for a directory
+ * @param {string} directoryPath - Absolute path to project directory
+ */
+export function deleteProjectMapping(directoryPath: string): Promise<void>;

package/dist/utils/browser.js

@@ -0,0 +1,44 @@
+/**
+ * Browser utilities for opening URLs
+ */
+
+import { execFile } from 'child_process';
+import { platform } from 'os';
+
+/**
+ * Open a URL in the default browser
+ * @param {string} url - URL to open
+ * @returns {Promise<boolean>} True if successful
+ */
+export async function openBrowser(url) {
+  return new Promise(resolve => {
+    let command;
+    let args;
+    let os = platform();
+    switch (os) {
+      case 'darwin':
+        // macOS
+        command = 'open';
+        args = [url];
+        break;
+      case 'win32':
+        // Windows
+        command = 'cmd.exe';
+        args = ['/c', 'start', '""', url];
+        break;
+      default:
+        // Linux and others
+        command = 'xdg-open';
+        args = [url];
+        break;
+    }
+    execFile(command, args, error => {
+      if (error) {
+        // Browser opening failed, but don't throw - user can manually open
+        resolve(false);
+      } else {
+        resolve(true);
+      }
+    });
+  });
+}

package/dist/utils/config-loader.js

@@ -2,9 +2,11 @@ import { cosmiconfigSync } from 'cosmiconfig';
 import { resolve } from 'path';
 import { getApiToken, getApiUrl, getParallelId } from './environment-config.js';
 import { validateVizzlyConfigWithDefaults } from './config-schema.js';
+import { getAccessToken, getProjectMapping } from './global-config.js';
 const DEFAULT_CONFIG = {
   // API Configuration
-  apiKey: getApiToken(),
+  apiKey: undefined,
+  // Will be set from env, global config, or CLI overrides
   apiUrl: getApiUrl(),
   // Server Configuration (for run command)
   server: {
@@ -70,16 +72,80 @@ export async function loadConfig(configPath = null, cliOverrides = {}) {
   // Merge validated file config
   mergeConfig(config, validatedFileConfig);
 
-  // 3. Override with environment variables
+  // 3. Check project mapping for current directory (if no CLI flag)
+  if (!cliOverrides.token) {
+    const currentDir = process.cwd();
+    if (process.env.DEBUG_CONFIG) {
+      console.log('[CONFIG] Looking up project mapping for:', currentDir);
+    }
+    const projectMapping = await getProjectMapping(currentDir);
+    if (projectMapping && projectMapping.token) {
+      // Handle both string tokens and token objects (backward compatibility)
+      let token;
+      if (typeof projectMapping.token === 'string') {
+        token = projectMapping.token;
+      } else if (typeof projectMapping.token === 'object' && projectMapping.token.token) {
+        // Handle nested token object from old API responses
+        token = projectMapping.token.token;
+      } else {
+        token = String(projectMapping.token);
+      }
+      config.apiKey = token;
+      config.projectSlug = projectMapping.projectSlug;
+      config.organizationSlug = projectMapping.organizationSlug;
+
+      // Debug logging
+      if (process.env.DEBUG_CONFIG) {
+        console.log('[CONFIG] Found project mapping:', {
+          dir: currentDir,
+          projectSlug: projectMapping.projectSlug,
+          hasToken: !!projectMapping.token,
+          tokenType: typeof projectMapping.token,
+          tokenPrefix: token ? token.substring(0, 8) + '***' : 'none'
+        });
+        console.log('[CONFIG] Set config.apiKey to:', config.apiKey ? config.apiKey.substring(0, 8) + '***' : 'NONE');
+      }
+    } else if (process.env.DEBUG_CONFIG) {
+      console.log('[CONFIG] No project mapping found for:', currentDir);
+    }
+  }
+
+  // 3.5. Check global config for user access token (if no CLI flag)
+  if (!config.apiKey && !cliOverrides.token) {
+    const globalToken = await getAccessToken();
+    if (globalToken) {
+      config.apiKey = globalToken;
+    }
+  }
+
+  // 4. Override with environment variables (higher priority than fallbacks)
   const envApiKey = getApiToken();
   const envApiUrl = getApiUrl();
   const envParallelId = getParallelId();
+  if (process.env.DEBUG_CONFIG) {
+    console.log('[CONFIG] Step 4 - env vars:', JSON.stringify({
+      hasEnvApiKey: !!envApiKey,
+      envApiKeyPrefix: envApiKey ? envApiKey.substring(0, 8) + '***' : 'none',
+      configApiKeyBefore: config.apiKey ? config.apiKey.substring(0, 8) + '***' : 'NONE'
+    }));
+  }
   if (envApiKey) config.apiKey = envApiKey;
   if (envApiUrl !== 'https://app.vizzly.dev') config.apiUrl = envApiUrl;
   if (envParallelId) config.parallelId = envParallelId;
 
-  // 4. Apply CLI overrides (highest priority)
+  // 5. Apply CLI overrides (highest priority)
+  if (process.env.DEBUG_CONFIG) {
+    console.log('[CONFIG] Step 5 - before CLI overrides:', {
+      configApiKey: config.apiKey ? config.apiKey.substring(0, 8) + '***' : 'NONE',
+      cliToken: cliOverrides.token ? cliOverrides.token.substring(0, 8) + '***' : 'none'
+    });
+  }
   applyCLIOverrides(config, cliOverrides);
+  if (process.env.DEBUG_CONFIG) {
+    console.log('[CONFIG] Step 6 - after CLI overrides:', {
+      configApiKey: config.apiKey ? config.apiKey.substring(0, 8) + '***' : 'NONE'
+    });
+  }
   return config;
 }
 

package/dist/utils/file-helpers.js

@@ -0,0 +1,64 @@
+/**
+ * @module file-helpers
+ * @description Utilities for handling file-based screenshot inputs
+ */
+
+import { existsSync, readFileSync } from 'fs';
+import { resolve } from 'path';
+import { VizzlyError } from '../errors/vizzly-error.js';
+
+/**
+ * Resolve image buffer from file path or return buffer as-is
+ * Handles both Buffer inputs and file path strings, with proper validation and error handling
+ *
+ * @param {Buffer|string} imageBufferOrPath - Image data as Buffer or file path
+ * @param {string} contextName - Context for error messages (e.g., 'screenshot', 'compare')
+ * @returns {Buffer} The image buffer
+ * @throws {VizzlyError} When file not found, unreadable, or invalid input type
+ *
+ * @example
+ * // With Buffer
+ * const buffer = resolveImageBuffer(myBuffer, 'screenshot');
+ *
+ * @example
+ * // With file path
+ * const buffer = resolveImageBuffer('./my-image.png', 'screenshot');
+ */
+export function resolveImageBuffer(imageBufferOrPath, contextName) {
+  // Return Buffer as-is
+  if (Buffer.isBuffer(imageBufferOrPath)) {
+    return imageBufferOrPath;
+  }
+
+  // Validate input type
+  if (typeof imageBufferOrPath !== 'string') {
+    throw new VizzlyError(`Invalid image input: expected Buffer or file path string`, 'INVALID_INPUT', {
+      contextName,
+      type: typeof imageBufferOrPath
+    });
+  }
+
+  // Resolve to absolute path for consistent behavior
+  const filePath = resolve(imageBufferOrPath);
+
+  // Check file exists
+  if (!existsSync(filePath)) {
+    throw new VizzlyError(`Screenshot file not found: ${imageBufferOrPath}`, 'FILE_NOT_FOUND', {
+      contextName,
+      filePath,
+      originalPath: imageBufferOrPath
+    });
+  }
+
+  // Read file with error handling
+  try {
+    return readFileSync(filePath);
+  } catch (error) {
+    throw new VizzlyError(`Failed to read screenshot file: ${imageBufferOrPath} - ${error.message}`, 'FILE_READ_ERROR', {
+      contextName,
+      filePath,
+      originalPath: imageBufferOrPath,
+      originalError: error.message
+    });
+  }
+}