@applitools/core 3.11.8 → 4.0.1

package/dist/classic/get-base-eyes.js

@@ -24,11 +24,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetBaseEyes = void 0;
-const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
+const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const utils = __importStar(require("@applitools/utils"));
 function makeGetBaseEyes({ settings: defaultSettings, eyes, logger: mainLogger, }) {
     const getBaseEyesWithCache = utils.general.wrap(getBaseEyes, (getBaseEyes, options) => {
-        const key = (0, extract_renderer_key_1.extractRendererKey)(options.settings.renderer);
+        const key = (0, to_environment_key_1.toEnvironmentKey)(options.settings.environment);
         let item = eyes.storage.get(key);
         if (!item) {
             item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
@@ -42,19 +42,10 @@ function makeGetBaseEyes({ settings: defaultSettings, eyes, logger: mainLogger,
     async function getBaseEyes({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger);
         logger.log(`Command "getBaseEyes" is called with settings`, settings);
-        let environment;
-        if (utils.types.has(settings.renderer, 'environment')) {
-            environment = settings.renderer.environment;
-        }
-        else {
-            // NOTE: ios and android handled by nml-client
-            // TODO: chrome emulation, desktop
-            environment = { renderer: settings.renderer };
-        }
         return eyes.core.base.openEyes({
             settings: {
                 ...defaultSettings,
-                environment: { ...defaultSettings.environment, ...environment, properties: settings.renderer.properties },
+                environment: { ...defaultSettings.environment, ...settings.environment },
             },
             logger,
         });

package/dist/classic/open-eyes.js

@@ -31,7 +31,7 @@ const check_and_close_1 = require("./check-and-close");
 const close_1 = require("../automation/close");
 const abort_1 = require("../automation/abort");
 const get_results_1 = require("../automation/get-results");
-const extract_default_renderers_1 = require("./utils/extract-default-renderers");
+const extract_default_environments_1 = require("./utils/extract-default-environments");
 const abort_controller_1 = require("abort-controller");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ core, spec, logger: mainLogger }) {
@@ -50,7 +50,7 @@ function makeOpenEyes({ core, spec, logger: mainLogger }) {
                 settings.environment.ecSessionId = (_c = (await driver.getSessionId())) !== null && _c !== void 0 ? _c : undefined;
             }
         }
-        const renderers = await (0, extract_default_renderers_1.extractDefaultRenderers)({ driver, settings });
+        const environments = await (0, extract_default_environments_1.extractDefaultEnvironments)({ driver, settings });
         const controller = new abort_controller_1.AbortController();
         const account = await core.getAccountInfo({ settings, logger });
         return utils.general.extend({}, eyes => {
@@ -66,16 +66,16 @@ function makeOpenEyes({ core, spec, logger: mainLogger }) {
                     ufgServer: account.ufgServer,
                     uploadUrl: account.uploadUrl,
                     stitchingServiceUrl: account.stitchingServiceUrl,
-                    renderEnvironmentsUrl: account.renderEnvironmentsUrl,
+                    supportedEnvironmentsUrl: account.supportedEnvironmentsUrl,
                     account,
                 },
                 running: true,
                 storage,
                 getBaseEyes: (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, logger }),
-                check: (0, check_1.makeCheck)({ eyes, target: driver, renderers, spec, signal: controller.signal, logger }),
-                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, renderers, spec, signal: controller.signal, logger }),
-                close: (0, close_1.makeClose)({ eyes, target: driver, renderers, logger }),
-                abort: (0, abort_1.makeAbort)({ eyes, target: driver, renderers, spec, controller, logger }),
+                check: (0, check_1.makeCheck)({ eyes, target: driver, environments, spec, signal: controller.signal, logger }),
+                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, environments, spec, signal: controller.signal, logger }),
+                close: (0, close_1.makeClose)({ eyes, target: driver, environments, logger }),
+                abort: (0, abort_1.makeAbort)({ eyes, target: driver, environments, spec, controller, logger }),
                 getResults: (0, get_results_1.makeGetResults)({ eyes, logger }),
             };
         });

package/dist/classic/utils/extract-default-environments.js

