@applitools/nml-client 1.6.6 → 1.7.1

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [1.7.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.7.0...js/nml-client@1.7.1) (2024-02-18)
+
+
+### Dependencies
+
+* @applitools/spec-driver-webdriver bumped to 1.1.0
+  #### Features
+
+  * env var to skip deprected jwp commands ([#2200](https://github.com/applitools/eyes.sdk.javascript1/issues/2200)) ([d9123db](https://github.com/applitools/eyes.sdk.javascript1/commit/d9123dbba85679d1c6999718b90b89debb18ed18))
+
+## [1.7.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.6.6...js/nml-client@1.7.0) (2024-02-13)
+
+
+### 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))
+
+
+### Dependencies
+
+* @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))
+
 ## [1.6.6](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.6.5...js/nml-client@1.6.6) (2024-02-06)
 
 

package/dist/client.js

@@ -5,13 +5,14 @@ const logger_1 = require("@applitools/logger");
 const requests_1 = require("./server/requests");
 const take_snapshots_1 = require("./take-snapshots");
 const take_screenshots_1 = require("./take-screenshots");
+const 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,
     };
 }
 exports.makeNMLClient = makeNMLClient;

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./server/requests"), exports);
+__exportStar(require("./utils/get-environments-info"), exports);

package/dist/pre-take-screenshot.js

@@ -0,0 +1,9 @@
+"use strict";
+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;

package/dist/server/requests.js

@@ -22,57 +22,51 @@ 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.makeNMLRequests = void 0;
 const req_broker_1 = require("./req-broker");
-const req_1 = __importDefault(require("@applitools/req"));
 const utils = __importStar(require("@applitools/utils"));
