@testivai/witness-cdp 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,329 @@
+/**
+ * Types for TestivAI CDP SDK
+ * Extends types from @testivai/common with CDP-specific additions
+ */
+import { TestivaiConfig } from '@testivai/common';
+/**
+ * CDP-specific configuration extending the base TestivaiConfig
+ */
+export interface CdpConfig extends TestivaiConfig {
+    /** Chrome DevTools Protocol port */
+    cdpPort?: number;
+    /** Project ID from TestivAI dashboard */
+    projectId?: string;
+    /** Auto-launch Chrome if not running */
+    autoLaunch?: boolean;
+    /** Chrome executable path (for auto-launch) */
+    chromePath?: string;
+    /** Additional Chrome launch arguments */
+    chromeArgs?: string[];
+    /** Timeout for CDP connections (ms) */
+    connectionTimeout?: number;
+    /** Retry attempts for CDP connection */
+    connectionRetries?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * 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;
+}
+/**
+ * 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>;
+}
+/**
+ * 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;
+}
+/**
+ * Unified Performance metrics for both Playwright and CDP SDKs
+ */
+export interface CDPerformanceMetrics {
+    /** CDP runtime metrics */
+    cdp?: {
+        Timestamp?: number;
+        Documents?: number;
+        Frames?: number;
+        JSEventListeners?: number;
+        Nodes?: number;
+        LayoutCount?: number;
+        RecalcStyleCount?: number;
+        LayoutDuration?: number;
+        RecalcStyleDuration?: number;
+        ScriptDuration?: number;
+        TaskDuration?: number;
+        JSHeapUsedSize?: number;
+        JSHeapTotalSize?: number;
+    };
+    /** Navigation timing and Web Vitals */
+    timing?: {
+        navigation?: {
+            type: number;
+            redirectCount: number;
+        };
+        timing?: {
+            navigationStart: number;
+            unloadEventStart: number;
+            unloadEventEnd: number;
+            redirectStart: number;
+            redirectEnd: number;
+            fetchStart: number;
+            domainLookupStart: number;
+            domainLookupEnd: number;
+            connectStart: number;
+            connectEnd: number;
+            secureConnectionStart: number;
+            requestStart: number;
+            responseStart: number;
+            responseEnd: number;
+            domLoading: number;
+            domInteractive: number;
+            domContentLoadedEventStart: number;
+            domContentLoadedEventEnd: number;
+            domComplete: number;
+            loadEventStart: number;
+            loadEventEnd: number;
+        };
+        webVitals?: {
+            firstContentfulPaint?: number;
+            largestContentfulPaint?: number;
+            cumulativeLayoutShift?: number;
+            firstInputDelay?: number;
+        };
+    };
+    /** Timestamp when metrics were captured */
+    timestamp?: number;
+}
+/**
+ * Performance timing metrics
+ * @deprecated Use CDPerformanceMetrics 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
+ */
+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;
+    };
+}
+/**
+ * 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?: {
+        computed_styles: Record<string, Record<string, string>>;
+    };
+    /** 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;
+    };
+    /** Screenshot data (base64) */
+    screenshotData?: string;
+    /** Performance metrics */
+    performanceMetrics?: CDPerformanceMetrics;
+}
+/**
+ * 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[];
+    /** 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;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * CDP connection information
+ */
+export interface CdpConnectionInfo {
+    /** WebSocket URL for CDP connection */
+    webSocketDebuggerUrl: string;
+    /** Chrome devtools URL */
+    devtoolsFrontendUrl: string;
+    /** Browser ID */
+    id: string;
+    /** Browser title */
+    title?: string;
+    /** Browser URL */
+    url?: string;
+    /** Browser version */
+    browserVersion?: string;
+    /** Protocol version */
+    protocolVersion?: string;
+    /** User agent */
+    userAgent?: string;
+    /** V8 version */
+    v8Version?: string;
+    /** WebKit version */
+    webKitVersion?: string;
+}
+/**
+ * Framework detection result
+ */
+export interface FrameworkDetection {
+    /** Detected framework */
+    framework: 'cypress' | 'webdriverio' | 'selenium-js' | 'selenium-python' | 'unknown';
+    /** Confidence level (0-1) */
+    confidence: number;
+    /** Evidence for detection */
+    evidence: string[];
+    /** Configuration files found */
+    configFiles: string[];
+    /** Instructions for setup */
+    instructions: string[];
+}
+/**
+ * Command execution result
+ */
+export interface CommandResult {
+    /** Exit code */
+    exitCode: number;
+    /** Signal that terminated the process */
+    signal: string | null;
+    /** Standard output */
+    stdout: string;
+    /** Standard error */
+    stderr: string;
+    /** Duration in milliseconds */
+    duration: number;
+}
+/**
+ * Batch upload result
+ */
+export interface BatchResult {
+    /** Batch ID */
+    batchId: string;
+    /** Number of snapshots uploaded */
+    snapshotCount: number;
+    /** Upload duration in milliseconds */
+    duration: number;
+    /** Dashboard URL */
+    dashboardUrl?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,cAAc;IAC/C,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,mBAAmB;IACnB,CAAC,EAAE,MAAM,CAAC;IACV,mBAAmB;IACnB,CAAC,EAAE,MAAM,CAAC;IACV,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,0BAA0B;IAC1B,GAAG,CAAC,EAAE;QACJ,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,uCAAuC;IACvC,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE;YACX,IAAI,EAAE,MAAM,CAAC;YACb,aAAa,EAAE,MAAM,CAAC;SACvB,CAAC;QACF,MAAM,CAAC,EAAE;YACP,eAAe,EAAE,MAAM,CAAC;YACxB,gBAAgB,EAAE,MAAM,CAAC;YACzB,cAAc,EAAE,MAAM,CAAC;YACvB,aAAa,EAAE,MAAM,CAAC;YACtB,WAAW,EAAE,MAAM,CAAC;YACpB,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,EAAE,MAAM,CAAC;YAC1B,eAAe,EAAE,MAAM,CAAC;YACxB,YAAY,EAAE,MAAM,CAAC;YACrB,UAAU,EAAE,MAAM,CAAC;YACnB,qBAAqB,EAAE,MAAM,CAAC;YAC9B,YAAY,EAAE,MAAM,CAAC;YACrB,aAAa,EAAE,MAAM,CAAC;YACtB,WAAW,EAAE,MAAM,CAAC;YACpB,UAAU,EAAE,MAAM,CAAC;YACnB,cAAc,EAAE,MAAM,CAAC;YACvB,0BAA0B,EAAE,MAAM,CAAC;YACnC,wBAAwB,EAAE,MAAM,CAAC;YACjC,WAAW,EAAE,MAAM,CAAC;YACpB,cAAc,EAAE,MAAM,CAAC;YACvB,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,SAAS,CAAC,EAAE;YACV,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAC9B,sBAAsB,CAAC,EAAE,MAAM,CAAC;YAChC,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC;KACH,CAAC;IACF,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8BAA8B;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8BAA8B;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,aAAa,CAAC,EAAE;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;KAAE,CAAC;IACrE,+BAA+B;IAC/B,MAAM,EAAE,UAAU,CAAC;IACnB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,+BAA+B;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sBAAsB;IACtB,GAAG,EAAE,OAAO,CAAC;IACb,kCAAkC;IAClC,OAAO,EAAE,WAAW,CAAC;IACrB,8BAA8B;IAC9B,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,qEAAqE;IACrE,EAAE,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC1B,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,0BAA0B;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uBAAuB;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,yBAAyB;IACzB,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,aAAa,GAAG,iBAAiB,GAAG,SAAS,CAAC;IACrF,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gCAAgC;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Types for TestivAI CDP SDK
+ * Extends types from @testivai/common with CDP-specific additions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/utils/file-naming.d.ts

@@ -0,0 +1,31 @@
+/**
+ * File naming utilities for TestivAI CDP SDK
+ * Converts snapshot names to safe filenames
+ */
+/**
+ * Convert a snapshot name to a safe filename
+ * - Replace spaces with hyphens
+ * - Remove or replace special characters
+ * - Limit length
+ * - Ensure it's not empty
+ */
+export declare function toSafeFilename(name: string): string;
+/**
+ * Generate a unique filename with timestamp
+ */
+export declare function generateUniqueFilename(name: string, extension?: string): string;
+/**
+ * Extract snapshot name from a URL
+ * Useful for auto-generating names from page URLs
+ */
+export declare function extractNameFromUrl(url: string): string;
+/**
+ * Sanitize a name for use in test names
+ * Less restrictive than filename sanitization
+ */
+export declare function sanitizeTestName(name: string): string;
+/**
+ * Check if a filename is safe
+ */
+export declare function isSafeFilename(filename: string): boolean;
+//# sourceMappingURL=file-naming.d.ts.map

package/dist/utils/file-naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-naming.d.ts","sourceRoot":"","sources":["../../src/utils/file-naming.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAwCnD;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,MAAW,GAAG,MAAM,CAMnF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CA6BtD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAoBrD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CA4BxD"}

package/dist/utils/file-naming.js

@@ -0,0 +1,137 @@
+"use strict";
+/**
+ * File naming utilities for TestivAI CDP SDK
+ * Converts snapshot names to safe filenames
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSafeFilename = toSafeFilename;
+exports.generateUniqueFilename = generateUniqueFilename;
+exports.extractNameFromUrl = extractNameFromUrl;
+exports.sanitizeTestName = sanitizeTestName;
+exports.isSafeFilename = isSafeFilename;
+/**
+ * Convert a snapshot name to a safe filename
+ * - Replace spaces with hyphens
+ * - Remove or replace special characters
+ * - Limit length
+ * - Ensure it's not empty
+ */
+function toSafeFilename(name) {
+    if (!name || typeof name !== 'string') {
+        return 'snapshot';
+    }
+    // Remove leading/trailing whitespace
+    let filename = name.trim();
+    // If empty after trimming, use default
+    if (!filename) {
+        return 'snapshot';
+    }
+    // Replace spaces and common separators with hyphens
+    filename = filename.replace(/[\s_\/\\]+/g, '-');
+    // Remove invalid filename characters (Windows-safe)
+    // Keep: letters, numbers, hyphens, dots, underscores, parentheses
+    filename = filename.replace(/[<>:"|?*]/g, '');
+    // Replace multiple consecutive hyphens with single hyphen
+    filename = filename.replace(/-+/g, '-');
+    // Remove leading/trailing hyphens and dots
+    filename = filename.replace(/^[-\.]+|[-\.]+$/g, '');
+    // Limit length (255 is max for most filesystems, leave room for extension)
+    if (filename.length > 200) {
+        filename = filename.substring(0, 200);
+        // Remove trailing hyphen if we cut in the middle
+        filename = filename.replace(/-$/, '');
+    }
+    // If still empty after cleaning, use default
+    if (!filename) {
+        return 'snapshot';
+    }
+    // Convert to lowercase for consistency
+    return filename.toLowerCase();
+}
+/**
+ * Generate a unique filename with timestamp
+ */
+function generateUniqueFilename(name, extension = '') {
+    const safeName = toSafeFilename(name);
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+    const uniqueName = `${safeName}-${timestamp}`;
+    return extension ? `${uniqueName}.${extension.replace(/^\./, '')}` : uniqueName;
+}
+/**
+ * Extract snapshot name from a URL
+ * Useful for auto-generating names from page URLs
+ */
+function extractNameFromUrl(url) {
+    try {
+        const urlObj = new URL(url);
+        const pathname = urlObj.pathname;
+        // Remove leading/trailing slashes
+        const cleanPath = pathname.replace(/^\/|\/$/g, '');
+        // If path is empty or just '/', use hostname
+        if (!cleanPath) {
+            return urlObj.hostname.replace(/\./g, '-');
+        }
+        // Convert path segments to name
+        const segments = cleanPath.split('/');
+        const lastSegment = segments[segments.length - 1];
+        // If last segment looks like an ID, use the parent
+        if (/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i.test(lastSegment) ||
+            /^\d+$/.test(lastSegment)) {
+            return segments[segments.length - 2] || 'page';
+        }
+        return lastSegment || 'page';
+    }
+    catch {
+        // If URL parsing fails, extract from string
+        const matches = url.match(/\/([^\/]+)\/?$/);
+        return matches ? matches[1] : 'page';
+    }
+}
+/**
+ * Sanitize a name for use in test names
+ * Less restrictive than filename sanitization
+ */
+function sanitizeTestName(name) {
+    if (!name || typeof name !== 'string') {
+        return 'test';
+    }
+    // Remove leading/trailing whitespace
+    let testName = name.trim();
+    // Replace multiple spaces with single space
+    testName = testName.replace(/\s+/g, ' ');
+    // Remove control characters
+    testName = testName.replace(/[\x00-\x1F\x7F]/g, '');
+    // Limit length
+    if (testName.length > 100) {
+        testName = testName.substring(0, 100);
+    }
+    return testName || 'test';
+}
+/**
+ * Check if a filename is safe
+ */
+function isSafeFilename(filename) {
+    if (!filename || typeof filename !== 'string') {
+        return false;
+    }
+    // Check for invalid characters
+    if (/[<>:"|?*]/.test(filename)) {
+        return false;
+    }
+    // Check reserved names (Windows)
+    const reservedNames = [
+        'CON', 'PRN', 'AUX', 'NUL',
+        'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9',
+        'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'
+    ];
+    const nameWithoutExt = filename.split('.')[0].toUpperCase();
+    if (reservedNames.includes(nameWithoutExt)) {
+        return false;
+    }
+    // Check length
+    if (filename.length > 255) {
+        return false;
+    }
+    return true;
+}
+//# sourceMappingURL=file-naming.js.map

package/dist/utils/file-naming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-naming.js","sourceRoot":"","sources":["../../src/utils/file-naming.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AASH,wCAwCC;AAKD,wDAMC;AAMD,gDA6BC;AAMD,4CAoBC;AAKD,wCA4BC;AAxJD;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,qCAAqC;IACrC,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAE3B,uCAAuC;IACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,oDAAoD;IACpD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IAEhD,oDAAoD;IACpD,kEAAkE;IAClE,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE9C,0DAA0D;IAC1D,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAExC,2CAA2C;IAC3C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAEpD,2EAA2E;IAC3E,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC1B,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACtC,iDAAiD;QACjD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,6CAA6C;IAC7C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,uCAAuC;IACvC,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,IAAY,EAAE,YAAoB,EAAE;IACzE,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,GAAG,QAAQ,IAAI,SAAS,EAAE,CAAC;IAE9C,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;AAClF,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,GAAW;IAC5C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAEjC,kCAAkC;QAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAEnD,6CAA6C;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7C,CAAC;QAED,gCAAgC;QAChC,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAElD,mDAAmD;QACnD,IAAI,iEAAiE,CAAC,IAAI,CAAC,WAAW,CAAC;YACnF,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC;QACjD,CAAC;QAED,OAAO,WAAW,IAAI,MAAM,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,4CAA4C;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACvC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,qCAAqC;IACrC,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAE3B,4CAA4C;IAC5C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEzC,4BAA4B;IAC5B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAEpD,eAAe;IACf,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC1B,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,QAAgB;IAC7C,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+BAA+B;IAC/B,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iCAAiC;IACjC,MAAM,aAAa,GAAG;QACpB,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK;QAC1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;QACtE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;KACvE,CAAC;IAEF,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5D,IAAI,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,eAAe;IACf,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/utils/framework-detect.d.ts

@@ -0,0 +1,31 @@
+import { FrameworkDetection } from '../types';
+/**
+ * Framework detection utility
+ */
+export declare class FrameworkDetector {
+    /**
+     * Detect the testing framework in use
+     */
+    static detect(): FrameworkDetection;
+    /**
+     * Detect Cypress
+     */
+    private static detectCypress;
+    /**
+     * Detect WebdriverIO
+     */
+    private static detectWebdriverIO;
+    /**
+     * Detect Selenium JS
+     */
+    private static detectSeleniumJS;
+    /**
+     * Detect Selenium Python
+     */
+    private static detectSeleniumPython;
+    /**
+     * Generate setup instructions for the detected framework
+     */
+    private static generateInstructions;
+}
+//# sourceMappingURL=framework-detect.d.ts.map

package/dist/utils/framework-detect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework-detect.d.ts","sourceRoot":"","sources":["../../src/utils/framework-detect.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,MAAM,CAAC,MAAM,IAAI,kBAAkB;IA4DnC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAuC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAiChC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA8C/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IA4CnC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAuHpC"}