@applitools/core 3.8.0 → 3.8.1

package/dist/ufg/check.js

@@ -0,0 +1,277 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeCheck = void 0;
+const driver_1 = require("@applitools/driver");
+const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
+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");
+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, storage, target: defaultTarget, spec, signal, logger: mainLogger, }) {
+    return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        logger = logger.extend(mainLogger);
+        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 { 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 : []);
+        const ufgClient = await eyes.core.getUFGClient({
+            settings: {
+                ...eyes.test.ufgServer,
+                eyesServerUrl: eyes.test.eyesServer.eyesServerUrl,
+                apiKey: eyes.test.eyesServer.apiKey,
+            },
+            logger,
+        });
+        let snapshots;
+        let snapshotUrl;
+        let snapshotTitle;
+        let userAgent;
+        let regionToTarget;
+        let scrollRootSelector;
+        let selectorsToCalculate;
+        const driver = spec && (0, driver_1.isDriver)(target, spec)
+            ? await (0, driver_1.makeDriver)({ spec, driver: target, reset: target === defaultTarget, logger })
+            : null;
+        if (driver) {
+            const environment = await driver.getEnvironment();
+            await driver.currentContext.setScrollingElement((_b = settings.scrollRootElement) !== null && _b !== void 0 ? _b : null);
+            if (uniqueRenderers.length === 0) {
+                if (environment.isWeb) {
+                    const viewportSize = await driver.getViewportSize();
+                    uniqueRenderers.push({ name: 'chrome', ...viewportSize });
+                }
+                else {
+                    // TODO add default nmg renderers
+                }
+            }
+            let cleanupGeneratedSelectors;
+            if (environment.isWeb) {
+                userAgent = await driver.getUserAgentLegacy();
+                const generated = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+                    context: driver.currentContext,
+                    elementReferences: [
+                        ...(elementReferenceToTarget ? [elementReferenceToTarget] : []),
+                        ...(settings.scrollRootElement ? [settings.scrollRootElement] : []),
+                        ...elementReferencesToCalculate,
+                    ],
+                });
+                cleanupGeneratedSelectors = generated.cleanupGeneratedSelectors;
+                selectorsToCalculate = generated.selectors;
+                if (elementReferenceToTarget) {
+                    if (!((_c = selectorsToCalculate[0]) === null || _c === void 0 ? void 0 : _c.safeSelector))
+                        throw new Error('Target element not found');
+                    regionToTarget = selectorsToCalculate[0].safeSelector;
+                    selectorsToCalculate = selectorsToCalculate.slice(1);
+                }
+                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;
+            const snapshotOptions = {
+                settings: {
+                    ...eyes.test.eyesServer,
+                    waitBeforeCapture: settings.waitBeforeCapture,
+                    disableBrowserFetching: settings.disableBrowserFetching,
+                    layoutBreakpoints: settings.layoutBreakpoints,
+                    renderers: uniqueRenderers,
+                    skipResources: ufgClient.getCachedResourceUrls(),
+                },
+                hooks: {
+                    async beforeSnapshots() {
+                        if (settings.lazyLoad && environment.isWeb) {
+                            await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                                context: driver.currentContext,
+                                settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                                logger,
+                            });
+                        }
+                    },
+                },
+                provides: {
+                    getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
+                    getIOSDevices: ufgClient.getIOSDevices,
+                },
+            };
+            if (environment.isWeb) {
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, ...snapshotOptions, logger });
+            }
+            else {
+                const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.eyesServer, driver, logger });
+                snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
+            }
+            await currentContext.focus();
+            snapshotUrl = await driver.getUrl();
+            snapshotTitle = await driver.getTitle();
+            await (cleanupGeneratedSelectors === null || cleanupGeneratedSelectors === void 0 ? void 0 : cleanupGeneratedSelectors());
+        }
+        else {
+            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 = (_j = elementReferenceToTarget) !== null && _j !== void 0 ? _j : settings.region);
+        selectorsToCalculate !== null && selectorsToCalculate !== void 0 ? selectorsToCalculate : (selectorsToCalculate = elementReferencesToCalculate.map(selector => ({
+            originalSelector: selector,
+            safeSelector: selector,
+        })));
+        const promises = uniqueRenderers.map(async ({ properties, ...renderer }, index) => {
+            const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
+            if (utils.types.has(renderer, 'name') && renderer.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);
+            }
+            try {
+                if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                    rendererLogger.warn('Command "check" was aborted before rendering');
+                    throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
+                }
+                const { cookies, ...snapshot } = snapshots[index];
+                if (utils.types.has(renderer, 'iosDeviceInfo') || utils.types.has(renderer, 'androidDeviceInfo')) {
+                    renderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
+                }
+                const renderTargetPromise = ufgClient.createRenderTarget({
+                    snapshot,
+                    settings: {
+                        renderer,
+                        cookies,
+                        headers: {
+                            Referer: snapshotUrl,
+                            'User-Agent': userAgent,
+                            ...settings.headers,
+                        },
+                        proxy: eyes.test.eyesServer.proxy,
+                        autProxy: settings.autProxy,
+                    },
+                    logger: rendererLogger,
+                });
+                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, properties }, logger: rendererLogger });
+                try {
+                    if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                        rendererLogger.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`);
+                    }
+                    const renderTarget = await renderTargetPromise;
+                    if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                        rendererLogger.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`);
+                    }
+                    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),
+                            renderer,
+                            renderEnvironmentId: baseEyes.test.renderEnvironmentId,
+                            uploadUrl: baseEyes.test.uploadUrl,
+                            stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
+                        },
+                        signal,
+                        logger: rendererLogger,
+                    });
+                    let offset = 0;
+                    const baseSettings = getBaseCheckSettings({
+                        calculatedRegions: selectorsToCalculate.map(({ originalSelector, safeSelector }) => ({
+                            selector: originalSelector !== null && originalSelector !== void 0 ? originalSelector : undefined,
+                            regions: safeSelector ? selectorRegions[offset++] : [],
+                        })),
+                    });
+                    baseSettings.renderId = renderId;
+                    baseTarget.source = snapshotUrl;
+                    baseTarget.name = snapshotTitle;
+                    if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                        rendererLogger.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`);
+                    }
+                    await baseEyes.check({
+                        target: { ...baseTarget, isTransformed: true },
+                        settings: baseSettings,
+                        logger: rendererLogger,
+                    });
+                    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`);
+                    }
+                    return { eyes: baseEyes, renderer };
+                }
+                catch (error) {
+                    rendererLogger.error(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" failed due to an error`, error);
+                    if (baseEyes.running && !(signal === null || signal === void 0 ? void 0 : signal.aborted))
+                        await baseEyes.abort({ logger: rendererLogger });
+                    error.info = { eyes: baseEyes };
+                    throw error;
+                }
+            }
+            catch (error) {
+                rendererLogger.error(`Renderer with id ${renderer.id} failed before rendering started due to an error`, error);
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
+                throw error;
+            }
+        });
+        return uniqueRenderers.map((renderer, index) => {
+            var _a;
+            const key = JSON.stringify(renderer);
+            storage.set(key, [...((_a = storage.get(key)) !== null && _a !== void 0 ? _a : []), promises[index]]);
+            return { asExpected: true, userTestId: eyes.test.userTestId, renderer };
+        });
+    };
+}
+exports.makeCheck = makeCheck;