+const get_environments_info_1 = require("../utils/get-environments-info");
 function makeNMLRequests({ settings, logger: mainLogger, }) {
     let brokerUrl = settings.brokerUrl;
+    const supportedEnvironmentsUrl = settings.supportedEnvironmentsUrl;
+    const proxy = settings.proxy;
     const req = (0, req_broker_1.makeReqBroker)({ settings, logger: mainLogger });
-    const getSupportedEnvironmentsWithCache = utils.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-${utils.general.shortid()}`] });
+        logger.log('Request "preTakeScreenshot" called');
+        const response = await req(brokerUrl, {
+            name: 'PRE_TAKE_SCREENSHOT',
+            body: {
+                protocolVersion: '1.0',
+                name: 'PRE_TAKE_SCREENSHOT',
+                key: utils.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, logger = mainLogger, }) {
+        var _a, _b;
         logger = logger.extend(mainLogger, { tags: [`nml-request-${utils.general.shortid()}`] });
         logger.log('Request "takeScreenshots" called with settings', settings);
-        const supportedEnvironments = await getSupportedEnvironmentsWithCache({ logger });
-        const { localEnvironment, renderEnvironments, environmentSettings } = settings.environments.reduce((result, environment) => {
-            var _a;
-            if (!utils.types.has(environment, 'iosDeviceInfo') && !utils.types.has(environment, 'androidDeviceInfo')) {
-                result.localEnvironment = environment;
-            }
-            else {
-                const deviceInfo = utils.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: utils.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: undefined,
-            renderEnvironments: [],
-            environmentSettings: [],
+        const { localEnvironment, renderEnvironments, environmentSettings } = await (0, get_environments_info_1.getNMLEnvironmentsInfo)({
+            environments: settings.environments,
+            supportedEnvironmentsUrl,
+            proxy,
+            logger,
         });
         try {
             const response = await req(brokerUrl, {
@@ -85,6 +79,9 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                         ...settings,
                         environments: undefined,
                         deviceList: !localEnvironment ? environmentSettings : undefined,
+                        scrollRootElement: fallbackId(settings.scrollRootElement),
+                        region: fallbackId(settings.region),
+                        selectorsToFindRegionsFor: (_a = settings.selectorsToFindRegionsFor) === null || _a === void 0 ? void 0 : _a.map(selector => fallbackId(selector)),
                     },
                 },
                 logger,
@@ -95,12 +92,23 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
             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 }]
+                    ? [
+                        {
+                            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 _a;
                         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: (_a = result.payload.result[index].result) === null || _a === void 0 ? void 0 : _a.selectorRegions,
+                            environment,
+                        };
                     });
             }
             else {
@@ -118,6 +126,9 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                 brokerUrl = error.nextPath;
             throw error;
         }
+        function fallbackId(selector) {
+            return utils.types.isString(selector) ? { type: 'accessibility-identifier', selector } : selector;
+        }
     }
     async function takeSnapshots({ settings, logger = mainLogger, }) {
         try {

package/dist/utils/get-environments-info.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) 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 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNMLEnvironmentsInfo = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const req_1 = __importDefault(require("@applitools/req"));
+const getNMLSupportedEnvironmentsWithCache = utils.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 (!utils.types.has(environment, 'iosDeviceInfo') && !utils.types.has(environment, 'androidDeviceInfo')) {
+            result.localEnvironment = environment;
+        }
+        else {
+            const deviceInfo = utils.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: utils.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: undefined,
+        renderEnvironments: [],
+        environmentSettings: [],
+    });
+}
+exports.getNMLEnvironmentsInfo = getNMLEnvironmentsInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.6.6",
+  "version": "1.7.1",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {
@@ -41,7 +41,7 @@
     "@applitools/utils": "1.7.0"
   },
   "devDependencies": {
-    "@applitools/spec-driver-webdriver": "^1.0.56",
+    "@applitools/spec-driver-webdriver": "^1.1.0",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",

package/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './client';
 export * from './types';
 export * from './server/requests';
+export * from './utils/get-environments-info';

package/types/pre-take-screenshot.d.ts

@@ -0,0 +1,10 @@
+import { type Logger } from '@applitools/logger';
+import { type NMLRequests } from './server/requests';
+type Options = {
+    requests: NMLRequests;
+    logger: Logger;
+};
+export declare function makePreTakeScreenshot({ requests, logger: defaultLogger }: Options): ({ logger }: {
+    logger?: Logger | undefined;
+}) => Promise<void>;
+export {};

package/types/server/requests.d.ts

@@ -1,9 +1,9 @@
 import type { BrokerServerSettings, ScreenshotSettings, Screenshot, SnapshotSettings, IOSSnapshot, AndroidSnapshot } from '../types';
 import { type Logger } from '@applitools/logger';
 export interface NMLRequests {
-    getSupportedEnvironments(options: {
+    preTakeScreenshot(options: {
         logger?: Logger;
-    }): Promise<Record<string, any>>;
+    }): Promise<void>;
     takeScreenshots(options: {
         settings: ScreenshotSettings;
         logger?: Logger;

package/types/types.d.ts

@@ -2,6 +2,9 @@ import type { Size, Location, Region } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
 export interface NMLClient {
+    preTakeScreenshot(options: {
+        logger?: Logger;
+    }): Promise<void>;
     takeScreenshots(options: {
         settings: ScreenshotSettings;
         logger?: Logger;
@@ -10,9 +13,6 @@ export interface NMLClient {
         settings: SnapshotSettings;
         logger?: Logger;
     }): Promise<TSnapshot[]>;
-    getSupportedEnvironments(options: {
-        logger?: Logger;
-    }): Promise<Record<string, any>>;
 }
 export interface BrokerServerSettings {
     brokerUrl: string;
@@ -84,7 +84,7 @@ export type Screenshot = {
     locationInViewport?: Location;
     locationInView?: Location;
     fullViewSize?: Size;
-    calculatedRegions?: Region[];
+    calculateRegions?: Region[][];
     environment: ActualEnvironment;
 };
 export type SnapshotSettings = {

package/types/utils/get-environments-info.d.ts

@@ -0,0 +1,13 @@
+import { ActualEnvironment, Environment } from '../types';
+import { Logger } from '@applitools/logger';
+import { Proxy } from '@applitools/req';
+export declare function getNMLEnvironmentsInfo({ environments, supportedEnvironmentsUrl, proxy, logger, }: {
+    environments: Environment[];
+    supportedEnvironmentsUrl: string;
+    proxy?: Proxy;
+    logger?: Logger;
+}): Promise<{
+    localEnvironment: ActualEnvironment | undefined;
+    renderEnvironments: ActualEnvironment[];
+    environmentSettings: any[];
+}>;