@argos-ci/cypress 2.0.5 → 2.1.0

package/dist/support.d.ts

@@ -8,6 +8,12 @@ type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & C
      * Custom CSS evaluated during the screenshot process.
      */
     argosCSS?: string;
+    /**
+     * Sensitivity threshold between 0 and 1.
+     * The higher the threshold, the less sensitive the diff will be.
+     * @default 0.5
+     */
+    threshold?: number;
 };
 declare global {
     namespace Cypress {
@@ -15,12 +21,20 @@ declare global {
             /**
              * Stabilize the UI and takes a screenshot of the application under test.
              *
-             * @see https://on.cypress.io/screenshot
+             * @see https://argos-ci.com/docs/cypress#api-overview
              * @example
              *    cy.argosScreenshot("my-screenshot")
              *    cy.get(".post").argosScreenshot()
              */
-            argosScreenshot: (name: string, options?: ArgosScreenshotOptions) => Chainable<null>;
+            argosScreenshot: (
+            /**
+             * Name of the screenshot. Must be unique.
+             */
+            name: string, 
+            /**
+             * Options for the screenshot.
+             */
+            options?: ArgosScreenshotOptions) => Chainable<null>;
         }
     }
 }

package/dist/support.mjs

@@ -1,8 +1,8 @@
 import 'cypress-wait-until';
 import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
-import { getScreenshotName, getMetadataPath } from '@argos-ci/util/browser';
+import { getScreenshotName, validateThreshold, getMetadataPath } from '@argos-ci/util/browser';
 
-var version = "2.0.4";
+var version = "2.0.5";
 
 function injectArgos() {
     cy.window({
@@ -96,6 +96,11 @@ Cypress.Commands.add("argosScreenshot", {
                     version
                 }
             };
+            metadata.transient = {};
+            if (options.threshold !== undefined) {
+                validateThreshold(options.threshold);
+                metadata.transient.threshold = options.threshold;
+            }
             cy.writeFile(getMetadataPath(ref.props.path), JSON.stringify(metadata));
         });
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Visual testing solution to avoid visual regression. Cypress commands and utilities for Argos visual testing.",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -43,15 +43,15 @@
   },
   "dependencies": {
     "@argos-ci/browser": "2.1.2",
-    "@argos-ci/core": "2.3.0",
-    "@argos-ci/util": "2.0.0",
+    "@argos-ci/core": "2.4.0",
+    "@argos-ci/util": "2.1.0",
     "cypress-wait-until": "^3.0.1"
   },
   "peerDependencies": {
     "cypress": "^12.0.0 || ^13.0.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.2.0",
+    "@argos-ci/cli": "2.3.0",
     "@argos-ci/cypress": "workspace:.",
     "@types/node": "^18.0.0",
     "cypress": "^13.7.2",
@@ -64,5 +64,5 @@
     "test": "pnpm exec cypress run",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "0c328bfcd6475ad625c0335cab11e912e856173c"
+  "gitHead": "aca82cf842a6d8310611a8594c581794df85cbd8"
 }