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

package/.github/workflows/ci.yml

@@ -9,15 +9,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v5
         with:
-          node-version: 16
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
 
       - name: Build
         run: npm run build
+
+      - name: Unit tests
+        run: npm test

package/.github/workflows/release.yml

@@ -7,17 +7,22 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    
+    permissions:
+      contents: write # to publish a GitHub release
+      issues: write # to comment on released issues
+      pull-requests: write # to comment on released pull requests
+      id-token: write # to publish to npm with trusted publishing (OIDC) and provenance
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v5
         with:
-          node-version: 18
+          node-version: 22
 
       - name: Install dependencies
         run: npm ci

package/README.md

@@ -55,7 +55,7 @@ import { addVisualRegressionTrackerPlugin } from "@visual-regression-tracker/age
 export default defineConfig({
   // e2e or component, depending of testing style
   e2e: {
-    setupNodeEvents (on, config) => {
+    setupNodeEvents(on, config) {
       addVisualRegressionTrackerPlugin(on, config);
     }
   }
@@ -89,9 +89,10 @@ export default defineConfig({
       // Required
       "branchName": "develop",
 
-      // Branch with baseline
+      // Branch to take baselines from instead of the project's main branch
       // Optional - when not set, main branch from project settings is used
-      "baselineBranchName": "release",
+      // Also read from VRT_SOURCEBRANCH when not set here
+      "sourceBranch": "release",
 
       // Log errors instead of throwing exceptions
       // Optional - default false
@@ -117,6 +118,7 @@ _Is overriden if ENV variables are present_
   "apiKey": "tXZVHX0EA4YQM1MGDD",
   "ciBuildId": "commit_sha",
   "branchName": "develop",
+  "sourceBranch": "release",
   "enableSoftAssert": false
 }
 ```
@@ -131,10 +133,15 @@ VRT_PROJECT="Default project"
 VRT_APIKEY="tXZVHX0EA4YQM1MGDD"
 VRT_CIBUILDID="commit_sha"
 VRT_BRANCHNAME="develop"
-VRT_BASELINEBRANCHNAME="release"
+VRT_SOURCEBRANCH="release"
 VRT_ENABLESOFTASSERT=true
 ```
 
+`sourceBranch` replaces `baselineBranchName` (`VRT_BASELINEBRANCHNAME`), which
+the server never read. The old name still works as an alias and logs a
+deprecation warning; like the other `VRT_*` variables, `VRT_BASELINEBRANCHNAME`
+is read only when `visualRegressionTracker` is not set in the Cypress config.
+
 ## Usage
 
 ### Setup

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="cypress" />
+/// <reference types="cypress" preserve="true" />
 /**
  * Register task event handlers for Cypress.
  * @param on

package/dist/plugin.js

@@ -9,7 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addVisualRegressionTrackerPlugin = void 0;
+exports.addVisualRegressionTrackerPlugin = addVisualRegressionTrackerPlugin;
+/// <reference types="cypress" preserve="true" />
 const fs_1 = require("fs");
 const sdk_js_1 = require("@visual-regression-tracker/sdk-js");
 const utils_1 = require("./utils");
@@ -22,42 +23,45 @@ const utils_1 = require("./utils");
 function addVisualRegressionTrackerPlugin(on, config) {
     var _a;
     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);
+    // sdk-js skips VRT_* variables when given an explicit config
+    const vrt = new sdk_js_1.VisualRegressionTracker(vrtConfig && Object.assign(Object.assign({}, vrtConfig), { sourceBranch: vrtConfig.sourceBranch ||
+            vrtConfig.baselineBranchName ||
+            process.env.VRT_SOURCEBRANCH }));
     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;
+            var _a;
             try {
                 if (!vrt[utils_1.VRT_IS_STARTED]()) {
                     yield vrt.start();
                 }
             }
             catch (err) {
-                return (_b = err.message) !== null && _b !== void 0 ? _b : err;
+                return (_a = err.message) !== null && _a !== void 0 ? _a : 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;
+            var _a;
             try {
                 if (vrt[utils_1.VRT_IS_STARTED]()) {
                     yield vrt.stop();
                 }
             }
             catch (err) {
-                return (_c = err.message) !== null && _c !== void 0 ? _c : err;
+                return (_a = err.message) !== null && _a !== void 0 ? _a : 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;
+            var _a;
             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;
+                return (_a = err.message) !== null && _a !== void 0 ? _a : err;
             }
             finally {
                 if (!props.keepScreenshot && props.imagePath) {
@@ -67,4 +71,3 @@ function addVisualRegressionTrackerPlugin(on, config) {
         }),
     });
 }
-exports.addVisualRegressionTrackerPlugin = addVisualRegressionTrackerPlugin;

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="cypress" />
-/// <reference types="node" />
+/// <reference types="cypress" preserve="true" />
+/// <reference types="node" preserve="true" />
 declare namespace Cypress {
     interface Chainable {
         /**

package/dist/types.js

@@ -1,3 +1,5 @@
 "use strict";
+/// <reference types="cypress" preserve="true" />
+/// <reference types="node" preserve="true" />
 /* global Cypress, cy */
 //export { }

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="cypress" />
-/// <reference types="node" />
+/// <reference types="cypress" preserve="true" />
+/// <reference types="node" preserve="true" />
 import { TestRunResponse } from "@visual-regression-tracker/sdk-js";
 export declare const VRT_TASK_START = "VRT_START";
 export declare const VRT_TASK_STOP = "VRT_STOP";
@@ -14,7 +14,7 @@ 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 | undefined;
+    pixelRatio?: number;
     options: any;
 }) => {
     name: string;
@@ -28,7 +28,7 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     keepScreenshot: any;
     retryLimit: any;
 };
-export declare const checkResult: (result: TestRunResponse | string, errorCallback?: ((err: string) => boolean) | undefined) => void;
+export declare const checkResult: (result: TestRunResponse | string, errorCallback?: (err: string) => boolean) => void;
 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

@@ -1,4 +1,6 @@
 "use strict";
+/// <reference types="cypress" preserve="true" />
+/// <reference types="node" preserve="true" />
 /* global Cypress, cy */
 Object.defineProperty(exports, "__esModule", { value: true });
 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;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Visual Regression Tracker integration plugin for Cypress",
   "main": "dist/index.js",
   "types": "dist/",
   "scripts": {
     "build": "tsc",
+    "test": "jest",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -27,16 +28,17 @@
     "node": ">=16.16.0"
   },
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "5.7.0"
+    "@visual-regression-tracker/sdk-js": "^5.8.0"
   },
   "devDependencies": {
-    "@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"
+    "@jest/globals": "^30.5.2",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.20.5",
+    "cypress": "^16.2.0",
+    "jest": "^30.5.2",
+    "semantic-release": "^25.0.9",
+    "ts-jest": "^29.4.15",
+    "typescript": "^6.0.3"
   },
   "peerDependencies": {
     "cypress": ">=12.17.1"