@testivai/witness-playwright 1.9.0 → 2.0.1

package/dist/types.d.ts

@@ -1,10 +1,5 @@
 /**
- * Types for Testivai Witness Playwright SDK
- *
- * Defines the data shapes for evidence collection:
- * - SnapshotPayload: DOM + Layout data for a single snapshot
- * - BatchPayload: Git + Browser info + collection of snapshots
- * - TestivAIConfig: Configuration for visual analysis behavior
+ * Types for the TestivAI Playwright adapter
  */
 /**
  * How an ignored selector is neutralized before capture:
@@ -24,219 +19,28 @@ export type IgnoreSelectorInput = string | {
     mode?: IgnoreMode;
 };
 /**
- * Layout configuration for visual analysis
- */
-export interface LayoutConfig {
-    /** Sensitivity level: 0-4 scale (0=strict/precise, 4=very lenient) */
-    sensitivity: number;
-    /** Base pixel tolerance for layout differences */
-    tolerance: number;
-    /** Per-selector tolerance overrides (optional) */
-    selectorTolerances?: Record<string, number>;
-    /** Use relative tolerance for large elements (optional) */
-    useRelativeTolerance?: boolean;
-    /** Percentage multiplier for relative tolerance (optional) */
-    relativeTolerance?: number;
-}
-/**
- * AI configuration for visual analysis
- */
-export interface AIConfig {
-    /** Sensitivity level: 0-4 scale (0=conservative, 4=aggressive) */
-    sensitivity: number;
-    /** Minimum confidence threshold for AI_BUG verdict (0.0-1.0) */
-    confidence: number;
-    /** Include AI reasoning in results (optional) */
-    enableReasoning?: boolean;
-}
-/**
- * Performance metrics configuration
- */
-export interface PerformanceMetricsConfig {
-    /** Enable performance metrics capture (default: true) */
-    enabled?: boolean;
-}
-/**
- * Structure analysis configuration
- * Controls how page structure (HTML elements, hierarchy, semantics) is analyzed.
- * @renamed Was `DOMAnalysisConfig` — renamed to conceal internal layer terminology (IP protection)
- */
-export interface StructureAnalysisConfig {
-    /** Enable fingerprint generation (default: true) */
-    enableFingerprint?: boolean;
-    /** Enable structural analysis (default: true) */
-    enableStructure?: boolean;
-    /** Enable semantic analysis (default: true) */
-    enableSemantic?: boolean;
-    /** Attributes to ignore in analysis */
-    ignoreAttributes?: string[];
-    /** Elements to ignore completely */
-    ignoreElements?: string[];
-    /** Content patterns to ignore */
-    ignoreContentPatterns?: RegExp[];
-}
-/**
- * Structure fingerprint and analysis result
- * Contains the structural analysis of a page: element fingerprint, hierarchy info, and semantic structure.
- * @renamed Was `DOMAnalysis` — renamed to conceal internal layer terminology (IP protection)
- */
-export interface StructureAnalysis {
-    /** Fast hash of normalized DOM structure */
-    fingerprint?: string;
-    /** Structural information about the DOM */
-    structure?: {
-        totalElements: number;
-        elementTypes: Record<string, number>;
-        maxDepth: number;
-        interactiveElements: {
-            buttons: number;
-            inputs: number;
-            links: number;
-            forms: number;
-        };
-    };
-    /** Semantic structure information */
-    semantic?: {
-        headings: Record<string, number>;
-        landmarks: {
-            hasHeader: boolean;
-            hasNav: boolean;
-            hasMain: boolean;
-            hasFooter: boolean;
-            hasAside: boolean;
-        };
-        lists: {
-            ordered: number;
-            unordered: number;
-        };
-        tables: number;
-        images: number;
-    };
-    /** Component analysis (if detectable) */
-    components?: Record<string, Array<{
-        selector: string;
-        text: string;
-        attributes: Record<string, string>;
-    }>>;
-}
-/**
- * Structure change information
- * Describes a detected change in page structure between baseline and current.
- * @renamed Was `DOMChange` — renamed to conceal internal layer terminology (IP protection)
- */
-export interface StructureChange {
-    type: 'fingerprint' | 'structure' | 'semantic' | 'component';
-    severity: 'low' | 'medium' | 'high';
-    description: string;
-    details?: any;
-}
-/**
- * Performance timing metrics
- * @deprecated Use performanceMetrics with browser Performance.getMetrics instead
- */
-export interface PerformanceTimings {
-    /** Navigation start time */
-    navigationStart?: number;
-    /** DOM content loaded time */
-    domContentLoaded?: number;
-    /** Page load complete time */
-    loadComplete?: number;
-    /** First contentful paint */
-    firstContentfulPaint?: number;
-    /** Largest contentful paint */
-    largestContentfulPaint?: number;
-    /** Time to interactive */
-    timeToInteractive?: number;
-    /** Total blocking time */
-    totalBlockingTime?: number;
-    /** Cumulative layout shift */
-    cumulativeLayoutShift?: number;
-}
-/**
- * Lighthouse performance results
- * @deprecated Lighthouse has been removed. Use performanceMetrics with browser Performance.getMetrics instead
- */
-export interface LighthouseResults {
-    /** Performance score (0-100) */
-    performance?: number;
-    /** Accessibility score (0-100) */
-    accessibility?: number;
-    /** Best practices score (0-100) */
-    bestPractices?: number;
-    /** SEO score (0-100) */
-    seo?: number;
-    /** Core Web Vitals */
-    coreWebVitals?: {
-        lcp?: number;
-        fid?: number;
-        cls?: number;
-    };
-}
-/**
- * Environment-specific configuration overrides
- */
-export interface EnvironmentConfig {
-    /** Configuration for CI environments */
-    ci?: {
-        layout?: Partial<LayoutConfig>;
-        ai?: Partial<AIConfig>;
-    };
-    /** Configuration for development environments */
-    development?: {
-        layout?: Partial<LayoutConfig>;
-        ai?: Partial<AIConfig>;
-    };
-    /** Configuration for production environments */
-    production?: {
-        layout?: Partial<LayoutConfig>;
-        ai?: Partial<AIConfig>;
-    };
-}
-/**
- * Complete TestivAI project configuration
+ * Project-level configuration, loaded from `testivai.config.ts` /
+ * `testivai.config.js` in the project root. Everything here can also be set
+ * in `.testivai/config.json`; this file exists for setups that prefer a
+ * typed config module.
  */
 export interface TestivAIProjectConfig {
-    /** API key for authentication */
-    apiKey?: string;
-    /** API endpoint URL (defaults to production) */
-    apiUrl?: string;
-    /** Layout analysis settings */
-    layout: LayoutConfig;
-    /** AI analysis settings */
-    ai: AIConfig;
-    /** Performance metrics settings (optional) */
-    performanceMetrics?: PerformanceMetricsConfig;
     /**
-     * Structure analysis settings (optional)
-     * @renamed Was `dom` — renamed to conceal internal layer terminology (IP protection)
+     * CSS selectors for elements to hide during screenshot capture.
+     * Merged with `.testivai/config.json` and per-snapshot values.
      */
-    structure?: StructureAnalysisConfig;
-    /** Environment-specific overrides (optional) */
-    environments?: EnvironmentConfig;
+    ignoreSelectors?: IgnoreSelectorInput[];
     /** Stabilize captures (disable animations, hide caret, wait for fonts). Default: true. */
     stabilize?: boolean;
 }
 /**
- * Per-test configuration overrides
+ * Per-snapshot configuration overrides
  */
 export interface TestivAIConfig {
-    /** Layout settings (optional - overrides project defaults) */
-    layout?: Partial<LayoutConfig>;
-    /** AI settings (optional - overrides project defaults) */
-    ai?: Partial<AIConfig>;
-    /** Performance settings (optional - overrides project defaults) */
-    performanceMetrics?: Partial<PerformanceMetricsConfig>;
-    /**
-     * Structure analysis settings (optional - overrides project defaults)
-     * @renamed Was `dom` — renamed to conceal internal layer terminology (IP protection)
-     */
-    structure?: Partial<StructureAnalysisConfig>;
-    /** Element selectors to capture (existing option) */
-    selectors?: string[];
     /** Use browser capture for full-page screenshots (default: true, set to false for scroll-and-stitch) */
     useBrowserCapture?: boolean;
     /**
-     * CSS selectors for elements to hide during screenshot capture (local mode).
+     * CSS selectors for elements to hide during screenshot capture.
      * Elements are set to `visibility: hidden` before the screenshot is taken and
      * restored immediately after — so dynamic content (version badges, timestamps,
      * ads, live clocks) never contributes to the pixel diff.
@@ -273,154 +77,3 @@ export interface TestivAIConfig {
      */
     mask?: Array<string | Record<string, number | string>>;
 }