@@ -0,0 +1,70 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractDefaultEnvironments = void 0;
+const utils = __importStar(require("@applitools/utils"));
+async function extractDefaultEnvironments({ driver, settings, }) {
+    var _a, _b, _c;
+    const environment = {};
+    if (!driver)
+        return [(_a = settings === null || settings === void 0 ? void 0 : settings.environment) !== null && _a !== void 0 ? _a : environment];
+    const currentContext = driver.currentContext;
+    try {
+        const driverEnvironment = await driver.getEnvironment();
+        const viewport = await driver.getViewport();
+        const size = await driver.getViewportSize();
+        environment.viewportSize = utils.geometry.scale(size, viewport.viewportScale);
+        if (driverEnvironment.isEC)
+            environment.ecSessionId = (_b = (await driver.getSessionId())) !== null && _b !== void 0 ? _b : undefined;
+        if (driverEnvironment.isWeb)
+            environment.userAgent = await driver.getUserAgentLegacy();
+        if (driverEnvironment.deviceName)
+            environment.deviceName = driverEnvironment.deviceName;
+        if (driverEnvironment.isNative && driverEnvironment.platformName) {
+            environment.os = driverEnvironment.platformName;
+            if (driverEnvironment.platformVersion)
+                environment.os += ` ${driverEnvironment.platformVersion}`;
+            if (!(settings === null || settings === void 0 ? void 0 : settings.keepPlatformNameAsIs)) {
+                if (/^android/i.test(environment.os)) {
+                    environment.os = `Android${environment.os.slice(7)}`;
+                }
+                if (/^ios/i.test(environment.os)) {
+                    environment.os = `iOS${environment.os.slice(3)}`;
+                }
+            }
+        }
+        else if (driverEnvironment.isReliable &&
+            driverEnvironment.isChromium &&
+            ((driverEnvironment.isWindows && Number.parseInt(driverEnvironment.browserVersion) >= 107) ||
+                (driverEnvironment.isMac && Number.parseInt(driverEnvironment.browserVersion) >= 90))) {
+            environment.os = `${driverEnvironment.platformName} ${(_c = driverEnvironment.platformVersion) !== null && _c !== void 0 ? _c : ''}`.trim();
+        }
+        return [environment];
+    }
+    finally {
+        await currentContext.focus();
+    }
+}
+exports.extractDefaultEnvironments = extractDefaultEnvironments;

package/dist/classic/utils/take-screenshots.js

@@ -55,6 +55,6 @@ async function takeScreenshots({ driver, settings, logger, }) {
             : await driver.getViewportSize();
     }
     await screenshot.restoreState();
-    return new Array(settings.renderers.length).fill(baseTarget);
+    return new Array(settings.environments.length).fill(baseTarget);
 }
 exports.takeScreenshots = takeScreenshots;

package/dist/close-batch.js

