@applitools/core 4.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # Changelog
 
+## [4.1.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.0.2...js/core@4.1.0) (2023-11-07)
+
+
+### Features
+
+* added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+
+
+### Bug Fixes
+
+* fixed issue that caused dom snapshots to be taken for different viewport sizes when layout breakpoints were explicitly turned off ([4121876](https://github.com/applitools/eyes.sdk.javascript1/commit/4121876189f133b6023cfea52ca91c02c31079fb))
+
+
+### Dependencies
+
+* @applitools/dom-shared bumped to 1.0.11
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+* @applitools/dom-capture bumped to 11.2.4
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+
+
+
+* @applitools/dom-snapshot bumped to 4.7.13
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+  * handled duplicated style properties in inline style tags ([#2014](https://github.com/applitools/eyes.sdk.javascript1/issues/2014)) ([2f8bada](https://github.com/applitools/eyes.sdk.javascript1/commit/2f8bada9cd44c65a69e54cbd08f57534632f12d2))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.0.49
+
+* @applitools/spec-driver-selenium bumped to 1.5.63
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.5
+
+* @applitools/driver bumped to 1.15.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+* @applitools/ufg-client bumped to 1.9.7
+  #### Bug Fixes
+
+  * added retries on ufg requests that respond with 503 status code ([7d78917](https://github.com/applitools/eyes.sdk.javascript1/commit/7d78917d559fa182c6723ca34cef2118cf08a036))
+* @applitools/screenshoter bumped to 3.8.15
+
+* @applitools/nml-client bumped to 1.5.15
+
+* @applitools/ec-client bumped to 1.7.15
+
+
+## [4.0.2](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.0.1...js/core@4.0.2) (2023-10-30)
+
+
+### Bug Fixes
+
+* generate safe selectors as close as possible to taking dom snapshot ([#1987](https://github.com/applitools/eyes.sdk.javascript1/issues/1987)) ([102208b](https://github.com/applitools/eyes.sdk.javascript1/commit/102208b909c0b149808f6e4c24a0a662305b1b78))
+
 ## [4.0.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.0.0...js/core@4.0.1) (2023-10-25)
 
 

package/dist/check.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("./lang"));
 const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget, spec, logger: mainLogger, }) {
     let stepIndex = 0;
@@ -57,7 +58,7 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
         settings.stepIndex = stepIndex++;
         (_p = settings.waitBetweenStitches) !== null && _p !== void 0 ? _p : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
         if (settings.matchLevel === 'Content') {
-            logger.console.log(chalk_1.default.yellow(`The "Content" match level value has been deprecated, use "IgnoreColors" instead.`));
+            logger.console.log(chalk_1.default.yellow(lang.matchLevelContentDeprecatedWarning));
         }
         const driver = (0, driver_1.isDriver)(target, spec)
             ? await (0, driver_1.makeDriver)({ spec, driver: target, reset: target === defaultTarget, logger })

package/dist/classic/check-and-close.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
@@ -31,10 +34,12 @@ const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const uniquify_environments_1 = require("../automation/utils/uniquify-environments");
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
+const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
 function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         logger = logger.extend(mainLogger);
         logger.log('Command "checkAndClose" is called with settings', settings);
         if (!target)
@@ -70,7 +75,9 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                 });
             }
             const { elementReferencesToCalculate, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
-            if (driverEnvironment.isWeb || !driverEnvironment.isApplitoolsLib || settings.screenshotMode === 'default') {
+            if (driverEnvironment.isWeb ||
+                !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) ||
+                settings.screenshotMode === 'default') {
                 const screenshots = await (0, take_screenshots_1.takeScreenshots)({
                     driver,
                     settings: {
@@ -89,6 +96,13 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                 });
             }
             else {
+                if (driverEnvironment.applitoolsLib.conflictingCapabilities) {
+                    const message = lang.applitoolsLibConflictingCapabilitiesWarning({
+                        conflictingCapabilities: driverEnvironment.applitoolsLib.conflictingCapabilities,
+                    });
+                    logger.console.log(chalk_1.default.yellow(message));
+                    logger.log(message);
+                }
                 const nmlClient = await eyes.core.getNMLClient({
                     driver,
                     settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },

package/dist/classic/check.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
@@ -31,10 +34,12 @@ const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const uniquify_environments_1 = require("../automation/utils/uniquify-environments");
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
+const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
 function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         logger = logger.extend(mainLogger);
         logger.log('Command "check" is called with settings', settings);
         if (!target)
@@ -70,7 +75,9 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                 });
             }
             const { elementReferencesToCalculate, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
-            if (driverEnvironment.isWeb || !driverEnvironment.isApplitoolsLib || settings.screenshotMode === 'default') {
+            if (driverEnvironment.isWeb ||
+                !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) ||
+                settings.screenshotMode === 'default') {
                 const screenshots = await (0, take_screenshots_1.takeScreenshots)({
                     driver,
                     settings: {
@@ -89,6 +96,13 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                 });
             }
             else {
+                if (driverEnvironment.applitoolsLib.conflictingCapabilities) {
+                    const message = lang.applitoolsLibConflictingCapabilitiesWarning({
+                        conflictingCapabilities: driverEnvironment.applitoolsLib.conflictingCapabilities,
+                    });
+                    logger.console.log(chalk_1.default.yellow(message));
+                    logger.log(message);
+                }
                 const nmlClient = await eyes.core.getNMLClient({
                     driver,
                     settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },

package/dist/lang.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applitoolsLibConflictingCapabilitiesWarning = exports.requestedEnvironmentOutOfDriverBoundsWarning = exports.breakpointOutOfDriverBoundsWarning = exports.requestedEnvironmentSmallerThenBreakpointWarning = exports.edgeUfgEnvironmentDeprecatedWarning = exports.matchLevelContentDeprecatedWarning = void 0;
+exports.matchLevelContentDeprecatedWarning = `The "Content" match level value has been deprecated, use "IgnoreColors" instead.`;
+exports.edgeUfgEnvironmentDeprecatedWarning = `The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`;
+const requestedEnvironmentSmallerThenBreakpointWarning = (options) => {
+    const browsers = options.browsers.map(({ name, width }) => `(${name}, ${width})`).join(', ');
+    return `The following configuration's viewport-widths are smaller than the smallest configured layout breakpoint (${options.breakpoint} pixels): [${browsers}]. As a fallback, the resources that will be used for these configurations have been captured on a viewport-width of ${options.breakpoint} - 1 pixels. If an additional layout breakpoint is needed for you to achieve better results - please add it to your configuration.`;
+};
+exports.requestedEnvironmentSmallerThenBreakpointWarning = requestedEnvironmentSmallerThenBreakpointWarning;
+const breakpointOutOfDriverBoundsWarning = (options) => {
+    const browsers = options.browsers.map(({ name, width }) => `(${name}, ${width})`).join(', ');
+    return `One of the configured layout breakpoints is ${options.requiredWidth} pixels, while your local browser has a limit of ${options.actualWidth}, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for the following configurations: [${browsers}] have been captured on the browser's limit (${options.actualWidth} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`;
+};
+exports.breakpointOutOfDriverBoundsWarning = breakpointOutOfDriverBoundsWarning;
+const requestedEnvironmentOutOfDriverBoundsWarning = (options) => {
+    const browsers = options.browsers.map(({ name }) => `(${name})`).join(', ');
+    return `The following configurations [${browsers}] have a viewport-width of ${options.requiredWidth} pixels, while your local browser has a limit of ${options.actualWidth} pixels, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for these checkpoints have been captured on the browser's limit (${options.actualWidth} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`;
+};
+exports.requestedEnvironmentOutOfDriverBoundsWarning = requestedEnvironmentOutOfDriverBoundsWarning;
+const applitoolsLibConflictingCapabilitiesWarning = (options) => {
+    const conflictingCapabilities = Object.entries(options.conflictingCapabilities)
+        .map(entry => entry.join(': '))
+        .join(', ');
+    return `We have identified ${conflictingCapabilities} in your driver capabilities, this may prevent Applitools Native Library from loading. If you are not sure whether this will cause a problem, contact Support.`;
+};
+exports.applitoolsLibConflictingCapabilitiesWarning = applitoolsLibConflictingCapabilitiesWarning;

package/dist/ufg/check-and-close.js

@@ -34,6 +34,7 @@ const uniquify_environments_1 = require("../automation/utils/uniquify-environmen
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
 function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
@@ -132,8 +133,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
             const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
             const ufgEnvironment = environment;
             if (utils.types.has(ufgEnvironment, 'name') && ufgEnvironment.name === 'edge') {
-                const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
-                environmentLogger.console.log(message);
+                environmentLogger.console.log(chalk_1.default.yellow(lang.edgeUfgEnvironmentDeprecatedWarning));
             }
             try {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {

package/dist/ufg/check.js

@@ -34,6 +34,7 @@ const uniquify_environments_1 = require("../automation/utils/uniquify-environmen
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
@@ -132,8 +133,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
             const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
             const ufgEnvironment = environment;
             if (utils.types.has(ufgEnvironment, 'name') && ufgEnvironment.name === 'edge') {
-                const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
-                environmentLogger.console.log(message);
+                environmentLogger.console.log(chalk_1.default.yellow(lang.edgeUfgEnvironmentDeprecatedWarning));
             }
             try {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {

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

@@ -27,10 +27,11 @@ exports.extractCrossFrames = exports.takeDomSnapshot = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { getProcessPagePoll, getPollResult, getProcessPagePollForIE, getPollResultForIE, } = require('@applitools/dom-snapshot');
 async function takeDomSnapshot({ context, settings, logger, }) {
+    var _a;
     const driver = context.driver;
     const environment = await driver.getEnvironment();
     const features = await driver.getFeatures();
-    const cookies = features.allCookies ? await driver.getCookies().catch(() => []) : [];
+    const cookies = ((_a = settings === null || settings === void 0 ? void 0 : settings.cookies) !== null && _a !== void 0 ? _a : features.allCookies) ? await driver.getCookies().catch(() => []) : [];
     const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context }));
     snapshot.cookies = cookies;
     return snapshot;

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

@@ -35,9 +35,13 @@ const calculate_regions_1 = require("./calculate-regions");
 const wait_for_lazy_load_1 = require("../../automation/utils/wait-for-lazy-load");
 const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../../lang"));
 __exportStar(require("./take-dom-snapshot"), exports);
 async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
     var _a, _b, _c, _d, _e, _f, _g;
+    // calculating cookies here once so that we (a) don't do it for each dom snapshot, and (b) do it before generating safe selectors
+    const features = await driver.getFeatures();
+    settings.cookies = features.allCookies ? await driver.getCookies().catch(() => []) : [];
     const currentContext = driver.currentContext;
     let calculateRegionsResults = {};
     const waitBeforeCapture = async () => {
@@ -55,16 +59,17 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
             logger,
         });
     }
-    if (!((_a = settings.layoutBreakpoints) === null || _a === void 0 ? void 0 : _a.reload) && settings.calculateRegionsOptions) {
-        calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
-            ...settings.calculateRegionsOptions,
-            driver,
-        });
-    }
-    if (!settings.layoutBreakpoints) {
+    if (!((_a = settings.layoutBreakpoints) === null || _a === void 0 ? void 0 : _a.breakpoints)) {
         logger.log(`taking single dom snapshot`);
         await ((_b = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _b === void 0 ? void 0 : _b.call(hooks));
         await waitBeforeCapture();
+        // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
+        if (settings.calculateRegionsOptions) {
+            calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
+                ...settings.calculateRegionsOptions,
+                driver,
+            });
+        }
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         await ((_c = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _c === void 0 ? void 0 : _c.call(calculateRegionsResults));
         return Array(settings.environments.length).fill({ snapshot, ...calculateRegionsResults });
@@ -84,12 +89,11 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
     }, Promise.resolve(new Map()));
     const smallestBreakpoint = Math.min(...(isStrictBreakpoints ? settings.layoutBreakpoints.breakpoints : []));
     if (isStrictBreakpoints && requiredWidths.has(smallestBreakpoint - 1)) {
-        const smallestBrowsers = requiredWidths
-            .get(smallestBreakpoint - 1)
-            .map(({ name, width }) => `(${name}, ${width})`)
-            .join(', ');
-        const message = chalk_1.default.yellow(`The following configuration's viewport-widths are smaller than the smallest configured layout breakpoint (${smallestBreakpoint} pixels): [${smallestBrowsers}]. As a fallback, the resources that will be used for these configurations have been captured on a viewport-width of ${smallestBreakpoint} - 1 pixels. If an additional layout breakpoint is needed for you to achieve better results - please add it to your configuration.`);
-        logger.console.log(message);
+        const message = lang.requestedEnvironmentSmallerThenBreakpointWarning({
+            breakpoint: smallestBreakpoint,
+            browsers: requiredWidths.get(smallestBreakpoint - 1),
+        });
+        logger.console.log(chalk_1.default.yellow(message));
     }
     logger.log(`taking multiple dom snapshots for breakpoints:`, settings.layoutBreakpoints.breakpoints);
     logger.log(`required widths: ${[...requiredWidths.keys()].join(', ')}`);
@@ -99,6 +103,13 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         logger.log(`taking dom snapshot for existing width ${viewportSize.width}`);
         await ((_e = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _e === void 0 ? void 0 : _e.call(hooks));
         await waitBeforeCapture();
+        // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
+        if (settings.calculateRegionsOptions) {
+            calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
+                ...settings.calculateRegionsOptions,
+                driver,
+            });
+        }
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         requiredWidths.get(viewportSize.width).forEach(({ index }) => {
             snapshotsResults[index] = { snapshot, ...calculateRegionsResults };
@@ -108,35 +119,43 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         logger.log(`taking dom snapshot for width ${requiredWidth}`);
         try {
             await driver.setViewportSize({ width: requiredWidth, height: viewportSize.height });
-            if (settings.layoutBreakpoints.reload) {
-                await driver.reloadPage();
-                await waitBeforeCapture();
-                if (settings.calculateRegionsOptions) {
-                    calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
-                        ...settings.calculateRegionsOptions,
-                        driver,
-                    });
-                }
-            }
         }
-        catch (err) {
-            logger.error(err);
+        catch (error) {
+            logger.error(`Failed to set viewport size to ${requiredWidth} du to error: `, error);
             const actualViewportSize = await driver.getViewportSize();
             if (isStrictBreakpoints) {
-                const failedBrowsers = browsersInfo.map(({ name, width }) => `(${name}, ${width})`).join(', ');
-                const message = chalk_1.default.yellow(`One of the configured layout breakpoints is ${requiredWidth} pixels, while your local browser has a limit of ${actualViewportSize.width}, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for the following configurations: [${failedBrowsers}] have been captured on the browser's limit (${actualViewportSize.width} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`);
-                logger.console.log(message);
+                const message = lang.breakpointOutOfDriverBoundsWarning({
+                    requiredWidth,
+                    actualWidth: actualViewportSize.width,
+                    browsers: browsersInfo,
+                });
+                logger.console.log(chalk_1.default.yellow(message));
                 logger.log(message);
             }
             else {
-                const failedBrowsers = browsersInfo.map(({ name }) => `(${name})`).join(', ');
-                const message = chalk_1.default.yellow(`The following configurations [${failedBrowsers}] have a viewport-width of ${requiredWidth} pixels, while your local browser has a limit of ${actualViewportSize.width} pixels, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for these checkpoints have been captured on the browser's limit (${actualViewportSize.width} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`);
-                logger.console.log(message);
+                const message = lang.requestedEnvironmentOutOfDriverBoundsWarning({
+                    requiredWidth,
+                    actualWidth: actualViewportSize.width,
+                    browsers: browsersInfo,
+                });
+                logger.console.log(chalk_1.default.yellow(message));
                 logger.log(message);
             }
         }
+        if (settings.layoutBreakpoints.reload) {
+            await driver.reloadPage();
+        }
         await ((_f = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _f === void 0 ? void 0 : _f.call(hooks));
         await waitBeforeCapture();
+        if (settings.layoutBreakpoints.reload) {
+            // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
+            if (settings.calculateRegionsOptions) {
+                calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
+                    ...settings.calculateRegionsOptions,
+                    driver,
+                });
+            }
+        }
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         browsersInfo.forEach(({ index }) => {
             snapshotsResults[index] = { snapshot, ...calculateRegionsResults };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -69,18 +69,18 @@
   },
   "dependencies": {
     "@applitools/core-base": "1.7.2",
-    "@applitools/dom-capture": "11.2.3",
-    "@applitools/dom-snapshot": "4.7.12",
-    "@applitools/driver": "1.14.4",
-    "@applitools/ec-client": "1.7.14",
+    "@applitools/dom-capture": "11.2.4",
+    "@applitools/dom-snapshot": "4.7.13",
+    "@applitools/driver": "1.15.0",
+    "@applitools/ec-client": "1.7.15",
     "@applitools/logger": "2.0.12",
-    "@applitools/nml-client": "1.5.14",
+    "@applitools/nml-client": "1.5.15",
     "@applitools/req": "1.6.2",
-    "@applitools/screenshoter": "3.8.14",
+    "@applitools/screenshoter": "3.8.15",
     "@applitools/snippets": "2.4.24",
     "@applitools/socket": "1.1.12",
-    "@applitools/spec-driver-webdriver": "1.0.48",
-    "@applitools/ufg-client": "1.9.6",
+    "@applitools/spec-driver-webdriver": "1.0.49",
+    "@applitools/ufg-client": "1.9.7",
     "@applitools/utils": "1.6.2",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -91,17 +91,16 @@
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^5.7.0",
+    "@applitools/bongo": "^5.7.4",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.2.4",
-    "@applitools/spec-driver-selenium": "^1.5.62",
+    "@applitools/spec-driver-puppeteer": "^1.2.5",
+    "@applitools/spec-driver-selenium": "^1.5.63",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.3.0",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/yargs": "^17.0.22",
-    "chromedriver": "^115.0.1",
     "nock": "^13.3.2",
     "png-async": "^0.9.4",
     "puppeteer": "^19.11.1",

package/types/lang.d.ts

@@ -0,0 +1,27 @@
+export declare const matchLevelContentDeprecatedWarning = "The \"Content\" match level value has been deprecated, use \"IgnoreColors\" instead.";
+export declare const edgeUfgEnvironmentDeprecatedWarning = "The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.";
+export declare const requestedEnvironmentSmallerThenBreakpointWarning: (options: {
+    breakpoint: number;
+    browsers: {
+        name: string;
+        width: number;
+    }[];
+}) => string;
+export declare const breakpointOutOfDriverBoundsWarning: (options: {
+    requiredWidth: number;
+    actualWidth: number;
+    browsers: {
+        name: string;
+        width: number;
+    }[];
+}) => string;
+export declare const requestedEnvironmentOutOfDriverBoundsWarning: (options: {
+    requiredWidth: number;
+    actualWidth: number;
+    browsers: {
+        name: string;
+    }[];
+}) => string;
+export declare const applitoolsLibConflictingCapabilitiesWarning: (options: {
+    conflictingCapabilities: Record<string, any>;
+}) => string;

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

@@ -1,5 +1,5 @@
 import { type Logger } from '@applitools/logger';
-import { type SpecType, type Context } from '@applitools/driver';
+import { type SpecType, type Context, type Cookie } from '@applitools/driver';
 import { type DomSnapshot } from '@applitools/ufg-client';
 export type RawDomSnapshot = {
     url: string;
@@ -30,6 +30,7 @@ export type DomSnapshotSettings = {
     executionTimeout?: number;
     pollTimeout?: number;
     showLogs?: boolean;
+    cookies?: Cookie[];
 };
 export declare function takeDomSnapshot<TSpec extends SpecType>({ context, settings, logger, }: {
     context: Context<TSpec>;