@vizzly-testing/cli 0.35.2 → 0.35.3-beta.1

package/dist/tdd/services/baseline-downloader.js

@@ -1,151 +0,0 @@
-/**
- * Baseline Downloader
- *
- * Functions for downloading baseline images from the cloud API.
- * These are lower-level utilities - orchestration happens in TddService.
- */
-
-import { existsSync, writeFileSync } from 'node:fs';
-import { fetchWithTimeout } from '../../utils/fetch-utils.js';
-
-/**
- * Download a single baseline image
- *
- * @param {string} url - URL to download from
- * @param {string} destPath - Destination file path
- * @param {Object} options - Options
- * @param {number} options.timeout - Request timeout in ms (default: 30000)
- * @returns {Promise<{ success: boolean, error?: string }>}
- */
-export async function downloadBaselineImage(url, destPath, options = {}) {
-  let {
-    timeout = 30000
-  } = options;
-  try {
-    let response = await fetchWithTimeout(url, {
-      timeout
-    });
-    if (!response.ok) {
-      return {
-        success: false,
-        error: `HTTP ${response.status}: ${response.statusText}`
-      };
-    }
-    let buffer = Buffer.from(await response.arrayBuffer());
-    writeFileSync(destPath, buffer);
-    return {
-      success: true
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error: error.message
-    };
-  }
-}
-
-/**
- * Check if a baseline already exists with matching SHA
- *
- * @param {string} filePath - Path to the baseline file
- * @param {string} expectedSha - Expected SHA256 hash
- * @param {Map<string, string>} shaMap - Map of filename -> sha256
- * @returns {boolean}
- */
-export function baselineMatchesSha(filePath, expectedSha, shaMap) {
-  if (!existsSync(filePath) || !expectedSha) {
-    return false;
-  }
-  let filename = filePath.split('/').pop();
-  let storedSha = shaMap.get(filename);
-  return storedSha === expectedSha;
-}
-
-/**
- * Download multiple baselines in batches
- *
- * @param {Array} screenshots - Screenshots to download
- * @param {Object} options - Options
- * @param {string} options.baselinePath - Path to baselines directory
- * @param {Map<string, string>} options.existingShaMap - Existing SHA map for skip logic
- * @param {number} options.batchSize - Concurrent downloads (default: 5)
- * @param {Function} options.onProgress - Progress callback (downloaded, skipped, errors, total)
- * @param {Function} options.getFilePath - Function to get file path for a screenshot
- * @returns {Promise<{ downloaded: number, skipped: number, errors: number }>}
- */
-export async function downloadBaselinesInBatches(screenshots, options = {}) {
-  let {
-    existingShaMap = new Map(),
-    batchSize = 5,
-    onProgress,
-    getFilePath
-  } = options;
-  let downloaded = 0;
-  let skipped = 0;
-  let errors = 0;
-  let total = screenshots.length;
-
-  // Process in batches
-  for (let i = 0; i < screenshots.length; i += batchSize) {
-    let batch = screenshots.slice(i, i + batchSize);
-    let batchPromises = batch.map(async screenshot => {
-      let filePath = getFilePath(screenshot);
-      let url = screenshot.original_url;
-      if (!url) {
-        errors++;
-        return;
-      }
-
-      // Skip if SHA matches
-      if (baselineMatchesSha(filePath, screenshot.sha256, existingShaMap)) {
-        skipped++;
-        downloaded++;
-        return;
-      }
-      let result = await downloadBaselineImage(url, filePath);
-      if (result.success) {
-        downloaded++;
-      } else {
-        errors++;
-      }
-    });
-    await Promise.all(batchPromises);
-    if (onProgress) {
-      onProgress(downloaded, skipped, errors, total);
-    }
-  }
-  return {
-    downloaded,
-    skipped,
-    errors
-  };
-}
-
-/**
- * Build baseline metadata entry for a downloaded screenshot
- *
- * @param {Object} screenshot - Screenshot data from API
- * @param {string} filename - Local filename
- * @param {string} filePath - Full file path
- * @param {Object} buildInfo - Build information
- * @returns {Object} Metadata entry
- */
-export function buildBaselineMetadataEntry(screenshot, filename, filePath, buildInfo = {}) {
-  return {
-    name: screenshot.name,
-    originalName: screenshot.name,
-    sha256: screenshot.sha256,
-    id: screenshot.id,
-    filename,
-    path: filePath,
-    browser: screenshot.browser || screenshot.metadata?.browser,
-    viewport_width: screenshot.viewport_width || screenshot.metadata?.viewport?.width || screenshot.properties?.viewport?.width,
-    originalUrl: screenshot.original_url,
-    fileSize: screenshot.file_size,
-    dimensions: screenshot.dimensions,
-    // Build info for tracking
-    buildId: buildInfo.buildId,
-    commitSha: buildInfo.commitSha,
-    approvalStatus: screenshot.approval_status
-  };
-}