@@ -29,9 +29,9 @@ function makeCloseBatch({ core, logger: mainLogger }) {
     return async function closeBatch({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger, { tags: [`close-batch-${utils.general.shortid()}`] });
         (utils.types.isArray(settings) ? settings : [settings]).forEach(settings => {
-            var _a, _b, _c, _d, _e;
-            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-            (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+            var _a, _b, _c, _d;
+            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+            (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         });
         return core.base.closeBatch({ settings, logger });
     };

package/dist/close.js

@@ -25,15 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeClose = void 0;
 const utils = __importStar(require("@applitools/utils"));
-function makeClose({ eyes, renderers: defaultRenderers, logger: mainLogger, }) {
+function makeClose({ eyes, environments: defaultEnvironments, logger: mainLogger, }) {
     return async function close({ settings, config, logger = mainLogger, } = {}) {
         var _a, _b;
         logger = logger.extend(mainLogger, { tags: [`close-${utils.general.shortid()}`] });
         const typedEyes = await eyes.getTypedEyes({ logger });
         settings = { ...config === null || config === void 0 ? void 0 : config.close, ...settings };
         (_a = settings.updateBaselineIfNew) !== null && _a !== void 0 ? _a : (settings.updateBaselineIfNew = true);
-        if (typedEyes.type === 'classic' && !utils.types.isEmpty(defaultRenderers)) {
-            (_b = settings.renderers) !== null && _b !== void 0 ? _b : (settings.renderers = defaultRenderers);
+        if (typedEyes.type === 'classic' && !utils.types.isEmpty(defaultEnvironments)) {
+            (_b = settings.environments) !== null && _b !== void 0 ? _b : (settings.environments = defaultEnvironments);
         }
         await typedEyes.close({ settings, logger });
     };

package/dist/core.js

@@ -38,11 +38,11 @@ const open_eyes_1 = require("./open-eyes");
 const make_manager_1 = require("./make-manager");
 const close_batch_1 = require("./close-batch");
 const delete_test_1 = require("./delete-test");
-const extract_environment_1 = require("./utils/extract-environment");
+const extract_test_environment_1 = require("./utils/extract-test-environment");
 const utils = __importStar(require("@applitools/utils"));
 function makeCore({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, asyncCache, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
-    const environment = (0, extract_environment_1.extractEnvironment)(defaultEnvironment);
+    const environment = (0, extract_test_environment_1.extractTestEnvironment)(defaultEnvironment);
     logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment`, environment);
     const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, cwd, logger });
     return utils.general.extend(base, core => {

package/dist/delete-test.js

@@ -29,9 +29,9 @@ function makeDeleteTest({ core, logger: mainLogger }) {
     return async function deleteTest({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger, { tags: [`delete-test-${utils.general.shortid()}`] });
         (utils.types.isArray(settings) ? settings : [settings]).forEach(settings => {
-            var _a, _b, _c, _d, _e;
-            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-            (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+            var _a, _b, _c, _d;
+            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+            (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         });
         return core.base.deleteTest({ settings, logger });
     };

package/dist/extract-text.js

@@ -31,11 +31,11 @@ function makeExtractText({ spec, core, logger: mainLogger }) {
         logger = logger.extend(mainLogger, { tags: [`extract-text-${utils.general.shortid()}`] });
         settings = utils.types.isArray(settings) ? settings : [settings];
         settings = settings.map(settings => {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e;
             settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
             (_a = settings.userCommandId) !== null && _a !== void 0 ? _a : (settings.userCommandId = `extract-text--${utils.general.guid()}`);
-            (_b = settings.eyesServerUrl) !== null && _b !== void 0 ? _b : (settings.eyesServerUrl = (_e = (_d = (_c = settings.serverUrl) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _d !== void 0 ? _d : utils.general.getEnvValue('SERVER_URL')) !== null && _e !== void 0 ? _e : 'https://eyesapi.applitools.com');
-            (_f = settings.apiKey) !== null && _f !== void 0 ? _f : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+            (_b = settings.eyesServerUrl) !== null && _b !== void 0 ? _b : (settings.eyesServerUrl = (_d = (_c = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
+            (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
             return settings;
         });
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });

package/dist/get-account-info.js

@@ -27,10 +27,10 @@ exports.makeGetAccountInfo = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function makeGetAccountInfo({ core, logger: mainLogger }) {
     return async function getAccountInfo({ settings, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         logger = logger.extend(mainLogger, { tags: [`get-account-info-${utils.general.shortid()}`] });
-        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-        (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+        (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         return core.base.getAccountInfo({ settings, logger });
     };
 }

package/dist/get-manager-results.js

@@ -40,7 +40,7 @@ function makeGetManagerResults({ core, storage, logger: mainLogger, }) {
                         result,
                         error: result.status !== 'Passed' ? new test_error_1.TestError(result) : undefined,
                         userTestId: result.userTestId,
-                        renderer: result.renderer,
+                        environment: result.environment,
                     })));
                 });
             }

package/dist/locate-text.js

@@ -28,11 +28,11 @@ const core_1 = require("./classic/core");
 const utils = __importStar(require("@applitools/utils"));
 function makeLocateText({ spec, core, logger: mainLogger }) {
     return async function locateText({ target, settings, config, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         logger = logger.extend(mainLogger, { tags: [`locate-text-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
-        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-        (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+        (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });
         const results = await classicCore.locateText({ target, settings, logger });
         return results;

package/dist/locate.js

@@ -28,11 +28,11 @@ const core_1 = require("./classic/core");
 const utils = __importStar(require("@applitools/utils"));
 function makeLocate({ spec, core, logger: mainLogger }) {
     return async function locate({ target, settings, config, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         logger = logger.extend(mainLogger, { tags: [`locate-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
-        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-        (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+        (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });
         const results = await classicCore.locate({ target, settings, logger });
         return results;

package/dist/log-event.js

@@ -29,9 +29,9 @@ function makeLogEvent({ core, logger: mainLogger }) {
     return async function logEvent({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger, { tags: [`log-event-${utils.general.shortid()}`] });
         (utils.types.isArray(settings) ? settings : [settings]).forEach(settings => {
-            var _a, _b, _c, _d, _e;
-            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_d = (_c = (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
-            (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+            var _a, _b, _c, _d;
+            (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+            (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         });
         return core.base.logEvent({ settings, logger });
     };

package/dist/open-eyes.js

@@ -36,27 +36,27 @@ const get_eyes_results_1 = require("./get-eyes-results");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, asyncCache, }) {
     return async function openEyes({ type = defaultType, settings, config, target, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
-        var _v, _w, _x, _y;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+        var _u, _v, _w, _x;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...settings };
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
-        (_b = settings.eyesServerUrl) !== null && _b !== void 0 ? _b : (settings.eyesServerUrl = (_e = (_d = (_c = settings.serverUrl) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _d !== void 0 ? _d : utils.general.getEnvValue('SERVER_URL')) !== null && _e !== void 0 ? _e : 'https://eyesapi.applitools.com');
-        (_f = settings.apiKey) !== null && _f !== void 0 ? _f : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
-        (_g = settings.useDnsCache) !== null && _g !== void 0 ? _g : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
+        (_b = settings.eyesServerUrl) !== null && _b !== void 0 ? _b : (settings.eyesServerUrl = (_d = (_c = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _c !== void 0 ? _c : utils.general.getEnvValue('SERVER_URL')) !== null && _d !== void 0 ? _d : 'https://eyesapi.applitools.com');
+        (_e = settings.apiKey) !== null && _e !== void 0 ? _e : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (_f = settings.useDnsCache) !== null && _f !== void 0 ? _f : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
         settings.batch = { ...batch, ...settings.batch };
-        (_h = (_v = settings.batch).id) !== null && _h !== void 0 ? _h : (_v.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
-        (_k = (_w = settings.batch).name) !== null && _k !== void 0 ? _k : (_w.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_l = (_x = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_x.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_m = (_y = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_y.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
-        (_o = settings.keepBatchOpen) !== null && _o !== void 0 ? _o : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
-        (_p = settings.branchName) !== null && _p !== void 0 ? _p : (settings.branchName = utils.general.getEnvValue('BRANCH'));
-        (_q = settings.parentBranchName) !== null && _q !== void 0 ? _q : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
-        (_r = settings.baselineBranchName) !== null && _r !== void 0 ? _r : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
-        (_s = settings.ignoreBaseline) !== null && _s !== void 0 ? _s : (settings.ignoreBaseline = false);
-        (_t = settings.compareWithParentBranch) !== null && _t !== void 0 ? _t : (settings.compareWithParentBranch = false);
+        (_g = (_u = settings.batch).id) !== null && _g !== void 0 ? _g : (_u.id = (_h = utils.general.getEnvValue('BATCH_ID')) !== null && _h !== void 0 ? _h : `generated-${utils.general.guid()}`);
+        (_j = (_v = settings.batch).name) !== null && _j !== void 0 ? _j : (_v.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_k = (_w = settings.batch).sequenceName) !== null && _k !== void 0 ? _k : (_w.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_l = (_x = settings.batch).notifyOnCompletion) !== null && _l !== void 0 ? _l : (_x.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_m = settings.keepBatchOpen) !== null && _m !== void 0 ? _m : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
+        (_o = settings.branchName) !== null && _o !== void 0 ? _o : (settings.branchName = utils.general.getEnvValue('BRANCH'));
+        (_p = settings.parentBranchName) !== null && _p !== void 0 ? _p : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
+        (_q = settings.baselineBranchName) !== null && _q !== void 0 ? _q : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
+        (_r = settings.ignoreBaseline) !== null && _r !== void 0 ? _r : (settings.ignoreBaseline = false);
+        (_s = settings.compareWithParentBranch) !== null && _s !== void 0 ? _s : (settings.compareWithParentBranch = false);
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }));
-        const renderers = (_u = config === null || config === void 0 ? void 0 : config.check) === null || _u === void 0 ? void 0 : _u.renderers;
+        const environments = (_t = config === null || config === void 0 ? void 0 : config.check) === null || _t === void 0 ? void 0 : _t.environments;
         core.logEvent({
             settings: {
                 ...settings,
@@ -85,8 +85,8 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, bat
             getTypedEyes,
             check: (0, check_1.makeCheck)({ type, eyes, target: driver, spec, logger }),
             checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, eyes, target: driver, spec, logger }),
-            close: (0, close_1.makeClose)({ eyes, renderers, logger }),
-            abort: (0, abort_1.makeAbort)({ eyes, renderers, logger }),
+            close: (0, close_1.makeClose)({ eyes, environments, logger }),
+            abort: (0, abort_1.makeAbort)({ eyes, environments, logger }),
             getResults: (0, get_eyes_results_1.makeGetEyesResults)({ eyes, logger }),
         })); // TODO solve the types issue
     };

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

@@ -30,12 +30,12 @@ exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
-const uniquify_renderers_1 = require("../automation/utils/uniquify-renderers");
-const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
+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 utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRenderers = [], spec, signal, logger: mainLogger, }) {
+function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
         var _a, _b, _c;
         logger = logger.extend(mainLogger);
@@ -47,7 +47,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
         const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings,
         });
-        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : defaultRenderers);
+        const uniqueEnvironments = (0, uniquify_environments_1.uniquifyEnvironments)((_a = settings.environments) !== null && _a !== void 0 ? _a : defaultEnvironments);
         const ufgClient = await eyes.core.getUFGClient({
             settings: {
                 ...eyes.test.ufgServer,
@@ -76,7 +76,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                         waitBeforeCapture: settings.waitBeforeCapture,
                         disableBrowserFetching: settings.disableBrowserFetching,
                         layoutBreakpoints: settings.layoutBreakpoints,
-                        renderers: uniqueRenderers,
+                        environments: uniqueEnvironments,
                         skipResources: ufgClient.getCachedResourceUrls(),
                         lazyLoad: settings.lazyLoad,
                         calculateRegionsOptions: {
@@ -95,14 +95,14 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
             else {
                 const nmlClient = await eyes.core.getNMLClient({
                     driver,
-                    settings: { ...eyes.test.eyesServer, renderEnvironmentsUrl: eyes.test.renderEnvironmentsUrl },
+                    settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
                     logger,
                 });
                 const snapshots = (await nmlClient.takeSnapshots({
                     settings: {
                         ...eyes.test.eyesServer,
                         waitBeforeCapture: settings.waitBeforeCapture,
-                        renderers: uniqueRenderers,
+                        environments: uniqueEnvironments,
                     },
                     logger,
                 }));
@@ -124,20 +124,20 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
             snapshotTitle = await driver.getTitle();
         }
         else {
-            snapshotResults = !utils.types.isArray(target) ? Array(uniqueRenderers.length).fill(target) : target;
+            snapshotResults = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
             snapshotUrl = utils.types.has((_c = snapshotResults[0]) === null || _c === void 0 ? void 0 : _c.snapshot, 'url') ? snapshotResults[0].snapshot.url : undefined;
         }
-        const promises = uniqueRenderers.map(async (renderer, index) => {
-            var _a;
-            const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
-            const ufgRenderer = renderer;
-            if (utils.types.has(ufgRenderer, 'name') && ufgRenderer.name === 'edge') {
+        const promises = uniqueEnvironments.map(async (environment, index) => {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            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.`);
-                rendererLogger.console.log(message);
+                environmentLogger.console.log(message);
             }
             try {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                    rendererLogger.warn('Command "check" was aborted before rendering');
+                    environmentLogger.warn('Command "check" was aborted before rendering');
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
                 const { snapshot: snapshotFromResult, selectorsToCalculate: selectorsToCalculateFromSnapshot, regionToTarget, scrollRootSelector, } = snapshotResults[index];
@@ -147,13 +147,13 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                     originalSelector: selector,
                     safeSelector: selector,
                 }));
-                if (utils.types.has(ufgRenderer, 'iosDeviceInfo') || utils.types.has(ufgRenderer, 'androidDeviceInfo')) {
-                    ufgRenderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
+                if (utils.types.has(ufgEnvironment, 'iosDeviceInfo') || utils.types.has(ufgEnvironment, 'androidDeviceInfo')) {
+                    ufgEnvironment.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
                 }
                 const renderTargetPromise = ufgClient.createRenderTarget({
                     snapshot,
                     settings: {
-                        renderer: ufgRenderer,
+                        environment: ufgEnvironment,
                         cookies,
                         headers: {
                             Referer: snapshotUrl,
@@ -163,26 +163,26 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                         proxy: eyes.test.eyesServer.proxy,
                         autProxy: settings.autProxy,
                     },
-                    logger: rendererLogger,
+                    logger: environmentLogger,
                 });
-                const baseEyes = await eyes.getBaseEyes({ settings: { renderer }, logger });
+                const baseEyes = await eyes.getBaseEyes({ settings: { environment }, logger });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        rendererLogger.warn('Command "check" was aborted before rendering');
+                        environmentLogger.warn('Command "check" was aborted before rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        rendererLogger.warn(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
                     }
                     const renderTarget = await renderTargetPromise;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        rendererLogger.warn('Command "check" was aborted before rendering');
+                        environmentLogger.warn('Command "check" was aborted before rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        rendererLogger.warn(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_e = baseEyes.test.environment) === null || _e === void 0 ? void 0 : _e.environmentId}" was aborted during one of the previous steps`);
                     }
                     const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
@@ -192,13 +192,13 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                             scrollRootElement: scrollRootSelector,
                             selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: !!settings.pageId,
-                            renderer: ufgRenderer,
-                            renderEnvironmentId: baseEyes.test.renderEnvironmentId,
+                            environment: ufgEnvironment,
+                            environmentId: baseEyes.test.environment.environmentId,
                             uploadUrl: baseEyes.test.uploadUrl,
                             stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
                         },
                         signal,
-                        logger: rendererLogger,
+                        logger: environmentLogger,
                     });
                     let offset = 0;
                     const baseSettings = getBaseCheckSettings({
@@ -211,34 +211,34 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                     baseTarget.source = snapshotUrl;
                     baseTarget.name = snapshotTitle;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        rendererLogger.warn('Command "check" was aborted after rendering');
+                        environmentLogger.warn('Command "check" was aborted after rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted after rendering');
                     }
                     else if (!baseEyes.running) {
-                        rendererLogger.warn(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_f = baseEyes.test.environment) === null || _f === void 0 ? void 0 : _f.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_g = baseEyes.test.environment) === null || _g === void 0 ? void 0 : _g.environmentId}" was aborted during one of the previous steps`);
                     }
                     await baseEyes.checkAndClose({
                         target: { ...baseTarget, isTransformed: true },
                         settings: baseSettings,
-                        logger: rendererLogger,
+                        logger: environmentLogger,
                     });
                 }
                 catch (error) {
-                    rendererLogger.error(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" failed due to an error`, error);
-                    await baseEyes.abort({ logger: rendererLogger });
+                    environmentLogger.error(`Render on environment with id "${(_h = baseEyes.test.environment) === null || _h === void 0 ? void 0 : _h.environmentId}" failed due to an error`, error);
+                    await baseEyes.abort({ logger: environmentLogger });
                     error.info = { eyes: baseEyes };
                     throw error;
                 }
             }
             catch (error) {
-                rendererLogger.error(`Renderer with id ${ufgRenderer.id} failed before rendering started due to an error`, error);
-                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer: ufgRenderer };
+                environmentLogger.error(`Environment with id ${ufgEnvironment.environmentId} failed before rendering started due to an error`, error);
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, environment: ufgEnvironment };
                 throw error;
             }
         });
-        uniqueRenderers.forEach((renderer, index) => {
-            const key = (0, extract_renderer_key_1.extractRendererKey)(renderer);
+        uniqueEnvironments.forEach((environment, index) => {
+            const key = (0, to_environment_key_1.toEnvironmentKey)(environment);
             let item = eyes.storage.get(key);
             if (!item) {
                 item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };