@applitools/core 1.0.0

package/dist/ufg/core.js

@@ -0,0 +1,78 @@
+"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.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 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, }) {
+    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`);
+    const throttle = (0, throat_1.default)(concurrency);
+    core !== null && core !== void 0 ? core : (core = (0, core_base_1.makeCore)({ agentId, cwd, logger }));
+    // open eyes with concurrency
+    core.openEyes = utils.general.wrap(core.openEyes, (openEyes, options) => {
+        return new Promise((resolve, rejects) => {
+            throttle(() => {
+                return new Promise(async (done) => {
+                    try {
+                        const eyes = await openEyes(options);
+                        resolve(utils.general.extend(eyes, {
+                            // release concurrency slot when closed
+                            close: utils.general.wrap(eyes.close, (close, options) => close(options).finally(done)),
+                            // release concurrency slot when aborted
+                            abort: utils.general.wrap(eyes.abort, (abort, options) => abort(options).finally(done)),
+                        }));
+                    }
+                    catch (error) {
+                        rejects(error);
+                        // release concurrency slot when error thrown
+                        done();
+                    }
+                });
+            });
+        });
+    });
+    return utils.general.extend(core, {
+        type: 'ufg',
+        isDriver: spec === null || spec === void 0 ? void 0 : spec.isDriver,
+        isElement: spec === null || spec === void 0 ? void 0 : spec.isElement,
+        isSelector: spec === null || spec === void 0 ? void 0 : spec.isSelector,
+        getViewportSize: (0, get_viewport_size_1.makeGetViewportSize)({ spec, logger }),
+        setViewportSize: (0, set_viewport_size_1.makeSetViewportSize)({ spec, logger }),
+        locate: (0, locate_1.makeLocate)({ spec, core, logger }),
+        openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, client, core, logger }),
+    });
+}
+exports.makeCore = makeCore;

package/dist/ufg/open-eyes.js

@@ -0,0 +1,123 @@
+"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 abort_controller_1 = require("abort-controller");
+const driver_1 = require("@applitools/driver");
+const ufg_client_1 = require("@applitools/ufg-client");
+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 utils = __importStar(require("@applitools/utils"));
+function makeOpenEyes({ spec, core, client, logger: defaultLogger, }) {
+    return async function openEyes({ target, settings, logger = defaultLogger, }) {
+        var _a, _b, _c;
+        logger.log(`Command "openEyes" is called with ${(spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) ? 'default driver and' : ''} settings`, settings);
+        if (spec === null || spec === void 0 ? void 0 : spec.isDriver(target)) {
+            const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+            if ((_a = settings.environment) === null || _a === void 0 ? void 0 : _a.viewportSize) {
+                await driver.setViewportSize(settings.environment.viewportSize);
+            }
+        }
+        const account = await core.getAccountInfo({ settings, logger });
+        const test = {
+            userTestId: settings.userTestId,
+            batchId: (_b = settings.batch) === null || _b === void 0 ? void 0 : _b.id,
+            server: { serverUrl: settings.serverUrl, apiKey: settings.apiKey, proxy: settings.proxy },
+            account,
+        };
+        client !== null && client !== void 0 ? client : (client = (0, ufg_client_1.makeUFGClient)({ config: { ...account.ufg, ...account }, concurrency: (_c = settings.renderConcurrency) !== null && _c !== void 0 ? _c : 5, logger }));
+        const controller = new abort_controller_1.AbortController();
+        // get eyes per environment
+        const getEyes = utils.general.cachify(async ({ rawEnvironment }) => {
+            const eyes = await core.openEyes({ settings: { ...settings, environment: { rawEnvironment } }, logger });
+            const aborted = makeHolderPromise();
+            const queue = [];
+            eyes.check = utils.general.wrap(eyes.check, async (check, options) => {
+                var _a, _b;
+                var _c;
+                const index = options.settings.index;
+                (_a = queue[index]) !== null && _a !== void 0 ? _a : (queue[index] = makeHolderPromise());
+                if (index > 0)
+                    await Promise.race([((_b = queue[_c = index - 1]) !== null && _b !== void 0 ? _b : (queue[_c] = makeHolderPromise())).promise, aborted.promise]);
+                return check(options).finally(queue[index].resolve);
+            });
+            eyes.abort = utils.general.wrap(eyes.abort, async (abort, options) => {
+                aborted.reject(new Error('Command "check" was aborted due to possible error in previous step'));
+                return abort(options);
+            });
+            return eyes;
+        });
+        const storage = [];
+        let index = 0;
+        // check with indexing and storage
+        const check = utils.general.wrap((0, check_1.makeCheck)({ spec, getEyes, client, signal: controller.signal, test, target, logger }), async (check, options) => {
+            ;
+            options.settings.index = index++;
+            const results = await check(options);
+            storage.push(...results.map(result => result.promise));
+            return results;
+        });
+        let closed = false;
+        // close only once
+        const close = utils.general.wrap((0, close_1.makeClose)({ storage, logger }), async (close, options) => {
+            if (closed || aborted)
+                return [];
+            closed = true;
+            return close(options);
+        });
+        let aborted = false;
+        // abort only once
+        const abort = utils.general.wrap((0, abort_1.makeAbort)({ storage, controller, logger }), async (abort, options) => {
+            if (aborted || closed)
+                return [];
+            aborted = true;
+            return abort(options);
+        });
+        return {
+            test,
+            get running() {
+                return !closed && !aborted;
+            },
+            get closed() {
+                return closed;
+            },
+            get aborted() {
+                return aborted;
+            },
+            check,
+            checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ spec, getEyes, client, test, target, logger }),
+            close,
+            abort,
+        };
+    };
+}
+exports.makeOpenEyes = makeOpenEyes;
+function makeHolderPromise() {
+    let resolve, reject;
+    const promise = new Promise((...args) => ([resolve, reject] = args));
+    return { promise, resolve, reject };
+}

package/dist/ufg/utils/generate-safe-selectors.js

@@ -0,0 +1,60 @@
+"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.generateSafeSelectors = void 0;
+const snippets = __importStar(require("@applitools/snippets"));
+const utils = __importStar(require("@applitools/utils"));
+async function generateSafeSelectors({ context, elementReferences, }) {
+    const mapping = {
+        elements: [],
+        ids: [],
+    };
+    for (const elementReference of elementReferences) {
+        const elements = await context.elements(elementReference);
+        mapping.elements.push(elements);
+        mapping.ids.push(Array(elements.length).fill(utils.general.guid()));
+    }
+    const generatedSelectors = await context.execute(snippets.addElementIds, [mapping.elements.flat(), mapping.ids.flat()]);
+    let offset = 0;
+    const selectors = mapping.elements.map(elements => {
+        if (elements.length === 0)
+            return null;
+        const safeSelector = generatedSelectors[offset].reduce((selector, value) => {
+            return selector ? { ...selector, shadow: { type: 'css', selector: value } } : { type: 'css', selector: value };
+        }, null);
+        offset += elements.length;
+        return { safeSelector, originalSelector: elements[0].commonSelector };
+    });
+    return {
+        selectors,
+        cleanupGeneratedSelectors,
+    };
+    async function cleanupGeneratedSelectors() {
+        if (!mapping.elements.length)
+            return;
+        await context.execute(snippets.cleanupElementIds, [mapping.elements.flat()]);
+    }
+}
+exports.generateSafeSelectors = generateSafeSelectors;

package/dist/ufg/utils/take-dom-snapshot.js

@@ -0,0 +1,132 @@
+"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.extractCrossFrames = exports.deserializeDomSnapshot = exports.takeDomSnapshot = void 0;
+const dom_snapshot_1 = require("@applitools/dom-snapshot");
+const execute_poll_script_1 = require("../../utils/execute-poll-script");
+const utils = __importStar(require("@applitools/utils"));
+async function takeDomSnapshot({ context, settings, logger, }) {
+    var _a;
+    const driver = context.driver;
+    const isLegacyBrowser = driver.isIE || driver.isEdgeLegacy;
+    const arg = {
+        dontFetchResources: settings === null || settings === void 0 ? void 0 : settings.disableBrowserFetching,
+        skipResources: settings === null || settings === void 0 ? void 0 : settings.skipResources,
+        removeReverseProxyURLPrefixes: Boolean(process.env.APPLITOOLS_SCRIPT_REMOVE_REVERSE_PROXY_URL_PREFIXES),
+        chunkByteLength: (_a = settings === null || settings === void 0 ? void 0 : settings.chunkByteLength) !== null && _a !== void 0 ? _a : (Number(process.env.APPLITOOLS_SCRIPT_RESULT_MAX_BYTE_LENGTH) || (driver.isIOS ? 100000 : 250 * 1024 * 1024)),
+        serializeResources: true,
+        compressResources: false,
+        showLogs: settings === null || settings === void 0 ? void 0 : settings.showLogs,
+    };
+    const scripts = {
+        main: {
+            script: `return (${isLegacyBrowser ? await (0, dom_snapshot_1.getProcessPagePollForIE)() : await (0, dom_snapshot_1.getProcessPagePoll)()}).apply(null, arguments);`,
+            args: [arg],
+        },
+        poll: {
+            script: `return (${isLegacyBrowser ? await (0, dom_snapshot_1.getPollResultForIE)() : await (0, dom_snapshot_1.getPollResult)()}).apply(null, arguments);`,
+            args: [arg],
+        },
+    };
+    const cookies = driver.features.allCookies ? await driver.getCookies().catch(() => []) : [];
+    const snapshot = await takeContextDomSnapshot({ context });
+    snapshot.cookies = cookies;
+    return deserializeDomSnapshot({ snapshot });
+    async function takeContextDomSnapshot({ context }) {
+        // logger.log(`taking dom snapshot. ${context._reference ? `context referece: ${JSON.stringify(context._reference)}` : ''}`)
+        var _a, _b;
+        if (!driver.features.allCookies) {
+            cookies.push(...(await context.getCookies()));
+        }
+        const snapshot = await (0, execute_poll_script_1.executePollScript)({
+            context,
+            scripts,
+            settings: { executionTimeout: (_a = settings === null || settings === void 0 ? void 0 : settings.executionTimeout) !== null && _a !== void 0 ? _a : 5 * 60 * 1000, pollTimeout: (_b = settings === null || settings === void 0 ? void 0 : settings.pollTimeout) !== null && _b !== void 0 ? _b : 200 },
+            logger,
+        });
+        const crossFrames = extractCrossFrames({ snapshot, logger });
+        for (const { reference, parentSnapshot, cdtNode } of crossFrames) {
+            const frameContext = await context
+                .context(reference)
+                .then(context => context.focus())
+                .catch(err => {
+                logger.log(`could not switch to frame during takeDomSnapshot. Path to frame: ${JSON.stringify(reference)}`, err);
+            });
+            if (frameContext) {
+                const frameSnapshot = await takeContextDomSnapshot({ context: frameContext });
+                let url = new URL(frameSnapshot.url);
+                if (url.protocol === 'data:')
+                    url = new URL(`http://data-url-frame${url.search}`);
+                if (!url.searchParams.has('applitools-iframe'))
+                    url.searchParams.set('applitools-iframe', utils.general.guid());
+                frameSnapshot.url = url.href;
+                parentSnapshot.frames.push(frameSnapshot);
+                cdtNode.attributes.push({ name: 'data-applitools-src', value: frameSnapshot.url });
+            }
+        }
+        logger.log(`dom snapshot cdt length: ${snapshot.cdt.length}`);
+        logger.log(`blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url))); // eslint-disable-line prettier/prettier
+        logger.log(`resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls)); // eslint-disable-line prettier/prettier
+        return snapshot;
+    }
+}
+exports.takeDomSnapshot = takeDomSnapshot;
+function deserializeDomSnapshot({ snapshot }) {
+    const deserializedSnapshot = {
+        ...snapshot,
+        resourceContents: snapshot.blobs.reduce((resourceContents, blob) => {
+            if (blob.value === undefined)
+                return { ...resourceContents, [blob.url]: blob };
+            else
+                return { ...resourceContents, [blob.url]: { ...blob, value: Buffer.from(blob.value, 'base64') } };
+        }, {}),
+        frames: snapshot.frames.map(frameSnapshot => deserializeDomSnapshot({ snapshot: frameSnapshot })),
+    };
+    delete deserializedSnapshot.blobs;
+    delete deserializedSnapshot.selector;
+    delete deserializedSnapshot.crossFrames;
+    return deserializedSnapshot;
+}
+exports.deserializeDomSnapshot = deserializeDomSnapshot;
+function extractCrossFrames({ snapshot, parent = null, logger }) {
+    var _a;
+    const crossFrames = [snapshot, ...((_a = snapshot.frames) !== null && _a !== void 0 ? _a : [])].flatMap((snapshot, index) => {
+        var _a;
+        const crossFrames = ((_a = snapshot.crossFrames) !== null && _a !== void 0 ? _a : []).map(({ selector, index }) => ({
+            reference: { reference: { type: 'css', selector }, parent },
+            parentSnapshot: snapshot,
+            cdtNode: snapshot.cdt[index],
+        }));
+        return [
+            ...crossFrames,
+            ...(index > 0
+                ? extractCrossFrames({ snapshot, parent: { reference: { type: 'css', selector: snapshot.selector }, parent }, logger })
+                : []),
+        ];
+    });
+    logger.log(`frames paths for ${snapshot.crossFrames}`, crossFrames.map(selector => JSON.stringify(selector)).join(' , '));
+    return crossFrames;
+}
+exports.extractCrossFrames = extractCrossFrames;

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

