@visual-regression-tracker/agent-cypress 5.6.0 → 5.7.0

package/.github/workflows/ci.yml

@@ -9,10 +9,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v1.4.4
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
 
       - name: Install npm dependencies
         run: npm ci

package/.github/workflows/release.yml

@@ -6,15 +6,18 @@ on:
 jobs:
   release:
     name: Release
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
+    
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
 
       - name: Install dependencies
         run: npm ci

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -6,13 +6,27 @@ Npm: https://www.npmjs.com/package/@visual-regression-tracker/agent-cypress
 
 ## Installation
 
+Please note that the minimum supported Cypress version is [`12.17.1`, released in 10th July 2023](https://docs.cypress.io/guides/references/changelog#12-17-1).
+
 ### Add package
 
 `npm install @visual-regression-tracker/agent-cypress`
 
-### Add command
+### Add commands
+
+`<rootDir>/cypress/support/e2e.js` or `<rootDir>/cypress/support/component.js`
+
+All available commands:
+
+```js
+import {
+  addVrtCommands,
+} from "@visual-regression-tracker/agent-cypress";
+
+addVrtCommands();
+```
 
-`<rootDir>/cypress/support/commands.js`
+or one by one:
 
 ```js
 import {
@@ -21,7 +35,7 @@ import {
   addVrtStopCommand,
   addVrtTrackBufferCommand,
   addVrtTrackBase64Command,
-} from "@visual-regression-tracker/agent-cypress/dist/commands";
+} from "@visual-regression-tracker/agent-cypress";
 
 addVrtStartCommand();
 addVrtStopCommand();
@@ -32,27 +46,32 @@ addVrtTrackBase64Command();
 
 ### Add plugin
 
-`<rootDir>/cypress/plugins/index.js`
+`<rootDir>/cypress.config.js`
 
 ```js
-const {
-  addVisualRegressionTrackerPlugin,
-} = require("@visual-regression-tracker/agent-cypress/dist/plugin");
-
-module.exports = (on, config) => {
-  addVisualRegressionTrackerPlugin(on, config);
-};
+import { defineConfig } from 'cypress';
+import { addVisualRegressionTrackerPlugin } from "@visual-regression-tracker/agent-cypress";
+
+export default defineConfig({
+  // e2e or component, depending of testing style
+  e2e: {
+    setupNodeEvents (on, config) => {
+      addVisualRegressionTrackerPlugin(on, config);
+    }
+  }
+});
 ```
 
 ### Configuration
 
-#### Update cypress config
+#### Update Cypress config
 
-`<rootDir>/cypress.json`
+`<rootDir>/cypress.config.js`
 
 ```js
-{
-  "env": {
+export default defineConfig({
+
+  env: {
     "visualRegressionTracker": {
       // URL where backend is running
       // Required
@@ -83,7 +102,7 @@ module.exports = (on, config) => {
       "ciBuildId": "SOME_UNIQUE_ID",
     }
   }
-}
+});
 ```
 
 #### Or, as JSON config file `vrt.json`

package/cypress.config.ts

@@ -0,0 +1,30 @@
+import { defineConfig } from 'cypress';
+import { addVisualRegressionTrackerPlugin } from "./lib/plugin";
+
+/**
+ * @see https://docs.cypress.io/guides/references/configuration
+ */
+export default defineConfig({
+    e2e: {
+        baseUrl: "https://example.cypress.io",
+        specPattern: 'cypress/integration/*.spec.ts',
+
+        setupNodeEvents(on, config) {
+            // `on` is used to hook into various events Cypress emits
+            // `config` is the resolved Cypress config
+            addVisualRegressionTrackerPlugin(on, config);
+        },
+    },
+    video: false,
+    screenshotOnRunFailure: false,
+    retries: 0,
+    env: {
+        "visualRegressionTracker": {
+          "apiUrl": "http://localhost:4200",
+          "apiKey": "5H90NFWM6BMWWDMWKG8T11DWW22Y",
+          "project": "fcf9ab05-4bed-40d6-a033-c178948c9897",
+          "branchName": "master",
+          "enableSoftAssert": false
+        }
+    }
+});

package/dist/commands.d.ts

@@ -3,3 +3,12 @@ export declare const addVrtStopCommand: () => void;
 export declare const addVrtTrackCommand: () => void;
 export declare const addVrtTrackBufferCommand: () => void;
 export declare const addVrtTrackBase64Command: () => void;
+/**
+ * Add all Visual Tracker commands to Cypress namespace, so that these methods become available:
+ * * `cy.vrtStart();`
+ * * `cy.vrtStop();`
+ * * `cy.vrtTrack();`
+ * * `cy.vrtTrackBuffer();`
+ * * `cy.vrtTrackBase64();`
+ */
+export declare const addVrtCommands: () => void;

package/dist/commands.js

@@ -1,55 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addVrtTrackBase64Command = exports.addVrtTrackBufferCommand = exports.addVrtTrackCommand = exports.addVrtStopCommand = exports.addVrtStartCommand = void 0;
+exports.addVrtCommands = exports.addVrtTrackBase64Command = exports.addVrtTrackBufferCommand = exports.addVrtTrackCommand = exports.addVrtStopCommand = exports.addVrtStartCommand = void 0;
 /* global Cypress, cy */
-var utils_1 = require("./utils");
-var addVrtStartCommand = function () {
-    Cypress.Commands.add("vrtStart", {
-        prevSubject: ["optional"],
-    }, function () {
-        cy.task("VRT_START", {}, { log: false })
+const utils_1 = require("./utils");
+const addVrtStartCommand = () => {
+    Cypress.Commands.add(utils_1.VRT_COMMAND_START, {
+        // optional: may start a chain, or use an existing chain: (dual command)
+        prevSubject: "optional",
+    }, () => {
+        cy.task(utils_1.VRT_TASK_START, {}, { log: false })
             .then(utils_1.handleError)
-            .then(function () { return (0, utils_1.log)("Started"); });
+            .then(() => (0, utils_1.log)("Started"));
     });
 };
 exports.addVrtStartCommand = addVrtStartCommand;
-var addVrtStopCommand = function () {
-    Cypress.Commands.add("vrtStop", {
-        prevSubject: ["optional"],
-    }, function () {
-        cy.task("VRT_STOP", {}, { log: false })
+const addVrtStopCommand = () => {
+    Cypress.Commands.add(utils_1.VRT_COMMAND_STOP, {
+        // optional: may start a chain, or use an existing chain: (dual command)
+        prevSubject: "optional",
+    }, () => {
+        cy.task(utils_1.VRT_TASK_STOP, {}, { log: false })
             .then(utils_1.handleError)
-            .then(function () { return (0, utils_1.log)("Stopped"); });
+            .then(() => (0, utils_1.log)("Stopped"));
     });
 };
 exports.addVrtStopCommand = addVrtStopCommand;
-var addVrtTrackCommand = function () {
-    return Cypress.Commands.add("vrtTrack", {
-        prevSubject: ["optional", "element", "window", "document"],
-    }, function (subject, name, options, errorCallback) {
-        (0, utils_1.trackImage)(subject, name, options).then(function (result) {
-            return (0, utils_1.checkResult)(result, errorCallback);
-        });
-    });
-};
+const addVrtTrackCommand = () => Cypress.Commands.add(utils_1.VRT_COMMAND_TRACK, {
+    // https://docs.cypress.io/api/cypress-api/custom-commands#Arguments
+    prevSubject: ["optional", "element", "window", "document"],
+}, // @ts-ignore
+(subject, name, options, errorCallback) => {
+    (0, utils_1.trackImage)(subject, name, options).then((result) => (0, utils_1.checkResult)(result, errorCallback));
+});
 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);
-        });
-    });
-};
+const addVrtTrackBufferCommand = () => Cypress.Commands.add(utils_1.VRT_COMMAND_TRACK_BUFFER, {
+    prevSubject: false,
+}, (name, imageBuffer, options) => {
+    (0, utils_1.trackBuffer)(name, imageBuffer, options).then((result) => (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);
-        });
-    });
-};
+const addVrtTrackBase64Command = () => Cypress.Commands.add(utils_1.VRT_COMMAND_TRACK_BASE64, {
+    prevSubject: false,
+}, (name, imageBase64, options) => {
+    (0, utils_1.trackBase64)(name, imageBase64, options).then((result) => (0, utils_1.checkResult)(result));
+});
 exports.addVrtTrackBase64Command = addVrtTrackBase64Command;
+/**
+ * Add all Visual Tracker commands to Cypress namespace, so that these methods become available:
+ * * `cy.vrtStart();`
+ * * `cy.vrtStop();`
+ * * `cy.vrtTrack();`
+ * * `cy.vrtTrackBuffer();`
+ * * `cy.vrtTrackBase64();`
+ */
+const addVrtCommands = () => {
+    (0, exports.addVrtStartCommand)();
+    (0, exports.addVrtStopCommand)();
+    (0, exports.addVrtTrackCommand)();
+    (0, exports.addVrtTrackBufferCommand)();
+    (0, exports.addVrtTrackBase64Command)();
+};
+exports.addVrtCommands = addVrtCommands;

package/dist/index.d.ts

@@ -1,47 +1,2 @@
-/// <reference types="cypress" />
-/// <reference types="node" />
-declare namespace Cypress {
-    interface Chainable {
-        /**
-         * Validate image against baseline
-         * @param name Image identifier.
-         * @param options An object that contains one or more additional properties.
-         *
-         * @example
-         *    cy.vrtTrack("name")
-         *    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,
-         *       keepScreenshot: false,
-         *    })
-         */
-        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
-            keepScreenshot?: boolean;
-        }>, errorCallback?: (err: string) => 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;
-        vrtStop(): null;
-    }
-    interface IgnoreArea {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }
-    interface TrackOptions {
-        viewport?: string;
-        os?: string;
-        device?: string;
-        customTags?: string;
-        diffTollerancePercent?: number;
-        ignoreAreas?: IgnoreArea[];
-        retryLimit?: number;
-    }
-}
+export { addVrtStartCommand, addVrtStopCommand, addVrtTrackCommand, addVrtTrackBufferCommand, addVrtTrackBase64Command, addVrtCommands, } from "./commands";
+export { addVisualRegressionTrackerPlugin } from "./plugin";

package/dist/index.js

@@ -1 +1,12 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addVisualRegressionTrackerPlugin = exports.addVrtCommands = exports.addVrtTrackBase64Command = exports.addVrtTrackBufferCommand = exports.addVrtTrackCommand = exports.addVrtStopCommand = exports.addVrtStartCommand = void 0;
+var commands_1 = require("./commands");
+Object.defineProperty(exports, "addVrtStartCommand", { enumerable: true, get: function () { return commands_1.addVrtStartCommand; } });
+Object.defineProperty(exports, "addVrtStopCommand", { enumerable: true, get: function () { return commands_1.addVrtStopCommand; } });
+Object.defineProperty(exports, "addVrtTrackCommand", { enumerable: true, get: function () { return commands_1.addVrtTrackCommand; } });
+Object.defineProperty(exports, "addVrtTrackBufferCommand", { enumerable: true, get: function () { return commands_1.addVrtTrackBufferCommand; } });
+Object.defineProperty(exports, "addVrtTrackBase64Command", { enumerable: true, get: function () { return commands_1.addVrtTrackBase64Command; } });
+Object.defineProperty(exports, "addVrtCommands", { enumerable: true, get: function () { return commands_1.addVrtCommands; } });
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "addVisualRegressionTrackerPlugin", { enumerable: true, get: function () { return plugin_1.addVisualRegressionTrackerPlugin; } });

package/dist/plugin.d.ts

@@ -1 +1,8 @@
-export function addVisualRegressionTrackerPlugin(on: any, config: any): void;
+/// <reference types="cypress" />
+/**
+ * Register task event handlers for Cypress.
+ * @param on
+ * @param config
+ * @see https://docs.cypress.io/api/commands/task
+ */
+export declare function addVisualRegressionTrackerPlugin(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions): void;

package/dist/plugin.js

@@ -8,105 +8,63 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addVisualRegressionTrackerPlugin = void 0;
-var fs_1 = require("fs");
-var sdk_js_1 = require("@visual-regression-tracker/sdk-js");
+const fs_1 = require("fs");
+const sdk_js_1 = require("@visual-regression-tracker/sdk-js");
+const utils_1 = require("./utils");
+/**
+ * Register task event handlers for Cypress.
+ * @param on
+ * @param config
+ * @see https://docs.cypress.io/api/commands/task
+ */
 function addVisualRegressionTrackerPlugin(on, config) {
     var _a;
-    var _this = this;
-    var _b;
-    var vrtConfig = (_b = config === null || config === void 0 ? void 0 : config.env) === null || _b === void 0 ? void 0 : _b.visualRegressionTracker;
-    var vrt = new sdk_js_1.VisualRegressionTracker(vrtConfig);
-    on("task", (_a = {},
-        _a["VRT_START"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var err_1;
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 3, , 4]);
-                        if (!!vrt["isStarted"]()) return [3 /*break*/, 2];
-                        return [4 /*yield*/, vrt.start()];
-                    case 1:
-                        _b.sent();
-                        _b.label = 2;
-                    case 2: return [3 /*break*/, 4];
-                    case 3:
-                        err_1 = _b.sent();
-                        return [2 /*return*/, (_a = err_1.message) !== null && _a !== void 0 ? _a : err_1];
-                    case 4: return [2 /*return*/, null];
+    const vrtConfig = (_a = config === null || config === void 0 ? void 0 : config.env) === null || _a === void 0 ? void 0 : _a.visualRegressionTracker;
+    const vrt = new sdk_js_1.VisualRegressionTracker(vrtConfig);
+    on("task", {
+        // Start visual regression tracking unless it has already been started
+        [utils_1.VRT_TASK_START]: (props) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            try {
+                if (!vrt[utils_1.VRT_IS_STARTED]()) {
+                    yield vrt.start();
                 }
-            });
-        }); },
-        _a["VRT_STOP"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var err_2;
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 3, , 4]);
-                        if (!vrt["isStarted"]()) return [3 /*break*/, 2];
-                        return [4 /*yield*/, vrt.stop()];
-                    case 1:
-                        _b.sent();
-                        _b.label = 2;
-                    case 2: return [3 /*break*/, 4];
-                    case 3:
-                        err_2 = _b.sent();
-                        return [2 /*return*/, (_a = err_2.message) !== null && _a !== void 0 ? _a : err_2];
-                    case 4: return [2 /*return*/, null];
+            }
+            catch (err) {
+                return (_b = err.message) !== null && _b !== void 0 ? _b : err;
+            }
+            return null;
+        }),
+        // Stop visual regression tracking if it was started
+        [utils_1.VRT_TASK_STOP]: (props) => __awaiter(this, void 0, void 0, function* () {
+            var _c;
+            try {
+                if (vrt[utils_1.VRT_IS_STARTED]()) {
+                    yield vrt.stop();
                 }
-            });
-        }); },
-        _a["VRT_TRACK"] = function (props) { return __awaiter(_this, void 0, void 0, function () {
-            var err_3;
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 2, 3, 4]);
-                        return [4 /*yield*/, vrt.track(props, props === null || props === void 0 ? void 0 : props.retryLimit)];
-                    case 1: return [2 /*return*/, _b.sent()];
-                    case 2:
-                        err_3 = _b.sent();
-                        return [2 /*return*/, (_a = err_3.message) !== null && _a !== void 0 ? _a : err_3];
-                    case 3:
-                        if (!props.keepScreenshot && props.imagePath) {
-                            (0, fs_1.unlinkSync)(props.imagePath);
-                        }
-                        return [7 /*endfinally*/];
-                    case 4: return [2 /*return*/];
+            }
+            catch (err) {
+                return (_c = err.message) !== null && _c !== void 0 ? _c : err;
+            }
+            return null;
+        }),
+        // Track the given test case and optionally clean up the screenshot
+        [utils_1.VRT_TASK_TRACK]: (props) => __awaiter(this, void 0, void 0, function* () {
+            var _d;
+            try {
+                return yield vrt.track(props, props === null || props === void 0 ? void 0 : props.retryLimit);
+            }
+            catch (err) {
+                return (_d = err.message) !== null && _d !== void 0 ? _d : err;
+            }
+            finally {
+                if (!props.keepScreenshot && props.imagePath) {
+                    (0, fs_1.unlinkSync)(props.imagePath);
                 }
-            });
-        }); },
-        _a));
+            }
+        }),
+    });
 }
 exports.addVisualRegressionTrackerPlugin = addVisualRegressionTrackerPlugin;

package/dist/types.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="cypress" />
+/// <reference types="node" />
+declare namespace Cypress {
+    interface Chainable {
+        /**
+         * Validate image against baseline
+         * @param name Image identifier.
+         * @param options An object that contains one or more additional properties.
+         *
+         * @example
+         *    cy.vrtTrack("name")
+         *    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,
+         *       keepScreenshot: false,
+         *    })
+         */
+        vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
+            keepScreenshot?: boolean;
+        }>, errorCallback?: (err: string) => 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;
+        vrtStop(): null;
+    }
+    interface IgnoreArea {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }
+    interface TrackOptions {
+        viewport?: string;
+        os?: string;
+        device?: string;
+        customTags?: string;
+        diffTollerancePercent?: number;
+        ignoreAreas?: IgnoreArea[];
+        retryLimit?: number;
+    }
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+/* global Cypress, cy */
+//export { }

package/dist/utils.d.ts

@@ -1,6 +1,15 @@
 /// <reference types="cypress" />
 /// <reference types="node" />
 import { TestRunResponse } from "@visual-regression-tracker/sdk-js";
+export declare const VRT_TASK_START = "VRT_START";
+export declare const VRT_TASK_STOP = "VRT_STOP";
+export declare const VRT_TASK_TRACK = "VRT_TRACK";
+export declare const VRT_COMMAND_START = "vrtStart";
+export declare const VRT_COMMAND_STOP = "vrtStop";
+export declare const VRT_COMMAND_TRACK = "vrtTrack";
+export declare const VRT_COMMAND_TRACK_BUFFER = "vrtTrackBuffer";
+export declare const VRT_COMMAND_TRACK_BASE64 = "vrtTrackBase64";
+export declare const VRT_IS_STARTED = "isStarted";
 export declare const log: (message: string) => Cypress.Log;
 export declare const handleError: (err: unknown) => void;
 export declare const toTestRunDto: ({ name, pixelRatio, options, }: {

package/dist/utils.js

@@ -1,39 +1,37 @@
 "use strict";
 /* global Cypress, cy */
-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);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackBase64 = exports.trackBuffer = exports.trackImage = exports.checkResult = exports.toTestRunDto = exports.handleError = exports.log = void 0;
-var log = function (message) {
-    return Cypress.log({
-        name: "Visual Regression Tracker",
-        displayName: "VRT",
-        message: message,
-    });
-};
+exports.trackBase64 = exports.trackBuffer = exports.trackImage = exports.checkResult = exports.toTestRunDto = exports.handleError = exports.log = exports.VRT_IS_STARTED = exports.VRT_COMMAND_TRACK_BASE64 = exports.VRT_COMMAND_TRACK_BUFFER = exports.VRT_COMMAND_TRACK = exports.VRT_COMMAND_STOP = exports.VRT_COMMAND_START = exports.VRT_TASK_TRACK = exports.VRT_TASK_STOP = exports.VRT_TASK_START = void 0;
+// Task names
+exports.VRT_TASK_START = "VRT_START";
+exports.VRT_TASK_STOP = "VRT_STOP";
+exports.VRT_TASK_TRACK = "VRT_TRACK";
+// Command names
+exports.VRT_COMMAND_START = "vrtStart";
+exports.VRT_COMMAND_STOP = "vrtStop";
+exports.VRT_COMMAND_TRACK = "vrtTrack";
+exports.VRT_COMMAND_TRACK_BUFFER = "vrtTrackBuffer";
+exports.VRT_COMMAND_TRACK_BASE64 = "vrtTrackBase64";
+// Private method name in sdk-js, FIXME: public?
+exports.VRT_IS_STARTED = "isStarted";
+const log = (message) => Cypress.log({
+    name: "Visual Regression Tracker",
+    displayName: "VRT",
+    message,
+});
 exports.log = log;
-var handleError = function (err) {
+const handleError = (err) => {
     if (err) {
         throw new Error(err);
     }
 };
 exports.handleError = handleError;
-var toTestRunDto = function (_a) {
-    var _b;
-    var name = _a.name, _c = _a.pixelRatio, pixelRatio = _c === void 0 ? 1 : _c, options = _a.options;
+const toTestRunDto = ({ name, pixelRatio = 1, options, }) => {
+    var _a;
     return ({
-        name: name,
+        name,
         browser: Cypress.browser.name,
-        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),
+        viewport: (_a = options === null || options === void 0 ? void 0 : options.viewport) !== null && _a !== void 0 ? _a : `${Cypress.config("viewportWidth") * pixelRatio}x${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,
@@ -45,7 +43,7 @@ var toTestRunDto = function (_a) {
     });
 };
 exports.toTestRunDto = toTestRunDto;
-var checkResult = function (result, errorCallback) {
+const checkResult = (result, errorCallback) => {
     if (typeof result === "string") {
         // . this is an error message
         if (errorCallback) {
@@ -57,29 +55,29 @@ var checkResult = function (result, errorCallback) {
     }
 };
 exports.checkResult = checkResult;
-var trackImage = function (subject, name, options) {
-    var imagePath;
-    var pixelRatio;
-    var target = subject ? cy.wrap(subject) : cy;
+const trackImage = (subject, name, options) => {
+    let imagePath;
+    let pixelRatio;
+    const target = subject ? cy.wrap(subject) : cy;
+    // cy.screenshot() return Type is always Chainable<null>
+    // https://github.com/cypress-io/cypress/issues/21277
     return target
-        .screenshot(name, __assign(__assign({}, options), { onAfterScreenshot: function (el, props) {
+        .screenshot(name, Object.assign(Object.assign({}, options), { onAfterScreenshot: ($el, props) => {
             imagePath = props.path;
             pixelRatio = props.pixelRatio;
             return options === null || options === void 0 ? void 0 : options.onAfterScreenshot;
-        } }))
-        .then(function () { return (0, exports.log)("tracking ".concat(name)); })
-        .then(function () {
-        return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, pixelRatio: pixelRatio, options: options })), { imagePath: imagePath }), { log: false });
-    });
+        } })) // @ts-ignore
+        .then(() => (0, exports.log)(`tracking ${name}`))
+        .then(() => cy.task(exports.VRT_TASK_TRACK, Object.assign(Object.assign({}, (0, exports.toTestRunDto)({ name, pixelRatio, options })), { imagePath }), { log: false }));
 };
 exports.trackImage = trackImage;
-var trackBuffer = function (name, imageBuffer, options) {
-    (0, exports.log)("tracking ".concat(name));
-    return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBuffer: imageBuffer }), { log: false });
+const trackBuffer = (name, imageBuffer, options) => {
+    (0, exports.log)(`tracking ${name}`);
+    return cy.task(exports.VRT_TASK_TRACK, Object.assign(Object.assign({}, (0, exports.toTestRunDto)({ name, options })), { imageBuffer }), { log: false });
 };
 exports.trackBuffer = trackBuffer;
