@argos-ci/puppeteer 1.5.0 → 1.6.0

package/dist/index.d.ts

@@ -13,6 +13,11 @@ type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omi
      * Custom CSS evaluated during the screenshot process.
      */
     argosCSS?: string;
+    /**
+     * Disable hover effects by moving the mouse to the top-left corner of the page.
+     * @default true
+     */
+    disableHover?: boolean;
 };
 /**
  * @param page Puppeteer `page` object.
@@ -22,5 +27,5 @@ type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omi
  * @param options.viewports Viewports to take screenshots of.
  * @param options.argosCSS Custom CSS evaluated during the screenshot process.
  */
-declare function argosScreenshot(page: Page, name: string, { element, viewports, argosCSS, ...options }?: ArgosScreenshotOptions): Promise<void>;
+declare function argosScreenshot(page: Page, name: string, options?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -45,6 +45,35 @@ async function getScreenshotPath(name) {
     });
     return resolve(screenshotFolder, name + ".png");
 }
+function checkIsFullPage(options) {
+    return options.fullPage !== undefined ? options.fullPage : options.element === undefined;
+}
+/**
+ * Setup Argos for the screenshot process.
+ * @returns A function to teardown Argos.
+ */ async function setup(page, options) {
+    const { disableHover = true, argosCSS } = options;
+    const fullPage = checkIsFullPage(options);
+    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
+        }), {
+        fullPage,
+        argosCSS
+    });
+    if (disableHover) {
+        await page.mouse.move(0, 0);
+    }
+    return async ()=>{
+        await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.teardown({
+                fullPage,
+                argosCSS
+            }), {
+            fullPage,
+            argosCSS
+        });
+    };
+}
 /**
  * @param page Puppeteer `page` object.
  * @param name The name of the screenshot or the full path to the screenshot.
@@ -52,7 +81,8 @@ async function getScreenshotPath(name) {
  * @param options.element ElementHandle or string selector of the element to take a screenshot of.
  * @param options.viewports Viewports to take screenshots of.
  * @param options.argosCSS Custom CSS evaluated during the screenshot process.
- */ async function argosScreenshot(page, name, { element, viewports, argosCSS, ...options } = {}) {
+ */ async function argosScreenshot(page, name, options = {}) {
+    const { element, viewports, argosCSS, ...puppeteerOptions } = options;
     if (!page) {
         throw new Error("A Puppeteer `page` object is required.");
     }
@@ -64,14 +94,8 @@ async function getScreenshotPath(name) {
         // Inject Argos script into the page
         injectArgos(page)
     ]);
-    const fullPage = options.fullPage !== undefined ? options.fullPage : element === undefined;
-    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
-            fullPage,
-            argosCSS
-        }), {
-        fullPage,
-        argosCSS
-    });
+    const teardown = await setup(page, options);
+    const fullPage = checkIsFullPage(options);
     async function collectMetadata() {
         const [colorScheme, mediaType, puppeteerVersion, argosPuppeteerVersion, { browserName, browserVersion }] = await Promise.all([
             page.evaluate(()=>window.__ARGOS__.getColorScheme()),
@@ -116,7 +140,7 @@ async function getScreenshotPath(name) {
             path: screenshotPath,
             type: "png",
             fullPage,
-            ...options
+            ...puppeteerOptions
         };
         // If no element is specified, take a screenshot of the whole page
         if (element === undefined) {
@@ -151,14 +175,7 @@ async function getScreenshotPath(name) {
     } else {
         await stabilizeAndScreenshot(name);
     }
-    // Teardown Argos
-    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.teardown({
-            fullPage,
-            argosCSS
-        }), {
-        fullPage,
-        argosCSS
-    });
+    await teardown();
 }
 
 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.5.0",
+  "version": "1.6.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -40,11 +40,11 @@
     "puppeteer": ">=1"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.4.0",
+    "@argos-ci/browser": "1.4.1",
     "@argos-ci/util": "1.2.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.8",
+    "@argos-ci/cli": "1.0.9",
     "@types/jest": "^28.1.8",
     "@types/node": "^16.0.0",
     "eslint": "^8.23.0",
@@ -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": "dbd169d2307a498a7c44001197924947c28be803"
+  "gitHead": "47e813466b9224cb428eb44ee4d4d450f737763e"
 }