package/dist/tdd/services/hotspot-service.js

@@ -1,58 +0,0 @@
-/**
- * Hotspot Service
- *
- * Functions for downloading and managing hotspot data from the cloud.
- * Hotspots identify regions that frequently change due to dynamic content.
- */
-
-import { saveHotspotMetadata } from '../metadata/hotspot-metadata.js';
-
-/**
- * Download hotspots for screenshots from cloud API
- *
- * @param {Object} options
- * @param {Object} options.api - ApiService instance
- * @param {string} options.workingDir - Working directory
- * @param {string[]} options.screenshotNames - Names of screenshots to get hotspots for
- * @returns {Promise<{ success: boolean, count: number, regionCount: number, error?: string }>}
- */
-export async function downloadHotspots(options) {
-  let {
-    api,
-    workingDir,
-    screenshotNames
-  } = options;
-  if (!screenshotNames || screenshotNames.length === 0) {
-    return {
-      success: true,
-      count: 0,
-      regionCount: 0
-    };
-  }
-  try {
-    let response = await api.getHotspots(screenshotNames);
-    if (!response?.hotspots) {
-      return {
-        success: false,
-        error: 'API returned no hotspot data'
-      };
-    }
-
-    // Save hotspots to disk
-    saveHotspotMetadata(workingDir, response.hotspots, response.summary);
-
-    // Calculate stats
-    let count = Object.keys(response.hotspots).length;
-    let regionCount = Object.values(response.hotspots).reduce((sum, h) => sum + (h.regions?.length || 0), 0);
-    return {
-      success: true,
-      count,
-      regionCount
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error: error.message
-    };
-  }
-}

package/dist/utils/environment.js