-/**
- * Layout/Bounding box data for an element
- */
-export interface LayoutData {
-    /** X coordinate */
-    x: number;
-    /** Y coordinate */
-    y: number;
-    /** Width */
-    width: number;
-    /** Height */
-    height: number;
-    /** Top position */
-    top: number;
-    /** Left position */
-    left: number;
-    /** Right position */
-    right: number;
-    /** Bottom position */
-    bottom: number;
-}
-/**
- * Page structure snapshot data (HTML content)
- * @renamed Was `DOMData` — renamed to conceal internal layer terminology (IP protection)
- */
-export interface StructureData {
-    /** Serialized HTML of the element */
-    html: string;
-    /** Computed styles (optional) */
-    styles?: Record<string, string>;
-}
-/**
- * Computed styles data for visual comparison
- * @renamed Was `CSSData` — renamed to conceal internal layer terminology (IP protection)
- */
-export interface StylesData {
-    /** Computed styles keyed by element selector path */
-    computed_styles: Record<string, Record<string, string>>;
-}
-/**
- * Snapshot payload for a single evidence capture
- */
-export interface SnapshotPayload {
-    /**
-     * Page structure data (HTML content)
-     * @renamed Was `dom` — renamed to conceal internal layer terminology (IP protection)
-     */
-    structure: StructureData;
-    /**
-     * Computed styles data (optional)
-     * @renamed Was `css` — renamed to conceal internal layer terminology (IP protection)
-     */
-    styles?: StylesData;
-    /** Layout/bounding box data */
-    layout: LayoutData;
-    /** Timestamp when snapshot was taken */
-    timestamp: number;
-    /** Test name or identifier */
-    testName: string;
-    /** Snapshot name or identifier */
-    snapshotName: string;
-    /** URL of the page when snapshot was taken */
-    url?: string;
-    /** Viewport dimensions */
-    viewport?: {
-        width: number;
-        height: number;
-    };
-    /** TestivAI configuration for this snapshot */
-    testivaiConfig?: TestivAIConfig;
-    /** Base64-encoded screenshot data (PNG) */
-    screenshotData?: string;
-    /** Performance timing metrics (optional) */
-    performanceTimings?: PerformanceTimings;
-    /** Performance metrics from browser Performance.getMetrics (optional) */
-    performanceMetrics?: any;
-    /** Lighthouse results (optional) */
-    lighthouseResults?: LighthouseResults;
-    /**
-     * Structure analysis results (optional)
-     * @renamed Was `domAnalysis` — renamed to conceal internal layer terminology (IP protection)
-     */
-    structureAnalysis?: StructureAnalysis;
-}
-/**
- * Git information for batch context
- */
-export interface GitInfo {
-    /** Current branch name */
-    branch: string;
-    /** Current commit hash */
-    commit: string;
-    /** Repository URL (optional) */
-    repository?: string;
-    /** Commit message (optional) */
-    message?: string;
-    /** Author name (optional) */
-    author?: string;
-}
-/**
- * Browser context information
- */
-export interface BrowserInfo {
-    /** Browser name (chromium, firefox, webkit) */
-    name: string;
-    /** Browser version */
-    version: string;
-    /** Viewport width */
-    viewportWidth: number;
-    /** Viewport height */
-    viewportHeight: number;
-    /** User agent string */
-    userAgent: string;
-    /** Operating system */
-    os?: string;
-    /** Device type (desktop, mobile, tablet) */
-    device?: string;
-}
-/**
- * CI environment information for integration feedback (e.g., GitHub commit statuses, PR comments).
- * Mirrors CiInfo from ci.ts for payload serialization.
- */
-export interface CiInfoPayload {
-    /** CI provider name (e.g., 'github_actions', 'gitlab_ci', 'circleci') */
-    provider: string;
-    /** Pull/Merge request number (if available) */
-    prNumber?: number;
-    /** URL to the CI run (if available) */
-    runUrl?: string;
-    /** CI build/run identifier */
-    buildId?: string;
-}
-/**
- * Batch payload containing all evidence for a test run
- */
-export interface BatchPayload {
-    /** Git information */
-    git: GitInfo;
-    /** Browser context information */
-    browser: BrowserInfo;
-    /** Collection of snapshots */
-    snapshots: SnapshotPayload[];
-    /** Batch ID (generated) */
-    batchId: string;
-    /** Timestamp when batch was created */
-    timestamp: number;
-    /** Unique identifier for a CI/CD run, to group sharded jobs */
-    runId?: string | null;
-    /** CI environment information for integration feedback (optional) */
-    ci?: CiInfoPayload | null;
-}

