@applitools/nml-client 1.5.13 → 1.5.14

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [1.5.14](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.5.13...js/nml-client@1.5.14) (2023-10-17)
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.2
+  #### 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))
+* @applitools/logger bumped to 2.0.12
+  #### 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))
+
+
+
+* @applitools/req bumped to 1.6.2
+  #### 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))
+
+
+
+* @applitools/driver bumped to 1.14.4
+  #### 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))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.0.48
+
+
 ## [1.5.13](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.5.12...js/nml-client@1.5.13) (2023-09-29)
 
 

package/dist/client.js

@@ -11,7 +11,7 @@ function makeNMLClient({ settings, logger: defaultLogger, }) {
     return {
         takeScreenshots: (0, take_screenshots_1.makeTakeScreenshots)({ requests, logger }),
         takeSnapshots: (0, take_snapshots_1.makeTakeSnapshots)({ requests, logger }),
-        getSupportedRenderEnvironments: requests.getSupportedRenderEnvironments,
+        getSupportedEnvironments: requests.getSupportedEnvironments,
     };
 }
 exports.makeNMLClient = makeNMLClient;

package/dist/server/requests.js

@@ -33,46 +33,46 @@ const utils = __importStar(require("@applitools/utils"));
 function makeNMLRequests({ settings, logger: mainLogger, }) {
     let brokerUrl = settings.brokerUrl;
     const req = (0, req_broker_1.makeReqBroker)({ settings, logger: mainLogger });
-    const getSupportedRenderEnvironmentsWithCache = utils.general.cachify(getSupportedRenderEnvironments, () => 'default');
+    const getSupportedEnvironmentsWithCache = utils.general.cachify(getSupportedEnvironments, () => 'default');
     return {
-        getSupportedRenderEnvironments: getSupportedRenderEnvironmentsWithCache,
+        getSupportedEnvironments: getSupportedEnvironmentsWithCache,
         takeScreenshots,
         takeSnapshots,
     };
-    async function getSupportedRenderEnvironments({ logger: _logger }) {
-        const response = await (0, req_1.default)(settings.renderEnvironmentsUrl);
+    async function getSupportedEnvironments({ logger: _logger }) {
+        const response = await (0, req_1.default)(settings.supportedEnvironmentsUrl);
         const result = await response.json();
         return result;
     }
     async function takeScreenshots({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger, { tags: [`nml-request-${utils.general.shortid()}`] });
         logger.log('Request "takeScreenshots" called with settings', settings);
-        const supportedRenderEnvironments = await getSupportedRenderEnvironmentsWithCache({ logger });
-        const { localEnvironment, renderEnvironments, rendererSettings } = settings.renderers.reduce((result, renderer) => {
+        const supportedEnvironments = await getSupportedEnvironmentsWithCache({ logger });
+        const { localEnvironment, renderEnvironments, environmentSettings } = settings.environments.reduce((result, environment) => {
             var _a;
-            if (utils.types.has(renderer, 'environment')) {
-                result.localEnvironment = { ...renderer.environment, renderEnvironmentId: utils.general.guid(), renderer };
+            if (!utils.types.has(environment, 'iosDeviceInfo') && !utils.types.has(environment, 'androidDeviceInfo')) {
+                result.localEnvironment = { ...environment, environmentId: utils.general.guid() };
             }
             else {
-                const deviceInfo = utils.types.has(renderer, 'iosDeviceInfo')
-                    ? renderer.iosDeviceInfo
-                    : renderer.androidDeviceInfo;
+                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 = supportedRenderEnvironments[deviceInfo.deviceName][orientation].env;
+                const rawEnvironment = supportedEnvironments[deviceInfo.deviceName][orientation].env;
                 result.renderEnvironments.push({
-                    renderEnvironmentId: utils.general.guid(),
-                    renderer,
+                    requested: environment,
+                    environmentId: utils.general.guid(),
                     deviceName: rawEnvironment.deviceInfo,
                     os: rawEnvironment.os + (deviceInfo.version ? ` ${deviceInfo.version}` : ''),
                     viewportSize: rawEnvironment.displaySize,
                 });
-                result.rendererSettings.push({ ...supportedRenderEnvironments[deviceInfo.deviceName], orientation });
+                result.environmentSettings.push({ ...supportedEnvironments[deviceInfo.deviceName], orientation });
             }
             return result;
         }, {
             localEnvironment: undefined,
             renderEnvironments: [],
-            rendererSettings: [],
+            environmentSettings: [],
         });
         try {
             const response = await req(brokerUrl, {
@@ -83,8 +83,8 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                     key: utils.general.guid(),
                     payload: {
                         ...settings,
-                        renderers: undefined,
-                        deviceList: !localEnvironment ? rendererSettings : undefined,
+                        environments: undefined,
+                        deviceList: !localEnvironment ? environmentSettings : undefined,
                     },
                 },
                 logger,
@@ -92,9 +92,9 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
             const result = await response.json();
             brokerUrl = result.nextPath;
             const screenshots = localEnvironment
-                ? [{ image: result.payload.result.screenshotUrl, renderEnvironment: localEnvironment }]
-                : renderEnvironments.map((renderEnvironment, index) => {
-                    return { image: result.payload[index].result.screenshotUrl, renderEnvironment };
+                ? [{ image: result.payload.result.screenshotUrl, environment: localEnvironment }]
+                : renderEnvironments.map((environment, index) => {
+                    return { image: result.payload[index].result.screenshotUrl, environment };
                 });
             logger.log('Request "takeScreenshots" finished successfully with body', screenshots);
             return screenshots;
@@ -134,7 +134,7 @@ function makeNMLRequests({ settings, logger: mainLogger, }) {
                 ;
                 snapshot.vhsType = 'android-x';
             }
-            return Array(settings.renderers.length).fill(snapshot);
+            return Array(settings.environments.length).fill(snapshot);
         }
         catch (error) {
             if (error.nextPath)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.5.13",
+  "version": "1.5.14",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {
@@ -36,12 +36,12 @@
     "test": "run --top-level mocha './test/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15}"
   },
   "dependencies": {
-    "@applitools/logger": "2.0.11",
-    "@applitools/req": "1.6.1",
-    "@applitools/utils": "1.6.1"
+    "@applitools/logger": "2.0.12",
+    "@applitools/req": "1.6.2",
+    "@applitools/utils": "1.6.2"
   },
   "devDependencies": {
-    "@applitools/spec-driver-webdriver": "^1.0.47",
+    "@applitools/spec-driver-webdriver": "^1.0.48",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",

package/types/server/requests.d.ts

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

package/types/types.d.ts

@@ -10,42 +10,44 @@ export interface NMLClient {
         settings: SnapshotSettings;
         logger?: Logger;
     }): Promise<TSnapshot[]>;
-    getSupportedRenderEnvironments(options: {
+    getSupportedEnvironments(options: {
         logger?: Logger;
     }): Promise<Record<string, any>>;
 }
 export interface BrokerServerSettings {
     brokerUrl: string;
-    renderEnvironmentsUrl: string;
+    supportedEnvironmentsUrl: string;
     agentId?: string;
     proxy?: Proxy;
     useDnsCache?: boolean;
 }
 export type NMLClientSettings = BrokerServerSettings;
-export interface IOSDeviceRenderer {
+export interface IOSDeviceEnvironment {
     iosDeviceInfo: {
         deviceName: string;
         version?: string;
         screenOrientation?: string;
     };
 }
-export interface AndroidDeviceRenderer {
+export interface AndroidDeviceEnvironment {
     androidDeviceInfo: {
         deviceName: string;
         version?: string;
         screenOrientation?: string;
     };
 }
-export interface EnvironmentRenderer {
-    environment: any;
+export interface LocalEnvironment {
+    os: string;
+    deviceName: string;
+    viewportSize: Size;
 }
-export type Renderer = IOSDeviceRenderer | AndroidDeviceRenderer | EnvironmentRenderer;
-export interface RenderEnvironment {
+export type Environment = IOSDeviceEnvironment | AndroidDeviceEnvironment | LocalEnvironment;
+export interface ActualEnvironment {
+    requested?: IOSDeviceEnvironment | AndroidDeviceEnvironment;
+    environmentId: string;
     os: string;
     deviceName: string;
     viewportSize: Size;
-    renderEnvironmentId: string;
-    renderer: Renderer;
 }
 export type Selector = string | {
     selector: string;
@@ -54,7 +56,7 @@ export type Selector = string | {
     frame?: Selector;
 };
 export type ScreenshotSettings = {
-    renderers: Renderer[];
+    environments: Environment[];
     webview?: boolean | string;
     region?: Region | Selector;
     fully?: boolean;
@@ -86,10 +88,10 @@ export type Screenshot = {
     locationInView?: Location;
     fullViewSize?: Size;
     calculatedRegions?: Region[];
-    renderEnvironment: RenderEnvironment;
+    environment: ActualEnvironment;
 };
 export type SnapshotSettings = {
-    renderers: Renderer[];
+    environments: Environment[];
     resourceSeparation?: boolean;
     waitBeforeCapture?: number;
     name?: string;