@@ -0,0 +1,141 @@
+"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 __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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.takeDomSnapshots = void 0;
+const take_dom_snapshot_1 = require("./take-dom-snapshot");
+const chalk_1 = __importDefault(require("chalk"));
+const utils = __importStar(require("@applitools/utils"));
+__exportStar(require("./take-dom-snapshot"), exports);
+async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
+    var _a, _b, _c, _d;
+    const currentContext = driver.currentContext;
+    await ((_a = hooks === null || hooks === void 0 ? void 0 : hooks.beforeSnapshots) === null || _a === void 0 ? void 0 : _a.call(hooks));
+    if (!settings.layoutBreakpoints) {
+        logger.log(`taking single dom snapshot`);
+        await ((_b = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _b === void 0 ? void 0 : _b.call(hooks));
+        await utils.general.sleep(settings.waitBeforeCapture);
+        const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
+        return Array(settings.renderers.length).fill(snapshot);
+    }
+    const isStrictBreakpoints = utils.types.isArray(settings.layoutBreakpoints);
+    const requiredWidths = await settings.renderers.reduce(async (prev, renderer, index) => {
+        const { name, width } = await extractRendererInfo({ renderer });
+        const requiredWidths = await prev;
+        const requiredWidth = isStrictBreakpoints
+            ? calculateBreakpoint({ breakpoints: settings.layoutBreakpoints, value: width })
+            : width;
+        let renderers = requiredWidths.get(requiredWidth);
+        if (!renderers)
+            requiredWidths.set(requiredWidth, (renderers = []));
+        renderers.push({ name, width, index });
+        return requiredWidths;
+    }, Promise.resolve(new Map()));
+    const smallestBreakpoint = Math.min(...(isStrictBreakpoints ? settings.layoutBreakpoints : []));
+    if (isStrictBreakpoints && requiredWidths.has(smallestBreakpoint - 1)) {
+        const smallestBrowsers = requiredWidths
+            .get(smallestBreakpoint - 1)
+            .map(({ name, width }) => `(${name}, ${width})`)
+            .join(', ');
+        const message = chalk_1.default.yellow(`The following configuration's viewport-widths are smaller than the smallest configured layout breakpoint (${smallestBreakpoint} pixels): [${smallestBrowsers}]. As a fallback, the resources that will be used for these configurations have been captured on a viewport-width of ${smallestBreakpoint} - 1 pixels. If an additional layout breakpoint is needed for you to achieve better results - please add it to your configuration.`);
+        logger.console.log(message);
+    }
+    logger.log(`taking multiple dom snapshots for breakpoints:`, settings.layoutBreakpoints);
+    logger.log(`required widths: ${[...requiredWidths.keys()].join(', ')}`);
+    const viewportSize = await driver.getViewportSize();
+    const snapshots = Array(settings.renderers.length);
+    if (requiredWidths.has(viewportSize.width)) {
+        logger.log(`taking dom snapshot for existing width ${viewportSize.width}`);
+        await ((_c = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _c === void 0 ? void 0 : _c.call(hooks));
+        await utils.general.sleep(settings.waitBeforeCapture);
+        const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
+        requiredWidths.get(viewportSize.width).forEach(({ index }) => (snapshots[index] = snapshot));
+    }
+    for (const [requiredWidth, browsersInfo] of requiredWidths.entries()) {
+        logger.log(`taking dom snapshot for width ${requiredWidth}`);
+        try {
+            await driver.setViewportSize({ width: requiredWidth, height: viewportSize.height });
+        }
+        catch (err) {
+            logger.error(err);
+            const actualViewportSize = await driver.getViewportSize();
+            if (isStrictBreakpoints) {
+                const failedBrowsers = browsersInfo.map(({ name, width }) => `(${name}, ${width})`).join(', ');
+                const message = chalk_1.default.yellow(`One of the configured layout breakpoints is ${requiredWidth} pixels, while your local browser has a limit of ${actualViewportSize.width}, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for the following configurations: [${failedBrowsers}] have been captured on the browser's limit (${actualViewportSize.width} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`);
+                logger.console.log(message);
+                logger.log(message);
+            }
+            else {
+                const failedBrowsers = browsersInfo.map(({ name }) => `(${name})`).join(', ');
+                const message = chalk_1.default.yellow(`The following configurations [${failedBrowsers}] have a viewport-width of ${requiredWidth} pixels, while your local browser has a limit of ${actualViewportSize.width} pixels, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for these checkpoints have been captured on the browser's limit (${actualViewportSize.width} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`);
+                logger.console.log(message);
+                logger.log(message);
+            }
+        }
+        await ((_d = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _d === void 0 ? void 0 : _d.call(hooks));
+        await utils.general.sleep(settings.waitBeforeCapture);
+        const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
+        browsersInfo.forEach(({ index }) => (snapshots[index] = snapshot));
+    }
+    await driver.setViewportSize(viewportSize);
+    return snapshots;
+    function calculateBreakpoint({ breakpoints, value }) {
+        const nextBreakpointIndex = breakpoints
+            .sort((item1, item2) => (item1 > item2 ? 1 : -1))
+            .findIndex(breakpoint => breakpoint > value);
+        if (nextBreakpointIndex === -1)
+            return breakpoints[breakpoints.length - 1];
+        else if (nextBreakpointIndex === 0)
+            return breakpoints[0] - 1;
+        else
+            return breakpoints[nextBreakpointIndex - 1];
+    }
+    async function extractRendererInfo({ renderer }) {
+        if (utils.types.has(renderer, ['width', 'height'])) {
+            const { name, width, height } = renderer;
+            return { name, width, height };
+        }
+        else {
+            let devices, info;
+            if (utils.types.has(renderer, 'chromeEmulationInfo')) {
+                info = renderer.chromeEmulationInfo;
+                devices = await provides.getChromeEmulationDevices();
+            }
+            else if (utils.types.has(renderer, 'iosDeviceInfo')) {
+                info = renderer.iosDeviceInfo;
+                devices = await provides.getIOSDevices();
+            }
+            const { deviceName, screenOrientation = 'portrait' } = info;
+            const size = devices[deviceName][screenOrientation];
+            return { name: deviceName, screenOrientation, ...size };
+        }
+    }
+}
+exports.takeDomSnapshots = takeDomSnapshots;

package/dist/ufg/utils/take-snapshots.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 __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");
+const extract_broker_url_1 = require("../../utils/extract-broker-url");
+__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 (0, extract_broker_url_1.extractBrokerUrl)(driver);
+        if (brokerUrl) {
+            return (0, nml_client_1.takeSnapshots)({ url: brokerUrl, settings, logger });
+        }
+        else {
+            return (0, take_vhses_1.takeVHSes)({ driver, settings, hooks, logger });
+        }
+    }
+}
+exports.takeSnapshots = takeSnapshots;