@visual-regression-tracker/agent-cypress 5.1.0 → 5.4.0

package/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v1.4.4
+        uses: actions/setup-node@v2
 
       - name: Install dependencies
         run: npm ci

package/README.md

@@ -132,9 +132,11 @@ 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,
+  keepScreenshot: false, // Keep screenshot local copy, false by default
 });
 ```
 

package/dist/index.d.ts

@@ -12,14 +12,18 @@ 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}
          *       ],
-         *       retryLimit: 5
+         *       retryLimit: 5,
+         *       keepScreenshot: false,
          *    })
          */
-        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
+        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
+            keepScreenshot?: boolean;
+        }>): Chainable<null>;
         vrtTrackBuffer(name: string, imageBuffer: Buffer, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
         vrtTrackBase64(name: string, imageBase64: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): Chainable<null>;
         vrtStart(): null;
@@ -35,6 +39,7 @@ declare namespace Cypress {
         viewport?: string;
         os?: string;
         device?: string;
+        customTags?: string;
         diffTollerancePercent?: number;
         ignoreAreas?: IgnoreArea[];
         retryLimit?: number;

package/dist/plugin.js

@@ -106,7 +106,9 @@ function addVisualRegressionTrackerPlugin(on, config) {
                         return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
                     case 1:
                         result = _a.sent();
-                        (0, fs_1.unlinkSync)(props.imagePath);
+                        if (!props.keepScreenshot) {
+                            (0, fs_1.unlinkSync)(props.imagePath);
+                        }
                         return [2 /*return*/, result];
                 }
             });

package/dist/utils.d.ts

@@ -13,10 +13,12 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     viewport: any;
     os: any;
     device: any;
+    customTags: any;
     diffTollerancePercent: any;
     ignoreAreas: any;
+    keepScreenshot: any;
 };
-export declare const trackWithRetry: (trackFn: () => Cypress.Chainable<TestRunResponse>, shouldStopFn: (result: TestRunResponse) => boolean, onStopFn: (result: TestRunResponse) => Cypress.Chainable<unknown>, retryLimit?: number) => Cypress.Chainable<unknown>;
+export declare const trackWithRetry: (trackFn: () => Cypress.Chainable<TestRunResponse>, shouldStopFn: (result: TestRunResponse) => boolean, onStopFn: (result: TestRunResponse) => Cypress.Chainable<unknown>, retryLimit?: number) => unknown;
 export declare const checkResult: (result: TestRunResponse) => Cypress.Chainable<unknown>;
 export declare const shouldStopRetry: (result: TestRunResponse) => boolean;
 export declare const trackImage: (subject: any, name: string, options: any) => Cypress.Chainable<TestRunResponse>;

package/dist/utils.js

@@ -34,11 +34,13 @@ var toTestRunDto = function (_a) {
     return ({
         name: name,
         browser: Cypress.browser.name,
-        viewport: (_b = options === null || options === void 0 ? void 0 : options.viewport) !== null && _b !== void 0 ? _b : Cypress.config("viewportWidth") * pixelRatio + "x" + Cypress.config("viewportHeight") * pixelRatio,
+        viewport: (_b = options === null || options === void 0 ? void 0 : options.viewport) !== null && _b !== void 0 ? _b : "".concat(Cypress.config("viewportWidth") * pixelRatio, "x").concat(Cypress.config("viewportHeight") * pixelRatio),
         os: options === null || options === void 0 ? void 0 : options.os,
         device: options === null || options === void 0 ? void 0 : options.device,
+        customTags: options === null || options === void 0 ? void 0 : options.customTags,
         diffTollerancePercent: options === null || options === void 0 ? void 0 : options.diffTollerancePercent,
         ignoreAreas: options === null || options === void 0 ? void 0 : options.ignoreAreas,
+        keepScreenshot: options === null || options === void 0 ? void 0 : options.keepScreenshot,
     });
 };
 exports.toTestRunDto = toTestRunDto;
@@ -49,7 +51,7 @@ var trackWithRetry = function (trackFn, shouldStopFn, onStopFn, retryLimit) {
             onStopFn(result);
             return;
         }
-        (0, exports.log)("Diff found... Remaining retry attempts **" + retryLimit + "**");
+        (0, exports.log)("Diff found... Remaining retry attempts **".concat(retryLimit, "**"));
         return (0, exports.trackWithRetry)(trackFn, shouldStopFn, onStopFn, retryLimit - 1);
     });
 };
@@ -72,19 +74,19 @@ var trackImage = function (subject, name, options) {
             pixelRatio = props.pixelRatio;
             return options === null || options === void 0 ? void 0 : options.onAfterScreenshot;
         } }))
-        .then(function () { return (0, exports.log)("tracking " + name); })
+        .then(function () { return (0, exports.log)("tracking ".concat(name)); })
         .then(function () {
         return cy.task("VRT_TRACK_IMAGE_MULTIPART", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, pixelRatio: pixelRatio, options: options })), { imagePath: imagePath }), { log: false });
     });
 };
 exports.trackImage = trackImage;
 var trackBuffer = function (name, imageBuffer, options) {
-    (0, exports.log)("tracking " + name);
+    (0, exports.log)("tracking ".concat(name));
     return cy.task("VRT_TRACK_BUFFER_MULTIPART", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBuffer: imageBuffer }), { log: false });
 };
 exports.trackBuffer = trackBuffer;
 var trackBase64 = function (name, imageBase64, options) {
-    (0, exports.log)("tracking " + name);
+    (0, exports.log)("tracking ".concat(name));
     return cy.task("VRT_TRACK_IMAGE_BASE64", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBase64: imageBase64 }), { log: false });
 };
 exports.trackBase64 = trackBase64;

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.1.0",
+  "version": "5.4.0",
   "description": "Visual Regression Tracker integration plugin",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "test": "cypress run --spec 'cypress/integration/regression.spec.ts'",
     "build": "tsc",
@@ -23,16 +25,16 @@
   },
   "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.3.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "@types/node": "^16.7.7",
-    "cypress": "^8.3.1",
-    "jest": "^26.6.3",
-    "semantic-release": "^17.4.7",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.4.2"
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.23",
+    "cypress": "^9.5.2",
+    "jest": "^27.5.1",
+    "semantic-release": "^19.0.2",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
   },
   "publishConfig": {
     "access": "public"