@@ -1,109 +0,0 @@
-/**
- * Environment detection utilities for handling CI/interactive environments
- */
-
-/**
- * Check if running in a CI environment
- * Based on common CI environment variables
- * @returns {boolean} True if running in CI
- */
-export function isCI() {
-  return Boolean(process.env.CI ||
-  // Generic CI flag
-  process.env.CONTINUOUS_INTEGRATION ||
-  // TravisCI, CircleCI
-  process.env.BUILD_NUMBER ||
-  // Jenkins
-  process.env.GITHUB_ACTIONS ||
-  // GitHub Actions
-  process.env.GITLAB_CI ||
-  // GitLab CI
-  process.env.CIRCLECI ||
-  // CircleCI
-  process.env.TRAVIS ||
-  // TravisCI
-  process.env.APPVEYOR ||
-  // AppVeyor
-  process.env.CODEBUILD_BUILD_ID ||
-  // AWS CodeBuild
-  process.env.TEAMCITY_VERSION ||
-  // TeamCity
-  process.env.TF_BUILD ||
-  // Azure DevOps
-  process.env.DRONE ||
-  // Drone CI
-  process.env.BITBUCKET_BUILD_NUMBER // Bitbucket Pipelines
-  );
-}
-
-/**
- * Check if stdout supports interactive features
- * @returns {boolean} True if interactive features are supported
- */
-export function isInteractiveTerminal() {
-  return Boolean(process.stdout.isTTY && process.stdin.isTTY && (!process.env.TERM || process.env.TERM !== 'dumb'));
-}
-
-/**
- * Determine if interactive mode should be enabled
- * Takes into account CI detection, TTY support, and explicit flags
- * @param {Object} options
- * @param {boolean} [options.noInteractive] - Explicit flag to disable interactive mode
- * @param {boolean} [options.interactive] - Explicit flag to force interactive mode
- * @returns {boolean} True if interactive mode should be enabled
- */
-export function shouldUseInteractiveMode(options = {}) {
-  // Explicit flags take priority
-  // Commander.js sets interactive=false when --no-interactive is used
-  if (options.interactive === false) {
-    return false;
-  }
-  if (options.interactive === true) {
-    return true;
-  }
-
-  // Legacy support for explicit noInteractive flag
-  if (options.noInteractive === true) {
-    return false;
-  }
-
-  // Auto-detect based on environment
-  return !isCI() && isInteractiveTerminal();
-}
-
-/**
- * Get environment type for logging/debugging
- * @returns {string} Environment type description
- */
-export function getEnvironmentType() {
-  if (isCI()) {
-    return 'CI';
-  }
-  if (!isInteractiveTerminal()) {
-    return 'non-interactive';
-  }
-  return 'interactive';
-}
-
-/**
- * Get detailed environment info for debugging
- * @returns {Object} Environment details
- */
-export function getEnvironmentDetails() {
-  return {
-    isCI: isCI(),
-    isInteractiveTerminal: isInteractiveTerminal(),
-    environmentType: getEnvironmentType(),
-    stdoutIsTTY: Boolean(process.stdout.isTTY),
-    stdinIsTTY: Boolean(process.stdin.isTTY),
-    ciVars: {
-      CI: process.env.CI,
-      CONTINUOUS_INTEGRATION: process.env.CONTINUOUS_INTEGRATION,
-      GITHUB_ACTIONS: process.env.GITHUB_ACTIONS,
-      GITLAB_CI: process.env.GITLAB_CI,
-      CIRCLECI: process.env.CIRCLECI,
-      TRAVIS: process.env.TRAVIS
-    },
-    termType: process.env.TERM
-  };
-}

package/skills/vizzly/references/public-screenshots.md

@@ -1,44 +0,0 @@
-# Public Screenshots
-
-Public screenshots are Vizzly's path for stable image URLs in docs and manuals.
-
-Use this when a user asks for hotlinked UI screenshots, generated manual images, docs that stay current with UI, or CDN-like screenshot URLs.
-
-## Mental Model
-
-Do not use arbitrary build screenshot URLs as stable docs assets. Use Public Properties.
-
-The flow:
-
-1. Capture screenshots with stable metadata.
-2. Configure project Public Properties in Vizzly.
-3. Approve/publish the baseline build.
-4. Use the Public URLs tab to copy the stable URL.
-
-Example capture:
-
-```javascript
-await vizzlyScreenshot('watering-widget', screenshot, {
-  properties: {
-    manual: 'plant-care',
-    component: 'watering-widget',
-    viewport: 'desktop'
-  }
-});
-```
-
-Configure a Public Property like `manual=plant-care`. Vizzly publishes matching approved baseline screenshots and keeps stable URLs for each screenshot/property identity.
-
-## Good Uses
-
-- Product manuals
-- User docs
-- Component catalogs
-- In-app UI examples
-- Screenshots that should update when approved UI changes
-
-## Cautions
-
-- Public screenshots are public. Do not publish private user data, secrets, or internal-only UI.
-- A new unapproved build does not automatically become the public docs image.
-- Use stable names and properties so URLs do not churn.