@visual-regression-tracker/agent-cypress 5.0.1 → 5.3.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

@@ -19,11 +19,15 @@ import {
   addVrtTrackCommand,
   addVrtStartCommand,
   addVrtStopCommand,
+  addVrtTrackBufferCommand,
+  addVrtTrackBase64Command,
 } from "@visual-regression-tracker/agent-cypress/dist/commands";
 
 addVrtStartCommand();
 addVrtStopCommand();
 addVrtTrackCommand();
+addVrtTrackBufferCommand();
+addVrtTrackBase64Command();
 ```
 
 ### Add plugin
@@ -128,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,

package/dist/commands.d.ts

@@ -1,3 +1,5 @@
 export declare const addVrtStartCommand: () => void;
 export declare const addVrtStopCommand: () => void;
 export declare const addVrtTrackCommand: () => void;
+export declare const addVrtTrackBufferCommand: () => void;
+export declare const addVrtTrackBase64Command: () => void;

package/dist/commands.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addVrtTrackCommand = exports.addVrtStopCommand = exports.addVrtStartCommand = void 0;
+exports.addVrtTrackBase64Command = exports.addVrtTrackBufferCommand = exports.addVrtTrackCommand = exports.addVrtStopCommand = exports.addVrtStartCommand = void 0;
 /* global Cypress, cy */
 var utils_1 = require("./utils");
 var addVrtStartCommand = function () {
@@ -31,3 +31,23 @@ var addVrtTrackCommand = function () {
     });
 };
 exports.addVrtTrackCommand = addVrtTrackCommand;
+var addVrtTrackBufferCommand = function () {
+    return Cypress.Commands.add("vrtTrackBuffer", {
+        prevSubject: false,
+    }, function (name, imageBuffer, options) {
+        (0, utils_1.trackBuffer)(name, imageBuffer, options).then(function (result) {
+            return (0, utils_1.checkResult)(result);
+        });
+    });
+};
+exports.addVrtTrackBufferCommand = addVrtTrackBufferCommand;
+var addVrtTrackBase64Command = function () {
+    return Cypress.Commands.add("vrtTrackBase64", {
+        prevSubject: false,
+    }, function (name, imageBase64, options) {
+        (0, utils_1.trackBase64)(name, imageBase64, options).then(function (result) {
+            return (0, utils_1.checkResult)(result);
+        });
+    });
+};
+exports.addVrtTrackBase64Command = addVrtTrackBase64Command;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="cypress" />
+/// <reference types="node" />
 declare namespace Cypress {
     interface Chainable {
         /**
@@ -11,6 +12,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}
@@ -19,6 +21,8 @@ declare namespace Cypress {
          *    })
          */
         vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions>): 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;
         vrtStop(): null;
     }
@@ -32,6 +36,7 @@ declare namespace Cypress {
         viewport?: string;
         os?: string;
         device?: string;
+        customTags?: string;
         diffTollerancePercent?: number;
         ignoreAreas?: IgnoreArea[];
         retryLimit?: number;

package/dist/plugin.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -87,24 +98,39 @@ function addVisualRegressionTrackerPlugin(on, config) {
             });
         }); },
         _a["VRT_TRACK_IMAGE_MULTIPART"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var name, imagePath, browser, viewport, os, device, diffTollerancePercent, ignoreAreas, result;
+            var data, result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        data = (0, sdk_js_1.multipartDtoToFormData)(__assign(__assign({}, props), { buildId: vrt.buildId, projectId: vrt.projectId, branchName: vrt.config.branchName }));
+                        return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
+                    case 1:
+                        result = _a.sent();
+                        (0, fs_1.unlinkSync)(props.imagePath);
+                        return [2 /*return*/, result];
+                }
+            });
+        }); },
+        _a["VRT_TRACK_BUFFER_MULTIPART"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
+            var data, result;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        name = props.name, imagePath = props.imagePath, browser = props.browser, viewport = props.viewport, os = props.os, device = props.device, diffTollerancePercent = props.diffTollerancePercent, ignoreAreas = props.ignoreAreas;
-                        return [4 /*yield*/, vrt["submitTestRunMultipart"]({
-                                name: name,
-                                imagePath: imagePath,
-                                browser: browser,
-                                viewport: viewport,
-                                os: os,
-                                device: device,
-                                diffTollerancePercent: diffTollerancePercent,
-                                ignoreAreas: ignoreAreas,
-                            })];
+                        data = (0, sdk_js_1.bufferDtoToFormData)(__assign(__assign({}, props), { buildId: vrt.buildId, projectId: vrt.projectId, branchName: vrt.config.branchName }));
+                        return [4 /*yield*/, vrt["submitTestRunMultipart"](data)];
+                    case 1:
+                        result = _a.sent();
+                        return [2 /*return*/, result];
+                }
+            });
+        }); },
+        _a["VRT_TRACK_IMAGE_BASE64"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, vrt["submitTestRunBase64"](props)];
                     case 1:
                         result = _a.sent();
-                        (0, fs_1.unlinkSync)(imagePath);
                         return [2 /*return*/, result];
                 }
             });

package/dist/utils.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="cypress" />
+/// <reference types="node" />
 import { TestRunResponse } from "@visual-regression-tracker/sdk-js";
 export declare const log: (message: string) => Cypress.Log;
 export declare const handleError: (err: unknown) => void;
 export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     name: string;
-    pixelRatio: number;
+    pixelRatio?: number | undefined;
     options: any;
 }) => {
     name: string;
@@ -12,10 +13,13 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     viewport: any;
     os: any;
     device: any;
+    customTags: any;
     diffTollerancePercent: any;
     ignoreAreas: 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>;
+export declare const trackBuffer: (name: string, imageBuffer: Buffer, options: any) => Cypress.Chainable<TestRunResponse>;
+export declare const trackBase64: (name: string, imageBase64: string, options: any) => Cypress.Chainable<TestRunResponse>;

package/dist/utils.js

@@ -12,7 +12,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackImage = exports.shouldStopRetry = exports.checkResult = exports.trackWithRetry = exports.toTestRunDto = exports.handleError = exports.log = void 0;
+exports.trackBase64 = exports.trackBuffer = exports.trackImage = exports.shouldStopRetry = exports.checkResult = exports.trackWithRetry = exports.toTestRunDto = exports.handleError = exports.log = void 0;
 var sdk_js_1 = require("@visual-regression-tracker/sdk-js");
 var log = function (message) {
     return Cypress.log({
@@ -30,13 +30,14 @@ var handleError = function (err) {
 exports.handleError = handleError;
 var toTestRunDto = function (_a) {
     var _b;
-    var name = _a.name, pixelRatio = _a.pixelRatio, options = _a.options;
+    var name = _a.name, _c = _a.pixelRatio, pixelRatio = _c === void 0 ? 1 : _c, options = _a.options;
     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,
     });
@@ -49,7 +50,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,9 +73,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 ".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 ".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.0.1",
+  "version": "5.3.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.0.0"
+    "@visual-regression-tracker/sdk-js": "5.3.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "@types/node": "^16.7.7",
-    "cypress": "^7.7.0",
-    "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"