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

package/README.md

@@ -121,8 +121,6 @@ cy.vrtStart();
 
 ### Assert
 
-All `options` from `screenshot` command are also supported [more details](https://docs.cypress.io/api/commands/screenshot.html#Arguments)
-
 ```js
 cy.vrtTrack("Whole page with default params");
 
@@ -137,13 +135,24 @@ cy.vrtTrack("Whole page with additional options", {
   ignoreAreas: [{ x: 1, y: 2, width: 100, height: 200 }],
   retryLimit: 2,
   keepScreenshot: false, // Keep screenshot local copy, false by default
+}, (err)=>{
+  console.log('Screenshot has diff with baseline', err);
+  return true; // Skip failing test
 });
 ```
+##### options (optional)
+
+Allows to set options for taking screenshot. All `options` from `screenshot` command are also supported [more details](https://docs.cypress.io/api/commands/screenshot.html#Arguments)
 
 Viewport is taken from `Cypress.config()`, if option is not set
 
 Browser is taken from `Cypress.browser.name`
 
+##### errorCallbak (optional)
+Allows you to define a callback that receives the error for custom side-effects.
+
+Also allows to override assertion policy. When callback returns `true` this acts similar to `enableSoftAssertions` option in config, but allows to enable soft assertion only for one specific screenshot.
+
 ### Teadown
 
 ```js

package/dist/commands.js

@@ -26,8 +26,8 @@ exports.addVrtStopCommand = addVrtStopCommand;
 var addVrtTrackCommand = function () {
     return Cypress.Commands.add("vrtTrack", {
         prevSubject: ["optional", "element", "window", "document"],
-    }, function (subject, name, options) {
-        (0, utils_1.trackWithRetry)(function () { return (0, utils_1.trackImage)(subject, name, options); }, function (result) { return (0, utils_1.shouldStopRetry)(result); }, function (result) { return (0, utils_1.checkResult)(result); }, options === null || options === void 0 ? void 0 : options.retryLimit);
+    }, function (subject, name, options, errorCallback) {
+        (0, utils_1.trackWithRetry)(function () { return (0, utils_1.trackImage)(subject, name, options); }, function (result) { return (0, utils_1.shouldStopRetry)(result); }, function (result) { return (0, utils_1.checkResult)(result, errorCallback); }, options === null || options === void 0 ? void 0 : options.retryLimit);
     });
 };
 exports.addVrtTrackCommand = addVrtTrackCommand;

package/dist/index.d.ts

@@ -23,7 +23,7 @@ declare namespace Cypress {
          */
         vrtTrack(name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions & TrackOptions & {
             keepScreenshot?: boolean;
-        }>): Chainable<null>;
+        }>, 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;

package/dist/utils.d.ts

@@ -19,7 +19,7 @@ export declare const toTestRunDto: ({ name, pixelRatio, options, }: {
     keepScreenshot: any;
 };
 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 checkResult: (result: TestRunResponse, errorCallback?: ((err: string) => boolean) | undefined) => 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>;

package/dist/utils.js

@@ -56,9 +56,14 @@ var trackWithRetry = function (trackFn, shouldStopFn, onStopFn, retryLimit) {
     });
 };
 exports.trackWithRetry = trackWithRetry;
-var checkResult = function (result) {
-    return cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then(exports.handleError);
-};
+var checkResult = function (result, errorCallback) { return cy.task("VRT_PROCESS_ERROR_RESULT", result, { log: false }).then(function (err) {
+    if (err && errorCallback) {
+        if (errorCallback(err)) {
+            return;
+        }
+    }
+    (0, exports.handleError)(err);
+}); };
 exports.checkResult = checkResult;
 var shouldStopRetry = function (result) {
     return (result === null || result === void 0 ? void 0 : result.status) !== sdk_js_1.TestStatus.unresolved;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visual-regression-tracker/agent-cypress",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Visual Regression Tracker integration plugin",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",