-var trackBase64 = function (name, imageBase64, options) {
-    (0, exports.log)("tracking ".concat(name));
-    return cy.task("VRT_TRACK", __assign(__assign({}, (0, exports.toTestRunDto)({ name: name, options: options })), { imageBase64: imageBase64 }), { log: false });
+const trackBase64 = (name, imageBase64, options) => {
+    (0, exports.log)(`tracking ${name}`);
+    return cy.task(exports.VRT_TASK_TRACK, Object.assign(Object.assign({}, (0, exports.toTestRunDto)({ name, options })), { imageBase64 }), { log: false });
 };
 exports.trackBase64 = trackBase64;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.6.0",
-  "description": "Visual Regression Tracker integration plugin",
+  "version": "5.7.0",
+  "description": "Visual Regression Tracker integration plugin for Cypress",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/",
   "scripts": {
     "build": "tsc",
     "semantic-release": "semantic-release"
@@ -18,22 +18,28 @@
     "visual-regression-tracker"
   ],
   "author": "Pavel Strunkin <pashidlos@gmail.com>",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/Visual-Regression-Tracker/agent-cypress/issues"
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/agent-cypress#readme",
+  "engines": {
+    "node": ">=16.16.0"
+  },
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "5.6.0"
+    "@visual-regression-tracker/sdk-js": "5.7.0"
   },
   "devDependencies": {
-    "@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"
+    "@types/jest": "^29.5.3",
+    "@types/node": "^16.18.38",
+    "cypress": "^12.17.3",
+    "jest": "^29.6.1",
+    "semantic-release": "^21.0.7",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "cypress": ">=12.17.1"
   },
   "publishConfig": {
     "access": "public"