@applitools/core 2.3.11 → 2.3.13

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 2.3.13 - 2023/3/7
+
+### Features
+### Bug fixes
+- Fixed selector transformation for scroll root elements for ufg
+
+## 2.3.12 - 2023/3/7
+
+### Features
+- Update broker url using last response instead of using driver
+### Bug fixes
+- Replaced broker url cache with nml element cache
+
 ## 2.3.11 - 2023/3/6
 
 ### Features

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

@@ -28,7 +28,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
-const take_snapshots_1 = require("./utils/take-snapshots");
+const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
+const take_vhses_1 = require("./utils/take-vhses");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
@@ -36,14 +37,15 @@ const uniquify_renderers_1 = require("./utils/uniquify-renderers");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }) {
+function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger: defaultLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = defaultLogger, }) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         logger.log('Command "checkAndClose" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
             logger.warn('Command "checkAndClose" was called after test was already aborted');
             throw new abort_error_1.AbortError('Command "checkAndClose" was called after test was already aborted');
         }
+        const ufgClient = await eyes.getUFGClient({ logger });
         const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings,
         });
@@ -52,6 +54,7 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
         let snapshotTitle;
         let userAgent;
         let regionToTarget;
+        let scrollRootSelector;
         let selectorsToCalculate;
         const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
         if ((0, driver_1.isDriver)(target, spec)) {
@@ -72,30 +75,40 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
                     context: driver.currentContext,
                     elementReferences: [
                         ...(elementReferenceToTarget ? [elementReferenceToTarget] : []),
+                        ...(settings.scrollRootElement ? [settings.scrollRootElement] : []),
                         ...elementReferencesToCalculate,
                     ],
                 });
                 cleanupGeneratedSelectors = generated.cleanupGeneratedSelectors;
+                selectorsToCalculate = generated.selectors;
                 if (elementReferenceToTarget) {
-                    if (!((_b = generated.selectors[0]) === null || _b === void 0 ? void 0 : _b.safeSelector))
+                    if (!((_b = selectorsToCalculate[0]) === null || _b === void 0 ? void 0 : _b.safeSelector))
                         throw new Error('Target element not found');
-                    regionToTarget = generated.selectors[0].safeSelector;
-                    selectorsToCalculate = generated.selectors.slice(1);
+                    regionToTarget = selectorsToCalculate[0].safeSelector;
+                    selectorsToCalculate = selectorsToCalculate.slice(1);
                 }
-                else {
-                    selectorsToCalculate = generated.selectors;
+                if (settings.scrollRootElement) {
+                    scrollRootSelector = (_c = selectorsToCalculate[0].safeSelector) !== null && _c !== void 0 ? _c : undefined;
+                    selectorsToCalculate = selectorsToCalculate.slice(1);
                 }
             }
+            else {
+                regionToTarget = (0, driver_1.isSelector)(elementReferenceToTarget)
+                    ? (_e = (_d = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _d === void 0 ? void 0 : _d.call(spec, settings.scrollRootElement)) !== null && _e !== void 0 ? _e : undefined
+                    : undefined;
+                scrollRootSelector = (0, driver_1.isSelector)(settings.scrollRootElement)
+                    ? (_g = (_f = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _f === void 0 ? void 0 : _f.call(spec, settings.scrollRootElement)) !== null && _g !== void 0 ? _g : undefined
+                    : undefined;
+            }
             const currentContext = driver.currentContext;
-            snapshots = await (0, take_snapshots_1.takeSnapshots)({
-                driver,
+            const snapshotOptions = {
                 settings: {
                     ...eyes.test.server,
                     waitBeforeCapture: settings.waitBeforeCapture,
                     disableBrowserFetching: settings.disableBrowserFetching,
                     layoutBreakpoints: settings.layoutBreakpoints,
                     renderers: uniqueRenderers,
-                    skipResources: client.getCachedResourceUrls(),
+                    skipResources: ufgClient.getCachedResourceUrls(),
                 },
                 hooks: {
                     async beforeSnapshots() {
@@ -109,11 +122,22 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
                     },
                 },
                 provides: {
-                    getChromeEmulationDevices: client.getChromeEmulationDevices,
-                    getIOSDevices: client.getIOSDevices,
+                    getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
+                    getIOSDevices: ufgClient.getIOSDevices,
                 },
-                logger,
-            });
+            };
+            if (driver.isWeb) {
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, ...snapshotOptions, logger });
+            }
+            else {
+                const nmlClient = await eyes.getNMLClient({ driver, logger });
+                if (nmlClient) {
+                    snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
+                }
+                else {
+                    snapshots = await (0, take_vhses_1.takeVHSes)({ driver, ...snapshotOptions, logger });
+                }
+            }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
             snapshotTitle = await driver.getTitle();
