feat: customTags optional field added (#157)

Author: Eduard-iCH

README.md

@@ -132,6 +132,7 @@ cy.vrtTrack("Whole page with additional options", {
   viewport: "1920x1080",
   os: "MacOS",
   device: "Cloud agent",
+  customTags: "Cloud, DarkTheme, Auth",
   diffTollerancePercent: 1,
   ignoreAreas: [{ x: 1, y: 2, width: 100, height: 200 }],
   retryLimit: 2,

cypress/integration/example.spec.js

@@ -32,6 +32,7 @@ context("Visual Regression Tracker", () => {
     cy.vrtTrack("With additional options", {
       os: "MacOS",
       device: "Cloud agent",
+      customTags: "Cloud, DarkTheme, Auth",
       diffTollerancePercent: 0,
       ignoreAreas: [
         {

lib/index.ts

@@ -10,6 +10,7 @@ declare namespace Cypress {
      *    cy.get("#id").vrtTrack("name", {
      *       os: "MacOS",
      *       device: "Cloud agent",
+     *       customTags: "Cloud, DarkTheme, Auth",
      *       diffTollerancePercent: 1.23,
      *       ignoreAreas: [
      *         {x: 1, y: 2, width: 100, height: 200}
@@ -56,6 +57,7 @@ declare namespace Cypress {
     viewport?: string;
     os?: string;
     device?: string;
+    customTags?: string;
     diffTollerancePercent?: number;
     ignoreAreas?: IgnoreArea[];
     retryLimit?: number;

lib/utils.ts

@@ -38,6 +38,7 @@ export const toTestRunDto = ({
     }`,
   os: options?.os,
   device: options?.device,
+  customTags: options?.customTags,
   diffTollerancePercent: options?.diffTollerancePercent,
   ignoreAreas: options?.ignoreAreas,
 });

package-lock.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/agent-cypress#readme",
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "5.1.1"
+    "@visual-regression-tracker/sdk-js": "5.2.0"
   },
   "devDependencies": {
     "@types/jest": "^26.0.24",