package/dist/ufg/close.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeClose = void 0;
+const driver_1 = require("@applitools/driver");
+function makeClose({ storage, target, spec, logger: mainLogger }) {
+    return async function close({ settings, logger = mainLogger, } = {}) {
+        logger = logger.extend(mainLogger);
+        logger.log('Command "close" is called with settings', settings);
+        settings !== null && settings !== void 0 ? settings : (settings = {});
+        if (!settings.testMetadata) {
+            try {
+                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
+                settings.testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
+            }
+            catch (error) {
+                logger.warn('Command "close" received an error during extracting driver metadata', error);
+            }
+        }
+        storage.forEach(async (promises) => {
+            var _a, _b;
+            try {
+                const [{ eyes }] = await Promise.all(promises);
+                try {
+                    await eyes.close({ settings, logger });
+                }
+                catch (error) {
+                    logger.warn('Command "close" received an error during performing, trying to perform abort instead', error);
+                    await eyes.abort({ settings, logger });
+                }
+            }
+            catch (error) {
+                logger.warn('Command "close" received an error during waiting for eyes instances in background', error);
+                await ((_b = (_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes) === null || _b === void 0 ? void 0 : _b.abort({ settings, logger }));
+            }
+        });
+    };
+}
+exports.makeClose = makeClose;

package/dist/ufg/core.js

@@ -0,0 +1,57 @@
+"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.makeCore = void 0;
+const logger_1 = require("@applitools/logger");
+const core_base_1 = require("@applitools/core-base");
+const get_viewport_size_1 = require("../automation/get-viewport-size");
+const set_viewport_size_1 = require("../automation/set-viewport-size");
+const locate_1 = require("../automation/locate");
+const locate_text_1 = require("../automation/locate-text");
+const extract_text_1 = require("../automation/extract-text");
+const get_nml_client_1 = require("../automation/get-nml-client");
+const get_ufg_client_1 = require("./get-ufg-client");
+const open_eyes_1 = require("./open-eyes");
+const utils = __importStar(require("@applitools/utils"));
+function makeCore({ concurrency, spec, clients, base, fetchConcurrency, agentId = 'core-ufg', cwd = process.cwd(), logger: defaultLogger, }) {
+    const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-ufg' } });
+    logger.log(`Core ufg is initialized ${base ? 'with' : 'without'} custom base core`);
+    base !== null && base !== void 0 ? base : (base = (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger }));
+    return utils.general.extend(base, core => {
+        return {
+            type: 'ufg',
+            base: base,
+            getViewportSize: spec && (0, get_viewport_size_1.makeGetViewportSize)({ spec, logger }),
+            setViewportSize: spec && (0, set_viewport_size_1.makeSetViewportSize)({ spec, logger }),
+            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 }),
+            getUFGClient: (0, get_ufg_client_1.makeGetUFGClient)({ client: clients === null || clients === void 0 ? void 0 : clients.ufg, fetchConcurrency, logger }),
+            getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
+            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, core, logger }),
+        };
+    });
+}
+exports.makeCore = makeCore;

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

