@applitools/core 1.3.0 → 1.3.1

package/dist/check.js

@@ -31,6 +31,7 @@ const driver_1 = require("@applitools/driver");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
 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;
@@ -53,6 +54,7 @@ function makeCheck({ type: defaultType, eyes, target: defaultTarget, spec, logge
             (_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);
         }
+        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.`));

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/make-manager.js

@@ -38,9 +38,10 @@ function makeMakeManager({ spec, core, concurrency: defaultConcurrency = utils.g
             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

@@ -33,29 +33,33 @@ 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 = 'classic', 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;
+        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') {
             const ufgSettings = settings;
             const ufgConfig = config;
-            (_s = ufgSettings.renderConcurrency) !== null && _s !== void 0 ? _s : (ufgSettings.renderConcurrency = (_u = (_t = ufgConfig === null || ufgConfig === void 0 ? void 0 : ufgConfig.check) === null || _t === void 0 ? void 0 : _t.renderers) === null || _u === void 0 ? void 0 : _u.length);
+            (_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: {

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

@@ -1,7 +1,225 @@
 "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.makeCheckAndClose = void 0;
-function makeCheckAndClose(_options) {
-    return null;
+const driver_1 = require("@applitools/driver");
+const take_snapshots_1 = require("./utils/take-snapshots");
+const wait_for_lazy_load_1 = require("../utils/wait-for-lazy-load");
+const to_base_check_settings_1 = require("../utils/to-base-check-settings");
+const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
+const abort_error_1 = require("../errors/abort-error");
+const utils = __importStar(require("@applitools/utils"));
+const chalk_1 = __importDefault(require("chalk"));
+function makeCheckAndClose({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }) {
+    return async function checkAndClose({ target = defaultTarget, settings = {}, logger = defaultLogger, snapshots, }) {
+        var _a, _b;
+        logger.log('Command "checkAndClose" is called with settings', settings);
+        if (signal.aborted) {
+            logger.warn('Command "checkAndClose" was called after test was already aborted');
+            throw new abort_error_1.AbortError('Command "checkAndClose" was called after test was already aborted');
+        }
+        const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+        let snapshotUrl, snapshotTitle, userAgent, regionToTarget, selectorsToCalculate;
+        if ((0, driver_1.isDriver)(target, spec)) {
+            // TODO driver custom config
+            const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+            if (driver.isWeb && (!settings.renderers || settings.renderers.length === 0)) {
+                const viewportSize = await driver.getViewportSize();
+                settings.renderers = [{ name: 'chrome', ...viewportSize }];
+            }
+            let cleanupGeneratedSelectors;
+            if (driver.isWeb) {
+                userAgent = driver.userAgent;
+                const generated = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+                    context: driver.currentContext,
+                    elementReferences: [...(elementReferenceToTarget ? [elementReferenceToTarget] : []), ...elementReferencesToCalculate],
+                });
+                cleanupGeneratedSelectors = generated.cleanupGeneratedSelectors;
+                if (elementReferenceToTarget) {
+                    regionToTarget = (_a = generated.selectors[0]) === null || _a === void 0 ? void 0 : _a.safeSelector;
+                    if (!regionToTarget)
+                        throw new Error('Target element not found');
+                    selectorsToCalculate = generated.selectors.slice(1);
+                }
+                else {
+                    selectorsToCalculate = generated.selectors;
+                }
+            }
+            const currentContext = driver.currentContext;
+            if (!snapshots) {
+                snapshots = await (0, take_snapshots_1.takeSnapshots)({
+                    driver,
+                    settings: {
+                        ...eyes.test.server,
+                        waitBeforeCapture: settings.waitBeforeCapture,
+                        disableBrowserFetching: settings.disableBrowserFetching,
+                        layoutBreakpoints: settings.layoutBreakpoints,
+                        renderers: settings.renderers,
+                        skipResources: client.getCachedResourceUrls(),
+                    },
+                    hooks: {
+                        async beforeSnapshots() {
+                            if (driver.isWeb && settings.lazyLoad) {
+                                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                                    context: driver.currentContext,
+                                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                                    logger,
+                                });
+                            }
+                        },
+                    },
+                    provides: {
+                        getChromeEmulationDevices: client.getChromeEmulationDevices,
+                        getIOSDevices: client.getIOSDevices,
+                    },
+                    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(settings.renderers.length).fill(target) : target;
+            snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
+        }
+        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_b = elementReferenceToTarget) !== null && _b !== void 0 ? _b : settings.region);
+        selectorsToCalculate !== null && selectorsToCalculate !== void 0 ? selectorsToCalculate : (selectorsToCalculate = elementReferencesToCalculate.map(selector => ({
+            originalSelector: selector,
+            safeSelector: selector,
+        })));
+        const promises = settings.renderers.map(async (renderer, index) => {
+            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.`);
+                logger.console.log(message);
+            }
+            try {
+                if (signal.aborted) {
+                    logger.warn('Command "check" was aborted before rendering');
+                    throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
+                }
+                const { cookies, ...snapshot } = snapshots[index];
+                const snapshotType = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
+                const renderTargetPromise = client.createRenderTarget({
+                    snapshot,
+                    settings: {
+                        renderer,
+                        referer: snapshotUrl,
+                        cookies,
+                        proxy: eyes.test.server.proxy,
+                        autProxy: settings.autProxy,
+                        userAgent,
+                    },
+                });
+                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, type: snapshotType }, logger });
+                try {
+                    if (signal.aborted) {
+                        logger.warn('Command "check" was aborted before rendering');
+                        throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
+                    }
+                    else if (baseEyes.aborted) {
+                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                    }
+                    const renderTarget = await renderTargetPromise;
+                    if (signal.aborted) {
+                        logger.warn('Command "check" was aborted before rendering');
+                        throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
+                    }
+                    else if (baseEyes.aborted) {
+                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                    }
+                    const { renderId, selectorRegions, ...baseTarget } = await client.render({
+                        target: renderTarget,
+                        settings: {
+                            ...settings,
+                            rendererId: baseEyes.test.rendererId,
+                            region: regionToTarget,
+                            type: utils.types.has(snapshot, 'cdt') ? 'web' : 'native',
+                            renderer,
+                            selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
+                            includeFullPageSize: Boolean(settings.pageId),
+                        },
+                        signal,
+                    });
+                    let offset = 0;
+                    const baseSettings = getBaseCheckSettings({
+                        calculatedRegions: selectorsToCalculate.map(({ originalSelector, safeSelector }) => ({
+                            selector: originalSelector,
+                            regions: safeSelector ? selectorRegions[offset++] : [],
+                        })),
+                    });
+                    baseSettings.renderId = renderId;
+                    baseTarget.source = snapshotUrl;
+                    baseTarget.name = snapshotTitle;
+                    if (signal.aborted) {
+                        logger.warn('Command "check" was aborted after rendering');
+                        throw new abort_error_1.AbortError('Command "check" was aborted after rendering');
+                    }
+                    else if (baseEyes.aborted) {
+                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                    }
+                    const [result] = await baseEyes.checkAndClose({
+                        target: { ...baseTarget, isTransformed: true },
+                        settings: baseSettings,
+                        logger,
+                    });
+                    if (baseEyes.aborted) {
+                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                    }
+                    return { ...result, eyes, renderer };
+                }
+                catch (error) {
+                    await baseEyes.abort();
+                    error.info = { eyes: baseEyes };
+                    throw error;
+                }
+            }
+            catch (error) {
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
+                throw error;
+            }
+        });
+        return Promise.all(promises.map(async (promise) => {
+            var _a, _b;
+            try {
+                const result = await promise;
+                return { ...result, userTestId: eyes.test.userTestId, asExpected: true };
+            }
+            catch (error) {
+                await ((_b = (_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes) === null || _b === void 0 ? void 0 : _b.abort({ logger }));
+                throw error;
+            }
+        }));
+    };
 }
 exports.makeCheckAndClose = makeCheckAndClose;