package/dist/types.js

@@ -1,10 +1,5 @@
 "use strict";
 /**
- * Types for Testivai Witness Playwright SDK
- *
- * Defines the data shapes for evidence collection:
- * - SnapshotPayload: DOM + Layout data for a single snapshot
- * - BatchPayload: Git + Browser info + collection of snapshots
- * - TestivAIConfig: Configuration for visual analysis behavior
+ * Types for the TestivAI Playwright adapter
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testivai/witness-playwright",
-  "version": "1.9.0",
+  "version": "2.0.1",
   "description": "Playwright adapter for TestivAI Witness — local-first visual regression with pixel + DOM comparison",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,13 +22,13 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mcbuddy/testivai-oss.git",
+    "url": "git+https://github.com/testivai/testivai-oss.git",
     "directory": "packages/playwright"
   },
   "bugs": {
-    "url": "https://github.com/mcbuddy/testivai-oss/issues"
+    "url": "https://github.com/testivai/testivai-oss/issues"
   },
-  "homepage": "https://github.com/mcbuddy/testivai-oss/tree/main/packages/playwright#readme",
+  "homepage": "https://github.com/testivai/testivai-oss/tree/main/packages/playwright#readme",
   "publishConfig": {
     "access": "public"
   },
@@ -44,23 +44,17 @@
     "@playwright/test": ">=1.40.0"
   },
   "dependencies": {
-    "axios": "^1.16.1",
-    "chalk": "^4.1.2",
-    "commander": "^14.0.3",
-    "cross-fetch": "^4.0.0",
-    "fs-extra": "^11.3.5",
-    "sharp": "^0.34.5",
-    "simple-git": "^3.21.0",
-    "@testivai/common": "0.2.3",
-    "@testivai/witness": "1.13.0"
+    "fs-extra": "^11.4.0",
+    "sharp": "^0.35.3",
+    "@testivai/witness": "2.0.1"
   },
   "devDependencies": {
-    "@playwright/test": "^1.60.0",
+    "@playwright/test": "^1.62.1",
     "@types/fs-extra": "^11.0.4",
     "@types/jest": "^30.0.0",
     "@types/node": "^20.10.0",
     "jest": "^30.4.2",
-    "ts-jest": "^29.4.11",
+    "ts-jest": "^29.4.12",
     "ts-node": "^10.9.0",
     "typescript": "^6.0.3"
   },

package/dist/ci.d.ts

@@ -1,30 +0,0 @@
-/**
- * Utilities for detecting CI/CD environments and extracting a unique run identifier.
- */
-/**
- * CI environment information for integration feedback (e.g., GitHub commit statuses, PR comments).
- */
-export interface CiInfo {
-    /** CI provider name */
-    provider: string;
-    /** Pull/Merge request number (if available) */
-    prNumber?: number;
-    /** URL to the CI run (if available) */
-    runUrl?: string;
-    /** CI build/run identifier */
-    buildId?: string;
-}
-/**
- * Gets a unique identifier for the current CI run.
- * This ID is used to group snapshots from parallel shards into a single batch.
- *
- * @returns A unique string identifier for the CI run, or null if not in a known CI environment.
- */
-export declare function getCiRunId(): string | null;
-/**
- * Gets detailed CI environment information including PR number and run URL.
- * Used for integration feedback (GitHub commit statuses, PR comments, etc.).
- *
- * @returns CiInfo object if in a known CI environment, or null otherwise.
- */
-export declare function getCiInfo(): CiInfo | null;

