chore(release): 1.1.0 [skip ci]

# [1.1.0](v1.0.2...v1.1.0) (2022-11-03)

### Bug Fixes

* **deps:** update all non-major dependencies ([FRSOURCE#165](https://github.com/braze-inc/cypress-plugin-visual-regression-diff/issues/165)) ([602640f](602640f))
* ts declaration generation ([1a1e0cc](1a1e0cc))
* typings for older typescript ([FRSOURCE#170](https://github.com/braze-inc/cypress-plugin-visual-regression-diff/issues/170)) ([96499ec](96499ec)), closes [FRSOURCE#167](https://github.com/braze-inc/cypress-plugin-visual-regression-diff/issues/167)

### Features

* support Cypress retries functionality ([FRSOURCE#171](https://github.com/braze-inc/cypress-plugin-visual-regression-diff/issues/171)) ([7d7d010](7d7d010)), closes [FRSOURCE#168](https://github.com/braze-inc/cypress-plugin-visual-regression-diff/issues/168)

Author: semantic-release-bot

dist/plugins.js

@@ -34,7 +34,7 @@ const PATH_VARIABLES = {
 const WINDOWS_LIKE_DRIVE_REGEX = /^[A-Z]:$/;
 const METADATA_KEY = "FRSOURCE_CPVRD_V";
 
-var version = "3.0.1";
+var version = "3.1.0";
 
 function isHighSurrogate(codePoint) {
   return codePoint >= 0xd800 && codePoint <= 0xdbff;
@@ -143,7 +143,8 @@ const nameCacheCounter = {};
 const generateScreenshotPath = ({
   titleFromOptions,
   imagesPath,
-  specPath
+  specPath,
+  currentRetryNumber
 }) => {
   const parsePathPartVariables = (pathPart, i) => {
     if (pathPart === PATH_VARIABLES.specPath) {
@@ -163,6 +164,11 @@ const generateScreenshotPath = ({
 
   if (typeof nameCacheCounter[screenshotPath] === "undefined") {
     nameCacheCounter[screenshotPath] = -1;
+  } // it's a retry of the same image, so let's decrease the counter
+
+
+  if (currentRetryNumber > 0) {
+    --nameCacheCounter[screenshotPath];
   }
 
   return path.join(IMAGE_SNAPSHOT_PREFIX, `${screenshotPath} #${++nameCacheCounter[screenshotPath]}${FILE_SUFFIX.actual}.png`);

dist/plugins.js.map

@@ -66,7 +66,8 @@ const getConfig = options => {
     maxDiffThreshold: options.maxDiffThreshold || Cypress.env("pluginVisualRegressionMaxDiffThreshold") || 0.01,
     diffConfig: options.diffConfig || Cypress.env("pluginVisualRegressionDiffConfig") || {},
     screenshotConfig: options.screenshotConfig || Cypress.env("pluginVisualRegressionScreenshotConfig") || {},
-    remoteScreenshotServiceUrl: options.remoteScreenshotServiceUrl || Cypress.env("pluginVisualRegressionRemoteScreenshotServiceUrl")
+    remoteScreenshotServiceUrl: options.remoteScreenshotServiceUrl || Cypress.env("pluginVisualRegressionRemoteScreenshotServiceUrl"),
+    matchAgainstPath: options.matchAgainstPath || undefined
   };
 };
 Cypress.Commands.add("matchImage", {
@@ -81,12 +82,15 @@ Cypress.Commands.add("matchImage", {
     maxDiffThreshold,
     diffConfig,
     screenshotConfig,
-    remoteScreenshotServiceUrl
+    remoteScreenshotServiceUrl,
+    matchAgainstPath
   } = getConfig(options);
+  const currentRetryNumber = cy.state("test").currentRetry();
   return cy.then(() => cy.task(TASK.getScreenshotPathInfo, {
     titleFromOptions: options.title || Cypress.currentTest.titlePath.join(" "),
     imagesPath,
-    specPath: Cypress.spec.relative
+    specPath: Cypress.spec.relative,
+    currentRetryNumber
   }, {
     log: false
   })).then(({
@@ -129,7 +133,7 @@ Cypress.Commands.add("matchImage", {
   }).then(imgPath => cy.task(TASK.compareImages, {
     scaleFactor,
     imgNew: imgPath,
-    imgOld: imgPath.replace(FILE_SUFFIX.actual, ""),
+    imgOld: matchAgainstPath || imgPath.replace(FILE_SUFFIX.actual, ""),
     updateImages,
     maxDiffThreshold,
     diffConfig
@@ -166,6 +170,19 @@ Cypress.Commands.add("matchImage", {
       log.set("consoleProps", () => res);
       throw constructCypressError(log, new Error(res.message));
     }
+
+    return {
+      diffValue: res.imgDiff,
+      imgNewPath: imgPath,
+      imgPath: imgPath.replace(FILE_SUFFIX.actual, ""),
+      imgDiffPath: imgPath.replace(FILE_SUFFIX.actual, FILE_SUFFIX.diff),
+      imgNewBase64: res.imgNewBase64,
+      imgBase64: res.imgOldBase64,
+      imgDiffBase64: res.imgDiffBase64,
+      imgNew: typeof res.imgNewBase64 === "string" ? Cypress.Buffer.from(res.imgNewBase64, "base64") : undefined,
+      img: typeof res.imgOldBase64 === "string" ? Cypress.Buffer.from(res.imgOldBase64, "base64") : undefined,
+      imgDiff: typeof res.imgDiffBase64 === "string" ? Cypress.Buffer.from(res.imgDiffBase64, "base64") : undefined
+    };
   });
 });