@argos-ci/cypress 3.3.3 → 4.0.0

package/dist/support.d.ts

@@ -1,4 +1,4 @@
-import { ViewportOption, StabilizationOptions } from '@argos-ci/browser';
+import { ViewportOption, StabilizationPluginOptions } from '@argos-ci/browser';
 
 type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> & {
     /**
@@ -21,7 +21,7 @@ type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & C
      * Pass an object to customize the stabilization.
      * @default true
      */
-    stabilize?: boolean | StabilizationOptions;
+    stabilize?: boolean | StabilizationPluginOptions;
 };
 declare global {
     namespace Cypress {

package/dist/support.js

@@ -11,7 +11,7 @@ import {
 } from "@argos-ci/util/browser";
 
 // package.json
-var version = "3.3.2";
+var version = "3.4.0";
 
 // src/support.ts
 function injectArgos() {
@@ -22,31 +22,60 @@ function injectArgos() {
     window.eval(getGlobalScript());
   });
 }
-function setup(options) {
+function getStabilizationContext(options) {
   const { argosCSS } = options;
   const fullPage = !options.capture || options.capture === "fullPage";
+  return {
+    fullPage,
+    argosCSS,
+    options: options.stabilize
+  };
+}
+function beforeAll(options) {
+  const context = getStabilizationContext(options);
+  cy.window({ log: false }).then(
+    (window) => window.__ARGOS__.beforeAll(context)
+  );
+  return () => {
+    cy.window({ log: false }).then(
+      (window) => window.__ARGOS__.afterAll()
+    );
+  };
+}
+function beforeEach(options) {
+  const context = getStabilizationContext(options);
   cy.window({ log: false }).then(
-    (window) => window.__ARGOS__.setup({ fullPage, argosCSS })
+    (window) => window.__ARGOS__.beforeEach(context)
   );
   return () => {
     cy.window({ log: false }).then(
-      (window) => window.__ARGOS__.teardown({
-        fullPage,
-        argosCSS
-      })
+      (window) => window.__ARGOS__.afterEach()
     );
   };
 }
+function waitForReadiness(options) {
+  const context = getStabilizationContext(options);
+  cy.waitUntil(
+    () => cy.window({ log: false }).then((window) => {
+      const isStable = window.__ARGOS__.waitFor(
+        context
+      );
+      if (isStable) {
+        return true;
+      }
+      const failureReasons = window.__ARGOS__.getWaitFailureExplanations(context);
+      failureReasons.forEach((reason) => {
+        cy.log(`[argos] stability: ${reason}`);
+      });
+      return false;
+    })
+  );
+}
 Cypress.Commands.add(
   "argosScreenshot",
   { prevSubject: ["optional", "element", "window", "document"] },
   (subject, name, options = {}) => {
-    const {
-      viewports,
-      argosCSS: _argosCSS,
-      stabilize = true,
-      ...cypressOptions
-    } = options;
+    const { viewports, argosCSS: _argosCSS, ...cypressOptions } = options;
     if (!name) {
       throw new Error("The `name` argument is required.");
     }
@@ -56,24 +85,10 @@ Cypress.Commands.add(
       message: name
     });
     injectArgos();
-    const teardown = setup(options);
+    const afterAll = beforeAll(options);
     function stabilizeAndScreenshot(name2) {
-      if (stabilize) {
-        const stabilizationOptions = typeof stabilize === "object" ? stabilize : {};
-        cy.waitUntil(
-          () => cy.window({ log: false }).then((window) => {
-            const isStable = window.__ARGOS__.checkIsStable(stabilizationOptions);
-            if (isStable) {
-              return true;
-            }
-            const failureReasons = window.__ARGOS__.getStabilityFailureReasons(stabilizationOptions);
-            failureReasons.forEach((reason) => {
-              cy.log(`[argos] stability: ${reason}`);
-            });
-            return false;
-          })
-        );
-      }
+      waitForReadiness(options);
+      const afterEach = beforeEach(options);
       const ref = {};
       cy.wrap(subject).screenshot(name2, {
         blackout: ['[data-visual-test="blackout"]'].concat(
@@ -122,9 +137,7 @@ Cypress.Commands.add(
         }
         cy.writeFile(getMetadataPath(ref.props.path), JSON.stringify(metadata));
       });
-      cy.window({ log: false }).then((window) => {
-        window.__ARGOS__.afterEach();
-      });
+      afterEach();
     }
     if (viewports) {
       for (const viewport of viewports) {
@@ -141,6 +154,6 @@ Cypress.Commands.add(
     } else {
       stabilizeAndScreenshot(name);
     }
-    teardown();
+    afterAll();
   }
 );

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Cypress SDK for visual testing with Argos.",
-  "version": "3.3.3",
+  "version": "4.0.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -45,25 +45,27 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "3.1.3",
-    "@argos-ci/core": "3.1.0",
-    "@argos-ci/util": "2.3.0",
+    "@argos-ci/browser": "4.0.0",
+    "@argos-ci/core": "3.1.1",
+    "@argos-ci/util": "2.3.1",
     "cypress-wait-until": "^3.0.2"
   },
   "peerDependencies": {
     "cypress": "^12.0.0 || ^13.0.0 || ^14.0.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.5.5",
-    "@argos-ci/cypress": "workspace:.",
     "@types/node": "^18.19.44",
-    "cypress": "^14.0.0",
-    "eslint-plugin-cypress": "^4.1.0"
+    "cypress": "^14.2.0",
+    "eslint-plugin-cypress": "^4.2.0"
   },
   "scripts": {
     "build": "tsup",
-    "test": "pnpm exec cypress run",
-    "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
+    "test-e2e": "pnpm exec cypress run",
+    "build-e2e": "cypress install",
+    "e2e": "UPLOAD_TO_ARGOS=true pnpm run test-e2e",
+    "check-types": "tsc",
+    "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
+    "lint": "eslint ."
   },
-  "gitHead": "4f538068d5e42c378acdbaca292ab8cb1b49d031"
+  "gitHead": "6385df8f840714c9d77c52b2035bdbbc1b148791"
 }