@@ -0,0 +1,56 @@
+"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.makeGetBaseEyes = void 0;
+const utils = __importStar(require("@applitools/utils"));
+function makeGetBaseEyes({ settings: defaultSettings, eyes, base, logger: mainLogger, }) {
+    const getBaseEyesWithCache = utils.general.cachify(getBaseEyes, ([options]) => { var _a; return (_a = options === null || options === void 0 ? void 0 : options.settings) === null || _a === void 0 ? void 0 : _a.renderer; });
+    if (base) {
+        base.forEach(baseEyes => getBaseEyesWithCache.setCachedValue(baseEyes.test.renderer, Promise.resolve([baseEyes])));
+    }
+    return getBaseEyesWithCache;
+    async function getBaseEyes({ settings, logger = mainLogger, } = {}) {
+        logger = logger.extend(mainLogger);
+        logger.log(`Command "getBaseEyes" is called with settings`, settings);
+        if (!settings)
+            throw new Error('');
+        const ufgClient = await eyes.core.getUFGClient({
+            settings: {
+                ...eyes.test.ufgServer,
+                eyesServerUrl: eyes.test.eyesServer.eyesServerUrl,
+                apiKey: eyes.test.eyesServer.apiKey,
+            },
+            logger,
+        });
+        const environment = await ufgClient.getRenderEnvironment({ settings, logger });
+        environment.properties = settings.properties;
+        const baseEyes = await eyes.core.base.openEyes({
+            settings: { ...defaultSettings, environment: { ...defaultSettings.environment, ...environment } },
+            logger,
+        });
+        return [baseEyes];
+    }
+}
+exports.makeGetBaseEyes = makeGetBaseEyes;

