@wdio/image-comparison-core 1.1.4 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @wdio/image-comparison-core
 
+## 1.2.0
+
+### Minor Changes
+
+- 994f4da: ## #857 Support ignore regions for web screenshots
+
+  Add `ignore` support to all web screenshot methods (`saveScreen`/`checkScreen`, `saveElement`/`checkElement`, `saveFullPageScreen`/`checkFullPageScreen`) so that specified elements can be blocked out during visual comparison. This brings web parity with the native-app ignore-region support that already existed.
+
+  ### Changes
+
+  - **Ignore regions for full-page screenshots:** new `determineWebFullPageIgnoreRegions` function that calculates ignore-region rectangles for full-page screenshots, including a `fullPageCropTopPaddingCSS` correction for mobile scroll-and-stitch scenarios where the address-bar shadow padding shifts element positions
+  - **Consolidated `ignoreRegionPadding`:** moved `ignoreRegionPadding` into `BaseWebScreenshotOptions` so it is inherited by all web methods instead of being duplicated per method
+  - **Fix `isAndroidNativeWebScreenshot` type:** ensure `nativeWebScreenshot` is always a boolean (was accidentally an object for LambdaTest capabilities), preventing ignore-region DPR scaling failures
+  - **Fix viewport rounding for mobile:** restore `Math.round()` in `injectWebviewOverlay` and remove `Math.min` clamping in `getMobileViewPortPosition` to prevent 1-pixel crop shifts during full-page stitching
+  - **Fix `scrollElementIntoView` for scrolled pages:** account for `currentPosition` (existing scroll offset) when computing the target scroll position, so elements are scrolled into view correctly when the page is already scrolled
+  - **Dismiss Chrome Start Surface on Android:** when Chrome's tab-overview UI blocks the webview overlay, automatically press the Android Back button (up to 4 retries) to restore the active tab before measuring the viewport
+  - **Add hybrid status bar blockout:** on hybrid apps the statusbar was not blocked out which could result in flaky tests regarding battery and reception
+
+  # Committers: 1
+
+  - Wim Selles ([@wswebcreation](https://github.com/wswebcreation))
+
 ## 1.1.4
 
 ### Patch Changes

package/dist/base.interfaces.d.ts

@@ -48,6 +48,13 @@ export interface BaseWebScreenshotOptions {
      * @default true
      */
     hideScrollBars?: boolean;
+    /**
+     * Padding in device pixels added to each side of ignore regions (makes each region 2× this value wider and higher).
+     * Helps avoid 1px boundary differences on high-DPR / BiDi. Set to 0 to disable.
+     * Applies to screen, element, and full-page web methods.
+     * @default 1
+     */
+    ignoreRegionPadding?: number;
     /**
      * Elements to hide before taking screenshot
      * @default []

package/dist/base.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.interfaces.d.ts","sourceRoot":"","sources":["../src/base.interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACpB,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,sEAAsE;IACtE,cAAc,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,4EAA4E;IAC5E,gBAAgB,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACtB,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,gBAAgB,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,WAAW,EAAE,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,8BAA8B;IAC3C;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,yBAAyB;IACtC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC5B,uBAAuB;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,uBAAuB;IACvB,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC3B,gBAAgB;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,oEAAoE;AACpE,MAAM,WAAW,aAAc,SAAQ,eAAe,EAAE,cAAc;CAAG;AAEzE,MAAM,WAAW,eAAe;IAC5B,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"base.interfaces.d.ts","sourceRoot":"","sources":["../src/base.interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACpB,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,sEAAsE;IACtE,cAAc,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,4EAA4E;IAC5E,gBAAgB,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACtB,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,gBAAgB,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,WAAW,EAAE,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,8BAA8B;IAC3C;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,yBAAyB;IACtC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC5B,uBAAuB;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,uBAAuB;IACvB,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC3B,gBAAgB;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,oEAAoE;AACpE,MAAM,WAAW,aAAc,SAAQ,eAAe,EAAE,cAAc;CAAG;AAEzE,MAAM,WAAW,eAAe;IAC5B,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;CACf"}

package/dist/clientSideScripts/injectWebviewOverlay.test.js

@@ -54,6 +54,35 @@ describe('injectWebviewOverlay', () => {
             height: 1600,
         });
     });
+    it('should round values to integers with non-integer DPR (Android)', () => {
+        Object.defineProperty(window, 'devicePixelRatio', {
+            value: 2.625,
+            configurable: true,
+        });
+        Object.defineProperty(window, 'innerWidth', {
+            value: 412,
+            configurable: true,
+        });
+        Object.defineProperty(document.documentElement, 'clientHeight', {
+            value: 363,
+            configurable: true,
+        });
+        injectWebviewOverlay(true);
+        const overlay = document.querySelector('[data-test="ics-overlay"]');
+        const event = new window.MouseEvent('click', {
+            clientX: 206,
+            clientY: 181,
+            bubbles: true,
+        });
+        overlay.dispatchEvent(event);
+        const parsedData = JSON.parse(overlay.dataset.icsWebviewData);
+        expect(parsedData).toEqual({
+            x: Math.round(206 * 2.625),
+            y: Math.round(181 * 2.625),
+            width: Math.round(412 * 2.625),
+            height: Math.round(363 * 2.625),
+        });
+    });
     it('should use DPR = 1 for iOS (isAndroid = false)', () => {
         injectWebviewOverlay(false);
         const overlay = document.querySelector('[data-test="ics-overlay"]');

package/dist/clientSideScripts/scrollElementIntoView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scrollElementIntoView.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/scrollElementIntoView.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,GAAG,MAAM,CA+B3G"}
+{"version":3,"file":"scrollElementIntoView.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/scrollElementIntoView.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,GAAG,MAAM,CAkC3G"}

package/dist/clientSideScripts/scrollElementIntoView.js

@@ -17,7 +17,10 @@ export default function scrollElementIntoView(element, addressBarShadowPadding)
         currentPosition = bodyNode.scrollTop;
     }
     const { top } = element.getBoundingClientRect();
-    const yPosition = top - addressBarShadowPadding;
+    // BCR.top is viewport-relative, so the element's document position is
+    // currentPosition + top. Scroll there (minus padding) to place the
+    // element at the viewport top.
+    const yPosition = currentPosition + top - addressBarShadowPadding;
     // Scroll to the position
     if (htmlNode.scrollHeight > htmlNode.clientHeight) {
         htmlNode.scrollTop = yPosition;

package/dist/clientSideScripts/scrollElementIntoView.test.js

@@ -56,7 +56,8 @@ describe('scrollElementIntoView', () => {
         const addressBarShadowPadding = 10;
         const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
         expect(result).toBe(50);
-        expect(mockHtmlNode.scrollTop).toBe(90);
+        // currentPosition (50) + BCR.top (100) - padding (10) = 140
+        expect(mockHtmlNode.scrollTop).toBe(140);
     });
     it('should return current scroll position when body node has scroll', () => {
         mockHtmlNode.scrollTop = 0;
@@ -65,7 +66,8 @@ describe('scrollElementIntoView', () => {
         const addressBarShadowPadding = 10;
         const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
         expect(result).toBe(50);
-        expect(mockBodyNode.scrollTop).toBe(90);
+        // currentPosition (50) + BCR.top (100) - padding (10) = 140
+        expect(mockBodyNode.scrollTop).toBe(140);
     });
     it('should not scroll when neither html nor body is scrollable', () => {
         Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });

package/dist/commands/check.interfaces.d.ts

@@ -14,7 +14,7 @@ export interface CheckMethodOptions extends BaseImageCompareOptions, BaseMobileB
     /**
      * Ignore elements and or areas
      */
-    ignore?: ElementIgnore[];
+    ignore?: (ElementIgnore | ElementIgnore[])[];
 }
 export interface InternalCheckMethodOptions extends InternalSaveMethodOptions {
     testContext: TestContext;

package/dist/commands/check.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/check.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAC7F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAEzE,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB,EAAE,yBAAyB;IAC1F;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,0BAA0B;IAChF,kBAAkB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAkC,SAAQ,0BAA0B;IACjF,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;IAClC,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C;AAED,MAAM,WAAW,kCAAmC,SAAQ,0BAA0B;IAClF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C;AAED,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACtF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C"}
+{"version":3,"file":"check.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/check.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAC7F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAEzE,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB,EAAE,yBAAyB;IAC1F;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,EAAE,CAAC;CAChD;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,0BAA0B;IAChF,kBAAkB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAkC,SAAQ,0BAA0B;IACjF,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;IAClC,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C;AAED,MAAM,WAAW,kCAAmC,SAAQ,0BAA0B;IAClF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C;AAED,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACtF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C"}

package/dist/commands/checkFullPageScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkFullPageScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkFullPageScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,uBAAuB,CAAA;AAE/E;;GAEG;AACH,wBAA8B,mBAAmB,CAC7C,EACI,eAAe,EACf,oBAAoB,EACpB,OAAO,EACP,YAAY,EACZ,eAAuB,EACvB,GAAG,EACH,WAAW,GACd,EAAE,kCAAkC,GACtC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAgEtC"}
+{"version":3,"file":"checkFullPageScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkFullPageScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,uBAAuB,CAAA;AAE/E;;GAEG;AACH,wBAA8B,mBAAmB,CAC7C,EACI,eAAe,EACf,oBAAoB,EACpB,OAAO,EACP,YAAY,EACZ,eAAuB,EACvB,GAAG,EACH,WAAW,GACd,EAAE,kCAAkC,GACtC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAsEtC"}

package/dist/commands/checkFullPageScreen.js

@@ -8,7 +8,7 @@ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../
 export default async function checkFullPageScreen({ browserInstance, checkFullPageOptions, folders, instanceData, isNativeContext = false, tag, testContext, }) {
     // 1. Extract common variables
     const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkFullPageOptions.wic });
-    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, fullPageScrollTimeout, hideAfterFirstScroll = [], hideScrollBars, hideElements = [], removeElements = [], waitForFontsLoaded, } = checkFullPageOptions.method;
+    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, fullPageScrollTimeout, hideAfterFirstScroll = [], hideScrollBars, hideElements = [], ignoreRegionPadding, removeElements = [], waitForFontsLoaded, } = checkFullPageOptions.method;
     // 2. Check if the method is supported in native context
     if (isNativeContext) {
         throw new Error('The method checkFullPageScreen is not supported in native context for native mobile apps!');
@@ -25,11 +25,13 @@ export default async function checkFullPageScreen({ browserInstance, checkFullPa
             hideAfterFirstScroll,
             hideScrollBars,
             hideElements,
+            ignore: checkFullPageOptions.method.ignore,
+            ignoreRegionPadding,
             removeElements,
             waitForFontsLoaded,
         },
     };
-    const { devicePixelRatio, fileName, base64Image } = await saveFullPageScreen({
+    const { devicePixelRatio, fileName, base64Image, ignoreRegions } = await saveFullPageScreen({
         browserInstance,
         folders,
         instanceData,
@@ -45,6 +47,9 @@ export default async function checkFullPageScreen({ browserInstance, checkFullPa
         methodCompareOptions: compareOptions,
         devicePixelRatio,
         fileName,
+        additionalProperties: {
+            ignoreRegions: ignoreRegions || [],
+        },
     });
     // 5. Now execute the compare and return the data
     return executeImageCompare({

package/dist/commands/checkWebElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebElement.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAA;AAE9E;;GAEG;AACH,wBAA8B,eAAe,CACzC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,mBAAmB,EACnB,WAAW,EACX,eAAuB,GAC1B,EAAE,iCAAiC,GACrC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CA0DtC"}
+{"version":3,"file":"checkWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebElement.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAA;AAE9E;;GAEG;AACH,wBAA8B,eAAe,CACzC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,mBAAmB,EACnB,WAAW,EACX,eAAuB,GAC1B,EAAE,iCAAiC,GACrC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAgEtC"}

package/dist/commands/checkWebElement.js

@@ -8,7 +8,7 @@ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../
 export default async function checkWebElement({ browserInstance, instanceData, folders, element, tag, checkElementOptions, testContext, isNativeContext = false, }) {
     // 1. Extract common variables
     const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic });
-    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, resizeDimensions, hideElements = [], removeElements = [], waitForFontsLoaded = false, } = checkElementOptions.method;
+    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, resizeDimensions, ignoreRegionPadding, hideElements = [], removeElements = [], waitForFontsLoaded = false, } = checkElementOptions.method;
     // 2. Take the actual element screenshot and retrieve the needed data
     const saveElementOptions = {
         wic: checkElementOptions.wic,
@@ -19,17 +19,19 @@ export default async function checkWebElement({ browserInstance, instanceData, f
             enableLegacyScreenshotMethod,
             hideScrollBars,
             resizeDimensions,
+            ignoreRegionPadding,
             hideElements,
             removeElements,
             waitForFontsLoaded,
         },
     };
-    const { devicePixelRatio, fileName, base64Image } = await saveWebElement({
+    const { devicePixelRatio, fileName, base64Image, ignoreRegions } = await saveWebElement({
         browserInstance,
         instanceData,
         folders,
         element,
         tag,
+        ignore: checkElementOptions.method.ignore,
         saveElementOptions,
     });
     // 3. Determine the options
@@ -41,6 +43,9 @@ export default async function checkWebElement({ browserInstance, instanceData, f
         devicePixelRatio,
         fileName,
         isElementScreenshot: true,
+        additionalProperties: {
+            ignoreRegions: ignoreRegions || [],
+        },
     });
     // 4. Now execute the compare and return the data
     return executeImageCompare({

package/dist/commands/checkWebScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAA;AAE7E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,kBAAkB,EAClB,eAAuB,EACvB,WAAW,GACd,EAAE,gCAAgC,GACpC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAuDtC"}
+{"version":3,"file":"checkWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/checkWebScreen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAIzE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAA;AAE7E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,kBAAkB,EAClB,eAAuB,EACvB,WAAW,GACd,EAAE,gCAAgC,GACpC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CA+DtC"}

package/dist/commands/checkWebScreen.js

@@ -8,8 +8,10 @@ import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../
 export default async function checkWebScreen({ browserInstance, instanceData, folders, tag, checkScreenOptions, isNativeContext = false, testContext, }) {
     // 1. Extract common variables
     const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkScreenOptions.wic });
-    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, hideElements = [], removeElements = [], waitForFontsLoaded, } = checkScreenOptions.method;
-    // 2. Take the actual screenshot and retrieve the needed data
+    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, ignoreRegionPadding, hideElements = [], removeElements = [], waitForFontsLoaded, } = checkScreenOptions.method;
+    // 2. Take the actual screenshot and resolve ignore regions in one go.
+    //    Ignore regions are resolved while the DOM is still in screenshot state
+    //    (scrollbar hidden, elements hidden/removed) so positions match the image.
     const saveScreenOptions = {
         wic: checkScreenOptions.wic,
         method: {
@@ -18,16 +20,18 @@ export default async function checkWebScreen({ browserInstance, instanceData, fo
             enableLayoutTesting,
             enableLegacyScreenshotMethod,
             hideScrollBars,
+            ignoreRegionPadding,
             hideElements,
             removeElements,
             waitForFontsLoaded,
         },
     };
-    const { devicePixelRatio, fileName, base64Image } = await saveWebScreen({
+    const { devicePixelRatio, fileName, base64Image, ignoreRegions } = await saveWebScreen({
         browserInstance,
         instanceData,
         folders,
         tag,
+        ignore: checkScreenOptions.method.ignore,
         saveScreenOptions,
         isNativeContext,
     });
@@ -39,6 +43,9 @@ export default async function checkWebScreen({ browserInstance, instanceData, fo
         methodCompareOptions,
         devicePixelRatio,
         fileName,
+        additionalProperties: {
+            ignoreRegions: ignoreRegions || [],
+        },
     });
     // 4. Now execute the compare and return the data
     return executeImageCompare({

package/dist/commands/checkWebScreen.test.js

@@ -189,6 +189,49 @@ describe('checkWebScreen', () => {
         expect(saveWebScreenSpy.mock.calls[0]).toMatchSnapshot();
         expect(executeImageCompareSpy.mock.calls[0]).toMatchSnapshot();
     });
+    it('should pass ignore elements to saveWebScreen and forward resolved regions', async () => {
+        const { buildBaseExecuteCompareOptions } = await import('../helpers/utils.js');
+        const buildBaseExecuteCompareOptionsSpy = vi.mocked(buildBaseExecuteCompareOptions);
+        const mockIgnoreElement = { elementId: 'ignore-el', selector: '.navbar' };
+        const mockIgnoreRegion = { x: 10, y: 20, width: 100, height: 50 };
+        const resolvedRegions = [
+            { x: 50, y: 60, width: 200, height: 100 },
+            { x: 10, y: 20, width: 100, height: 50 },
+        ];
+        // saveWebScreen returns ignoreRegions resolved during screenshot
+        saveWebScreenSpy.mockResolvedValueOnce({
+            devicePixelRatio: 2,
+            fileName: 'test-screen.png',
+            ignoreRegions: resolvedRegions,
+        });
+        const options = {
+            ...baseOptions,
+            checkScreenOptions: {
+                ...baseOptions.checkScreenOptions,
+                method: {
+                    ...baseOptions.checkScreenOptions.method,
+                    ignore: [mockIgnoreElement, mockIgnoreRegion],
+                }
+            }
+        };
+        await checkWebScreen(options);
+        // ignore is passed through to saveWebScreen
+        expect(saveWebScreenSpy).toHaveBeenCalledWith(expect.objectContaining({
+            ignore: [mockIgnoreElement, mockIgnoreRegion],
+        }));
+        // resolved regions are forwarded to the compare options
+        expect(buildBaseExecuteCompareOptionsSpy).toHaveBeenCalledWith(expect.objectContaining({
+            additionalProperties: { ignoreRegions: resolvedRegions },
+        }));
+    });
+    it('should pass empty array when no ignore regions are returned', async () => {
+        const { buildBaseExecuteCompareOptions } = await import('../helpers/utils.js');
+        const buildBaseExecuteCompareOptionsSpy = vi.mocked(buildBaseExecuteCompareOptions);
+        await checkWebScreen(baseOptions);
+        expect(buildBaseExecuteCompareOptionsSpy).toHaveBeenCalledWith(expect.objectContaining({
+            additionalProperties: { ignoreRegions: [] },
+        }));
+    });
     it('should handle all method options correctly', async () => {
         const mockHideElement = {
             elementId: 'hide-element',

package/dist/commands/fullPage.interfaces.d.ts

@@ -2,11 +2,17 @@ import type { BaseMobileWebScreenshotOptions, BaseWebScreenshotOptions, Folders
 import type { DefaultOptions } from '../helpers/options.interfaces.js';
 import type { ResizeDimensions } from '../methods/images.interfaces.js';
 import type { CheckMethodOptions } from './check.interfaces.js';
+import type { ElementIgnore } from './element.interfaces.js';
 export interface SaveFullPageOptions {
     wic: DefaultOptions;
     method: SaveFullPageMethodOptions;
 }
 export interface SaveFullPageMethodOptions extends Partial<Folders>, BaseWebScreenshotOptions, BaseMobileWebScreenshotOptions {
+    /**
+     * Elements or regions to ignore when saving/comparing full-page (desktop and mobile web).
+     * Same format as saveScreen / checkScreen (selectors or { x, y, width, height } in document CSS pixels).
+     */
+    ignore?: (ElementIgnore | ElementIgnore[])[];
     /**
      * The amount of milliseconds to wait for a new scroll. This will be used for the legacy
      * fullpage screenshot method.

package/dist/commands/fullPage.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fullPage.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/fullPage.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC9G,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE/D,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,yBAAyB,CAAC;CACrC;AAED,MAAM,WAAW,yBAA0B,SAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,wBAAwB,EAAE,8BAA8B;IACzH;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,WAAW,EAAE,CAAC;IACrC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB,EAAE,kBAAkB;CAAI;AAErG,MAAM,WAAW,oBAAoB;IACjC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,0BAA0B,CAAC;CACtC"}
+{"version":3,"file":"fullPage.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/fullPage.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC9G,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAE5D,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,yBAAyB,CAAC;CACrC;AAED,MAAM,WAAW,yBAA0B,SAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,wBAAwB,EAAE,8BAA8B;IACzH;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,EAAE,CAAC;IAC7C;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,WAAW,EAAE,CAAC;IACrC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB,EAAE,kBAAkB;CAAI;AAErG,MAAM,WAAW,oBAAoB;IACjC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,0BAA0B,CAAC;CACtC"}

package/dist/commands/save.interfaces.d.ts

@@ -1,7 +1,7 @@
 import type { InstanceData } from '../methods/instanceData.interfaces.js';
 import type { SaveFullPageOptions } from './fullPage.interfaces.js';
 import type { SaveScreenOptions } from './screen.interfaces.js';
-import type { SaveElementOptions, WicElement } from './element.interfaces.js';
+import type { SaveElementOptions, WicElement, ElementIgnore } from './element.interfaces.js';
 import type { SaveTabbableOptions } from './tabbable.interfaces.js';
 import type { Folders } from '../base.interfaces.js';
 export interface InternalSaveMethodOptions {
@@ -12,10 +12,12 @@ export interface InternalSaveMethodOptions {
     tag: string;
 }
 export interface InternalSaveScreenMethodOptions extends InternalSaveMethodOptions {
+    ignore?: (ElementIgnore | ElementIgnore[])[];
     saveScreenOptions: SaveScreenOptions;
 }
 export interface InternalSaveElementMethodOptions extends InternalSaveMethodOptions {
     element: HTMLElement | WicElement;
+    ignore?: (ElementIgnore | ElementIgnore[])[];
     saveElementOptions: SaveElementOptions;
 }
 export interface InternalSaveFullPageMethodOptions extends InternalSaveMethodOptions {

package/dist/commands/save.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"save.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/save.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAA;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,MAAM,WAAW,yBAAyB;IACtC,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,YAAY,EAAE,YAAY,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IAC9E,iBAAiB,EAAE,iBAAiB,CAAC;CACxC;AAED,MAAM,WAAW,gCAAiC,SAAQ,yBAAyB;IAC/E,OAAO,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,kBAAkB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAkC,SAAQ,yBAAyB;IAChF,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C;AAED,MAAM,WAAW,qCAAsC,SAAQ,yBAAyB;IACpF,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C"}
+{"version":3,"file":"save.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/save.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAA;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,MAAM,WAAW,yBAAyB;IACtC,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,YAAY,EAAE,YAAY,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IAC9E,MAAM,CAAC,EAAE,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,EAAE,CAAC;IAC7C,iBAAiB,EAAE,iBAAiB,CAAC;CACxC;AAED,MAAM,WAAW,gCAAiC,SAAQ,yBAAyB;IAC/E,OAAO,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,MAAM,CAAC,EAAE,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,EAAE,CAAC;IAC7C,kBAAkB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAkC,SAAQ,yBAAyB;IAChF,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C;AAED,MAAM,WAAW,qCAAsC,SAAQ,yBAAyB;IACpF,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C"}

package/dist/commands/saveElement.d.ts

@@ -3,5 +3,5 @@ import type { InternalSaveElementMethodOptions } from './save.interfaces.js';
 /**
  * Saves an image of an element
  */
-export default function saveElement({ browserInstance, element, folders, instanceData, isNativeContext, saveElementOptions, tag, }: InternalSaveElementMethodOptions): Promise<ScreenshotOutput>;
+export default function saveElement({ browserInstance, element, folders, instanceData, isNativeContext, ignore, saveElementOptions, tag, }: InternalSaveElementMethodOptions): Promise<ScreenshotOutput>;
 //# sourceMappingURL=saveElement.d.ts.map

package/dist/commands/saveElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveElement.d.ts","sourceRoot":"","sources":["../../src/commands/saveElement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAI5E;;GAEG;AACH,wBAA8B,WAAW,CACrC,EACI,eAAe,EACf,OAAO,EACP,OAAO,EACP,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,GAAG,GACN,EAAE,gCAAgC,GACpC,OAAO,CAAC,gBAAgB,CAAC,CAI3B"}
+{"version":3,"file":"saveElement.d.ts","sourceRoot":"","sources":["../../src/commands/saveElement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAI5E;;GAEG;AACH,wBAA8B,WAAW,CACrC,EACI,eAAe,EACf,OAAO,EACP,OAAO,EACP,YAAY,EACZ,eAAe,EACf,MAAM,EACN,kBAAkB,EAClB,GAAG,GACN,EAAE,gCAAgC,GACpC,OAAO,CAAC,gBAAgB,CAAC,CAI3B"}

package/dist/commands/saveElement.js

@@ -3,8 +3,8 @@ import saveWebElement from './saveWebElement.js';
 /**
  * Saves an image of an element
  */
-export default async function saveElement({ browserInstance, element, folders, instanceData, isNativeContext, saveElementOptions, tag, }) {
+export default async function saveElement({ browserInstance, element, folders, instanceData, isNativeContext, ignore, saveElementOptions, tag, }) {
     return isNativeContext
         ? saveAppElement({ browserInstance, element, folders, instanceData, saveElementOptions, isNativeContext, tag })
-        : saveWebElement({ browserInstance, element, folders, instanceData, saveElementOptions, tag });
+        : saveWebElement({ browserInstance, element, folders, instanceData, saveElementOptions, tag, ignore });
 }

package/dist/commands/saveFullPageScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveFullPageScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveFullPageScreen.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAGhF,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAA;AAI7E;;GAEG;AACH,wBAA8B,kBAAkB,CAC5C,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,mBAAmB,EACnB,eAAe,GAClB,EAAE,iCAAiC,GACrC,OAAO,CAAC,gBAAgB,CAAC,CAsE3B"}
+{"version":3,"file":"saveFullPageScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveFullPageScreen.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAGhF,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAA;AAK7E;;GAEG;AACH,wBAA8B,kBAAkB,CAC5C,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,mBAAmB,EACnB,eAAe,GAClB,EAAE,iCAAiC,GACrC,OAAO,CAAC,gBAAgB,CAAC,CA+F3B"}

package/dist/commands/saveFullPageScreen.js

@@ -4,6 +4,7 @@ import { takeFullPageScreenshots } from '../methods/takeFullPageScreenshots.js';
 import { makeFullPageBase64Image } from '../methods/images.js';
 import { getMethodOrWicOption, canUseBidiScreenshot } from '../helpers/utils.js';
 import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
+import { determineWebFullPageIgnoreRegions } from '../methods/rectangles.js';
 /**
  * Saves an image of the full page
  */
@@ -20,7 +21,7 @@ export default async function saveFullPageScreen({ browserInstance, instanceData
     // 3.  Prepare the screenshot
     const beforeOptions = createBeforeScreenshotOptions(instanceData, saveFullPageOptions.method, saveFullPageOptions.wic);
     const enrichedInstanceData = await beforeScreenshot(browserInstance, beforeOptions, true);
-    const { dimensions: { window: { devicePixelRatio, innerHeight, isEmulated: _isEmulated, isLandscape, screenHeight, screenWidth, }, }, isAndroid, isAndroidChromeDriverScreenshot, isAndroidNativeWebScreenshot, isIOS, } = enrichedInstanceData;
+    const { dimensions: { window: { devicePixelRatio, innerHeight, isEmulated: _isEmulated, isLandscape, screenHeight, screenWidth, }, }, isAndroid, isAndroidChromeDriverScreenshot, isAndroidNativeWebScreenshot, isIOS, isMobile, } = enrichedInstanceData;
     // 4.  Take the screenshot
     const fullPageScreenshotOptions = {
         addressBarShadowPadding: beforeOptions.addressBarShadowPadding,
@@ -44,7 +45,22 @@ export default async function saveFullPageScreen({ browserInstance, instanceData
     const fullPageBase64Image = (screenshotsData.fullPageHeight === -1 && screenshotsData.fullPageWidth === -1)
         ? screenshotsData.data[0].screenshot // BiDi screenshot - use directly
         : await makeFullPageBase64Image(screenshotsData, { devicePixelRatio: devicePixelRatio || NaN, isLandscape });
-    // 6.  Return the data
+    // 6. Resolve ignore regions while the DOM is still in screenshot state.
+    //    Full-page image (BiDi or stitched) is in document coordinates; regions are document-relative device pixels.
+    //    On mobile scroll-and-stitch we crop addressBarShadowPadding from the top of each tile, so we pass
+    //    fullPageCropTopPaddingCSS so ignore regions align with the stitched canvas.
+    const ignore = saveFullPageOptions.method?.ignore;
+    const ignoreRegionPadding = getMethodOrWicOption(saveFullPageOptions.method, saveFullPageOptions.wic, 'ignoreRegionPadding') ?? 1;
+    const usedStitchedMobile = isMobile && !(screenshotsData.fullPageHeight === -1 && screenshotsData.fullPageWidth === -1);
+    const ignoreRegions = ignore && ignore.length > 0
+        ? await determineWebFullPageIgnoreRegions({
+            browserInstance,
+            devicePixelRatio: devicePixelRatio || 1,
+            fullPageCropTopPaddingCSS: usedStitchedMobile ? beforeOptions.addressBarShadowPadding : 0,
+            ignoreRegionPadding,
+        }, ignore)
+        : undefined;
+    // 7.  Return the data
     const afterOptions = buildAfterScreenshotOptions({
         base64Image: fullPageBase64Image,
         folders,
@@ -55,5 +71,9 @@ export default async function saveFullPageScreen({ browserInstance, instanceData
         beforeOptions,
         wicOptions: saveFullPageOptions.wic
     });
-    return afterScreenshot(browserInstance, afterOptions);
+    const result = await afterScreenshot(browserInstance, afterOptions);
+    return {
+        ...result,
+        ...(ignoreRegions ? { ignoreRegions } : {}),
+    };
 }

package/dist/commands/saveWebElement.d.ts

@@ -3,5 +3,5 @@ import type { InternalSaveElementMethodOptions } from './save.interfaces.js';
 /**
  * Saves an image of an element
  */
-export default function saveWebElement({ browserInstance, instanceData, folders, element, tag, saveElementOptions, }: InternalSaveElementMethodOptions): Promise<ScreenshotOutput>;
+export default function saveWebElement({ browserInstance, instanceData, folders, element, tag, ignore, saveElementOptions, }: InternalSaveElementMethodOptions): Promise<ScreenshotOutput>;
 //# sourceMappingURL=saveWebElement.d.ts.map

package/dist/commands/saveWebElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebElement.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAOhF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAE5E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,kBAAkB,GACrB,EAAE,gCAAgC,GACpC,OAAO,CAAC,gBAAgB,CAAC,CA+D3B"}
+{"version":3,"file":"saveWebElement.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebElement.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAOhF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAG5E;;GAEG;AACH,wBAA8B,cAAc,CACxC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,MAAM,EACN,kBAAkB,GACrB,EAAE,gCAAgC,GACpC,OAAO,CAAC,gBAAgB,CAAC,CA0F3B"}

package/dist/commands/saveWebElement.js

@@ -4,10 +4,11 @@ import afterScreenshot from '../helpers/afterScreenshot.js';
 import { DEFAULT_RESIZE_DIMENSIONS } from '../helpers/constants.js';
 import { canUseBidiScreenshot, getMethodOrWicOption } from '../helpers/utils.js';
 import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
+import { determineWebElementIgnoreRegions } from '../methods/rectangles.js';
 /**
  * Saves an image of an element
  */
-export default async function saveWebElement({ browserInstance, instanceData, folders, element, tag, saveElementOptions, }) {
+export default async function saveWebElement({ browserInstance, instanceData, folders, element, tag, ignore, saveElementOptions, }) {
     // 1. Set some variables
     const { addressBarShadowPadding, autoElementScroll } = saveElementOptions.wic;
     const enableLegacyScreenshotMethod = getMethodOrWicOption(saveElementOptions.method, saveElementOptions.wic, 'enableLegacyScreenshotMethod');
@@ -38,6 +39,23 @@ export default async function saveWebElement({ browserInstance, instanceData, fo
     };
     const shouldUseBidi = canUseBidiScreenshot(browserInstance) && !isMobile && !enableLegacyScreenshotMethod;
     const screenshotData = await takeElementScreenshot(browserInstance, elementScreenshotOptions, shouldUseBidi);
+    // 3b. Resolve ignore regions (element-local) while the DOM is still in screenshot state.
+    // determineWebElementIgnoreRegions returns device-pixel regions, or CSS-pixel regions when
+    // the element image is from the native driver on Android native web (see that function).
+    const ignoreRegionPadding = getMethodOrWicOption(saveElementOptions.method, saveElementOptions.wic, 'ignoreRegionPadding') ?? 1;
+    const ignoreRegions = ignore && ignore.length > 0
+        ? await (async () => {
+            const rootElement = await element;
+            return determineWebElementIgnoreRegions({
+                browserInstance,
+                devicePixelRatio: devicePixelRatio || 1,
+                rootElement: rootElement,
+                ignoreRegionPadding,
+                isAndroidNativeWebScreenshot,
+                isWebDriverElementScreenshot: screenshotData.isWebDriverElementScreenshot,
+            }, ignore);
+        })()
+        : undefined;
     // 4. Return the data
     const afterOptions = buildAfterScreenshotOptions({
         base64Image: screenshotData.base64Image,
@@ -49,5 +67,9 @@ export default async function saveWebElement({ browserInstance, instanceData, fo
         beforeOptions,
         wicOptions: saveElementOptions.wic
     });
-    return afterScreenshot(browserInstance, afterOptions);
+    const result = await afterScreenshot(browserInstance, afterOptions);
+    return {
+        ...result,
+        ...(ignoreRegions ? { ignoreRegions } : {}),
+    };
 }

package/dist/commands/saveWebScreen.d.ts

@@ -3,5 +3,5 @@ import type { InternalSaveScreenMethodOptions } from './save.interfaces.js';
 /**
  * Saves an image of the viewport of the screen
  */
-export default function saveWebScreen({ browserInstance, instanceData, folders, tag, saveScreenOptions, isNativeContext, }: InternalSaveScreenMethodOptions): Promise<ScreenshotOutput>;
+export default function saveWebScreen({ browserInstance, instanceData, folders, tag, ignore, saveScreenOptions, isNativeContext, }: InternalSaveScreenMethodOptions): Promise<ScreenshotOutput>;
 //# sourceMappingURL=saveWebScreen.d.ts.map

package/dist/commands/saveWebScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebScreen.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAA;AAK3E;;GAEG;AACH,wBAA8B,aAAa,CACvC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,iBAAiB,EACjB,eAAuB,GAC1B,EAAE,+BAA+B,GACnC,OAAO,CAAC,gBAAgB,CAAC,CA4D3B"}
+{"version":3,"file":"saveWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebScreen.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAA;AAM3E;;GAEG;AACH,wBAA8B,aAAa,CACvC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,MAAM,EACN,iBAAiB,EACjB,eAAuB,GAC1B,EAAE,+BAA+B,GACnC,OAAO,CAAC,gBAAgB,CAAC,CAoF3B"}

package/dist/commands/saveWebScreen.js

@@ -3,10 +3,11 @@ import beforeScreenshot from '../helpers/beforeScreenshot.js';
 import afterScreenshot from '../helpers/afterScreenshot.js';
 import { canUseBidiScreenshot, getMethodOrWicOption } from '../helpers/utils.js';
 import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
+import { determineWebScreenIgnoreRegions } from '../methods/rectangles.js';
 /**
  * Saves an image of the viewport of the screen
  */
-export default async function saveWebScreen({ browserInstance, instanceData, folders, tag, saveScreenOptions, isNativeContext = false, }) {
+export default async function saveWebScreen({ browserInstance, instanceData, folders, tag, ignore, saveScreenOptions, isNativeContext = false, }) {
     // 1. Set some variables
     const { addIOSBezelCorners } = saveScreenOptions.wic;
     const enableLegacyScreenshotMethod = getMethodOrWicOption(saveScreenOptions.method, saveScreenOptions.wic, 'enableLegacyScreenshotMethod');
@@ -33,7 +34,22 @@ export default async function saveWebScreen({ browserInstance, instanceData, fol
         isMobile,
     };
     const { base64Image } = await takeWebScreenshot(browserInstance, webScreenshotOptions, shouldUseBidi);
-    // 4. Return the data
+    // 4. Resolve ignore regions while the DOM is still in screenshot state
+    //    (scrollbar hidden, elements hidden/removed, CSS applied).
+    //    This must happen BEFORE afterScreenshot restores the DOM.
+    const ignoreRegionPadding = getMethodOrWicOption(saveScreenOptions.method, saveScreenOptions.wic, 'ignoreRegionPadding') ?? 1;
+    const ignoreRegions = ignore && ignore.length > 0
+        ? await determineWebScreenIgnoreRegions({
+            browserInstance,
+            devicePixelRatio: devicePixelRatio || 1,
+            deviceRectangles: instanceData.deviceRectangles,
+            isAndroid,
+            isAndroidNativeWebScreenshot,
+            isIOS,
+            ignoreRegionPadding,
+        }, ignore)
+        : undefined;
+    // 5. Restore the DOM and return the data
     const afterOptions = buildAfterScreenshotOptions({
         base64Image,
         folders,
@@ -44,5 +60,9 @@ export default async function saveWebScreen({ browserInstance, instanceData, fol
         beforeOptions,
         wicOptions: saveScreenOptions.wic
     });
-    return afterScreenshot(browserInstance, afterOptions);
+    const result = await afterScreenshot(browserInstance, afterOptions);
+    return {
+        ...result,
+        ...(ignoreRegions ? { ignoreRegions } : {}),
+    };
 }

package/dist/helpers/afterScreenshot.interfaces.d.ts

@@ -1,6 +1,8 @@
+import type { RectanglesOutput } from '../methods/rectangles.interfaces.js';
 export interface ScreenshotOutput {
     devicePixelRatio: number;
     fileName: string;
+    ignoreRegions?: RectanglesOutput[];
     isLandscape: boolean;
     path: string;
     base64Image?: string;