Merge pull request #33 from AnglesHQ/visual-verification-methods

Add comparison algorithm options to screenshot compare methods

Author: snevesbarros

src/lib/models/requests/CompareOptions.ts

@@ -0,0 +1,8 @@
+export class CompareOptions {
+  /** Comparison algorithm: 'pixel' (default), 'ssim', or 'phash' (JSON endpoints only). */
+  algorithm?: 'pixel' | 'ssim' | 'phash';
+  /** Per-pixel colour-distance threshold (0-1, pixel algorithm only). Defaults to 0.5. */
+  threshold?: number;
+  /** When true (pixel algorithm only), changed pixels are clustered into regions. */
+  regions?: boolean;
+}

src/lib/models/response/ImageCompareResponse.ts

@@ -1,6 +1,23 @@
+export class DiffRegion {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  /** Number of changed pixels inside the region. */
+  pixels: number;
+}
+
 export class ImageCompareResponse {
+  /** Algorithm that produced this result: 'pixel', 'ssim', or 'phash'. */
+  algorithm?: string;
   isSameDimensions: boolean;
   rawMisMatchPercentage: number;
   misMatchPercentage: number;
   analysisTime: number;
-}
+  /** SSIM score in [-1, 1] (1 = identical); present when algorithm is 'ssim'. */
+  ssim?: number;
+  /** Normalised perceptual-hash distance (0-1); present when algorithm is 'phash'. */
+  distance?: number;
+  /** Clustered change regions; present when requested with regions=true (pixel only). */
+  regions?: DiffRegion[];
+}

src/lib/requests/ScreenshotRequests.ts

@@ -6,6 +6,7 @@ import { StoreScreenshot } from '../models/requests/StoreScreenshot';
 import { ImageCompareResponse } from '../models/response/ImageCompareResponse';
 import { ImageFindResponse } from '../models/response/ImageFindResponse';
 import { FindImageOptions } from '../models/requests/FindImageOptions';
+import { CompareOptions } from '../models/requests/CompareOptions';
 import {DefaultResponse} from "../models/response/DefaultResponse";
 
 export class ScreenshotRequests extends BaseRequests {
@@ -122,21 +123,39 @@ export class ScreenshotRequests extends BaseRequests {
     return this.get<Screenshot>(path);
   }
 
-  // TODO: Get screenshot compare Resemblejs JSON
+  /**
+   * Compares two stored screenshots and returns the comparison statistics.
+   * @param {CompareOptions} [options] - algorithm/threshold/regions
+   */
+  public compareScreenshots(screenshotId: string, screenshotCompareId: string, options?: CompareOptions): Promise<ImageCompareResponse> {
+    return this.get<ImageCompareResponse>(`screenshot/${screenshotId}/compare/${screenshotCompareId}`, {
+      params: options,
+    });
+  }
 
-  // TODO: get screenshot compare Resemblejs Image
+  /**
+   * Compares two stored screenshots and resolves with the diff image.
+   */
+  public compareScreenshotsImage(screenshotId: string, screenshotCompareId: string, cache?: boolean, options?: CompareOptions): Promise<AxiosResponse> {
+    return this.get<AxiosResponse>(`screenshot/${screenshotId}/compare/${screenshotCompareId}/image`, {
+      params: { useCache: cache || false, ...options },
+      responseType: 'arraybuffer',
+    });
+  }
 
-  public getBaselineCompareImage(screenshotId: string, cache: boolean): Promise<AxiosResponse> {
+  public getBaselineCompareImage(screenshotId: string, cache: boolean, options?: CompareOptions): Promise<AxiosResponse> {
     const useCache = cache || false;
     return this.get<AxiosResponse>(`screenshot/${screenshotId}/baseline/compare/image/`,
       {
-        params: { useCache },
+        params: { useCache, ...options },
         responseType: 'arraybuffer'
       });
   }
 
-  public getBaselineCompare(screenshotId: string) : Promise<ImageCompareResponse> {
-    return this.get<ImageCompareResponse>(`screenshot/${screenshotId}/baseline/compare/`);
+  public getBaselineCompare(screenshotId: string, options?: CompareOptions) : Promise<ImageCompareResponse> {
+    return this.get<ImageCompareResponse>(`screenshot/${screenshotId}/baseline/compare/`, {
+      params: options,
+    });
   }
 
   /**