package/dist/ci.js

@@ -1,117 +0,0 @@
-"use strict";
-/**
- * Utilities for detecting CI/CD environments and extracting a unique run identifier.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCiRunId = getCiRunId;
-exports.getCiInfo = getCiInfo;
-/**
- * Gets a unique identifier for the current CI run.
- * This ID is used to group snapshots from parallel shards into a single batch.
- *
- * @returns A unique string identifier for the CI run, or null if not in a known CI environment.
- */
-function getCiRunId() {
-    // GitHub Actions
-    if (process.env.GITHUB_RUN_ID) {
-        return `github-${process.env.GITHUB_RUN_ID}`;
-    }
-    // GitLab CI
-    if (process.env.GITLAB_CI) {
-        return `gitlab-${process.env.CI_PIPELINE_ID}`;
-    }
-    // Jenkins
-    if (process.env.JENKINS_URL) {
-        return `jenkins-${process.env.BUILD_ID}`;
-    }
-    // CircleCI
-    if (process.env.CIRCLECI) {
-        return `circleci-${process.env.CIRCLE_WORKFLOW_ID}`;
-    }
-    // Travis CI
-    if (process.env.TRAVIS) {
-        return `travis-${process.env.TRAVIS_BUILD_ID}`;
-    }
-    return null;
-}
-/**
- * Gets detailed CI environment information including PR number and run URL.
- * Used for integration feedback (GitHub commit statuses, PR comments, etc.).
- *
- * @returns CiInfo object if in a known CI environment, or null otherwise.
- */
-function getCiInfo() {
-    // GitHub Actions
-    if (process.env.GITHUB_ACTIONS) {
-        const serverUrl = process.env.GITHUB_SERVER_URL || 'https://github.com';
-        const repo = process.env.GITHUB_REPOSITORY;
-        const runId = process.env.GITHUB_RUN_ID;
-        // PR number: available via GITHUB_EVENT_NUMBER in pull_request events,
-        // or from GITHUB_REF (refs/pull/<number>/merge)
-        let prNumber;
-        if (process.env.GITHUB_EVENT_NUMBER) {
-            prNumber = parseInt(process.env.GITHUB_EVENT_NUMBER, 10) || undefined;
-        }
-        else if (process.env.GITHUB_REF?.startsWith('refs/pull/')) {
-            const match = process.env.GITHUB_REF.match(/^refs\/pull\/(\d+)\//);
-            if (match) {
-                prNumber = parseInt(match[1], 10);
-            }
-        }
-        return {
-            provider: 'github_actions',
-            prNumber,
-            runUrl: repo && runId ? `${serverUrl}/${repo}/actions/runs/${runId}` : undefined,
-            buildId: runId,
-        };
-    }
-    // GitLab CI
-    if (process.env.GITLAB_CI) {
-        const prNumber = process.env.CI_MERGE_REQUEST_IID
-            ? parseInt(process.env.CI_MERGE_REQUEST_IID, 10) || undefined
-            : undefined;
-        return {
-            provider: 'gitlab_ci',
-            prNumber,
-            runUrl: process.env.CI_PIPELINE_URL || undefined,
-            buildId: process.env.CI_PIPELINE_ID,
-        };
-    }
-    // CircleCI
-    if (process.env.CIRCLECI) {
-        const prNumber = process.env.CIRCLE_PULL_REQUEST
-            ? parseInt(process.env.CIRCLE_PULL_REQUEST.split('/').pop() || '', 10) || undefined
-            : undefined;
-        return {
-            provider: 'circleci',
-            prNumber,
-            runUrl: process.env.CIRCLE_BUILD_URL || undefined,
-            buildId: process.env.CIRCLE_WORKFLOW_ID,
-        };
-    }
-    // Jenkins
-    if (process.env.JENKINS_URL) {
-        const prNumber = process.env.CHANGE_ID
-            ? parseInt(process.env.CHANGE_ID, 10) || undefined
-            : undefined;
-        return {
-            provider: 'jenkins',
-            prNumber,
-            runUrl: process.env.BUILD_URL || undefined,
-            buildId: process.env.BUILD_ID,
-        };
-    }
-    // Travis CI
-    if (process.env.TRAVIS) {
-        const prNumber = process.env.TRAVIS_PULL_REQUEST && process.env.TRAVIS_PULL_REQUEST !== 'false'
-            ? parseInt(process.env.TRAVIS_PULL_REQUEST, 10) || undefined
-            : undefined;
-        return {
-            provider: 'travis_ci',
-            prNumber,
-            runUrl: process.env.TRAVIS_BUILD_WEB_URL || undefined,
-            buildId: process.env.TRAVIS_BUILD_ID,
-        };
-    }
-    return null;
-}

package/dist/mode.d.ts

@@ -1,21 +0,0 @@
-/**
- * Resolve whether the adapter should run in local mode.
- *
- * Local-first is the zero-config default: with no API key, the adapter
- * captures to `.testivai/temp/<name>/` and writes an HTML report — no cloud,
- * no account, nothing scary. Cloud mode activates only when a key is present.
- *
- * Precedence (first match wins):
- *   1. TESTIVAI_MODE env — explicit override ('local' | 'cloud')
- *   2. .testivai/config.json `mode` — project default
- *   3. TESTIVAI_API_KEY presence — key ⇒ cloud, no key ⇒ local
- *
- * This is deliberately derivable from the shell environment and the config
- * file alone, so it resolves identically in the Playwright main process (the
- * reporter) and in worker processes (the `snapshot()` capture) — env vars set
- * at runtime by the reporter never propagate to already-spawned workers.
- */
-export declare function resolveLocalMode(opts?: {
-    apiKey?: string;
-    projectRoot?: string;
-}): boolean;