package/dist/ufg/get-results.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeGetResults = void 0;
+const abort_error_1 = require("../errors/abort-error");
+function makeGetResults({ storage, logger: mainLogger }) {
+    return async function getResults({ settings, logger = mainLogger, } = {}) {
+        logger = logger.extend(mainLogger);
+        logger.log('Command "getResults" is called with settings', settings);
+        return Promise.all(Array.from(storage.values(), async (promises) => {
+            var _a;
+            try {
+                const [{ eyes, renderer }] = await Promise.all(promises);
+                const [result] = await eyes.getResults({ settings, logger });
+                return { ...result, renderer };
+            }
+            catch (error) {
+                if (error instanceof abort_error_1.AbortError && ((_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes)) {
+                    logger.warn('Command "getResults" received an abort error during performing', settings);
+                    const [result] = await error.info.eyes.getResults({ settings, logger });
+                    return { ...result, renderer: error.info.renderer };
+                }
+                logger.fatal('Command "getResults" received an error during performing', settings);
+                throw error;
+            }
+        }));
+    };
+}
+exports.makeGetResults = makeGetResults;

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

@@ -0,0 +1,47 @@
+"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({ client, fetchConcurrency, logger: mainLogger }) {
+    // we are caching by the server config, therefor if the user creates another Runner / manager with the same server config but different
+    // fetchConcurrency, it will not take any affect.
+    const getUFGClientWithCache = utils.general.cachify(getUFGClient, ([options]) => client ? 'default' : [{ ...options.settings, fetchConcurrency: undefined }]);
+    if (client)
+        getUFGClientWithCache.setCachedValue('default', Promise.resolve(client));
+    return getUFGClientWithCache;
+    async function getUFGClient({ settings, logger = mainLogger }) {
+        logger = logger.extend(mainLogger);
+        const tunnelIds = utils.general.getEnvValue('FETCH_RESOURCE_FROM_TUNNEL', 'boolean')
+            ? utils.general.getEnvValue('TUNNEL_IDS')
+            : undefined;
+        return (0, ufg_client_1.makeUFGClient)({
+            settings: { ...settings, fetchConcurrency, tunnelIds },
+            logger,
+        });
+    }
+}
+exports.makeGetUFGClient = makeGetUFGClient;

package/dist/ufg/open-eyes.js

@@ -0,0 +1,97 @@
+"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.makeOpenEyes = void 0;
+const driver_1 = require("@applitools/driver");
+const get_base_eyes_1 = require("./get-base-eyes");
+const check_1 = require("./check");
+const check_and_close_1 = require("./check-and-close");
+const close_1 = require("./close");
+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, spec, logger: mainLogger }) {
+    return async function openEyes({ target, settings, base, logger = mainLogger, }) {
+        var _a, _b;
+        logger = logger.extend(mainLogger);
+        logger.log(`Command "openEyes" is called with ${target ? 'default driver and' : ''}`, ...(settings ? ['settings', settings] : []), base ? 'predefined eyes' : '');
+        const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger }));
+        if (driver && !base) {
+            const environment = await (driver === null || driver === void 0 ? void 0 : driver.getEnvironment());
+            const currentContext = driver.currentContext;
+            (_a = settings.environment) !== null && _a !== void 0 ? _a : (settings.environment = {});
+            if (environment.isEC) {
+                settings.environment.ecSessionId = (_b = (await driver.getSessionId())) !== null && _b !== void 0 ? _b : undefined;
+            }
+            if (settings.environment.viewportSize) {
+                await driver.setViewportSize(settings.environment.viewportSize);
+            }
+            await currentContext.focus();
+        }
+        const controller = new abort_controller_1.AbortController();
+        const account = await core.getAccountInfo({ settings, logger });
+        return utils.general.extend({}, eyes => {
+            var _a;
+            const storage = new Map();
+            let running = true;
+            return {
+                type: 'ufg',
+                core,
+                test: {
+                    userTestId: settings.userTestId,
+                    batchId: (_a = settings.batch) === null || _a === void 0 ? void 0 : _a.id,
+                    keepBatchOpen: settings.keepBatchOpen,
+                    eyesServer: account.eyesServer,
+                    ufgServer: account.ufgServer,
+                    uploadUrl: account.uploadUrl,
+                    stitchingServiceUrl: account.stitchingServiceUrl,
+                    account,
+                },
+                get running() {
+                    return running;
+                },
+                getBaseEyes: (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, base, logger }),
+                // check with indexing and storage
+                check: (0, check_1.makeCheck)({ eyes, storage, target: driver, spec, signal: controller.signal, logger }),
+                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, storage, target: driver, spec, signal: controller.signal, logger }),
+                close: utils.general.wrap((0, close_1.makeClose)({ storage, target: driver, logger }), async (close, options) => {
+                    if (!running)
+                        return;
+                    running = false;
+                    return close(options);
+                }),
+                abort: utils.general.wrap((0, abort_1.makeAbort)({ storage, target: driver, spec, controller, logger }), async (abort, options) => {
+                    if (!running)
+                        return;
+                    running = false;
+                    return abort(options);
+                }),
+                getResults: (0, get_results_1.makeGetResults)({ storage, logger }),
+            };
+        });
+    };
+}
+exports.makeOpenEyes = makeOpenEyes;

package/dist/ufg/types.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("../automation/types"), exports);