@argos-ci/playwright 1.3.1 → 1.4.0

package/dist/index.d.ts

@@ -11,6 +11,10 @@ type ArgosScreenshotOptions = {
      * Viewports to take screenshots of.
      */
     viewports?: ViewportOption[];
+    /**
+     * Custom CSS evaluated during the screenshot process.
+     */
+    argosCSS?: string;
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
-declare function argosScreenshot(page: Page, name: string, { element, has, hasText, viewports, ...options }?: ArgosScreenshotOptions): Promise<void>;
+declare function argosScreenshot(page: Page, name: string, { element, has, hasText, viewports, argosCSS, ...options }?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -80,6 +80,8 @@ const screenshotFolder = "./screenshots";
 /**
  * Inject Argos script into the page.
  */ async function injectArgos(page) {
+    const injected = await page.evaluate(()=>typeof window.__ARGOS__ !== "undefined");
+    if (injected) return;
     const fileName = require.resolve("@argos-ci/browser/global.js");
     const content = await readFile(fileName, "utf-8");
     await page.addScriptTag({
@@ -101,7 +103,7 @@ function getViewportSize(page) {
     }
     return viewportSize;
 }
-async function argosScreenshot(page, name, { element, has, hasText, viewports, ...options } = {}) {
+async function argosScreenshot(page, name, { element, has, hasText, viewports, argosCSS, ...options } = {}) {
     if (!page) {
         throw new Error("A Playwright `page` object is required.");
     }
@@ -124,10 +126,12 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, .
     ]);
     const originalViewportSize = getViewportSize(page);
     const fullPage = options.fullPage !== undefined ? options.fullPage : handle === page;
-    await page.evaluate(({ fullPage })=>window.__ARGOS__.prepareForScreenshot({
-            fullPage
+    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
         }), {
-        fullPage
+        fullPage,
+        argosCSS
     });
     async function collectMetadata(testInfo) {
         const [colorScheme, mediaType, libMetadata, testMetadata] = await Promise.all([
@@ -196,20 +200,28 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, .
         }
     }
     // If no viewports are specified, take a single screenshot
-    if (!viewports) {
+    if (viewports) {
+        // Take screenshots for each viewport
+        for (const viewport of viewports){
+            const viewportSize = resolveViewport(viewport);
+            await page.setViewportSize(viewportSize);
+            await stabilizeAndScreenshot(getScreenshotName(name, {
+                viewportWidth: viewportSize.width
+            }));
+        }
+        // Restore the original viewport size
+        await page.setViewportSize(originalViewportSize);
+    } else {
         await stabilizeAndScreenshot(name);
-        return;
-    }
-    // Take screenshots for each viewport
-    for (const viewport of viewports){
-        const viewportSize = resolveViewport(viewport);
-        await page.setViewportSize(viewportSize);
-        await stabilizeAndScreenshot(getScreenshotName(name, {
-            viewportWidth: viewportSize.width
-        }));
     }
-    // Restore the original viewport size
-    await page.setViewportSize(originalViewportSize);
+    // Teardown Argos
+    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.teardown({
+            fullPage,
+            argosCSS
+        }), {
+        fullPage,
+        argosCSS
+    });
 }
 
 export { argosScreenshot };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/playwright",
   "description": "Visual testing solution to avoid visual regression. Playwright commands and utilities for Argos visual testing.",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -42,7 +42,7 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.1.0",
+    "@argos-ci/browser": "1.2.0",
     "@argos-ci/core": "1.3.0",
     "@argos-ci/util": "1.1.0"
   },
@@ -58,5 +58,5 @@
     "test": "pnpm exec playwright test",
     "e2e": "WITH_ARGOS_REPORTER=true pnpm run test"
   },
-  "gitHead": "8022e7391f8bd156e23a83b5da0ce452e28e324e"
+  "gitHead": "ad3ddc6e774f2b6e381259b4bfae72855326246b"
 }