@applitools/core 1.2.17 → 1.3.1

package/dist/automation/get-viewport-size.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetViewportSize = void 0;
 const driver_1 = require("@applitools/driver");
 function makeGetViewportSize({ spec, logger: defaultLogger, }) {
-    return async function getViewportSize({ driver, target, logger = defaultLogger, }) {
-        logger.log(`Command "getViewportSize" is called with ${driver ? 'driver' : 'target'}`);
-        driver !== null && driver !== void 0 ? driver : (driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger }));
+    return async function getViewportSize({ target, logger = defaultLogger, }) {
+        logger.log(`Command "getViewportSize" is called`);
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
         return driver.getViewportSize();
     };
 }

package/dist/automation/locate.js

@@ -4,12 +4,12 @@ exports.makeLocate = void 0;
 const driver_1 = require("@applitools/driver");
 const take_screenshot_1 = require("./utils/take-screenshot");
 function makeLocate({ spec, core, logger: defaultLogger, }) {
-    return async function locate({ settings, driver, target, logger = defaultLogger, } = {}) {
-        logger.log(`Command "locate" is called with ${driver ? 'driver' : 'target'} and settings`, settings);
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null);
-        if (!driver) {
-            return core.locate({ target: target, settings: settings, logger });
+    return async function locate({ settings, target, logger = defaultLogger, }) {
+        logger.log(`Command "locate" is called with settings`, settings);
+        if (!(0, driver_1.isDriver)(target, spec)) {
+            return core.locate({ target, settings: settings, logger });
         }
+        const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
         const screenshot = await (0, take_screenshot_1.takeScreenshot)({ driver, settings, logger });
         const baseTarget = { image: await screenshot.image.toPng() };
         const results = await core.locate({ target: baseTarget, settings: settings, logger });

package/dist/automation/set-viewport-size.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeSetViewportSize = void 0;
 const driver_1 = require("@applitools/driver");
 function makeSetViewportSize({ spec, logger: defaultLogger, }) {
-    return async function setViewportSize({ driver, target, size, logger = defaultLogger, }) {
-        logger.log(`Command "setViewportSize" is called with ${driver ? 'driver' : 'target'} and size`, size);
-        driver !== null && driver !== void 0 ? driver : (driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger }));
+    return async function setViewportSize({ target, size, logger = defaultLogger, }) {
+        logger.log(`Command "setViewportSize" is called with size`, size);
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
         return driver.setViewportSize(size);
     };
 }

package/dist/check-and-close.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
-function makeCheckAndClose({ type: defaultType, getTypedEyes, logger: defaultLogger, }) {
-    return async function checkAndClose({ type = defaultType, target, settings = {}, config, logger = defaultLogger, } = {}) {
+const driver_1 = require("@applitools/driver");
+function makeCheckAndClose({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    return async function checkAndClose({ type = defaultType, target = defaultTarget, settings = {}, config, logger = defaultLogger, } = {}) {
         settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...config === null || config === void 0 ? void 0 : config.check, ...config === null || config === void 0 ? void 0 : config.close, ...settings };
-        const eyes = await getTypedEyes({ type, renderers: settings.renderers });
-        const results = await eyes.checkAndClose({
-            target: target,
-            settings: settings,
+        const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+        const typedEyes = await eyes.getTypedEyes({
+            type,
+            settings: driver && {
+                type: driver.isNative ? 'native' : 'web',
+                renderers: settings.renderers,
+            },
             logger,
         });
+        const results = await typedEyes.checkAndClose({ target: driver !== null && driver !== void 0 ? driver : target, settings, logger });
         return results;
     };
 }

package/dist/check.js

@@ -27,37 +27,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
+const driver_1 = require("@applitools/driver");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheck({ type: defaultType, getTypedEyes, logger: defaultLogger, }) {
-    return async function check({ type = defaultType, target, settings, config, logger = defaultLogger, } = {}) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
-        var _s, _t, _u, _v;
+function makeCheck({ type: defaultType, eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    let stepIndex = 0;
+    return async function check({ type = defaultType, target = defaultTarget, settings, config, logger = defaultLogger, } = {}) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        var _r, _s, _t, _u;
         settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...config === null || config === void 0 ? void 0 : config.check, ...settings };
-        const eyes = await getTypedEyes({ type, renderers: settings.renderers });
         (_a = settings.fully) !== null && _a !== void 0 ? _a : (settings.fully = !settings.region && (!settings.frames || settings.frames.length === 0));
         (_b = settings.waitBeforeCapture) !== null && _b !== void 0 ? _b : (settings.waitBeforeCapture = 100);
         (_c = settings.stitchMode) !== null && _c !== void 0 ? _c : (settings.stitchMode = 'Scroll');
         (_d = settings.hideScrollbars) !== null && _d !== void 0 ? _d : (settings.hideScrollbars = true);
         (_e = settings.hideCaret) !== null && _e !== void 0 ? _e : (settings.hideCaret = true);
-        (_f = settings.overlap) !== null && _f !== void 0 ? _f : (settings.overlap = { top: 10, bottom: 50 });
-        (_g = settings.matchLevel) !== null && _g !== void 0 ? _g : (settings.matchLevel = 'Strict');
-        (_h = settings.ignoreCaret) !== null && _h !== void 0 ? _h : (settings.ignoreCaret = true);
-        (_j = settings.sendDom) !== null && _j !== void 0 ? _j : (settings.sendDom = eyes.test.account.rcaEnabled || settings.matchLevel === 'Layout' || settings.enablePatterns || settings.useDom);
-        (_k = settings.autProxy) !== null && _k !== void 0 ? _k : (settings.autProxy = eyes.test.server.proxy);
-        (_l = settings.useDom) !== null && _l !== void 0 ? _l : (settings.useDom = false);
-        (_m = (_s = settings).retryTimeout) !== null && _m !== void 0 ? _m : (_s.retryTimeout = 2000);
+        settings.overlap = { top: 10, bottom: 50, ...settings === null || settings === void 0 ? void 0 : settings.overlap };
+        (_f = settings.matchLevel) !== null && _f !== void 0 ? _f : (settings.matchLevel = 'Strict');
+        (_g = settings.ignoreCaret) !== null && _g !== void 0 ? _g : (settings.ignoreCaret = true);
+        (_h = settings.sendDom) !== null && _h !== void 0 ? _h : (settings.sendDom = eyes.test.account.rcaEnabled || settings.matchLevel === 'Layout' || settings.enablePatterns || settings.useDom);
+        (_j = settings.autProxy) !== null && _j !== void 0 ? _j : (settings.autProxy = eyes.test.server.proxy);
+        (_k = settings.useDom) !== null && _k !== void 0 ? _k : (settings.useDom = false);
+        (_l = (_r = settings).retryTimeout) !== null && _l !== void 0 ? _l : (_r.retryTimeout = 2000);
         settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
         if (settings.lazyLoad) {
-            (_o = (_t = settings.lazyLoad).scrollLength) !== null && _o !== void 0 ? _o : (_t.scrollLength = 300);
-            (_p = (_u = settings.lazyLoad).waitingTime) !== null && _p !== void 0 ? _p : (_u.waitingTime = 2000);
-            (_q = (_v = settings.lazyLoad).maxAmountToScroll) !== null && _q !== void 0 ? _q : (_v.maxAmountToScroll = 15000);
+            (_m = (_s = settings.lazyLoad).scrollLength) !== null && _m !== void 0 ? _m : (_s.scrollLength = 300);
+            (_o = (_t = settings.lazyLoad).waitingTime) !== null && _o !== void 0 ? _o : (_t.waitingTime = 2000);
+            (_p = (_u = settings.lazyLoad).maxAmountToScroll) !== null && _p !== void 0 ? _p : (_u.maxAmountToScroll = 15000);
         }
-        (_r = settings.waitBetweenStitches) !== null && _r !== void 0 ? _r : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
+        settings.stepIndex = stepIndex++;
+        (_q = settings.waitBetweenStitches) !== null && _q !== void 0 ? _q : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
         if (settings.matchLevel === 'Content') {
             logger.console.log(chalk_1.default.yellow(`The "Content" match level value has been deprecated, use "IgnoreColors" instead.`));
         }
-        const results = await eyes.check({ target: target, settings, logger });
+        const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+        const typedEyes = await eyes.getTypedEyes({
+            type,
+            settings: driver && {
+                type: driver.isNative ? 'native' : 'web',
+                renderers: settings.renderers,
+            },
+            logger,
+        });
+        const results = await typedEyes.check({ target: driver !== null && driver !== void 0 ? driver : target, settings, logger });
         return results;
     };
 }

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

@@ -30,19 +30,23 @@ const take_dom_capture_1 = require("./utils/take-dom-capture");
 const to_base_check_settings_1 = require("../utils/to-base-check-settings");
 const wait_for_lazy_load_1 = require("../utils/wait-for-lazy-load");
 const utils = __importStar(require("@applitools/utils"));
-function makeCheckAndClose({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }) {
-    return async function checkAndClose({ settings = {}, driver, target, logger = defaultLogger, } = {}) {
+function makeCheckAndClose({ eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    return async function checkAndClose({ target = defaultTarget, settings = {}, logger = defaultLogger, } = {}) {
         var _a;
         logger.log('Command "checkAndClose" is called with settings', settings);
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : defaultDriver);
         const baseEyes = await eyes.getBaseEyes({ logger });
-        if (!driver) {
-            const baseTarget = target;
+        if (!(0, driver_1.isDriver)(target, spec)) {
             const baseSettings = settings;
-            return (await Promise.all(baseEyes.map(baseEyes => baseEyes.checkAndClose({ target: baseTarget, settings: baseSettings, logger })))).flat();
+            return (await Promise.all(baseEyes.map(baseEyes => baseEyes.checkAndClose({ target, settings: baseSettings, logger })))).flat();
+        }
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+        if (settings.lazyLoad && driver.isWeb) {
+            await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                context: driver.currentContext,
+                settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                logger,
+            });
         }
-        if (settings.lazyLoad)
-            await (0, wait_for_lazy_load_1.waitForLazyLoad)({ driver, settings: settings.lazyLoad !== true ? settings.lazyLoad : {}, logger });
         const { elementReferencesToCalculate, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
         const screenshot = await (0, take_screenshot_1.takeScreenshot)({
             driver,

package/dist/classic/check.js

@@ -30,21 +30,25 @@ const take_dom_capture_1 = require("./utils/take-dom-capture");
 const to_base_check_settings_1 = require("../utils/to-base-check-settings");
 const wait_for_lazy_load_1 = require("../utils/wait-for-lazy-load");
 const utils = __importStar(require("@applitools/utils"));
-function makeCheck({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }) {
-    return async function check({ settings = {}, driver, target, logger = defaultLogger, } = {}) {
-        var _a;
+function makeCheck({ eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    return async function check({ target = defaultTarget, settings = {}, logger = defaultLogger, } = {}) {
+        var _a, _b;
         logger.log('Command "check" is called with settings', settings);
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : defaultDriver);
         const baseEyes = await eyes.getBaseEyes();
-        if (!driver) {
-            const baseTarget = target;
-            const baseSettings = settings;
-            return (await Promise.all(baseEyes.map(baseEyes => baseEyes.check({ target: baseTarget, settings: baseSettings, logger })))).flat();
+        if (!(0, driver_1.isDriver)(target, spec)) {
+            return (await Promise.all(baseEyes.map(baseEyes => baseEyes.check({ target, settings: settings, logger })))).flat();
         }
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
         await driver.refreshContexts();
-        await driver.currentContext.setScrollingElement(settings.scrollRootElement);
+        await driver.currentContext.setScrollingElement((_a = settings.scrollRootElement) !== null && _a !== void 0 ? _a : null);
         if (settings.lazyLoad && driver.isWeb) {
-            await (0, wait_for_lazy_load_1.waitForLazyLoad)({ driver, settings: settings.lazyLoad !== true ? settings.lazyLoad : {}, logger });
+            if (settings.lazyLoad) {
+                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                    context: driver.currentContext,
+                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                    logger,
+                });
+            }
         }
         // TODO it actually could be different per eyes
         const shouldRunOnce = true;
@@ -71,7 +75,7 @@ function makeCheck({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }
                 if (settings.fully)
                     await screenshot.scrollingElement.setAttribute('data-applitools-scroll', 'true');
                 else
-                    await ((_a = screenshot.element) === null || _a === void 0 ? void 0 : _a.setAttribute('data-applitools-scroll', 'true'));
+                    await ((_b = screenshot.element) === null || _b === void 0 ? void 0 : _b.setAttribute('data-applitools-scroll', 'true'));
                 baseTarget.dom = await (0, take_dom_capture_1.takeDomCapture)({ driver, logger }).catch(() => null);
             }
             if (settings.pageId) {

package/dist/classic/extract-text.js

@@ -29,19 +29,15 @@ const take_screenshot_1 = require("../automation/utils/take-screenshot");
 const take_dom_capture_1 = require("./utils/take-dom-capture");
 const utils = __importStar(require("@applitools/utils"));
 const snippets_1 = require("@applitools/snippets");
-function makeExtractText({ eyes, driver: defaultDriver, spec, logger: defaultLogger, }) {
-    return async function extractText({ settings, driver, target, logger = defaultLogger, } = {}) {
+function makeExtractText({ eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    return async function extractText({ target = defaultTarget, settings, logger = defaultLogger, }) {
         logger.log('Command "extractText" is called with settings', settings);
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : defaultDriver);
         const [baseEyes] = await eyes.getBaseEyes();
-        if (!driver) {
-            return baseEyes.extractText({
-                target: target,
-                settings: settings,
-                logger,
-            });
+        if (!(0, driver_1.isDriver)(target, spec)) {
+            return baseEyes.extractText({ target, settings: settings, logger });
         }
         settings = utils.types.isArray(settings) ? settings : [settings];
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
         const results = await settings.reduce(async (prev, settings) => {
             var _a;
             const steps = await prev;

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

@@ -27,13 +27,13 @@ exports.makeGetBaseEyes = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function makeGetBaseEyes({ settings, core, eyes, logger: defaultLogger }) {
     const getBaseEyesWithCache = utils.general.cachify(getBaseEyes, () => 'default');
-    if (eyes) {
+    if (eyes)
         getBaseEyesWithCache.setCachedValue('default', Promise.resolve(eyes));
-    }
     return getBaseEyesWithCache;
     async function getBaseEyes({ logger = defaultLogger } = {}) {
-        logger.log(`Command "getBaseEyes" is called with ${utils.types.isArray(eyes) ? `eyes array of length ${eyes.length}` : 'single eyes instance'}`);
-        return [await core.openEyes({ settings, logger })];
+        logger.log(`Command "getBaseEyes" is called with settings`, settings);
+        const eyes = await core.openEyes({ settings, logger });
+        return [eyes];
     }
 }
 exports.makeGetBaseEyes = makeGetBaseEyes;

package/dist/classic/locate-text.js

@@ -28,14 +28,14 @@ const driver_1 = require("@applitools/driver");
 const take_screenshot_1 = require("../automation/utils/take-screenshot");
 // import {takeDomCapture} from './utils/take-dom-capture'
 const utils = __importStar(require("@applitools/utils"));
-function makeLocateText({ spec, driver: defaultDriver, eyes, logger: defaultLogger, }) {
-    return async function locateText({ settings, driver, target, logger = defaultLogger, } = {}) {
+function makeLocateText({ eyes, target: defaultTarget, spec, logger: defaultLogger, }) {
+    return async function locateText({ target = defaultTarget, settings, logger = defaultLogger, }) {
         logger.log('Command "locateText" is called with settings', settings);
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : defaultDriver);
         const [baseEyes] = await eyes.getBaseEyes();
-        if (!driver) {
-            return baseEyes.locateText({ target: target, settings: settings, logger });
+        if (!(0, driver_1.isDriver)(target, spec)) {
+            return baseEyes.locateText({ target, settings: settings, logger });
         }
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
         const screenshot = await (0, take_screenshot_1.takeScreenshot)({ driver, settings, logger });
         const baseTarget = {
             image: await screenshot.image.toPng(),

package/dist/classic/open-eyes.js

@@ -32,11 +32,11 @@ const locate_text_1 = require("./locate-text");
 const extract_text_1 = require("./extract-text");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ core, spec, logger: defaultLogger, }) {
-    return async function openEyes({ settings, eyes, driver, target, logger = defaultLogger, }) {
+    return async function openEyes({ target, settings, eyes, logger = defaultLogger, }) {
         var _a, _b, _c, _d, _e;
         var _f;
-        logger.log(`Command "openEyes" is called with ${(spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? 'default driver and' : ''}`, ...(settings ? ['settings', settings] : []), eyes ? 'predefined eyes' : '');
-        driver !== null && driver !== void 0 ? driver : (driver = (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }) : null);
+        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, customConfig: settings }));
         if (driver && !eyes) {
             const currentContext = driver.currentContext;
             (_a = settings.environment) !== null && _a !== void 0 ? _a : (settings.environment = {});
@@ -79,10 +79,10 @@ function makeOpenEyes({ core, spec, logger: defaultLogger, }) {
         return utils.general.extend(baseEyes, eyes => ({
             type: 'classic',
             getBaseEyes,
-            check: (0, check_1.makeCheck)({ eyes, driver, spec, logger }),
-            checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, driver, spec, logger }),
-            locateText: (0, locate_text_1.makeLocateText)({ eyes, driver, spec, logger }),
-            extractText: (0, extract_text_1.makeExtractText)({ eyes, driver, spec, logger }),
+            check: (0, check_1.makeCheck)({ eyes, target: driver, spec, logger }),
+            checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, spec, logger }),
+            locateText: (0, locate_text_1.makeLocateText)({ eyes, target: driver, spec, logger }),
+            extractText: (0, extract_text_1.makeExtractText)({ eyes, target: driver, spec, logger }),
         }));
     };
 }

package/dist/close.js

@@ -7,7 +7,8 @@ function makeClose({ eyes, logger: defaultLogger, }) {
         var _a;
         settings = { ...config === null || config === void 0 ? void 0 : config.close, ...settings };
         (_a = settings.updateBaselineIfNew) !== null && _a !== void 0 ? _a : (settings.updateBaselineIfNew = true);
-        const results = await eyes.close({ settings, logger });
+        const typedEyes = await eyes.getTypedEyes({ logger });
+        const results = await typedEyes.close({ settings, logger });
         if (settings.throwErr) {
             results.forEach(result => {
                 if (result.status !== 'Passed')

package/dist/extract-text.js

@@ -40,7 +40,8 @@ function makeExtractText({ eyes, logger: defaultLogger, }) {
             settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
             (_a = settings.autProxy) !== null && _a !== void 0 ? _a : (settings.autProxy = eyes.test.server.proxy);
         }
-        const results = await eyes.extractText({ target: target, settings, logger });
+        const classicEyes = await eyes.getTypedEyes({ type: 'classic', logger });
+        const results = await classicEyes.extractText({ target, settings, logger });
         return results;
     };
 }

package/dist/get-typed-eyes.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeGetTypedEyes = void 0;
+function makeGetTypedEyes({ type: defaultType, settings: defaultSettings, target, cores, logger: defaultLogger, }) {
+    let eyes;
+    return async function getTypesEyes({ type = defaultType, settings, logger = defaultLogger, } = {}) {
+        if (!eyes) {
+            eyes =
+                type === 'ufg'
+                    ? await cores.ufg.openEyes({ target, settings: defaultSettings, logger })
+                    : await cores.classic.openEyes({ target, settings: defaultSettings, logger });
+            return eyes;
+        }
+        else if (eyes.type === type) {
+            return eyes;
+        }
+        else if (type === 'ufg') {
+            const baseEyes = await eyes.getBaseEyes();
+            return cores.ufg.openEyes({ target, settings: defaultSettings, eyes: baseEyes, logger });
+        }
+        else {
+            const baseEyes = (await Promise.all(settings.renderers.map(renderer => eyes.getBaseEyes({ settings: { type: settings.type, renderer } })))).flat();
+            return cores.classic.openEyes({ target, settings: defaultSettings, eyes: baseEyes, logger });
+        }
+    };
+}
+exports.makeGetTypedEyes = makeGetTypedEyes;

package/dist/index.js

@@ -26,8 +26,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatters = void 0;
+exports.formatters = exports.takeDomSnapshots = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./core"), exports);
+var take_dom_snapshots_1 = require("./ufg/utils/take-dom-snapshots");
+Object.defineProperty(exports, "takeDomSnapshots", { enumerable: true, get: function () { return take_dom_snapshots_1.takeDomSnapshots; } });
 exports.formatters = __importStar(require("./utils/format-results"));
 __exportStar(require("@applitools/driver/dist/debug"), exports);

package/dist/locate-text.js

@@ -6,7 +6,8 @@ function makeLocateText({ eyes, logger: defaultLogger, }) {
         var _a;
         settings = { ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
         (_a = settings.autProxy) !== null && _a !== void 0 ? _a : (settings.autProxy = eyes.test.server.proxy);
-        const results = await eyes.locateText({ target: target, settings, logger });
+        const classicEyes = await eyes.getTypedEyes({ type: 'classic', logger });
+        const results = await classicEyes.locateText({ target: target, settings, logger });
         return results;
     };
 }

package/dist/make-manager.js

@@ -31,16 +31,17 @@ const open_eyes_1 = require("./open-eyes");
 const close_manager_1 = require("./close-manager");
 const utils = __importStar(require("@applitools/utils"));
 function makeMakeManager({ spec, core, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), agentId: defaultAgentId, cwd = process.cwd(), logger: defaultLogger, }) {
-    return async function makeManager({ type, concurrency = defaultConcurrency, legacyConcurrency, agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId, logger = defaultLogger, } = {}) {
+    return async function makeManager({ type = 'classic', concurrency = defaultConcurrency, legacyConcurrency, agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId, logger = defaultLogger, } = {}) {
         concurrency !== null && concurrency !== void 0 ? concurrency : (concurrency = utils.types.isInteger(legacyConcurrency) ? legacyConcurrency * 5 : 5);
         core !== null && core !== void 0 ? core : (core = (0, core_base_1.makeCore)({ agentId, cwd, logger }));
         const cores = {
             ufg: (0, core_2.makeCore)({ spec, core, concurrency, logger }),
             classic: (0, core_1.makeCore)({ spec, core, logger }),
         };
+        const batch = { id: `generated-${utils.general.guid()}` };
         const storage = [];
         // open eyes with result storage
-        const openEyes = utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, spec, core, cores, logger }), async (openEyes, options) => {
+        const openEyes = utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, spec, core, cores, logger, batch }), async (openEyes, options) => {
             const eyes = await openEyes(options);
             const item = { eyes };
             storage.push(item);
@@ -51,6 +52,12 @@ function makeMakeManager({ spec, core, concurrency: defaultConcurrency = utils.g
                     (_a = item.promise) !== null && _a !== void 0 ? _a : (item.promise = promise);
                     return promise;
                 },
+                checkAndClose(options) {
+                    var _a;
+                    const promise = eyes.checkAndClose(options);
+                    (_a = item.promise) !== null && _a !== void 0 ? _a : (item.promise = promise);
+                    return promise;
+                },
                 abort(options) {
                     var _a;
                     const promise = eyes.abort(options);

package/dist/open-eyes.js

@@ -26,34 +26,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeOpenEyes = void 0;
 const core_1 = require("./classic/core");
 const core_2 = require("./ufg/core");
+const get_typed_eyes_1 = require("./get-typed-eyes");
 const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
 const locate_text_1 = require("./locate-text");
 const extract_text_1 = require("./extract-text");
 const close_1 = require("./close");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ type: defaultType, concurrency, core, cores, spec, logger: defaultLogger, }) {
+function makeOpenEyes({ type: defaultType = 'classic', concurrency, core, cores, spec, logger: defaultLogger, batch, }) {
     return async function openEyes({ type = defaultType, settings, config, target, logger = defaultLogger, }) {
-        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, _z;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        var _x, _y, _z, _0;
         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.serverUrl) !== null && _b !== void 0 ? _b : (settings.serverUrl = (_c = 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'));
-        (_e = settings.batch) !== null && _e !== void 0 ? _e : (settings.batch = {});
-        (_f = (_v = settings.batch).id) !== null && _f !== void 0 ? _f : (_v.id = (_g = utils.general.getEnvValue('BATCH_ID')) !== null && _g !== void 0 ? _g : utils.general.guid());
-        (_h = (_w = settings.batch).name) !== null && _h !== void 0 ? _h : (_w.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_j = (_x = settings.batch).sequenceName) !== null && _j !== void 0 ? _j : (_x.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_k = (_y = settings.batch).notifyOnCompletion) !== null && _k !== void 0 ? _k : (_y.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
-        (_l = settings.keepBatchOpen) !== null && _l !== void 0 ? _l : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
-        (_m = settings.branchName) !== null && _m !== void 0 ? _m : (settings.branchName = utils.general.getEnvValue('BRANCH'));
-        (_o = settings.parentBranchName) !== null && _o !== void 0 ? _o : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
-        (_p = settings.baselineBranchName) !== null && _p !== void 0 ? _p : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
-        (_q = settings.ignoreBaseline) !== null && _q !== void 0 ? _q : (settings.ignoreBaseline = false);
-        (_r = settings.compareWithParentBranch) !== null && _r !== void 0 ? _r : (settings.compareWithParentBranch = false);
+        settings.batch = {
+            ...settings.batch,
+            properties: [...((_e = batch === null || batch === void 0 ? void 0 : batch.properties) !== null && _e !== void 0 ? _e : []), ...((_g = (_f = settings.batch) === null || _f === void 0 ? void 0 : _f.properties) !== null && _g !== void 0 ? _g : [])],
+            ...batch,
+        };
+        (_h = (_x = settings.batch).id) !== null && _h !== void 0 ? _h : (_x.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
+        (_k = (_y = settings.batch).name) !== null && _k !== void 0 ? _k : (_y.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_l = (_z = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_z.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_m = (_0 = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_0.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);
         if (type === 'ufg') {
-            ;
-            (_s = (_z = settings).renderConcurrency) !== null && _s !== void 0 ? _s : (_z.renderConcurrency = (_u = (_t = config === null || config === void 0 ? void 0 : config.check) === null || _t === void 0 ? void 0 : _t.renderers) === null || _u === void 0 ? void 0 : _u.length);
+            const ufgSettings = settings;
+            const ufgConfig = config;
+            (_u = ufgSettings.renderConcurrency) !== null && _u !== void 0 ? _u : (ufgSettings.renderConcurrency = (_w = (_v = ufgConfig === null || ufgConfig === void 0 ? void 0 : ufgConfig.check) === null || _v === void 0 ? void 0 : _v.renderers) === null || _w === void 0 ? void 0 : _w.length);
         }
         core.logEvent({
             settings: {
@@ -71,33 +77,25 @@ function makeOpenEyes({ type: defaultType, concurrency, core, cores, spec, logge
             },
             logger,
         });
-        cores !== null && cores !== void 0 ? cores : (cores = {
-            ufg: (0, core_2.makeCore)({ spec, core, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, logger }),
-            classic: (0, core_1.makeCore)({ spec, core, logger }),
+        const getTypedEyes = (0, get_typed_eyes_1.makeGetTypedEyes)({
+            type,
+            settings: settings,
+            target,
+            cores: cores !== null && cores !== void 0 ? cores : {
+                ufg: (0, core_2.makeCore)({ spec, core, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, logger }),
+                classic: (0, core_1.makeCore)({ spec, core, logger }),
+            },
+            logger,
         });
-        const eyes = type === 'ufg'
-            ? await cores.ufg.openEyes({ target, settings: settings, logger })
-            : await cores.classic.openEyes({ target, settings: settings, logger });
-        async function getTypedEyes({ type = 'classic', renderers, }) {
-            if (eyes.type === type) {
-                return eyes;
-            }
-            else if (type === 'ufg') {
-                const baseEyes = await eyes.getBaseEyes();
-                return cores.ufg.openEyes({ target, eyes: baseEyes, logger });
-            }
-            else {
-                const baseEyes = (await Promise.all(renderers.map(renderer => eyes.getBaseEyes({ settings: { renderer, type: 'native' } })))).flat();
-                return cores.classic.openEyes({ target, eyes: baseEyes, logger });
-            }
-        }
-        return utils.general.extend(eyes, {
-            check: (0, check_1.makeCheck)({ type, getTypedEyes, logger }),
-            checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, getTypedEyes, logger }),
+        const eyes = await getTypedEyes({ logger });
+        return utils.general.extend(eyes, eyes => ({
+            getTypedEyes,
+            check: (0, check_1.makeCheck)({ type, eyes, target, spec, logger }),
+            checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, eyes, target, spec, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ eyes, logger }),
             extractText: (0, extract_text_1.makeExtractText)({ eyes, logger }),
             close: (0, close_1.makeClose)({ eyes, logger }),
-        });
+        }));
     };
 }
 exports.makeOpenEyes = makeOpenEyes;

package/dist/types.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("@applitools/core-base/types"), exports);
+__exportStar(require("./automation/types"), exports);

package/dist/ufg/abort.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeAbort = void 0;
 const abort_error_1 = require("../errors/abort-error");
-function makeAbort({ storage, controller, logger: defaultLogger, }) {
+function makeAbort({ storage, controller, logger: defaultLogger }) {
     return async function ({ logger = defaultLogger, } = {}) {
         controller.abort();
         const tests = storage.reduce((tests, { renderer, promise }) => {