package/dist/ufg/core.js

@@ -53,6 +53,8 @@ function makeCore({ concurrency, spec, client, core, agentId = 'core-ufg', cwd =
                             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)),
+                            // release concurrency slot when checkAndClose is done
+                            checkAndClose: utils.general.wrap(eyes.checkAndClose, (checkAndClose, options) => checkAndClose(options).finally(done)),
                         }));
                     }
                     catch (error) {

package/dist/ufg/open-eyes.js

@@ -56,7 +56,6 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger, }) {
         return utils.general.extend({}, eyes => {
             var _a;
             const storage = [];
-            let stepIndex = 0;
             let closed = false;
             let aborted = false;
             return {
@@ -80,7 +79,7 @@ function makeOpenEyes({ core, client, spec, logger: defaultLogger, }) {
                 getBaseEyes,
                 // check with indexing and storage
                 check: utils.general.wrap((0, check_1.makeCheck)({ eyes, client, target: driver, spec, signal: controller.signal, logger }), async (check, options = {}) => {
-                    const results = await check({ ...options, settings: { ...options.settings, stepIndex: stepIndex++ } });
+                    const results = await check(options);
                     storage.push(...results.map(result => ({ promise: result.promise, renderer: result.renderer })));
                     return results;
                 }),

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

@@ -37,11 +37,19 @@ __exportStar(require("./take-dom-snapshot"), exports);
 async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
     var _a, _b, _c, _d;
     const currentContext = driver.currentContext;
+    const waitBeforeCapture = async () => {
+        if (typeof settings.waitBeforeCapture === 'function') {
+            await settings.waitBeforeCapture();
+        }
+        else {
+            await utils.general.sleep(settings.waitBeforeCapture);
+        }
+    };
     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);
+        await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         return Array(settings.renderers.length).fill(snapshot);
     }
@@ -74,7 +82,7 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
     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);
+        await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         requiredWidths.get(viewportSize.width).forEach(({ index }) => (snapshots[index] = snapshot));
     }
@@ -100,7 +108,7 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
             }
         }
         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);
