Merge pull request #45 from Visual-Regression-Tracker/44-ignorearea

Add ignoreAreas into testRun payload #44

Author: pashidlos

README.md

@@ -51,6 +51,12 @@ const vrt = new VisualRegressionTracker(config);
 vrt.start();
 ```
 
+### Teardown
+
+```js
+vrt.stop();
+```
+
 ### Assert
 
 ```js
@@ -78,11 +84,27 @@ await vrt.track({
 
   // Optional
   device: "PC",
-});
-```
-
-### Teardown
 
-```js
-vrt.stop();
+  // Array of areas to be ignored
+  // Optional
+  ignoreAreas: [
+    {
+      // X-coordinate relative of left upper corner
+      // Required
+      x: 10;
+
+      // Y-coordinate relative of left upper corner
+      // Required
+      y: 20;
+
+      // Area width in px
+      // Required
+      width: 300;
+
+      // Height width in px
+      // Required
+      height: 400;
+    }
+  ]
+});
 ```

lib/types/ignoreArea.ts

@@ -0,0 +1,6 @@
+export interface IgnoreArea {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}

lib/types/index.ts

@@ -3,3 +3,4 @@ export * from "./testRun";
 export * from "./response/buildResponse";
 export * from "./response/testRunResponse";
 export * from "./testStatus";
+export * from "./ignoreArea";

lib/types/testRun.ts

@@ -1,3 +1,5 @@
+import { IgnoreArea } from "./ignoreArea";
+
 export interface TestRun {
   name: string;
   imageBase64: string;
@@ -6,4 +8,5 @@ export interface TestRun {
   viewport?: string;
   device?: string;
   diffTollerancePercent?: number;
+  ignoreAreas?: IgnoreArea[];
 }

lib/visualRegressionTracker.spec.ts

@@ -259,6 +259,14 @@ describe("VisualRegressionTracker", () => {
         device: "device",
         viewport: "viewport",
         browser: "browser",
+        ignoreAreas: [
+          {
+            x: 1,
+            y: 2,
+            height: 300,
+            width: 400,
+          },
+        ],
       };
       const buildId = "1312";
       const projectId = "asd";
@@ -281,6 +289,7 @@ describe("VisualRegressionTracker", () => {
           device: testRun.device,
           viewport: testRun.viewport,
           browser: testRun.browser,
+          ignoreAreas: testRun.ignoreAreas,
         },
         {
           headers: {