@applitools/core 4.36.0 → 4.37.0

package/CHANGELOG.md

@@ -1,5 +1,89 @@
 # Changelog
 
+## [4.37.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.36.0...js/core@4.37.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))
+
+
+### 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))
+
+
+
+
 ## [4.36.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.35.1...js/core@4.36.0) (2025-04-13)
 
 

package/dist/automation/utils/to-base-check-settings.js

@@ -38,7 +38,7 @@ async function extractMobileElementsIntoCheckSettings({ settings, driver, logger
     logger = logger.extend({ tags: [`extract-mobile-elements-${utils.general.shortid()}`] });
     const environment = await driver.getEnvironment();
     if (settings.region) {
-        logger.log('extract element form region', settings.region);
+        logger.log('extract element from region', settings.region);
         const region = await driver.element(settings.region).catch(error => logger.log(error));
         if (!region) {
             throw new Error('region not found');
@@ -63,7 +63,7 @@ async function extractMobileElementsIntoCheckSettings({ settings, driver, logger
         if (!settings[`${regionType}Regions`])
             return obj;
         obj[`${regionType}Regions`] = (await Promise.all((_b = (_a = settings[`${regionType}Regions`]) === null || _a === void 0 ? void 0 : _a.flatMap(async (reference) => {
-            logger.log('extract element form region', reference);
+            logger.log('extract element from region', reference);
             const { region } = utils.types.has(reference, 'region') ? reference : { region: reference };
             const handleRegion = new Set();
             const elements = await driver.elements(region).catch(error => logger.log(error));

package/dist/classic/check.js

@@ -355,7 +355,7 @@ async function takeNMLScreenshot({ driver, settings, environments, logger, eyes,
                 aggregateCalculatedRegions.push({ regions, selector: reference });
             }
             else {
-                logger.log(`Regions "${reference}" was not found in the screenshot`);
+                logger.log(`Regions "${JSON.stringify(reference)}" was not found in the screenshot`);
             }
         });
         if ((_a = baseTarget.dom) === null || _a === void 0 ? void 0 : _a.error) {

package/dist/ufg/check.js

@@ -174,6 +174,12 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                             },
                         });
                     }
+                    try {
+                        logInvalidSettings(logger, settings);
+                    }
+                    catch (err) {
+                        logger.log('Failed to log invalid check settings', err);
+                    }
                     await baseEyes.check({
                         target: { ...baseTarget, isTransformed: true },
                         settings: baseSettings,
@@ -204,3 +210,14 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
     };
 }
 exports.makeCheck = makeCheck;
+function logInvalidSettings(logger, settings) {
+    const invalidKeys = ['overlap', 'scrollRootElement', 'stitchMode'];
+    if (!settings)
+        return;
+    const invalidEntries = Object.entries(settings)
+        .filter(([key]) => invalidKeys.includes(key))
+        .filter(([_, value]) => value !== undefined);
+    if (invalidEntries.length > 0) {
+        logger.warn('Warning - Invalid keys in check settings (will be ignored):', { settings, invalidEntries });
+    }
+}

package/dist/ufg/utils/take-dom-snapshots.js

@@ -54,36 +54,50 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         return Array(settings.environments.length).fill(snapshot);
     }
     const isStrictBreakpoints = utils.types.isArray((_b = settings.layoutBreakpoints) === null || _b === void 0 ? void 0 : _b.breakpoints);
-    const requiredWidths = await settings.environments.reduce(async (prev, environment, index) => {
-        const { name, width } = (await extractEnvironmentInfo(environment));
-        const requiredWidths = await prev;
-        const requiredWidth = isStrictBreakpoints
-            ? calculateBreakpoint({ breakpoints: settings.layoutBreakpoints.breakpoints, value: width })
-            : width;
-        let environments = requiredWidths.get(requiredWidth);
+    const initialViewportSize = await driver.getViewportSize();
+    const requiredSizes = await settings.environments.reduce(async (prev, environment, index) => {
+        var _a;
+        const { name, width, height } = (await extractEnvironmentInfo(environment));
+        const requiredSizes = await prev;
+        let requiredSize;
+        if ((_a = settings.layoutBreakpoints) === null || _a === void 0 ? void 0 : _a.heightBreakpoints) {
+            const requiredWidth = settings.layoutBreakpoints.breakpoints ? width : initialViewportSize.width;
+            requiredSize = `${requiredWidth},${height}`;
+        }
+        else {
+            const requiredWidth = isStrictBreakpoints
+                ? calculateBreakpoint({ breakpoints: settings.layoutBreakpoints.breakpoints, value: width })
+                : width;
+            requiredSize = `${requiredWidth},${initialViewportSize.height}`;
+        }
+        let environments = requiredSizes.get(requiredSize);
         if (!environments)
-            requiredWidths.set(requiredWidth, (environments = []));
-        environments.push({ name, width, index });
-        return requiredWidths;
+            requiredSizes.set(requiredSize, (environments = []));
+        environments.push({ name, width, height, index });
+        return requiredSizes;
     }, Promise.resolve(new Map()));
     const smallestBreakpoint = Math.min(...(isStrictBreakpoints ? settings.layoutBreakpoints.breakpoints : []));
-    if (isStrictBreakpoints && requiredWidths.has(smallestBreakpoint - 1)) {
+    const smallestSize = `${smallestBreakpoint - 1},${initialViewportSize.height}`;
+    if (isStrictBreakpoints && requiredSizes.has(smallestSize)) {
         const message = lang.requestedEnvironmentSmallerThenBreakpointWarning({
             breakpoint: smallestBreakpoint,
-            browsers: requiredWidths.get(smallestBreakpoint - 1),
+            browsers: requiredSizes.get(smallestSize),
         });
         logger.console.log(chalk_1.default.yellow(message));
     }
-    logger.log(`Taking multiple dom snapshots for the breakpoints`, settings.layoutBreakpoints);
-    const initialViewportSize = await driver.getViewportSize();
+    logger.log(`Taking multiple dom snapshots for the breakpoints`, isStrictBreakpoints ? settings.layoutBreakpoints : requiredSizes);
     const entries = [];
-    const initialsBrowsers = requiredWidths.get(initialViewportSize.width);
+    const initialSize = `${initialViewportSize.width},${initialViewportSize.height}`;
+    const initialsBrowsers = requiredSizes.get(initialSize);
     if (initialsBrowsers) {
         logger.log(`The first dom snapshot is going to be taking for initial viewport size`, initialViewportSize);
-        requiredWidths.delete(initialViewportSize.width);
+        requiredSizes.delete(initialSize);
         entries.push({ browsers: initialsBrowsers });
     }
-    requiredWidths.forEach((browsers, requiredWidth) => entries.push({ viewportSize: { width: requiredWidth, height: initialViewportSize.height }, browsers }));
+    requiredSizes.forEach((browsers, requiredSize) => {
+        const [requiredWidth, requiredHeight] = requiredSize.split(',').map(Number);
+        entries.push({ viewportSize: { width: requiredWidth, height: requiredHeight }, browsers });
+    });
     logger.log(`All entries to take dom snapshots for`, entries);
     // making safe selectors before any resize in order to make sure fallback selectors are created
     await (0, generate_safe_selectors_1.generateSafeSelectors)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.36.0",
+  "version": "4.37.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -77,17 +77,17 @@
   "dependencies": {
     "@applitools/core-base": "1.24.0",
     "@applitools/dom-capture": "11.5.5",
-    "@applitools/dom-snapshot": "4.11.17",
-    "@applitools/driver": "1.21.0",
-    "@applitools/ec-client": "1.10.8",
+    "@applitools/dom-snapshot": "4.11.18",
+    "@applitools/driver": "1.21.1",
+    "@applitools/ec-client": "1.10.9",
     "@applitools/logger": "2.1.2",
-    "@applitools/nml-client": "1.9.0",
+    "@applitools/nml-client": "1.9.1",
     "@applitools/req": "1.7.10",
-    "@applitools/screenshoter": "3.11.0",
-    "@applitools/snippets": "2.6.4",
+    "@applitools/screenshoter": "3.11.1",
+    "@applitools/snippets": "2.6.5",
     "@applitools/socket": "1.2.3",
-    "@applitools/spec-driver-webdriver": "1.2.1",
-    "@applitools/ufg-client": "1.16.8",
+    "@applitools/spec-driver-webdriver": "1.2.2",
+    "@applitools/ufg-client": "1.16.9",
     "@applitools/utils": "1.8.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -102,11 +102,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.26",
-    "@applitools/spec-driver-selenium": "^1.5.97",
+    "@applitools/spec-driver-puppeteer": "^1.4.27",
+    "@applitools/spec-driver-selenium": "^1.5.98",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.6.4",
+    "@applitools/tunnel-client": "^1.6.5",
     "@types/mocha": "^10.0.7",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",

package/types/ufg/check-and-close.d.ts

@@ -19,6 +19,7 @@ export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target
         disableBrowserFetching?: boolean | undefined;
         layoutBreakpoints?: {
             breakpoints: boolean | number[];
+            heightBreakpoints?: boolean | undefined;
             reload?: boolean | undefined;
         } | undefined;
         hooks?: {

package/types/ufg/types.d.ts

@@ -54,6 +54,7 @@ export type SnapshotSettings<TSpec extends SpecType> = AutomationCore.CheckSetti
     disableBrowserFetching?: boolean;
     layoutBreakpoints?: {
         breakpoints: number[] | boolean;
+        heightBreakpoints?: boolean;
         reload?: boolean;
     };
     hooks?: {

package/types/ufg/utils/take-dom-snapshots.d.ts

@@ -10,6 +10,7 @@ export type DomSnapshotsSettings<TSpec extends SpecType> = DomSnapshotSettings<T
     waitBeforeCapture?: number | (() => Promise<void>);
     layoutBreakpoints?: {
         breakpoints: number[] | boolean;
+        heightBreakpoints?: boolean;
         reload?: boolean;
     };
     lazyLoad?: boolean | LazyLoadOptions;

package/dist/errors/test-error.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestError = void 0;
-const core_base_1 = require("@applitools/core-base");
-class TestError extends core_base_1.CoreError {
-    constructor(result) {
-        if (result.status === 'Failed') {
-            super(`Test '${result.name}' of '${result.appName}' is failed! See details at ${result.url}`, {
-                reason: 'test failed',
-                result,
-            });
-        }
-        else if (result.status === 'Unresolved') {
-            if (result.isNew) {
-                super(`Test '${result.name}' of '${result.appName}' is new! Please approve the new baseline at ${result.url}`, {
-                    reason: 'test new',
-                    result,
-                });
-            }
-            else {
-                super(`Test '${result.name}' of '${result.appName}' detected differences! See details at: ${result.url}`, {
-                    reason: 'test different',
-                    result,
-                });
-            }
-        }
-        else {
-            super('');
-        }
-    }
-}
-exports.TestError = TestError;

package/types/errors/test-error.d.ts

@@ -1,5 +0,0 @@
-import type { TestResult } from '@applitools/core-base';
-import { CoreError } from '@applitools/core-base';
-export declare class TestError extends CoreError {
-    constructor(result: TestResult);
-}