@testivai/witness-playwright 1.8.0 → 2.0.0

package/README.md

@@ -113,6 +113,6 @@ MIT
 
 ## Support
 
-- Documentation: https://github.com/mcbuddy/testivai-oss/tree/main/packages/playwright
-- Issues: https://github.com/mcbuddy/testivai-oss/issues
+- Documentation: https://github.com/testivai/testivai-oss/tree/main/packages/playwright
+- Issues: https://github.com/testivai/testivai-oss/issues
 - Website: https://testiv.ai

package/dist/config/ignore-selectors.d.ts

@@ -14,7 +14,7 @@
  * These functions are pure (no Playwright dependency) so they can be
  * exercised in plain Jest unit tests without a browser.
  */
-import { TestivAIConfig, TestivAIProjectConfig, IgnoreMode, IgnoreSelectorInput } from '../types';
+import type { TestivAIConfig, TestivAIProjectConfig, IgnoreMode, IgnoreSelectorInput } from '../types';
 /** A fully-resolved ignore entry with an explicit mode. */
 export interface IgnoreRule {
     selector: string;

package/dist/config/loader.d.ts

@@ -1,4 +1,4 @@
-import { TestivAIProjectConfig, TestivAIConfig } from '../types';
+import type { TestivAIProjectConfig, TestivAIConfig } from '../types';
 /**
  * Load TestivAI configuration from file system
  * Supports both .ts and .js config files
@@ -7,23 +7,10 @@ import { TestivAIProjectConfig, TestivAIConfig } from '../types';
  */
 export declare function loadConfig(): Promise<TestivAIProjectConfig>;
 /**
- * Merge per-test configuration with project configuration
+ * Merge per-snapshot configuration with project configuration
  *
  * @param projectConfig The project-level configuration
- * @param testConfig Optional per-test configuration overrides
- * @returns TestivAIConfig The effective configuration for this test
+ * @param testConfig Optional per-snapshot configuration overrides
+ * @returns TestivAIConfig The effective configuration for this snapshot
  */
-export declare function mergeTestConfig(projectConfig: TestivAIProjectConfig, testConfig?: TestivAIConfig): TestivAIConfig;
-/**
- * Detect current environment (CI, development, production)
- *
- * @returns string The detected environment
- */
-export declare function detectEnvironment(): string;
-/**
- * Apply environment-specific overrides to configuration
- *
- * @param config The base configuration
- * @returns TestivAIProjectConfig Configuration with environment overrides applied
- */
-export declare function applyEnvironmentOverrides(config: TestivAIProjectConfig): TestivAIProjectConfig;
+export declare function mergeTestConfig(_projectConfig: TestivAIProjectConfig, testConfig?: TestivAIConfig): TestivAIConfig;

package/dist/config/loader.js

@@ -35,23 +35,12 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfig = loadConfig;
 exports.mergeTestConfig = mergeTestConfig;
-exports.detectEnvironment = detectEnvironment;
-exports.applyEnvironmentOverrides = applyEnvironmentOverrides;
 const fs = __importStar(require("fs-extra"));
 const path = __importStar(require("path"));
 /**
  * Default configuration when no config file is found
  */
-const DEFAULT_CONFIG = {
-    layout: {
-        sensitivity: 2, // Balanced sensitivity (0-4 scale)
-        tolerance: 1.0, // 1 pixel base tolerance
-    },
-    ai: {
-        sensitivity: 2, // Balanced AI analysis (0-4 scale)
-        confidence: 0.7, // 70% confidence required for AI_BUG
-    }
-};
+const DEFAULT_CONFIG = {};
 /**
  * Load TestivAI configuration from file system
  * Supports both .ts and .js config files
@@ -73,7 +62,7 @@ async function loadConfig() {
             configPath = jsConfigPath;
         }
         else {
-            console.log('⚠️  No testivai.config.ts or testivai.config.js found, using defaults');
+            // No config file is the normal zero-config case — silently use defaults
             return DEFAULT_CONFIG;
         }
         // Load configuration based on file type
@@ -88,171 +77,40 @@ async function loadConfig() {
             configModule = await Promise.resolve(`${configPath}`).then(s => __importStar(require(s)));
         }
         const config = configModule.default || configModule;
-        // Validate and merge with defaults
-        return validateAndMergeConfig(config);
+        if (!config) {
+            return DEFAULT_CONFIG;
+        }
+        return {
+            ignoreSelectors: config.ignoreSelectors,
+            stabilize: config.stabilize,
+        };
     }
     catch (error) {
-        console.warn('⚠️  Failed to load testivai config, using defaults:', error);
+        console.warn('Warning: failed to load testivai config, using defaults:', error);
         return DEFAULT_CONFIG;
     }
 }
 /**
- * Merge per-test configuration with project configuration
+ * Merge per-snapshot configuration with project configuration
  *
  * @param projectConfig The project-level configuration
- * @param testConfig Optional per-test configuration overrides
- * @returns TestivAIConfig The effective configuration for this test
+ * @param testConfig Optional per-snapshot configuration overrides
+ * @returns TestivAIConfig The effective configuration for this snapshot
  */
-function mergeTestConfig(projectConfig, testConfig) {
+function mergeTestConfig(_projectConfig, testConfig) {
     if (!testConfig) {
-        return {
-            layout: projectConfig.layout,
-            ai: projectConfig.ai,
-            // @renamed: dom → structure (IP protection)
-            structure: projectConfig.structure,
-            performanceMetrics: projectConfig.performanceMetrics
-        };
+        return {};
     }
     return {
-        layout: {
-            ...projectConfig.layout,
-            ...testConfig.layout
-        },
-        ai: {
-            ...projectConfig.ai,
-            ...testConfig.ai
-        },
-        // @renamed: dom → structure (IP protection)
-        structure: {
-            ...projectConfig.structure,
-            ...testConfig.structure
-        },
-        performanceMetrics: {
-            ...projectConfig.performanceMetrics,
-            ...testConfig.performanceMetrics
-        },
-        selectors: testConfig.selectors,
         useBrowserCapture: testConfig.useBrowserCapture,
         // Per-call capture options must survive the merge: without these,
         // witness(page, testInfo, name, { ignoreSelectors }) silently ignored
         // the selectors (masked for a long time by the diff engine's cumulated
         // threshold absorbing the tiny leaked pixels).
+        // Project-level ignoreSelectors and stabilize are read separately
+        // (collectIgnoreRules / resolveStabilize) so they are NOT merged here.
         ignoreSelectors: testConfig.ignoreSelectors,
         stabilize: testConfig.stabilize,
-        mask: testConfig.mask
+        mask: testConfig.mask,
     };
 }
-/**
- * Detect current environment (CI, development, production)
- *
- * @returns string The detected environment
- */
-function detectEnvironment() {
-    // Check for common CI environment variables
-    if (process.env.CI || process.env.CONTINUOUS_INTEGRATION) {
-        return 'ci';
-    }
-    // Check for production indicators
-    if (process.env.NODE_ENV === 'production') {
-        return 'production';
-    }
-    // Default to development
-    return 'development';
-}
-/**
- * Apply environment-specific overrides to configuration
- *
- * @param config The base configuration
- * @returns TestivAIProjectConfig Configuration with environment overrides applied
- */
-function applyEnvironmentOverrides(config) {
-    const environment = detectEnvironment();
-    if (!config.environments) {
-        return config;
-    }
-    // Type-safe environment override access
-    let envOverrides;
-    switch (environment) {
-        case 'ci':
-            envOverrides = config.environments.ci;
-            break;
-        case 'development':
-            envOverrides = config.environments.development;
-            break;
-        case 'production':
-            envOverrides = config.environments.production;
-            break;
-    }
-    if (!envOverrides) {
-        return config;
-    }
-    return {
-        layout: {
-            ...config.layout,
-            ...envOverrides.layout
-        },
-        ai: {
-            ...config.ai,
-            ...envOverrides.ai
-        },
-        environments: config.environments // Keep the original environments config
-    };
-}
-/**
- * Validate configuration values and merge with defaults
- *
- * @param config The configuration to validate
- * @returns TestivAIProjectConfig Validated configuration
- */
-function validateAndMergeConfig(config) {
-    // Guard against null/undefined config
-    if (!config) {
-        console.warn('⚠️  Config is null or undefined, using defaults');
-        return DEFAULT_CONFIG;
-    }
-    // Basic validation
-    const validatedConfig = {
-        // API configuration with production default
-        apiKey: config.apiKey,
-        apiUrl: config.apiUrl || 'https://core-api.testiv.ai',
-        layout: {
-            sensitivity: validateRange(config.layout?.sensitivity ?? DEFAULT_CONFIG.layout.sensitivity, 0, 4, 'layout.sensitivity', DEFAULT_CONFIG.layout.sensitivity),
-            tolerance: validateRange(config.layout?.tolerance ?? DEFAULT_CONFIG.layout.tolerance, 0, 100, 'layout.tolerance', DEFAULT_CONFIG.layout.tolerance),
-            selectorTolerances: config.layout?.selectorTolerances,
-            useRelativeTolerance: config.layout?.useRelativeTolerance,
-            relativeTolerance: config.layout?.relativeTolerance
-        },
-        ai: {
-            sensitivity: validateRange(config.ai?.sensitivity ?? DEFAULT_CONFIG.ai.sensitivity, 0, 4, 'ai.sensitivity', DEFAULT_CONFIG.ai.sensitivity),
-            confidence: validateRange(config.ai?.confidence ?? DEFAULT_CONFIG.ai.confidence, 0, 1, 'ai.confidence', DEFAULT_CONFIG.ai.confidence),
-            enableReasoning: config.ai?.enableReasoning
-        },
-        // @renamed: dom → structure (IP protection)
-        structure: config.structure, // Pass through structure analysis configuration as-is
-        performanceMetrics: config.performanceMetrics, // Pass through performance metrics configuration as-is
-        environments: config.environments
-    };
-    return applyEnvironmentOverrides(validatedConfig);
-}
-/**
- * Validate that a number is within the expected range
- *
- * @param value The value to validate
- * @param min Minimum allowed value
- * @param max Maximum allowed value
- * @param field Field name for error messages
- * @param defaultValue Default value to use when validation fails
- * @returns number The validated value
- */
-function validateRange(value, min, max, field, defaultValue) {
-    const numValue = Number(value);
-    if (isNaN(numValue)) {
-        console.warn(`⚠️  Invalid ${field}: ${value}, using default: ${defaultValue}`);
-        return defaultValue;
-    }
-    if (numValue < min || numValue > max) {
-        console.warn(`⚠️  ${field} must be between ${min} and ${max}, got ${numValue}, using default: ${defaultValue}`);
-        return defaultValue;
-    }
-    return numValue;
-}

package/dist/config/stabilize.d.ts

@@ -14,7 +14,7 @@
  *   4. default       true
  */
 import type { Page } from '@playwright/test';
-import { TestivAIConfig, TestivAIProjectConfig } from '../types';
+import type { TestivAIConfig, TestivAIProjectConfig } from '../types';
 /**
  * CSS injected for the duration of the capture. Near-zero durations (not
  * `none`) let every animation/transition COMPLETE instantly at its final
@@ -33,3 +33,21 @@ export declare function resolveStabilize(projectRoot: string, projectConfig: Tes
  * a missing FontFaceSet API just means no wait.
  */
 export declare function waitForFonts(page: Page): Promise<void>;
+/**
+ * Wait until the page has stopped changing: document complete, images
+ * finished, fonts loaded, and no DOM mutations for `quietMs`.
+ *
+ * Deliberately NOT `networkidle` — Playwright's own docs mark that DISCOURAGED
+ * for testing, and it is the wrong signal for a visual snapshot: a page with
+ * analytics beacons never goes quiet, while a network-idle page can still be
+ * animating. What matters is whether the rendered page settled.
+ *
+ * Always bounded; a page that never settles yields a capture, not a hang.
+ */
+export declare function waitForSettled(page: {
+    evaluate: (expr: string) => Promise<unknown>;
+}, quietMs?: number, timeoutMs?: number): Promise<void>;
+/** Detach the settle observer so it does not linger on the page under test. */
+export declare function stopSettleObserver(page: {
+    evaluate: (expr: string) => Promise<unknown>;
+}): Promise<void>;

package/dist/config/stabilize.js

@@ -52,6 +52,9 @@ exports.STABILIZE_CSS = void 0;
 exports.readWitnessConfigStabilize = readWitnessConfigStabilize;
 exports.resolveStabilize = resolveStabilize;
 exports.waitForFonts = waitForFonts;
+exports.waitForSettled = waitForSettled;
+exports.stopSettleObserver = stopSettleObserver;
+const witness_1 = require("@testivai/witness");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 /**
@@ -110,3 +113,49 @@ async function waitForFonts(page) {
         // Page navigated or evaluate failed — capture proceeds unstabilized fonts
     }
 }
+/**
+ * Wait until the page has stopped changing: document complete, images
+ * finished, fonts loaded, and no DOM mutations for `quietMs`.
+ *
+ * Deliberately NOT `networkidle` — Playwright's own docs mark that DISCOURAGED
+ * for testing, and it is the wrong signal for a visual snapshot: a page with
+ * analytics beacons never goes quiet, while a network-idle page can still be
+ * animating. What matters is whether the rendered page settled.
+ *
+ * Always bounded; a page that never settles yields a capture, not a hang.
+ */
+async function waitForSettled(page, quietMs = witness_1.DEFAULT_QUIET_MS, timeoutMs = witness_1.DEFAULT_SETTLE_TIMEOUT_MS) {
+    const expr = (0, witness_1.buildSettleProbeExpression)(quietMs);
+    const deadline = Date.now() + timeoutMs;
+    for (;;) {
+        let state;
+        try {
+            state = (await page.evaluate(expr));
+        }
+        catch {
+            return; // probe unavailable — never block the capture
+        }
+        // An unusable answer means we cannot probe; polling to the timeout would
+        // add the full wait to every capture.
+        if (!state || typeof state.settled !== 'boolean')
+            return;
+        if (state.settled)
+            return;
+        if (Date.now() >= deadline) {
+            if (process.env.TESTIVAI_DEBUG === 'true') {
+                console.log(`[TestivAI] page did not settle within ${timeoutMs}ms — capturing anyway`);
+            }
+            return;
+        }
+        await new Promise((resolve) => setTimeout(resolve, 50));
+    }
+}
+/** Detach the settle observer so it does not linger on the page under test. */
+async function stopSettleObserver(page) {
+    try {
+        await page.evaluate(witness_1.SETTLE_STOP_EXPRESSION);
+    }
+    catch {
+        // best-effort cleanup
+    }
+}

package/dist/index.d.ts

@@ -1,8 +1,6 @@
 import { snapshot } from './snapshot';
-import { getCiRunId } from './ci';
 export { snapshot, snapshot as witness };
 export declare const testivai: {
     witness: typeof snapshot;
-    ci: typeof getCiRunId;
 };
-export type { TestivAIConfig, TestivAIProjectConfig, StructureAnalysisConfig, StructureAnalysis } from './types';
+export type { TestivAIConfig, TestivAIProjectConfig, IgnoreMode, IgnoreSelectorInput } from './types';

package/dist/index.js

@@ -4,10 +4,6 @@ exports.testivai = exports.witness = exports.snapshot = void 0;
 const snapshot_1 = require("./snapshot");
 Object.defineProperty(exports, "snapshot", { enumerable: true, get: function () { return snapshot_1.snapshot; } });
 Object.defineProperty(exports, "witness", { enumerable: true, get: function () { return snapshot_1.snapshot; } });
-const ci_1 = require("./ci");
 exports.testivai = {
     witness: snapshot_1.snapshot,
-    ci: ci_1.getCiRunId,
 };
-// Structure analyzer is now handled on the backend
-// The types are kept for backwards compatibility

package/dist/reporter.d.ts

@@ -1,9 +1,5 @@
-import { Reporter, FullConfig, Suite, FullResult } from './reporter-types';
-import { type CompressionOptions } from '@testivai/common';
+import type { Reporter, FullConfig, Suite, FullResult } from './reporter-types';
 interface TestivaiReporterOptions {
-    apiUrl?: string;
-    apiKey?: string;
-    compression?: CompressionOptions;
     debug?: boolean;
     /**
      * Capture only — write `.testivai/temp/` and skip comparison and report
@@ -23,13 +19,7 @@ interface TestivaiReporterOptions {
 }
 export declare class TestivAIPlaywrightReporter implements Reporter {
     private options;
-    private gitInfo;
-    private browserInfo;
-    private runId;
-    private ciInfo;
     private tempDir;
-    private compressionHelper;
-    private localMode;
     private captureOnly;
     private shard;
     constructor(options?: TestivaiReporterOptions);
@@ -40,7 +30,7 @@ export declare class TestivAIPlaywrightReporter implements Reporter {
      *   3. auto: Playwright says this is shard i/N with N > 1
      */
     private resolveCaptureOnly;
-    onBegin(config: FullConfig, suite: Suite): Promise<void>;
+    onBegin(config: FullConfig, _suite: Suite): Promise<void>;
     onEnd(result: FullResult): Promise<void>;
 }
 export default TestivAIPlaywrightReporter;