@applitools/eyes-browser 1.0.6 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,81 @@
 # Changelog
 
+## [1.1.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-browser-v1.0.7...js/eyes-browser@1.1.0) (2024-02-13)
+
+
+### Features
+
+* add support for browser in eyes ([#2054](https://github.com/applitools/eyes.sdk.javascript1/issues/2054)) ([4af82dd](https://github.com/applitools/eyes.sdk.javascript1/commit/4af82dd2a667c13adfed0be98a026181755256c6))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.7.17
+  #### Bug Fixes
+
+  * throw error for encoding none unicode char ([#2171](https://github.com/applitools/eyes.sdk.javascript1/issues/2171)) ([4edb9cf](https://github.com/applitools/eyes.sdk.javascript1/commit/4edb9cfb27d8db2ff4cb09c8ebf1b95ab020633d))
+* @applitools/spec-driver-webdriver bumped to 1.0.57
+  #### Bug Fixes
+
+  * fixed issue with cdp commands on chromium browsers ([#2180](https://github.com/applitools/eyes.sdk.javascript1/issues/2180)) ([550fc77](https://github.com/applitools/eyes.sdk.javascript1/commit/550fc772d3988aae29e6f4a1a11d2a408072dc38))
+* @applitools/spec-driver-puppeteer bumped to 1.4.0
+  #### Features
+
+  * added support for puppeteer >= 22 ([#2185](https://github.com/applitools/eyes.sdk.javascript1/issues/2185)) ([59d23a9](https://github.com/applitools/eyes.sdk.javascript1/commit/59d23a9689d77c7db06df53b67fa293a3b3f166e))
+* @applitools/core bumped to 4.8.0
+  #### Features
+
+  * add support for regions and calculated regions ([#2161](https://github.com/applitools/eyes.sdk.javascript1/issues/2161)) ([fea4b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/fea4b1fca3d8f59eada2b5186cd32d47352ccf1a))
+
+
+  #### Bug Fixes
+
+  * missing viewport when using system screenshot and multi viewport ([#2173](https://github.com/applitools/eyes.sdk.javascript1/issues/2173)) ([411283c](https://github.com/applitools/eyes.sdk.javascript1/commit/411283c7bebc09f178d73b6b47e81e5ce4244d5e))
+  * nml coded region integration with universal ([6fb0934](https://github.com/applitools/eyes.sdk.javascript1/commit/6fb09348238dfe4698856f88e762a9abf80c686f))
+  * throw error for encoding none unicode char ([#2171](https://github.com/applitools/eyes.sdk.javascript1/issues/2171)) ([4edb9cf](https://github.com/applitools/eyes.sdk.javascript1/commit/4edb9cfb27d8db2ff4cb09c8ebf1b95ab020633d))
+
+
+
+* @applitools/screenshoter bumped to 3.8.23
+
+* @applitools/nml-client bumped to 1.7.0
+  #### Features
+
+  * add support for regions and calculated regions ([#2161](https://github.com/applitools/eyes.sdk.javascript1/issues/2161)) ([fea4b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/fea4b1fca3d8f59eada2b5186cd32d47352ccf1a))
+
+
+  #### Bug Fixes
+
+  * missing viewport when using system screenshot and multi viewport ([#2173](https://github.com/applitools/eyes.sdk.javascript1/issues/2173)) ([411283c](https://github.com/applitools/eyes.sdk.javascript1/commit/411283c7bebc09f178d73b6b47e81e5ce4244d5e))
+
+
+
+* @applitools/ec-client bumped to 1.7.25
+
+* @applitools/eyes bumped to 1.14.0
+  #### Features
+
+  * add Eyes.getResults method ([#2046](https://github.com/applitools/eyes.sdk.javascript1/issues/2046)) ([#2069](https://github.com/applitools/eyes.sdk.javascript1/issues/2069)) ([4d263e1](https://github.com/applitools/eyes.sdk.javascript1/commit/4d263e19cb5e5708790a1a7ef90ff8f3eee50d91))
+  * added `enableEyesLogs` configuration to the eyes service ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * added `useExecutionCloud` configuration to the eyes service ([#2033](https://github.com/applitools/eyes.sdk.javascript1/issues/2033)) ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * generate more enums ([#2179](https://github.com/applitools/eyes.sdk.javascript1/issues/2179)) ([5f4f916](https://github.com/applitools/eyes.sdk.javascript1/commit/5f4f91621b791a02464191123f69b12f590b9efe))
+
+
+  #### Bug Fixes
+
+  * error to unknown type in exception ([#2035](https://github.com/applitools/eyes.sdk.javascript1/issues/2035)) ([16d78c3](https://github.com/applitools/eyes.sdk.javascript1/commit/16d78c3cce90a5cb50cc2aa4e9ab6a58b7b93f89))
+  * fixed `serverUrl` configuration propagation ([247b7d8](https://github.com/applitools/eyes.sdk.javascript1/commit/247b7d88853dd1a9068d2d963582ad795752ace4))
+  * fixed default value in `useSystemScreenshot` method of check settings ([42a773c](https://github.com/applitools/eyes.sdk.javascript1/commit/42a773cc57e8e5de528a049b376159615892003b))
+  * fixed issue when w3c properties were added to legacy capabilities object in `Eyes.setMobileCapabilities` method ([94d785f](https://github.com/applitools/eyes.sdk.javascript1/commit/94d785f0428df101c207d6f09a55c46f2bdbf19e))
+
+
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+
 ## [1.0.6](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-browser@1.0.5...js/eyes-browser@1.0.6) (2024-01-30)
 
 

package/dist/index.js

@@ -32863,9 +32863,9 @@ var require_req_broker = __commonJS({
   }
 });
 
-// ../nml-client/dist/server/requests.js
-var require_requests2 = __commonJS({
-  "../nml-client/dist/server/requests.js"(exports) {
+// ../nml-client/dist/utils/get-environments-info.js
+var require_get_environments_info = __commonJS({
+  "../nml-client/dist/utils/get-environments-info.js"(exports) {
     "use strict";
     init_process();
     init_setImmediate();
@@ -32906,50 +32906,129 @@ var require_requests2 = __commonJS({
       return mod && mod.__esModule ? mod : { "default": mod };
     };
     Object.defineProperty(exports, "__esModule", { value: true });
+    exports.getNMLEnvironmentsInfo = void 0;
+    var utils34 = __importStar(require_browser3());
+    var req_1 = __importDefault((init_dist(), __toCommonJS(dist_exports)));
+    var getNMLSupportedEnvironmentsWithCache = utils34.general.cachify(getNMLSupportedEnvironments);
+    async function getNMLSupportedEnvironments({ supportedEnvironmentsUrl, proxy }) {
+      const response = await (0, req_1.default)(supportedEnvironmentsUrl, { proxy });
+      const result = await response.json();
+      return result;
+    }
+    async function getNMLEnvironmentsInfo({ environments, supportedEnvironmentsUrl, proxy, logger: _logger }) {
+      const supportedEnvironments = await getNMLSupportedEnvironmentsWithCache({ supportedEnvironmentsUrl, proxy });
+      return environments.reduce((result, environment) => {
+        var _a;
+        if (!utils34.types.has(environment, "iosDeviceInfo") && !utils34.types.has(environment, "androidDeviceInfo")) {
+          result.localEnvironment = environment;
+        } else {
+          const deviceInfo = utils34.types.has(environment, "iosDeviceInfo") ? environment.iosDeviceInfo : environment.androidDeviceInfo;
+          const orientation = deviceInfo.screenOrientation === "landscape" ? "landscapeLeft" : (_a = deviceInfo.screenOrientation) !== null && _a !== void 0 ? _a : "portrait";
+          const rawEnvironment = supportedEnvironments[deviceInfo.deviceName][orientation].env;
+          result.renderEnvironments.push({
+            requested: environment,
+            environmentId: utils34.general.guid(),
+            deviceName: rawEnvironment.deviceInfo,
+            os: rawEnvironment.os + (deviceInfo.version ? ` ${deviceInfo.version}` : ""),
+            viewportSize: rawEnvironment.displaySize
+          });
+          result.environmentSettings.push({ ...supportedEnvironments[deviceInfo.deviceName], orientation });
+        }
+        return result;
+      }, {
+        localEnvironment: void 0,
+        renderEnvironments: [],
+        environmentSettings: []
+      });
+    }
+    exports.getNMLEnvironmentsInfo = getNMLEnvironmentsInfo;
+  }
+});
+
+// ../nml-client/dist/server/requests.js
+var require_requests2 = __commonJS({
+  "../nml-client/dist/server/requests.js"(exports) {
+    "use strict";
+    init_process();
+    init_setImmediate();
+    init_buffer();
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      o[k2] = m[k];
+    });
+    var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? function(o, v) {
+      Object.defineProperty(o, "default", { enumerable: true, value: v });
+    } : function(o, v) {
+      o["default"] = v;
+    });
+    var __importStar = exports && exports.__importStar || function(mod) {
+      if (mod && mod.__esModule)
+        return mod;
+      var result = {};
+      if (mod != null) {
+        for (var k in mod)
+          if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+            __createBinding(result, mod, k);
+      }
+      __setModuleDefault(result, mod);
+      return result;
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
     exports.makeNMLRequests = void 0;
     var req_broker_1 = require_req_broker();
-    var req_1 = __importDefault((init_dist(), __toCommonJS(dist_exports)));
     var utils34 = __importStar(require_browser3());
+    var get_environments_info_1 = require_get_environments_info();
     function makeNMLRequests({ settings, logger: mainLogger }) {
       let brokerUrl = settings.brokerUrl;
+      const supportedEnvironmentsUrl = settings.supportedEnvironmentsUrl;
+      const proxy = settings.proxy;
       const req2 = (0, req_broker_1.makeReqBroker)({ settings, logger: mainLogger });
-      const getSupportedEnvironmentsWithCache = utils34.general.cachify(getSupportedEnvironments, () => "default");
       return {
-        getSupportedEnvironments: getSupportedEnvironmentsWithCache,
+        preTakeScreenshot,
         takeScreenshots,
         takeSnapshots
       };
-      async function getSupportedEnvironments({ logger: _logger }) {
-        const response = await (0, req_1.default)(settings.supportedEnvironmentsUrl);
+      async function preTakeScreenshot({ logger = mainLogger } = {}) {
+        var _a;
+        logger = logger.extend(mainLogger, { tags: [`nml-request-${utils34.general.shortid()}`] });
+        logger.log('Request "preTakeScreenshot" called');
+        const response = await req2(brokerUrl, {
+          name: "PRE_TAKE_SCREENSHOT",
+          body: {
+            protocolVersion: "1.0",
+            name: "PRE_TAKE_SCREENSHOT",
+            key: utils34.general.guid(),
+            payload: {}
+          },
+          logger
+        });
         const result = await response.json();
-        return result;
+        if (((_a = result === null || result === void 0 ? void 0 : result.payload) === null || _a === void 0 ? void 0 : _a.result) === "success")
+          logger.log('Request "preTakeScreenshot" finished successfully with body', result.payload);
+        else
+          throw new Error(`There was a problem in pre take screenshot. The provided error message was "${result}"`);
+        brokerUrl = result.nextPath;
       }
       async function takeScreenshots({ settings: settings2, logger = mainLogger }) {
+        var _a, _b;
         logger = logger.extend(mainLogger, { tags: [`nml-request-${utils34.general.shortid()}`] });
         logger.log('Request "takeScreenshots" called with settings', settings2);
-        const supportedEnvironments = await getSupportedEnvironmentsWithCache({ logger });
-        const { localEnvironment, renderEnvironments, environmentSettings } = settings2.environments.reduce((result, environment) => {
-          var _a;
-          if (!utils34.types.has(environment, "iosDeviceInfo") && !utils34.types.has(environment, "androidDeviceInfo")) {
-            result.localEnvironment = environment;
-          } else {
-            const deviceInfo = utils34.types.has(environment, "iosDeviceInfo") ? environment.iosDeviceInfo : environment.androidDeviceInfo;
-            const orientation = deviceInfo.screenOrientation === "landscape" ? "landscapeLeft" : (_a = deviceInfo.screenOrientation) !== null && _a !== void 0 ? _a : "portrait";
-            const rawEnvironment = supportedEnvironments[deviceInfo.deviceName][orientation].env;
-            result.renderEnvironments.push({
-              requested: environment,
-              environmentId: utils34.general.guid(),
-              deviceName: rawEnvironment.deviceInfo,
-              os: rawEnvironment.os + (deviceInfo.version ? ` ${deviceInfo.version}` : ""),
-              viewportSize: rawEnvironment.displaySize
-            });
-            result.environmentSettings.push({ ...supportedEnvironments[deviceInfo.deviceName], orientation });
-          }
-          return result;
-        }, {
-          localEnvironment: void 0,
-          renderEnvironments: [],
-          environmentSettings: []
+        const { localEnvironment, renderEnvironments, environmentSettings } = await (0, get_environments_info_1.getNMLEnvironmentsInfo)({
+          environments: settings2.environments,
+          supportedEnvironmentsUrl,
+          proxy,
+          logger
         });
         try {
           const response = await req2(brokerUrl, {
@@ -32961,7 +33040,10 @@ var require_requests2 = __commonJS({
               payload: {
                 ...settings2,
                 environments: void 0,
-                deviceList: !localEnvironment ? environmentSettings : void 0
+                deviceList: !localEnvironment ? environmentSettings : void 0,
+                scrollRootElement: fallbackId(settings2.scrollRootElement),
+                region: fallbackId(settings2.region),
+                selectorsToFindRegionsFor: (_a = settings2.selectorsToFindRegionsFor) === null || _a === void 0 ? void 0 : _a.map((selector) => fallbackId(selector))
               }
             },
             logger
@@ -32971,11 +33053,22 @@ var require_requests2 = __commonJS({
           let screenshots;
           if (Number(result.protocolVersion) >= 2) {
             logger.log(`Request "takeScreenshots" was performed on applitools lib v${result.nmlVersion} through protocol v${result.protocolVersion} on device`, result.payload.debugInfo);
-            screenshots = localEnvironment ? [{ image: result.payload.result[0].result.screenshotUrl, environment: localEnvironment }] : renderEnvironments.map((environment, index) => {
+            screenshots = localEnvironment ? [
+              {
+                image: result.payload.result[0].result.screenshotUrl,
+                environment: localEnvironment,
+                calculateRegions: (_b = result.payload.result[0].result) === null || _b === void 0 ? void 0 : _b.selectorRegions
+              }
+            ] : renderEnvironments.map((environment, index) => {
+              var _a2;
               if (result.payload.result[index].error) {
                 throw new Error(`There was a problem in taking screenshot for environment ${JSON.stringify(environment)}. The provided error message was "${result.payload.result[index].error.message}" and had a stack trace of "${result.payload.result[index].error.stack}"`);
               }
-              return { image: result.payload.result[index].result.screenshotUrl, environment };
+              return {
+                image: result.payload.result[index].result.screenshotUrl,
+                calculateRegions: (_a2 = result.payload.result[index].result) === null || _a2 === void 0 ? void 0 : _a2.selectorRegions,
+                environment
+              };
             });
           } else {
             screenshots = localEnvironment ? [{ image: result.payload.result.screenshotUrl, environment: localEnvironment }] : renderEnvironments.map((environment, index) => {
@@ -32989,6 +33082,9 @@ var require_requests2 = __commonJS({
             brokerUrl = error.nextPath;
           throw error;
         }
+        function fallbackId(selector) {
+          return utils34.types.isString(selector) ? { type: "accessibility-identifier", selector } : selector;
+        }
       }
       async function takeSnapshots({ settings: settings2, logger = mainLogger }) {
         try {
@@ -33066,6 +33162,24 @@ var require_take_screenshots = __commonJS({
   }
 });
 
+// ../nml-client/dist/pre-take-screenshot.js
+var require_pre_take_screenshot = __commonJS({
+  "../nml-client/dist/pre-take-screenshot.js"(exports) {
+    "use strict";
+    init_process();
+    init_setImmediate();
+    init_buffer();
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.makePreTakeScreenshot = void 0;
+    function makePreTakeScreenshot({ requests, logger: defaultLogger }) {
+      return async function preTakeScreenshot({ logger = defaultLogger }) {
+        return requests.preTakeScreenshot({ logger });
+      };
+    }
+    exports.makePreTakeScreenshot = makePreTakeScreenshot;
+  }
+});
+
 // ../nml-client/dist/client.js
 var require_client = __commonJS({
   "../nml-client/dist/client.js"(exports) {
@@ -33079,13 +33193,14 @@ var require_client = __commonJS({
     var requests_1 = require_requests2();
     var take_snapshots_1 = require_take_snapshots();
     var take_screenshots_1 = require_take_screenshots();
+    var pre_take_screenshot_1 = require_pre_take_screenshot();
     function makeNMLClient({ settings, logger: defaultLogger }) {
       const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: "nml-client" } });
       const requests = (0, requests_1.makeNMLRequests)({ settings, logger });
       return {
+        preTakeScreenshot: (0, pre_take_screenshot_1.makePreTakeScreenshot)({ requests, logger }),
         takeScreenshots: (0, take_screenshots_1.makeTakeScreenshots)({ requests, logger }),
-        takeSnapshots: (0, take_snapshots_1.makeTakeSnapshots)({ requests, logger }),
-        getSupportedEnvironments: requests.getSupportedEnvironments
+        takeSnapshots: (0, take_snapshots_1.makeTakeSnapshots)({ requests, logger })
       };
     }
     exports.makeNMLClient = makeNMLClient;
@@ -33134,6 +33249,7 @@ var require_dist5 = __commonJS({
     __exportStar(require_client(), exports);
     __exportStar(require_types7(), exports);
     __exportStar(require_requests2(), exports);
+    __exportStar(require_get_environments_info(), exports);
   }
 });
 
@@ -35747,10 +35863,70 @@ var require_to_base_check_settings = __commonJS({
       return result;
     };
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.toBaseCheckSettings = void 0;
+    exports.toBaseCheckSettings = exports.extractMobileElementsIntoCheckSettings = exports.hasCodedRegions = void 0;
     var utils34 = __importStar(require_browser3());
+    var regionTypes = ["ignore", "layout", "strict", "content", "floating", "accessibility"];
+    function hasCodedRegions(settings) {
+      for (const regionType of regionTypes) {
+        if (settings[`${regionType}Regions`])
+          return true;
+      }
+      return false;
+    }
+    exports.hasCodedRegions = hasCodedRegions;
+    async function extractMobileElementsIntoCheckSettings({ settings, driver, logger }) {
+      logger = logger.extend({ tags: [`extract-mobile-elements-${utils34.general.shortid()}`] });
+      if (settings.region) {
+        logger.log("extract element form region", settings.region);
+        const region = await driver.element(settings.region).catch((error) => logger.log(error));
+        if (!region) {
+          throw new Error("region not found");
+        }
+        settings.region = await (region === null || region === void 0 ? void 0 : region.getAttribute("name"));
+      }
+      if (settings.scrollRootElement) {
+        logger.log("extract element form scrollRootElement", settings.scrollRootElement);
+        const scrollRootElement = await driver.element(settings.scrollRootElement).catch((error) => logger.log(error));
+        if (!scrollRootElement) {
+          throw new Error("scrollRootElement not found");
+        }
+        settings.scrollRootElement = await scrollRootElement.getAttribute("name");
+      }
+      const codedRegionsAsElement = await regionTypes.reduce(async (promise, regionType) => {
+        var _a, _b;
+        const obj = await promise;
+        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);
+          const { region } = utils34.types.has(reference, "region") ? reference : { region: reference };
+          const handleRegion = /* @__PURE__ */ new Set();
+          const elements = await driver.elements(region).catch((error) => logger.log(error));
+          if (!elements)
+            return [];
+          return elements === null || elements === void 0 ? void 0 : elements.reduce(async (promise2, element) => {
+            const arr = await promise2;
+            const name = await element.getAttribute("name");
+            if (handleRegion.has(name))
+              return arr;
+            handleRegion.add(name);
+            return arr.concat({
+              region: {
+                name,
+                reference: region
+              }
+            });
+          }, Promise.resolve([]));
+        })) !== null && _b !== void 0 ? _b : [])).flat();
+        return obj;
+      }, Promise.resolve({}));
+      return {
+        ...settings,
+        ...codedRegionsAsElement
+      };
+    }
+    exports.extractMobileElementsIntoCheckSettings = extractMobileElementsIntoCheckSettings;
     function toBaseCheckSettings({ settings }) {
-      const regionTypes = ["ignore", "layout", "strict", "content", "floating", "accessibility"];
       const calculate = regionTypes.flatMap((regionType) => {
         var _a;
         return ((_a = settings[`${regionType}Regions`]) !== null && _a !== void 0 ? _a : []).reduce((regions, reference) => {
@@ -35963,6 +36139,7 @@ var require_check2 = __commonJS({
     };
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.makeCheck = void 0;
+    var nml_client_1 = require_dist5();
     var driver_1 = require_dist4();
     var take_screenshots_1 = require_take_screenshots2();
     var to_base_check_settings_1 = require_to_base_check_settings();
@@ -36009,20 +36186,30 @@ var require_check2 = __commonJS({
               logger
             });
           }
-          const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
           if (driverEnvironment.isWeb || !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) || settings.screenshotMode === "default") {
+            let actualEnvironments = uniqueEnvironments;
+            if (settings.screenshotMode === "default") {
+              const { localEnvironment, renderEnvironments } = await (0, nml_client_1.getNMLEnvironmentsInfo)({
+                environments: uniqueEnvironments,
+                supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl,
+                proxy: eyes.test.eyesServer.proxy,
+                logger
+              });
+              actualEnvironments = localEnvironment ? [localEnvironment] : renderEnvironments;
+            }
+            const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
             const screenshots = await (0, take_screenshots_1.takeScreenshots)({
               driver,
               settings: {
                 ...settings,
-                environments: uniqueEnvironments,
+                environments: actualEnvironments,
                 regionsToCalculate: elementReferences.calculate,
                 calculateView: !!settings.pageId,
                 domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : void 0
               },
               logger
             });
-            exactEnvironments.push(...uniqueEnvironments);
+            exactEnvironments.push(...actualEnvironments);
             screenshots.forEach(({ calculatedRegions, ...baseTarget }) => {
               baseTargets.push(baseTarget);
               baseSettings.push(getBaseCheckSettings({ calculatedRegions }));
@@ -36040,6 +36227,15 @@ var require_check2 = __commonJS({
               settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
               logger
             });
+            if (settings.scrollRootElement || settings.region || (0, to_base_check_settings_1.hasCodedRegions)(settings))
+              await nmlClient.preTakeScreenshot({ logger });
+            const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
+              settings: {
+                ...settings,
+                ...await (0, to_base_check_settings_1.extractMobileElementsIntoCheckSettings)({ settings, driver, logger })
+              }
+            });
+            const calculate = elementReferences.calculate;
             const screenshots = await nmlClient.takeScreenshots({
               settings: {
                 environments: uniqueEnvironments,
@@ -36051,14 +36247,28 @@ var require_check2 = __commonJS({
                 waitBeforeCapture: settings.waitBeforeCapture,
                 waitBetweenStitches: settings.waitBetweenStitches,
                 lazyLoad: settings.lazyLoad,
-                name: settings.name
+                name: settings.name,
+                region: elementReferences.target,
+                selectorsToFindRegionsFor: calculate.map(({ name }) => name),
+                scrollRootElement: elementReferences.scrolling
               },
               logger
             });
-            screenshots.forEach(({ environment, ...baseTarget }) => {
+            screenshots.forEach(({ environment, calculateRegions, ...baseTarget }) => {
+              const aggregateCalculatedRegions = [];
+              calculate.forEach(({ reference }, index) => {
+                const regions = calculateRegions === null || calculateRegions === void 0 ? void 0 : calculateRegions[index];
+                if (regions) {
+                  aggregateCalculatedRegions.push({ regions, selector: reference });
+                } else {
+                  logger.log(`Regions "${reference}" was not found in the screenshot`);
+                }
+              });
               exactEnvironments.push(environment);
               baseTargets.push({ ...baseTarget, isTransformed: true });
-              baseSettings.push(getBaseCheckSettings({ calculatedRegions: [] }));
+              baseSettings.push(getBaseCheckSettings({
+                calculatedRegions: aggregateCalculatedRegions
+              }));
             });
           }
         } else {
@@ -36158,6 +36368,7 @@ var require_check_and_close2 = __commonJS({
     };
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.makeCheckAndClose = void 0;
+    var nml_client_1 = require_dist5();
     var driver_1 = require_dist4();
     var take_screenshots_1 = require_take_screenshots2();
     var to_base_check_settings_1 = require_to_base_check_settings();
@@ -36206,18 +36417,35 @@ var require_check_and_close2 = __commonJS({
           }
           const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
           if (driverEnvironment.isWeb || !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) || settings.screenshotMode === "default") {
+            let actualEnvironments;
+            if (settings.screenshotMode === "default") {
+              if (!uniqueEnvironments.every((environment) => {
+                return !utils34.types.has(environment, "iosDeviceInfo") && !utils34.types.has(environment, "androidDeviceInfo");
+              })) {
+                const nmlEnvironmentsInfo = await (0, nml_client_1.getNMLEnvironmentsInfo)({
+                  environments: uniqueEnvironments,
+                  supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl,
+                  proxy: eyes.test.eyesServer.proxy,
+                  logger
+                });
+                actualEnvironments = nmlEnvironmentsInfo.renderEnvironments;
+              }
+            }
             const screenshots = await (0, take_screenshots_1.takeScreenshots)({
               driver,
               settings: {
                 ...settings,
-                environments: uniqueEnvironments,
+                environments: actualEnvironments !== null && actualEnvironments !== void 0 ? actualEnvironments : uniqueEnvironments,
                 regionsToCalculate: elementReferences.calculate,
                 calculateView: !!settings.pageId,
                 domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : void 0
               },
               logger
             });
-            exactEnvironments.push(...uniqueEnvironments);
+            if (actualEnvironments)
+              exactEnvironments.push(...actualEnvironments);
+            else
+              exactEnvironments.push(...uniqueEnvironments);
             screenshots.forEach(({ calculatedRegions, ...baseTarget }) => {
               baseTargets.push(baseTarget);
               baseSettings.push(getBaseCheckSettings({ calculatedRegions }));
@@ -82101,10 +82329,17 @@ creating temp style for access.`), r2 = Em(e4);
             }(t4))
               return Um(t4);
           }, rf = function(e4) {
-            return e4 && e4.replace(/(\\[0-9a-fA-F]{1,6}\s?)/g, (e5) => {
-              const t4 = parseInt(e5.substr(1).trim(), 16);
-              return String.fromCodePoint(t4);
+            const t4 = e4 && e4.replace(/(\\[0-9a-fA-F]{1,6}\s?)/g, (e5) => {
+              const t5 = parseInt(e5.substr(1).trim(), 16);
+              try {
+                return String.fromCodePoint(t5);
+              } catch (t6) {
+                if (t6 instanceof RangeError)
+                  return e5;
+                throw t6;
+              }
             }) || e4;
+            return t4;
           }, of = um, af = yh, sf = hm, lf = cm, cf = function(e4) {
             return function() {
               const t4 = ["[dom-snapshot]", `[+${Date.now() - e4}ms]`].concat(Array.from(arguments));
@@ -82155,7 +82390,7 @@ creating temp style for access.`), r2 = Em(e4);
               function D2(e5) {
                 return t5.defaultView && t5.defaultView.frameElement && t5.defaultView.frameElement.getAttribute(e5);
               }
-            }(t4).then((e4) => (u2("processPage end"), e4.scriptVersion = "4.7.16", e4));
+            }(t4).then((e4) => (u2("processPage end"), e4.scriptVersion = "4.7.17", e4));
           };
           window[mf] = window[mf] || {};
           const bf = pf(gf, window[mf], ff);
@@ -84481,7 +84716,7 @@ var require_package2 = __commonJS({
   "../core/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/core",
-      version: "4.7.0",
+      version: "4.8.0",
       homepage: "https://applitools.com",
       bugs: {
         url: "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -86507,15 +86742,6 @@ var require_spec_driver2 = __commonJS({
         isW3C
       };
     }
-    function command(method, url, body) {
-      if (getFrameworkMajorVersion() < 8) {
-        const { default: command2 } = __require("webdriver/build/command");
-        return command2(method, url, body);
-      } else {
-        const { command: command2 } = __require("webdriver");
-        return command2(method, url, body);
-      }
-    }
     function getFrameworkMajorVersion() {
       const version = __require("webdriver/package.json").version;
       return Number.parseInt(version);
@@ -86576,88 +86802,87 @@ var require_spec_driver2 = __commonJS({
     exports.isStaleElementError = isStaleElementError;
     function toDriver(driver) {
       var _a, _b, _c;
-      if (!utils34.types.has(driver, ["sessionId", "serverUrl"]))
-        return driver;
-      const url = new URL(driver.serverUrl);
-      const environment = extractEnvironment(driver.capabilities);
-      const options = {
-        sessionId: driver.sessionId,
-        protocol: url.protocol ? url.protocol.replace(/:$/, "") : void 0,
-        hostname: url.hostname,
-        port: Number(url.port) || void 0,
-        path: url.pathname,
-        capabilities: driver.capabilities,
-        logLevel: "silent",
-        ...environment
-      };
-      if (!options.port) {
-        if (options.protocol === "http")
-          options.port = 80;
-        if (options.protocol === "https")
-          options.port = 443;
-      }
-      if ((_a = driver.proxy) === null || _a === void 0 ? void 0 : _a.url) {
-        const proxyUrl = new URL(driver.proxy.url);
-        proxyUrl.username = (_b = driver.proxy.username) !== null && _b !== void 0 ? _b : proxyUrl.username;
-        proxyUrl.password = (_c = driver.proxy.password) !== null && _c !== void 0 ? _c : proxyUrl.password;
-        const proxyOptions = { ...(0, url_1.parse)(proxyUrl.href), rejectUnauthorized: false };
-        const httpAgent = (0, http_proxy_agent_1.default)(proxyOptions);
-        const httpsAgent = (0, https_proxy_agent_1.default)(proxyOptions);
-        httpsAgent.callback = utils34.general.wrap(httpsAgent.callback.bind(httpsAgent), (fn, request, options2, ...rest) => {
-          return fn(request, { ...options2, rejectUnauthorized: false }, ...rest);
-        });
-        options.agent = { http: httpAgent, https: httpsAgent };
+      let transformedDriver;
+      if (utils34.types.has(driver, ["sessionId", "serverUrl"])) {
+        const url = new URL(driver.serverUrl);
+        const environment = extractEnvironment(driver.capabilities);
+        const options = {
+          sessionId: driver.sessionId,
+          protocol: url.protocol ? url.protocol.replace(/:$/, "") : void 0,
+          hostname: url.hostname,
+          port: Number(url.port) || void 0,
+          path: url.pathname,
+          capabilities: driver.capabilities,
+          logLevel: "silent",
+          ...environment
+        };
+        if (!options.port) {
+          if (options.protocol === "http")
+            options.port = 80;
+          if (options.protocol === "https")
+            options.port = 443;
+        }
+        if ((_a = driver.proxy) === null || _a === void 0 ? void 0 : _a.url) {
+          const proxyUrl = new URL(driver.proxy.url);
+          proxyUrl.username = (_b = driver.proxy.username) !== null && _b !== void 0 ? _b : proxyUrl.username;
+          proxyUrl.password = (_c = driver.proxy.password) !== null && _c !== void 0 ? _c : proxyUrl.password;
+          const proxyOptions = { ...(0, url_1.parse)(proxyUrl.href), rejectUnauthorized: false };
+          const httpAgent = (0, http_proxy_agent_1.default)(proxyOptions);
+          const httpsAgent = (0, https_proxy_agent_1.default)(proxyOptions);
+          httpsAgent.callback = utils34.general.wrap(httpsAgent.callback.bind(httpsAgent), (fn, request, options2, ...rest) => {
+            return fn(request, { ...options2, rejectUnauthorized: false }, ...rest);
+          });
+          options.agent = { http: httpAgent, https: httpsAgent };
+        } else {
+          const httpAgent = http_1.default.globalAgent;
+          const httpsAgent = new https_1.default.Agent({ rejectUnauthorized: false });
+          options.agent = { http: httpAgent, https: httpsAgent };
+        }
+        const WebDriver = getWebDriver();
+        transformedDriver = WebDriver.attachToSession(options);
+        transformedDriver.original = driver.original;
       } else {
-        const httpAgent = http_1.default.globalAgent;
-        const httpsAgent = new https_1.default.Agent({ rejectUnauthorized: false });
-        options.agent = { http: httpAgent, https: httpsAgent };
+        transformedDriver = Object.create(driver, {
+          original: { enumerable: false, get: () => driver }
+        });
       }
-      const WebDriver = getWebDriver();
-      const attachedDriver = WebDriver.attachToSession(options, void 0, {
-        _getWindowSize: {
-          value: command("GET", "/session/:sessionId/window/current/size", {
-            command: "_getWindowSize",
-            description: "",
-            ref: "",
-            parameters: []
-          })
-        },
-        _setWindowSize: {
-          value: command("POST", "/session/:sessionId/window/current/size", {
-            command: "_setWindowSize",
-            parameters: [
-              { name: "width", type: "number", required: true, description: "" },
-              { name: "height", type: "number", required: true, description: "" }
-            ],
-            description: "",
-            ref: ""
-          })
-        },
-        setWindowPosition: {
-          value: command("POST", "/session/:sessionId/window/current/position", {
-            command: "setWindowPosition",
-            parameters: [
-              { name: "x", type: "number", required: true, description: "" },
-              { name: "y", type: "number", required: true, description: "" }
-            ],
-            description: "",
-            ref: ""
-          })
-        },
-        sendCommandAndGetResult: {
-          value: command("POST", "/session/:sessionId/chromium/send_command_and_get_result", {
-            command: "sendCommandAndGetResult",
-            parameters: [
-              { name: "cmd", type: "string", required: true, description: "" },
-              { name: "params", type: "object", required: true, description: "" }
-            ],
-            description: "Send a command to the DevTools debugger and wait for the result.",
-            ref: ""
-          })
-        }
-      });
-      attachedDriver.original = driver.original;
-      return attachedDriver;
+      if (utils34.types.isFunction(transformedDriver, "addCommand")) {
+        const command = getFrameworkMajorVersion() < 8 ? __require("webdriver/build/command").default : __require("webdriver").command;
+        transformedDriver.addCommand("_getWindowSize", command("GET", "/session/:sessionId/window/current/size", {
+          command: "_getWindowSize",
+          description: "",
+          ref: "",
+          parameters: []
+        }));
+        transformedDriver.addCommand("_setWindowSize", command("POST", "/session/:sessionId/window/current/size", {
+          command: "_setWindowSize",
+          parameters: [
+            { name: "width", type: "number", required: true, description: "" },
+            { name: "height", type: "number", required: true, description: "" }
+          ],
+          description: "",
+          ref: ""
+        }));
+        transformedDriver.addCommand("setWindowPosition", command("POST", "/session/:sessionId/window/current/position", {
+          command: "setWindowPosition",
+          parameters: [
+            { name: "x", type: "number", required: true, description: "" },
+            { name: "y", type: "number", required: true, description: "" }
+          ],
+          description: "",
+          ref: ""
+        }));
+        transformedDriver.addCommand("sendCommandAndGetResult", command("POST", "/session/:sessionId/chromium/send_command_and_get_result", {
+          command: "sendCommandAndGetResult",
+          parameters: [
+            { name: "cmd", type: "string", required: true, description: "" },
+            { name: "params", type: "object", required: true, description: "" }
+          ],
+          description: "Send a command to the DevTools debugger and wait for the result.",
+          ref: ""
+        }));
+      }
+      return transformedDriver;
     }
     exports.toDriver = toDriver;
     function toElement(element) {
@@ -86768,14 +86993,8 @@ var require_spec_driver2 = __commonJS({
     exports.getDriverInfo = getDriverInfo;
     async function getCapabilities(driver) {
       var _a;
-      try {
-        const capabilities = await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver));
-        return utils34.types.isObject(capabilities) ? capabilities : driver.capabilities;
-      } catch (error) {
-        if (/Cannot call non W3C standard command while in W3C mode/i.test(error.message))
-          return driver.capabilities;
-        throw new Error(`Unable to retrieve capabilities due to an error. The original error is ${error.message}`);
-      }
+      const capabilities = await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver).catch(() => null));
+      return utils34.types.isObject(capabilities) ? capabilities : driver.capabilities;
     }
     exports.getCapabilities = getCapabilities;
     async function getWindowSize(driver) {
@@ -88225,7 +88444,7 @@ var require_package3 = __commonJS({
   "../eyes/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/eyes",
-      version: "1.13.6",
+      version: "1.14.0",
       keywords: [
         "applitools",
         "eyes",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-browser",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "keywords": [
     "applitools",
     "browser",
@@ -48,7 +48,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/eyes": "1.13.6"
+    "@applitools/eyes": "1.14.0"
   },
   "devDependencies": {
     "@types/node": "^12.20.55",