+        await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         browsersInfo.forEach(({ index }) => (snapshots[index] = snapshot));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -61,14 +61,14 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.17",
+    "@applitools/core-base": "1.1.18",
     "@applitools/dom-capture": "11.2.0",
     "@applitools/dom-snapshot": "4.7.2",
     "@applitools/driver": "1.11.14",
     "@applitools/logger": "1.1.32",
-    "@applitools/nml-client": "1.3.14",
+    "@applitools/nml-client": "1.3.15",
     "@applitools/req": "1.1.19",
-    "@applitools/screenshoter": "3.7.13",
+    "@applitools/screenshoter": "3.7.14",
     "@applitools/snippets": "2.4.10",
     "@applitools/ufg-client": "1.1.8",
     "@applitools/utils": "1.3.18",

package/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from './types';
 export { type Selector } from '@applitools/driver';
 export * from './core';
+export { takeDomSnapshots } from './ufg/utils/take-dom-snapshots';
 export * as formatters from './utils/format-results';
 export * from '@applitools/driver/dist/debug';

package/types/open-eyes.d.ts

@@ -1,5 +1,5 @@
 import type { TypedCore, Eyes, Config, OpenSettings } from './types';
-import type { Core as BaseCore } from '@applitools/core-base';
+import type { Core as BaseCore, Batch } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type SpecDriver } from '@applitools/driver';
 type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
@@ -11,8 +11,9 @@ type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | '
     };
     spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
     logger?: Logger;
+    batch?: Batch;
 };
-export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, core, cores, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
+export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, core, cores, spec, logger: defaultLogger, batch, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
     type?: TType;
     settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>>;
     config?: Config<TElement, TSelector, TDefaultType> & Config<TElement, TSelector, TType>;

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

@@ -1,8 +1,9 @@
-import type { DriverTarget, Eyes } from './types';
+import type { DriverTarget, UFGTarget, Eyes, CheckSettings, TestResult, CloseSettings } from './types';
+import { type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
 import { type AbortSignal } from 'abort-controller';
 import { type Logger } from '@applitools/logger';
-import { type SpecDriver } from '@applitools/driver';
 import { type UFGClient } from '@applitools/ufg-client';
+import { type SpecDriver } from '@applitools/driver';
 type Options<TDriver, TContext, TElement, TSelector> = {
     eyes: Eyes<TDriver, TContext, TElement, TSelector>;
     client: UFGClient;
@@ -11,5 +12,10 @@ type Options<TDriver, TContext, TElement, TSelector> = {
     signal?: AbortSignal;
     logger?: Logger;
 };
-export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>(_options: Options<TDriver, TContext, TElement, TSelector>): any;
+export declare function makeCheckAndClose<TDriver, TContext, TElement, TSelector>({ spec, eyes, client, signal, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): ({ target, settings, logger, snapshots, }: {
+    target?: UFGTarget<TDriver, TContext, TElement, TSelector>;
+    settings?: CheckSettings<TElement, TSelector> & CloseSettings;
+    logger?: Logger;
+    snapshots?: DomSnapshot[] | AndroidSnapshot[] | IOSSnapshot[];
+}) => Promise<TestResult[]>;
 export {};

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

@@ -6,7 +6,7 @@ import { type DomSnapshotSettings } from './take-dom-snapshot';
 export * from './take-dom-snapshot';
 export type DomSnapshotsSettings = DomSnapshotSettings & {
     renderers: Renderer[];
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => void);
     layoutBreakpoints?: number[] | boolean;
 };
 export declare function takeDomSnapshots<TDriver extends Driver<unknown, unknown, unknown, unknown>>({ driver, settings, hooks, provides, logger, }: {