@@ -123,7 +147,7 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
             snapshots = !utils.types.isArray(target) ? Array(uniqueRenderers.length).fill(target) : target;
             snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
         }
-        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_c = elementReferenceToTarget) !== null && _c !== void 0 ? _c : settings.region);
+        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_h = elementReferenceToTarget) !== null && _h !== void 0 ? _h : settings.region);
         selectorsToCalculate !== null && selectorsToCalculate !== void 0 ? selectorsToCalculate : (selectorsToCalculate = elementReferencesToCalculate.map(selector => ({
             originalSelector: selector,
             safeSelector: selector,
@@ -140,7 +164,7 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
                 }
                 const { cookies, ...snapshot } = snapshots[index];
                 const snapshotType = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
-                const renderTargetPromise = client.createRenderTarget({
+                const renderTargetPromise = ufgClient.createRenderTarget({
                     snapshot,
                     settings: {
                         renderer,
@@ -170,11 +194,12 @@ function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget,
                         logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
                         throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
                     }
-                    const { renderId, selectorRegions, ...baseTarget } = await client.render({
+                    const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
                             ...settings,
                             region: regionToTarget,
+                            scrollRootElement: scrollRootSelector,
                             selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: Boolean(settings.pageId),
                             type: snapshotType,

package/dist/ufg/check.js

@@ -28,7 +28,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
-const take_snapshots_1 = require("./utils/take-snapshots");
+const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
+const take_vhses_1 = require("./utils/take-vhses");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
@@ -36,14 +37,15 @@ const uniquify_renderers_1 = require("./utils/uniquify-renderers");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger: defaultLogger, }) {
+function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: defaultLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = defaultLogger, }) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         logger.log('Command "check" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
             logger.warn('Command "check" was called after test was already aborted');
             throw new abort_error_1.AbortError('Command "check" was called after test was already aborted');
         }
+        const ufgClient = await eyes.getUFGClient({ logger });
         const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings,
         });
@@ -52,6 +54,7 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
         let snapshotTitle;
         let userAgent;
         let regionToTarget;
+        let scrollRootSelector;
         let selectorsToCalculate;
         const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
         const driver = spec && (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
@@ -73,30 +76,40 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
                     context: driver.currentContext,
                     elementReferences: [
                         ...(elementReferenceToTarget ? [elementReferenceToTarget] : []),
+                        ...(settings.scrollRootElement ? [settings.scrollRootElement] : []),
                         ...elementReferencesToCalculate,
                     ],
                 });
                 cleanupGeneratedSelectors = generated.cleanupGeneratedSelectors;
+                selectorsToCalculate = generated.selectors;
                 if (elementReferenceToTarget) {
-                    if (!((_c = generated.selectors[0]) === null || _c === void 0 ? void 0 : _c.safeSelector))
+                    if (!((_c = selectorsToCalculate[0]) === null || _c === void 0 ? void 0 : _c.safeSelector))
                         throw new Error('Target element not found');
-                    regionToTarget = (_d = generated.selectors[0]) === null || _d === void 0 ? void 0 : _d.safeSelector;
-                    selectorsToCalculate = generated.selectors.slice(1);
+                    regionToTarget = selectorsToCalculate[0].safeSelector;
+                    selectorsToCalculate = selectorsToCalculate.slice(1);
                 }
-                else {
-                    selectorsToCalculate = generated.selectors;
+                if (settings.scrollRootElement) {
+                    scrollRootSelector = (_d = selectorsToCalculate[0].safeSelector) !== null && _d !== void 0 ? _d : undefined;
+                    selectorsToCalculate = selectorsToCalculate.slice(1);
                 }
             }
+            else {
+                regionToTarget = (0, driver_1.isSelector)(elementReferenceToTarget)
+                    ? (_f = (_e = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _e === void 0 ? void 0 : _e.call(spec, settings.scrollRootElement)) !== null && _f !== void 0 ? _f : undefined
+                    : undefined;
+                scrollRootSelector = (0, driver_1.isSelector)(settings.scrollRootElement)
+                    ? (_h = (_g = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _g === void 0 ? void 0 : _g.call(spec, settings.scrollRootElement)) !== null && _h !== void 0 ? _h : undefined
+                    : undefined;
+            }
             const currentContext = driver.currentContext;
-            snapshots = await (0, take_snapshots_1.takeSnapshots)({
-                driver,
+            const snapshotOptions = {
                 settings: {
                     ...eyes.test.server,
                     waitBeforeCapture: settings.waitBeforeCapture,
                     disableBrowserFetching: settings.disableBrowserFetching,
                     layoutBreakpoints: settings.layoutBreakpoints,
                     renderers: uniqueRenderers,
-                    skipResources: client.getCachedResourceUrls(),
+                    skipResources: ufgClient.getCachedResourceUrls(),
                 },
                 hooks: {
                     async beforeSnapshots() {
@@ -110,11 +123,22 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
                     },
                 },
                 provides: {
-                    getChromeEmulationDevices: client.getChromeEmulationDevices,
-                    getIOSDevices: client.getIOSDevices,
+                    getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
+                    getIOSDevices: ufgClient.getIOSDevices,
                 },
-                logger,
-            });
+            };
+            if (driver.isWeb) {
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, ...snapshotOptions, logger });
+            }
+            else {
+                const nmlClient = await eyes.getNMLClient({ driver, logger });
+                if (nmlClient) {
+                    snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
+                }
+                else {
+                    snapshots = await (0, take_vhses_1.takeVHSes)({ driver, ...snapshotOptions, logger });
+                }
+            }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
             snapshotTitle = await driver.getTitle();
@@ -124,7 +148,7 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
             snapshots = !utils.types.isArray(target) ? Array(uniqueRenderers.length).fill(target) : target;
             snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
         }
-        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_e = elementReferenceToTarget) !== null && _e !== void 0 ? _e : settings.region);
+        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_j = elementReferenceToTarget) !== null && _j !== void 0 ? _j : settings.region);
         selectorsToCalculate !== null && selectorsToCalculate !== void 0 ? selectorsToCalculate : (selectorsToCalculate = elementReferencesToCalculate.map(selector => ({
             originalSelector: selector,
             safeSelector: selector,
@@ -141,7 +165,7 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
                 }
                 const { cookies, ...snapshot } = snapshots[index];
                 const snapshotType = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
-                const renderTargetPromise = client.createRenderTarget({
+                const renderTargetPromise = ufgClient.createRenderTarget({
                     snapshot,
                     settings: {
                         renderer,
@@ -171,11 +195,12 @@ function makeCheck({ eyes, client, target: defaultTarget, spec, signal, logger:
                         logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
                         throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
                     }
-                    const { renderId, selectorRegions, ...baseTarget } = await client.render({
+                    const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
                             ...settings,
                             region: regionToTarget,
+                            scrollRootElement: scrollRootSelector,
                             selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: Boolean(settings.pageId),
                             type: snapshotType,

package/dist/ufg/core.js

@@ -37,7 +37,7 @@ const extract_text_1 = require("../automation/extract-text");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
 const throat_1 = __importDefault(require("throat"));
-function makeCore({ concurrency, spec, client, core, agentId = 'core-ufg', cwd = process.cwd(), logger, }) {
+function makeCore({ concurrency, spec, clients, core, agentId = 'core-ufg', cwd = process.cwd(), logger, }) {
     var _a;
     logger = (_a = logger === null || logger === void 0 ? void 0 : logger.extend({ label: 'core-ufg' })) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ label: 'core-ufg' });
     logger.log(`Core ufg is initialized ${core ? 'with' : 'without'} custom base core`);
@@ -78,7 +78,7 @@ function makeCore({ concurrency, spec, client, core, agentId = 'core-ufg', cwd =
         locate: (0, locate_1.makeLocate)({ spec, core, logger }),
         locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
         extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
-        openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, client, core, logger }),
+        openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, logger }),
     });
 }
 exports.makeCore = makeCore;

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

@@ -25,21 +25,23 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetBaseEyes = void 0;
 const utils = __importStar(require("@applitools/utils"));
-function makeGetBaseEyes({ settings: defaultSettings, core, client, eyes, logger: defaultLogger }) {
+function makeGetBaseEyes({ eyes, settings: defaultSettings, core, baseEyes, logger: defaultLogger }) {
     const getBaseEyesWithCache = utils.general.cachify(getBaseEyes, ([options]) => options === null || options === void 0 ? void 0 : options.settings);
-    if (eyes)
-        eyes.forEach(eyes => getBaseEyesWithCache.setCachedValue(eyes.test.rendererInfo, Promise.resolve([eyes])));
+    if (baseEyes) {
+        baseEyes.forEach(baseEyes => getBaseEyesWithCache.setCachedValue(baseEyes.test.rendererInfo, Promise.resolve([baseEyes])));
+    }
     return getBaseEyesWithCache;
     async function getBaseEyes({ settings, logger = defaultLogger, } = {}) {
         logger.log(`Command "getBaseEyes" is called with settings`, settings);
         if (!settings)
             throw new Error('');
-        const environment = await client.bookRenderer({ settings });
-        const eyes = await core.openEyes({
+        const ufgClient = await eyes.getUFGClient({ logger });
+        const environment = await ufgClient.bookRenderer({ settings });
+        const eyesBase = await core.openEyes({
             settings: { ...defaultSettings, environment: { ...defaultSettings.environment, ...environment } },
             logger,
         });
-        return [eyes];
+        return [eyesBase];
     }
 }
 exports.makeGetBaseEyes = makeGetBaseEyes;

package/dist/ufg/get-nml-client.js

@@ -0,0 +1,41 @@
+"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.makeGetNMLClient = void 0;
+const nml_client_1 = require("@applitools/nml-client");
+const utils = __importStar(require("@applitools/utils"));
+function makeGetNMLClient({ config, client, logger: defaultLogger }) {
+    const getBaseEyesWithCache = utils.general.cachify(getNMLClient, () => 'default');
+    if (client)
+        getBaseEyesWithCache.setCachedValue('default', Promise.resolve(client));
+    return getBaseEyesWithCache;
+    async function getNMLClient({ driver, logger = defaultLogger }) {
+        const brokerUrl = await driver.extractBrokerUrl();
+        if (!brokerUrl)
+            return null;
+        return (0, nml_client_1.makeNMLClient)({ config: { brokerUrl, ...config }, logger });
+    }
+}
+exports.makeGetNMLClient = makeGetNMLClient;

package/dist/ufg/get-ufg-client.js

@@ -0,0 +1,38 @@
+"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.makeGetUFGClient = void 0;
+const ufg_client_1 = require("@applitools/ufg-client");
+const utils = __importStar(require("@applitools/utils"));
+function makeGetUFGClient({ config, concurrency, client, logger: defaultLogger }) {
+    const getBaseEyesWithCache = utils.general.cachify(getUFGClient, () => 'default');
+    if (client)
+        getBaseEyesWithCache.setCachedValue('default', Promise.resolve(client));
+    return getBaseEyesWithCache;
+    async function getUFGClient({ logger = defaultLogger } = {}) {
+        return (0, ufg_client_1.makeUFGClient)({ config, concurrency, logger });
+    }
+}
+exports.makeGetUFGClient = makeGetUFGClient;

package/dist/ufg/open-eyes.js

@@ -25,7 +25,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeOpenEyes = void 0;
 const driver_1 = require("@applitools/driver");
-const ufg_client_1 = require("@applitools/ufg-client");
+const get_ufg_client_1 = require("./get-ufg-client");
+const get_nml_client_1 = require("./get-nml-client");
 const get_base_eyes_1 = require("./get-base-eyes");
 const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
@@ -34,9 +35,9 @@ const abort_1 = require("./abort");
 const get_results_1 = require("./get-results");
 const abort_controller_1 = require("abort-controller");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ core, client, spec, logger: defaultLogger }) {
+function makeOpenEyes({ core, clients, spec, logger: defaultLogger }) {
     return async function openEyes({ target, settings, eyes, logger = defaultLogger, }) {
-        var _a, _b;
+        var _a;
         logger.log(`Command "openEyes" is called with ${target ? 'default driver and' : ''}`, ...(settings ? ['settings', settings] : []), eyes ? 'predefined eyes' : '');
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger }));
         if (driver && !eyes) {
@@ -52,14 +53,8 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger }) {
         }
         const controller = new abort_controller_1.AbortController();
         const account = await core.getAccountInfo({ settings, logger });
-        client !== null && client !== void 0 ? client : (client = (0, ufg_client_1.makeUFGClient)({
-            config: { ...account.ufg, ...account, proxy: settings.proxy },
-            concurrency: (_b = settings.renderConcurrency) !== null && _b !== void 0 ? _b : 5,
-            logger,
-        }));
-        const getBaseEyes = (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, core, client, logger });
         return utils.general.extend({}, eyes => {
-            var _a;
+            var _a, _b;
             const storage = new Map();
             let running = true;
             return {
@@ -74,9 +69,16 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger }) {
                 get running() {
                     return running;
                 },
-                getBaseEyes,
+                getUFGClient: (0, get_ufg_client_1.makeGetUFGClient)({
+                    config: { ...account.ufg, ...account, proxy: settings.proxy },
+                    concurrency: (_b = settings.renderConcurrency) !== null && _b !== void 0 ? _b : 5,
+                    client: clients === null || clients === void 0 ? void 0 : clients.ufg,
+                    logger,
+                }),
+                getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ config: settings, client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
+                getBaseEyes: (0, get_base_eyes_1.makeGetBaseEyes)({ eyes, settings, core, logger }),
                 // check with indexing and storage
-                check: utils.general.wrap((0, check_1.makeCheck)({ eyes, client: client, target: driver, spec, signal: controller.signal, logger }), async (check, options = {}) => {
+                check: utils.general.wrap((0, check_1.makeCheck)({ eyes, target: driver, spec, signal: controller.signal, logger }), async (check, options = {}) => {
                     const results = await check(options);
                     results.forEach(result => {
                         var _a;
@@ -85,14 +87,7 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger }) {
                     });
                     return results;
                 }),
-                checkAndClose: utils.general.wrap((0, check_and_close_1.makeCheckAndClose)({
-                    eyes,
-                    client: client,
-                    target: driver,
-                    spec,
-                    signal: controller.signal,
-                    logger,
-                }), async (checkAndClose, options = {}) => {
+                checkAndClose: utils.general.wrap((0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, spec, signal: controller.signal, logger }), async (checkAndClose, options = {}) => {
                     const results = await checkAndClose(options);
                     results.forEach(result => {
                         var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "2.3.11",
+  "version": "2.3.13",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -76,16 +76,16 @@
     "@applitools/core-base": "1.1.39",
     "@applitools/dom-capture": "11.2.1",
     "@applitools/dom-snapshot": "4.7.5",
-    "@applitools/driver": "1.11.34",
-    "@applitools/ec-client": "1.2.12",
+    "@applitools/driver": "1.11.35",
+    "@applitools/ec-client": "1.2.13",
     "@applitools/logger": "1.1.46",
-    "@applitools/nml-client": "1.3.37",
+    "@applitools/nml-client": "1.3.38",
     "@applitools/req": "1.1.30",
-    "@applitools/screenshoter": "3.7.28",
+    "@applitools/screenshoter": "3.7.29",
     "@applitools/snippets": "2.4.15",
     "@applitools/socket": "1.0.8",
-    "@applitools/spec-driver-webdriver": "1.0.14",
-    "@applitools/ufg-client": "1.2.0",
+    "@applitools/spec-driver-webdriver": "1.0.15",
+    "@applitools/ufg-client": "1.2.1",
     "@applitools/utils": "1.3.30",
     "@types/ws": "8.5.4",
     "abort-controller": "3.0.0",
@@ -99,9 +99,9 @@
   "devDependencies": {
     "@applitools/bongo": "^2.2.5",
     "@applitools/sdk-coverage-tests": "^2.7.12",
-    "@applitools/spec-driver-puppeteer": "^1.1.46",
-    "@applitools/spec-driver-selenium": "^1.5.31",
-    "@applitools/spec-driver-webdriverio": "^1.4.29",
+    "@applitools/spec-driver-puppeteer": "^1.1.47",
+    "@applitools/spec-driver-selenium": "^1.5.32",
+    "@applitools/spec-driver-webdriverio": "^1.4.30",
     "@applitools/test-server": "^1.1.26",
     "@applitools/test-utils": "^1.5.12",
     "@types/mocha": "^9.1.1",

package/types/ufg/check-and-close.d.ts

@@ -2,17 +2,15 @@ import type { Region } from '@applitools/utils';
 import type { DriverTarget, Target, Eyes, CheckSettings, TestResult, CloseSettings } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
-import { type UFGClient } from '@applitools/ufg-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
-    client: UFGClient;
     target?: DriverTarget<TSpec>;
     spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
     logger: Logger;
 };
-export declare function makeCheckAndClose<TSpec extends SpecType>({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
+export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
     target?: Target<TSpec> | undefined;
     settings?: (import("@applitools/core-base").CheckSettings<Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
         renderers?: import("@applitools/ufg-client").Renderer[] | undefined;

package/types/ufg/check.d.ts

@@ -1,17 +1,15 @@
 import type { DriverTarget, Target, Eyes, CheckSettings, CheckResult } from './types';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
-import { type UFGClient } from '@applitools/ufg-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
     eyes: Eyes<TSpec>;
-    client: UFGClient;
     target?: DriverTarget<TSpec>;
     spec?: SpecDriver<TSpec>;
     signal?: AbortSignal;
     logger: Logger;
 };
-export declare function makeCheck<TSpec extends SpecType>({ eyes, client, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
+export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, signal, logger: defaultLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
     settings?: CheckSettings<TSpec> | undefined;
     target?: Target<TSpec> | undefined;
     logger?: Logger | undefined;

package/types/ufg/core.d.ts

@@ -1,16 +1,20 @@
 import type { Core } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
 import { type UFGClient } from '@applitools/ufg-client';
+import { type NMLClient } from '@applitools/nml-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 type Options<TSpec extends SpecType> = {
     concurrency: number;
     spec?: SpecDriver<TSpec>;
-    client?: UFGClient;
+    clients?: {
+        ufg?: UFGClient;
+        nml?: NMLClient;
+    };
     core?: BaseCore;
     agentId?: string;
     cwd?: string;
     logger?: Logger;
 };
-export declare function makeCore<TSpec extends SpecType>({ concurrency, spec, client, core, agentId, cwd, logger, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType>({ concurrency, spec, clients, core, agentId, cwd, logger, }: Options<TSpec>): Core<TSpec>;
 export {};

package/types/ufg/get-base-eyes.d.ts

@@ -1,15 +1,16 @@
-import type { OpenSettings } from './types';
-import type { Core as CoreBase, Eyes as EyesBase } from '@applitools/core-base';
+import type { Eyes, OpenSettings } from './types';
+import type { Core as BaseCore, Eyes as EyesBase } from '@applitools/core-base';
+import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
-import { type UFGClient, type Renderer } from '@applitools/ufg-client';
+import { type Renderer } from '@applitools/ufg-client';
 type Options = {
+    eyes: Eyes<SpecType>;
     settings: OpenSettings;
-    eyes?: EyesBase[];
-    core: CoreBase;
-    client: UFGClient;
+    core: BaseCore;
+    baseEyes?: EyesBase[];
     logger: Logger;
 };
-export declare function makeGetBaseEyes({ settings: defaultSettings, core, client, eyes, logger: defaultLogger }: Options): (({ settings, logger, }?: {
+export declare function makeGetBaseEyes({ eyes, settings: defaultSettings, core, baseEyes, logger: defaultLogger }: Options): (({ settings, logger, }?: {
     settings?: {
         type: 'web' | 'native';
         renderer: Renderer;

package/types/ufg/get-nml-client.d.ts

@@ -0,0 +1,17 @@
+import { type SpecType, type Driver } from '@applitools/driver';
+import { type Logger } from '@applitools/logger';
+import { type NMLClient, type NMLRequestsConfig } from '@applitools/nml-client';
+type Options = {
+    config: Omit<NMLRequestsConfig, 'brokerUrl'>;
+    client?: NMLClient;
+    logger: Logger;
+};
+export declare function makeGetNMLClient({ config, client, logger: defaultLogger }: Options): (({ driver, logger }: {
+    driver: Driver<SpecType>;
+    logger?: Logger | undefined;
+}) => Promise<NMLClient | null>) & {
+    getCachedValues(): Promise<NMLClient | null>[];
+    setCachedValue(key: any, value: Promise<NMLClient | null>): void;
+    clearCache(): void;
+};
+export {};

package/types/ufg/get-ufg-client.d.ts

@@ -0,0 +1,16 @@
+import { type Logger } from '@applitools/logger';
+import { type UFGClient, type UFGRequestsConfig } from '@applitools/ufg-client';
+type Options = {
+    config: UFGRequestsConfig;
+    concurrency: number;
+    client?: UFGClient;
+    logger: Logger;
+};
+export declare function makeGetUFGClient({ config, concurrency, client, logger: defaultLogger }: Options): (({ logger }?: {
+    logger?: Logger | undefined;
+}) => Promise<UFGClient>) & {
+    getCachedValues(): Promise<UFGClient>[];
+    setCachedValue(key: any, value: Promise<UFGClient>): void;
+    clearCache(): void;
+};
+export {};

package/types/ufg/open-eyes.d.ts

@@ -1,15 +1,19 @@
 import type { DriverTarget, Eyes, OpenSettings } from './types';
 import type { Core as BaseCore, Eyes as BaseEyes } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type UFGClient } from '@applitools/ufg-client';
+import { type NMLClient } from '@applitools/nml-client';
+import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType> = {
     core: BaseCore;
-    client?: UFGClient;
+    clients?: {
+        ufg?: UFGClient;
+        nml?: NMLClient;
+    };
     spec?: SpecDriver<TSpec>;
     logger: Logger;
 };
-export declare function makeOpenEyes<TSpec extends SpecType>({ core, client, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, eyes, logger, }: {
+export declare function makeOpenEyes<TSpec extends SpecType>({ core, clients, spec, logger: defaultLogger }: Options<TSpec>): ({ target, settings, eyes, logger, }: {
     target?: DriverTarget<TSpec> | undefined;
     settings: OpenSettings;
     eyes?: BaseEyes<import("@applitools/core-base").ImageTarget>[] | undefined;

package/types/ufg/types.d.ts

@@ -1,10 +1,11 @@
 import type { MaybeArray } from '@applitools/utils';
 import type * as BaseCore from '@applitools/core-base/types';
 import type * as AutomationCore from '../automation/types';
-import { type SpecType } from '@applitools/driver';
+import { type SpecType, type Driver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
-import { type Renderer, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import { type UFGClient, type Renderer, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import { type NMLClient } from '@applitools/nml-client';
 export * from '../automation/types';
 export type SnapshotTarget = MaybeArray<DomSnapshot> | MaybeArray<AndroidSnapshot> | MaybeArray<IOSSnapshot>;
 export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
@@ -19,6 +20,13 @@ export interface Core<TSpec extends SpecType, TTarget = AutomationCore.Target<TS
 }
 export interface Eyes<TSpec extends SpecType, TTarget = Target<TSpec>> extends AutomationCore.Eyes<TSpec, TTarget> {
     readonly type: 'ufg';
+    getUFGClient(options?: {
+        logger?: Logger;
+    }): Promise<UFGClient>;
+    getNMLClient(options: {
+        driver: Driver<TSpec>;
+        logger?: Logger;
+    }): Promise<NMLClient | null>;
     getBaseEyes(options?: {
         settings?: {
             type: 'web' | 'native';

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

@@ -1,37 +0,0 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.takeSnapshots = void 0;
-const take_dom_snapshots_1 = require("./take-dom-snapshots");
-const take_vhses_1 = require("./take-vhses");
-const nml_client_1 = require("@applitools/nml-client");
-__exportStar(require("./take-dom-snapshots"), exports);
-__exportStar(require("./take-vhses"), exports);
-async function takeSnapshots({ driver, settings, hooks, provides, logger, }) {
-    if (driver.isWeb) {
-        return (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, settings, hooks, provides, logger });
-    }
-    else {
-        const brokerUrl = await driver.extractBrokerUrl();
-        if (brokerUrl) {
-            return (await (0, nml_client_1.takeSnapshots)({ url: brokerUrl, settings, logger }));
-        }
-        else {
-            return (0, take_vhses_1.takeVHSes)({ driver, settings, hooks, logger });
-        }
-    }
-}
-exports.takeSnapshots = takeSnapshots;

package/types/ufg/utils/take-snapshots.d.ts

@@ -1,21 +0,0 @@
-import type { Size } from '@applitools/utils';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type DomSnapshot, type AndroidSnapshot, type IOSSnapshot, type ChromeEmulationDevice, type IOSDevice, type ScreenOrientation } from '@applitools/ufg-client';
-import { type DomSnapshotsSettings } from './take-dom-snapshots';
-import { type VHSesSettings } from './take-vhses';
-export * from './take-dom-snapshots';
-export * from './take-vhses';
-export declare function takeSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
-    driver: Driver<TSpec>;
-    settings: DomSnapshotsSettings & VHSesSettings;
-    hooks: {
-        beforeSnapshots?(): void | Promise<void>;
-        beforeEachSnapshot?(): void | Promise<void>;
-    };
-    provides: {
-        getChromeEmulationDevices(): Promise<Record<ChromeEmulationDevice, Record<ScreenOrientation, Size>>>;
-        getIOSDevices(): Promise<Record<IOSDevice, Record<ScreenOrientation, Size>>>;
-    };
-    logger: Logger;
-}): Promise<DomSnapshot[] | AndroidSnapshot[] | IOSSnapshot[]>;