@applitools/eyes 1.33.4 → 1.34.0-debug-20250429-2

package/CHANGELOG.md

@@ -1,5 +1,101 @@
 # Changelog
 
+## [1.34.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.33.4...js/eyes@1.34.0) (2025-04-17)
+
+
+### Features
+
+* height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+### Bug Fixes
+
+* add checks for undefined regions in CheckSettings | AD-9042 ([#2868](https://github.com/Applitools-Dev/sdk/issues/2868)) ([0f7c991](https://github.com/Applitools-Dev/sdk/commit/0f7c9913d64e0535ba5ffe632923a3bf440be65f))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.18
+  #### Bug Fixes
+
+  * simplify sandbox creation and ensure cleanup after execution ([#2869](https://github.com/Applitools-Dev/sdk/issues/2869)) ([72c5e01](https://github.com/Applitools-Dev/sdk/commit/72c5e01307f6abd83fab365a7e235124caae0694))
+
+
+
+* @applitools/snippets bumped to 2.6.5
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/driver bumped to 1.21.1
+  #### Bug Fixes
+
+  * executePoll error logging FLD-2870 ([#2890](https://github.com/Applitools-Dev/sdk/issues/2890)) ([a8ff720](https://github.com/Applitools-Dev/sdk/commit/a8ff720efafacabe2023282748a6d8a0f1b3ff73))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.2.2
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.98
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.27
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/screenshoter bumped to 3.11.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/nml-client bumped to 1.9.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/tunnel-client bumped to 1.6.5
+  #### Bug Fixes
+
+  * enhance error messages in tunnel client ([cab26e6](https://github.com/Applitools-Dev/sdk/commit/cab26e6e3d56fa3cbabaa1a9c68de13046b8f57e))
+* @applitools/ufg-client bumped to 1.16.9
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+
+
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/ec-client bumped to 1.10.9
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/core bumped to 4.37.0
+  #### Features
+
+  * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+
+
 ## [1.33.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.33.1...js/eyes@1.33.2) (2025-04-03)
 
 

package/dist/input/CheckSettings.js

@@ -54,9 +54,11 @@ class CheckSettingsBaseFluent {
         return this.name(name);
     }
     ignoreRegion(region) {
-        if (!this._settings.ignoreRegions)
-            this._settings.ignoreRegions = [];
-        this._settings.ignoreRegions.push(region);
+        if (region) {
+            if (!this._settings.ignoreRegions)
+                this._settings.ignoreRegions = [];
+            this._settings.ignoreRegions.push(region);
+        }
         return this;
     }
     ignoreRegions(...regions) {
@@ -72,9 +74,11 @@ class CheckSettingsBaseFluent {
         return this.ignoreRegions(...regions);
     }
     layoutRegion(region) {
-        if (!this._settings.layoutRegions)
-            this._settings.layoutRegions = [];
-        this._settings.layoutRegions.push(region);
+        if (region) {
+            if (!this._settings.layoutRegions)
+                this._settings.layoutRegions = [];
+            this._settings.layoutRegions.push(region);
+        }
         return this;
     }
     layoutRegions(...regions) {
@@ -82,9 +86,11 @@ class CheckSettingsBaseFluent {
         return this;
     }
     strictRegion(region) {
-        if (!this._settings.strictRegions)
-            this._settings.strictRegions = [];
-        this._settings.strictRegions.push(region);
+        if (region) {
+            if (!this._settings.strictRegions)
+                this._settings.strictRegions = [];
+            this._settings.strictRegions.push(region);
+        }
         return this;
     }
     strictRegions(...regions) {
@@ -92,9 +98,11 @@ class CheckSettingsBaseFluent {
         return this;
     }
     contentRegion(region) {
-        if (!this._settings.contentRegions)
-            this._settings.contentRegions = [];
-        this._settings.contentRegions.push(region);
+        if (region) {
+            if (!this._settings.contentRegions)
+                this._settings.contentRegions = [];
+            this._settings.contentRegions.push(region);
+        }
         return this;
     }
     contentRegions(...regions) {
@@ -102,23 +110,25 @@ class CheckSettingsBaseFluent {
         return this;
     }
     floatingRegion(region, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
-        let floatingRegion;
-        if (utils.types.has(region, 'region')) {
-            const { maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset, ...rest } = region;
-            floatingRegion = {
-                offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
-                ...rest,
-            };
-        }
-        else {
-            floatingRegion = {
-                region,
-                offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
-            };
+        if (region) {
+            let floatingRegion;
+            if (utils.types.has(region, 'region')) {
+                const { maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset, ...rest } = region;
+                floatingRegion = {
+                    offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
+                    ...rest,
+                };
+            }
+            else {
+                floatingRegion = {
+                    region,
+                    offset: { top: maxUpOffset, bottom: maxDownOffset, left: maxLeftOffset, right: maxRightOffset },
+                };
+            }
+            if (!this._settings.floatingRegions)
+                this._settings.floatingRegions = [];
+            this._settings.floatingRegions.push(floatingRegion);
         }
-        if (!this._settings.floatingRegions)
-            this._settings.floatingRegions = [];
-        this._settings.floatingRegions.push(floatingRegion);
         return this;
     }
     floatingRegions(regionOrMaxOffset, ...regions) {
@@ -147,10 +157,12 @@ class CheckSettingsBaseFluent {
         return this.floatingRegions(regionOrMaxOffset, ...regions);
     }
     accessibilityRegion(region, type) {
-        const accessibilityRegion = utils.types.has(region, 'region') ? region : { region, type };
-        if (!this._settings.accessibilityRegions)
-            this._settings.accessibilityRegions = [];
-        this._settings.accessibilityRegions.push(accessibilityRegion);
+        if (region) {
+            const accessibilityRegion = utils.types.has(region, 'region') ? region : { region, type };
+            if (!this._settings.accessibilityRegions)
+                this._settings.accessibilityRegions = [];
+            this._settings.accessibilityRegions.push(accessibilityRegion);
+        }
         return this;
     }
     accessibilityRegions(regionOrType, ...regions) {
@@ -170,10 +182,12 @@ class CheckSettingsBaseFluent {
         return this;
     }
     dynamicRegion(region, type) {
-        const dynamicRegion = utils.types.has(region, 'region') ? region : { region, type };
-        if (!this._settings.dynamicRegions)
-            this._settings.dynamicRegions = [];
-        this._settings.dynamicRegions.push(dynamicRegion);
+        if (region) {
+            const dynamicRegion = utils.types.has(region, 'region') ? region : { region, type };
+            if (!this._settings.dynamicRegions)
+                this._settings.dynamicRegions = [];
+            this._settings.dynamicRegions.push(dynamicRegion);
+        }
         return this;
     }
     dynamicRegions(regionOrTypes, ...regions) {
@@ -507,13 +521,22 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
         this._settings.disableBrowserFetching = disableBrowserFetching;
         return this;
     }
-    layoutBreakpoints(breakpoints = true, settings) {
-        this._settings.layoutBreakpoints = {
-            breakpoints: utils.types.isArray(breakpoints)
-                ? Array.from(new Set(breakpoints)).sort((a, b) => (a < b ? 1 : -1))
-                : breakpoints,
-            reload: settings === null || settings === void 0 ? void 0 : settings.reload,
-        };
+    layoutBreakpoints(breakpoints = true, heightBreakpointsOrSettings, settings) {
+        if (utils.types.isBoolean(heightBreakpointsOrSettings)) {
+            this._settings.layoutBreakpoints = {
+                breakpoints: breakpoints,
+                heightBreakpoints: heightBreakpointsOrSettings,
+                reload: settings === null || settings === void 0 ? void 0 : settings.reload,
+            };
+        }
+        else {
+            this._settings.layoutBreakpoints = {
+                breakpoints: utils.types.isArray(breakpoints)
+                    ? Array.from(new Set(breakpoints)).sort((a, b) => (a < b ? 1 : -1))
+                    : breakpoints,
+                reload: heightBreakpointsOrSettings === null || heightBreakpointsOrSettings === void 0 ? void 0 : heightBreakpointsOrSettings.reload,
+            };
+        }
         return this;
     }
     hook(name, script) {
@@ -578,8 +601,20 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
         return this;
     }
     /** @internal */
+    toLayoutBreakpoints() {
+        var _a;
+        let layoutBreakpoints;
+        if (utils.types.has(this._settings.layoutBreakpoints, 'breakpoints')) {
+            layoutBreakpoints = this._settings.layoutBreakpoints;
+        }
+        else {
+            layoutBreakpoints = { breakpoints: (_a = this._settings.layoutBreakpoints) !== null && _a !== void 0 ? _a : false };
+        }
+        return layoutBreakpoints;
+    }
+    /** @internal */
     toJSON() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         return {
             target: undefined,
             settings: utils.general.removeUndefinedProps({
@@ -604,11 +639,9 @@ class CheckSettingsAutomationFluent extends CheckSettingsBaseFluent {
                 dynamicRegions: (_g = this._settings.dynamicRegions) === null || _g === void 0 ? void 0 : _g.map(this.toCoreCodedRegion),
                 disableBrowserFetching: this._settings.disableBrowserFetching,
                 layoutBreakpoints: utils.types.isDefined(this._settings.layoutBreakpoints)
-                    ? utils.types.has(this._settings.layoutBreakpoints, 'breakpoints')
-                        ? this._settings.layoutBreakpoints
-                        : { breakpoints: (_h = this._settings.layoutBreakpoints) !== null && _h !== void 0 ? _h : false }
+                    ? this.toLayoutBreakpoints()
                     : undefined,
-                ufgOptions: (_j = this._settings.ufgOptions) !== null && _j !== void 0 ? _j : this._settings.visualGridOptions,
+                ufgOptions: (_h = this._settings.ufgOptions) !== null && _h !== void 0 ? _h : this._settings.visualGridOptions,
                 nmgOptions: this._settings.nmgOptions,
                 screenshotMode: this._settings.useSystemScreenshot ? 'default' : undefined,
                 hooks: this._settings.hooks,
@@ -648,6 +681,12 @@ exports.TargetAutomation = {
         return new CheckSettingsAutomationFluent({}, this.spec);
     },
     region(region) {
+        if (!region) {
+            // eslint-disable-next-line no-console
+            console.warn('Target.region() called with no region. Will take a screenshot of the entire window instead.');
+            // eslint-disable-next-line no-console
+            console.trace();
+        }
         return new CheckSettingsAutomationFluent({}, this.spec).region(region);
     },
     frame(contextOrFrame, scrollRootElement) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.33.4",
+  "version": "1.34.0-debug-20250429-2",
   "keywords": [
     "applitools",
     "eyes",
@@ -46,10 +46,11 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.36.0",
+    "@applitools/core": "4.37.0-debug-20250429-2",
     "@applitools/logger": "2.1.2",
     "@applitools/utils": "1.8.0",
-    "chalk": "4.1.2"
+    "chalk": "4.1.2",
+    "yargs": "17.7.2"
   },
   "devDependencies": {
     "@applitools/req": "^1.7.10",

package/types/input/CheckSettings.d.ts

@@ -74,16 +74,21 @@ export type CheckSettingsBase<TRegion = never> = {
     stitchMode?: StitchMode;
 };
 export type CheckSettingsImage = CheckSettingsBase;
+type LayoutBreakpoints = boolean | number[] | {
+    breakpoints: number[] | boolean;
+    reload?: boolean;
+} | {
+    breakpoints: boolean;
+    heightBreakpoints: boolean;
+    reload?: boolean;
+};
 export type CheckSettingsAutomation<TSpec extends Core.SpecType> = CheckSettingsBase<RegionReference<TSpec>> & {
     frames?: (ContextReference<TSpec> | FrameReference<TSpec>)[];
     webview?: boolean | string;
     scrollRootElement?: ElementReference<TSpec>;
     fully?: boolean;
     disableBrowserFetching?: boolean;
-    layoutBreakpoints?: boolean | number[] | {
-        breakpoints: number[] | boolean;
-        reload?: boolean;
-    };
+    layoutBreakpoints?: LayoutBreakpoints;
     /** @deprecated */
     visualGridOptions?: {
         [key: string]: any;
@@ -207,9 +212,12 @@ export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType =
     /** @deprecated */
     stitchContent(stitchContent?: boolean): this;
     disableBrowserFetching(disableBrowserFetching: boolean): typeof this;
-    layoutBreakpoints(breakpoints?: boolean | number[], settings?: {
+    layoutBreakpoints(breakpoints: boolean, heightBreakpoints: boolean, settings?: {
+        reload?: boolean;
+    }): this;
+    layoutBreakpoints(breakpoints: boolean | number[], settings?: {
         reload?: boolean;
-    }): typeof this;
+    }): this;
     hook(name: string, script: string): typeof this;
     beforeRenderScreenshotHook(script: string): typeof this;
     /** @deprecated */
@@ -237,6 +245,12 @@ export declare class CheckSettingsAutomationFluent<TSpec extends Core.SpecType =
     densityMetrics(options: DensityMetrics): typeof this;
     stitchMode(stitchMode: StitchMode): typeof this;
     /** @internal */
+    protected toLayoutBreakpoints(): {
+        breakpoints: number[] | boolean;
+        heightBreakpoints?: boolean;
+        reload?: boolean;
+    };
+    /** @internal */
     toJSON(): {
         target: undefined;
         settings: Core.CheckSettings<TSpec, 'classic'> & Core.CheckSettings<TSpec, 'ufg'>;