@argos-ci/puppeteer 1.1.5 → 1.2.0

package/dist/index.d.ts

@@ -9,6 +9,10 @@ type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omi
      * Viewports to take screenshots of.
      */
     viewports?: ViewportOption[];
+    /**
+     * Custom CSS evaluated during the screenshot process.
+     */
+    argosCSS?: string;
 };
-declare function argosScreenshot(page: Page, name: string, { element, viewports, ...options }?: ArgosScreenshotOptions): Promise<void>;
+declare function argosScreenshot(page: Page, name: string, { element, viewports, argosCSS, ...options }?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -8,6 +8,8 @@ const require = createRequire(import.meta.url);
 /**
  * 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({
@@ -37,7 +39,7 @@ async function getBrowserInfo(page) {
         browserVersion
     };
 }
-async function argosScreenshot(page, name, { element, viewports, ...options } = {}) {
+async function argosScreenshot(page, name, { element, viewports, argosCSS, ...options } = {}) {
     if (!page) {
         throw new Error("A Puppeteer `page` object is required.");
     }
@@ -55,10 +57,12 @@ async function argosScreenshot(page, name, { element, viewports, ...options } =
         injectArgos(page)
     ]);
     const fullPage = options.fullPage !== undefined ? options.fullPage : element === undefined;
-    await page.evaluate(({ fullPage })=>window.__ARGOS__.prepareForScreenshot({
-            fullPage
+    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
         }), {
-        fullPage
+        fullPage,
+        argosCSS
     });
     async function collectMetadata() {
         const [colorScheme, mediaType, puppeteerVersion, argosPuppeteerVersion, { browserName, browserVersion }] = await Promise.all([
@@ -123,20 +127,28 @@ async function argosScreenshot(page, name, { element, viewports, ...options } =
         await element.screenshot(screenshotOptions);
     }
     // 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.setViewport(viewportSize);
+            await stabilizeAndScreenshot(getScreenshotName(name, {
+                viewportWidth: viewportSize.width
+            }));
+        }
+        // Restore the original viewport
+        await page.setViewport(originalViewport);
+    } else {
         await stabilizeAndScreenshot(name);
-        return;
-    }
-    // Take screenshots for each viewport
-    for (const viewport of viewports){
-        const viewportSize = resolveViewport(viewport);
-        await page.setViewport(viewportSize);
-        await stabilizeAndScreenshot(getScreenshotName(name, {
-            viewportWidth: viewportSize.width
-        }));
     }
-    // Restore the original viewport
-    await page.setViewport(originalViewport);
+    // 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/puppeteer",
   "description": "Visual testing solution to avoid visual regression. Puppeteer commands and utilities for Argos visual testing.",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -40,7 +40,7 @@
     "puppeteer": ">=1"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.1.1",
+    "@argos-ci/browser": "1.2.0",
     "@argos-ci/util": "1.1.0"
   },
   "devDependencies": {
@@ -63,5 +63,5 @@
     "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-puppeteer-e2e-node-$NODE_VERSION-$OS\"",
     "e2e": "pnpm run test && pnpm run argos-upload"
   },
-  "gitHead": "494f49d03803bd8e958f00b7d8ab09a89c8eaf62"
+  "gitHead": "ad3ddc6e774f2b6e381259b4bfae72855326246b"
 }