@argos-ci/cypress 1.1.2 → 1.2.0

package/dist/support.d.ts

@@ -11,7 +11,14 @@ declare global {
              *    cy.get(".post").argosScreenshot()
              */
             argosScreenshot: (name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions> & {
+                /**
+                 * Viewports to take screenshots of.
+                 */
                 viewports?: ViewportOption[];
+                /**
+                 * Custom CSS evaluated during the screenshot process.
+                 */
+                argosCSS?: string;
             }) => Chainable<null>;
         }
     }

package/dist/support.mjs

@@ -3,12 +3,15 @@ import { resolveViewport } from '@argos-ci/browser';
 import { getScreenshotName, getMetadataPath } from '@argos-ci/util/browser';
 
 function injectArgos() {
-    const fileName = typeof require.resolve === "function" ? require.resolve("@argos-ci/browser/global.js") : "node_modules/@argos-ci/browser/dist/global.js";
-    cy.readFile(fileName).then((source)=>cy.window({
-            log: false
-        }).then((window)=>{
+    cy.window({
+        log: false
+    }).then((window)=>{
+        if (typeof window.__ARGOS__ !== "undefined") return;
+        const fileName = typeof require.resolve === "function" ? require.resolve("@argos-ci/browser/global.js") : "node_modules/@argos-ci/browser/dist/global.js";
+        return cy.readFile(fileName).then((source)=>{
             window.eval(source);
-        }));
+        });
+    });
 }
 function readArgosCypressVersion() {
     const fileName = typeof require.resolve === "function" ? require.resolve("@argos-ci/cypress/package.json") : "node_modules/@argos-ci/cypress/package.json";
@@ -23,7 +26,7 @@ Cypress.Commands.add("argosScreenshot", {
         "window",
         "document"
     ]
-}, (subject, name, { viewports, ...options } = {})=>{
+}, (subject, name, { viewports, argosCSS, ...options } = {})=>{
     if (!name) {
         throw new Error("The `name` argument is required.");
     }
@@ -36,8 +39,9 @@ Cypress.Commands.add("argosScreenshot", {
     const fullPage = !options.capture || options.capture === "fullPage";
     cy.window({
         log: false
-    }).then((window)=>window.__ARGOS__.prepareForScreenshot({
-            fullPage
+    }).then((window)=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
         }));
     function stabilizeAndScreenshot(name) {
         cy.waitUntil(()=>cy.window({
@@ -88,17 +92,24 @@ Cypress.Commands.add("argosScreenshot", {
             });
         });
     }
-    if (!viewports) {
+    if (viewports) {
+        for (const viewport of viewports){
+            const viewportSize = resolveViewport(viewport);
+            cy.viewport(viewportSize.width, viewportSize.height);
+            stabilizeAndScreenshot(getScreenshotName(name, {
+                viewportWidth: viewportSize.width
+            }));
+        }
+        // Restore the original viewport
+        cy.viewport(Cypress.config("viewportWidth"), Cypress.config("viewportHeight"));
+    } else {
         stabilizeAndScreenshot(name);
-        return;
     }
-    for (const viewport of viewports){
-        const viewportSize = resolveViewport(viewport);
-        cy.viewport(viewportSize.width, viewportSize.height);
-        stabilizeAndScreenshot(getScreenshotName(name, {
-            viewportWidth: viewportSize.width
+    // Teardown Argos
+    cy.window({
+        log: false
+    }).then((window)=>window.__ARGOS__.teardown({
+            fullPage,
+            argosCSS
         }));
-    }
-    // Restore the original viewport
-    cy.viewport(Cypress.config("viewportWidth"), Cypress.config("viewportHeight"));
 });

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": "1.1.2",
+  "version": "1.2.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -36,7 +36,7 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.1.1",
+    "@argos-ci/browser": "1.2.0",
     "@argos-ci/util": "1.1.0",
     "cypress-wait-until": "^1.7.2"
   },
@@ -58,5 +58,5 @@
     "argos-upload": "pnpm exec argos upload cypress/screenshots --build-name \"argos-cypress-e2e-node-$NODE_VERSION-$OS\"",
     "e2e": "pnpm run test && pnpm run argos-upload"
   },
-  "gitHead": "27c07b619069353c2a8c8c98203b9c27b4e2bed0"
+  "gitHead": "ad3ddc6e774f2b6e381259b4bfae72855326246b"
 }