@testivai/witness-playwright 0.1.0

package/src/types.ts

@@ -0,0 +1,193 @@
+/**
+ * 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
+ */
+
+/**
+ * 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;
+}
+
+/**
+ * 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
+ */
+export interface TestivAIProjectConfig {
+  /** Layout analysis settings */
+  layout: LayoutConfig;
+  /** AI analysis settings */
+  ai: AIConfig;
+  /** Environment-specific overrides (optional) */
+  environments?: EnvironmentConfig;
+}
+
+/**
+ * Per-test configuration overrides
+ */
+export interface TestivAIConfig {
+  /** Layout settings (optional - overrides project defaults) */
+  layout?: Partial<LayoutConfig>;
+  /** AI settings (optional - overrides project defaults) */
+  ai?: Partial<AIConfig>;
+  /** Element selectors to capture (existing option) */
+  selectors?: 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;
+}
+
+/**
+ * DOM snapshot data
+ */
+export interface DOMData {
+  /** Serialized HTML of the element */
+  html: string;
+  /** Computed styles (optional) */
+  styles?: Record<string, string>;
+}
+
+/**
+ * Snapshot payload for a single evidence capture
+ */
+export interface SnapshotPayload {
+  /** DOM data (HTML + styles) */
+  dom: DOMData;
+  /** 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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+

package/test-results/.last-run.json

@@ -0,0 +1,4 @@
+{
+  "status": "passed",
+  "failedTests": []
+}

package/tsconfig.jest.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": ["node", "jest"]
+  },
+  "include": ["__tests__/unit/**/*.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "types": ["node", "@playwright/test", "jest"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "__tests__"]
+}
+