@applitools/core 1.0.9 → 1.1.1

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

@@ -47,6 +47,7 @@ function makeCheckAndClose({ spec, eyes, target: defaultTarget, logger: defaultL
             image: await screenshot.image.toPng(),
             locationInViewport: utils.geometry.location(screenshot.region),
         };
+        const baseSettings = await (0, transform_check_settings_1.transformCheckSettings)({ context: driver.currentContext, screenshot, settings, logger });
         if (driver.isWeb && settings.sendDom) {
             if (settings.fully)
                 await screenshot.scrollingElement.setAttribute('data-applitools-scroll', 'true');
@@ -58,7 +59,6 @@ function makeCheckAndClose({ spec, eyes, target: defaultTarget, logger: defaultL
             baseTarget.locationInView = utils.geometry.offset(scrollingOffset, screenshot.region);
             baseTarget.fullViewSize = scrollingElement ? await scrollingElement.getContentSize() : await driver.getViewportSize();
         }
-        const baseSettings = await (0, transform_check_settings_1.transformCheckSettings)({ driver, screenshot, settings, logger });
         await screenshot.restoreState();
         const results = await eyes.checkAndClose({ target: baseTarget, settings: baseSettings, logger });
         return results;

package/dist/classic/check.js

@@ -55,6 +55,7 @@ function makeCheck({ spec, eyes, target: defaultTarget, logger: defaultLogger, }
                 image: await screenshot.image.toPng(),
                 locationInViewport: utils.geometry.location(screenshot.region),
             };
+            baseSettings = await (0, transform_check_settings_1.transformCheckSettings)({ context: driver.currentContext, screenshot, settings, logger });
             if (driver.isWeb && settings.sendDom) {
                 if (settings.fully)
                     await screenshot.scrollingElement.setAttribute('data-applitools-scroll', 'true');
@@ -66,7 +67,6 @@ function makeCheck({ spec, eyes, target: defaultTarget, logger: defaultLogger, }
                 baseTarget.locationInView = utils.geometry.offset(scrollingOffset, screenshot.region);
                 baseTarget.fullViewSize = scrollingElement ? await scrollingElement.getContentSize() : await driver.getViewportSize();
             }
-            baseSettings = await (0, transform_check_settings_1.transformCheckSettings)({ driver, screenshot, settings, logger });
             await screenshot.restoreState();
             results = await eyes.check({ target: baseTarget, settings: { ...baseSettings, ignoreMismatch: !shouldRunOnce }, logger });
         } while (!shouldRunOnce && !results.some(result => result.asExpected) && Date.now() < finishAt);

package/dist/classic/locate.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeLocate = void 0;
+const driver_1 = require("@applitools/driver");
+const take_screenshot_1 = require("./utils/take-screenshot");
+function makeLocate({ spec, eyes, target: defaultTarget, logger: defaultLogger, }) {
+    return async function locate({ target = defaultTarget, settings, logger = defaultLogger, } = {}) {
+        logger.log('Command "check" is called with settings', settings);
+        if (!spec.isDriver(target)) {
+            return eyes.locate({ target, settings: settings, logger });
+        }
+        // TODO driver custom config
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+        const screenshot = await (0, take_screenshot_1.takeScreenshot)({ driver, settings, logger });
+        const baseTarget = {
+            image: await screenshot.image.toPng(),
+        };
+        const results = await eyes.locate({ target: baseTarget, settings: settings, logger });
+        return results;
+    };
+}
+exports.makeLocate = makeLocate;

package/dist/classic/utils/take-screenshot.js

@@ -0,0 +1,54 @@
+"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.takeScreenshot = void 0;
+const screenshoter_1 = require("@applitools/screenshoter");
+const utils = __importStar(require("@applitools/utils"));
+async function takeScreenshot({ driver, settings, logger, }) {
+    return (0, screenshoter_1.takeScreenshot)({
+        driver,
+        frames: settings.frames?.map(frame => {
+            return utils.types.has(frame, 'frame')
+                ? { reference: frame.frame, scrollingElement: frame.scrollRootElement }
+                : { reference: frame };
+        }),
+        region: settings.region,
+        fully: settings.fully,
+        hideScrollbars: settings.hideScrollbars,
+        hideCaret: settings.hideCaret,
+        scrollingMode: settings.stitchMode?.toLowerCase(),
+        overlap: settings.overlap,
+        wait: settings.waitBeforeCapture,
+        framed: driver.isNative,
+        stabilization: settings.normalization && {
+            crop: settings.normalization.cut,
+            scale: settings.normalization.scaleRatio,
+            rotation: settings.normalization.rotation,
+        },
+        debug: settings.debugImages,
+        logger,
+    });
+}
+exports.takeScreenshot = takeScreenshot;

package/dist/classic/utils/transform-check-settings.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformCheckSettings = void 0;
 const utils = __importStar(require("@applitools/utils"));
-async function transformCheckSettings({ driver, settings, screenshot, logger: _logger, }) {
+async function transformCheckSettings({ context, settings, screenshot, logger: _logger, }) {
     return {
         ...settings,
         region: undefined,
@@ -46,14 +46,14 @@ async function transformCheckSettings({ driver, settings, screenshot, logger: _l
                 transformedRegions.push(region);
             }
             else {
-                const elements = await driver.currentContext.elements(reference);
+                const elements = await context.elements(reference);
                 if (elements.length === 0)
                     continue;
                 const contextLocationInViewport = await elements[0].context.getLocationInViewport();
                 for (const element of elements) {
                     const elementRegionInViewport = utils.geometry.offset(await element.getRegion(), contextLocationInViewport);
                     const elementRegionInTarget = utils.geometry.offsetNegative(elementRegionInViewport, utils.geometry.location(screenshot.region));
-                    const elementRegionIScaled = utils.geometry.scale(elementRegionInTarget, driver.viewportScale);
+                    const elementRegionIScaled = utils.geometry.scale(elementRegionInTarget, context.driver.viewportScale);
                     transformedRegions.push({
                         region: elementRegionIScaled,
                         regionId: utils.types.isString(element.commonSelector) ? element.commonSelector : (_a = element.commonSelector) === null || _a === void 0 ? void 0 : _a.selector,

package/dist/ufg/abort.js

@@ -5,7 +5,11 @@ const abort_error_1 = require("../errors/abort-error");
 function makeAbort({ storage, controller, logger: defaultLogger }) {
     return async function ({ logger = defaultLogger, } = {}) {
         controller.abort();
-        return Promise.all(storage.map(async (promise) => {
+        const tests = storage.reduce((tests, { renderer, promise }) => {
+            const key = JSON.stringify(renderer);
+            return tests.set(key, promise);
+        }, new Map());
+        return Promise.all(Array.from(tests.values(), async (promise) => {
             let eyes, renderer;
             try {
                 const value = await promise;

package/dist/ufg/close.js

@@ -3,29 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeClose = void 0;
 function makeClose({ storage, logger: defaultLogger }) {
     return async function ({ settings, logger = defaultLogger, } = {}) {
-        const results = await Promise.allSettled(storage);
-        let error;
-        const eyes = results.reduce((eyes, result) => {
-            let value;
-            if (result.status === 'fulfilled') {
-                value = result.value;
-            }
-            else {
-                value = result.reason.info;
-                error !== null && error !== void 0 ? error : (error = result.reason);
-            }
-            return eyes.set(value.eyes, value.renderer);
+        const tests = storage.reduce((tests, { renderer, promise }) => {
+            var _a;
+            const key = JSON.stringify(renderer);
+            const promises = (_a = tests.get(key)) !== null && _a !== void 0 ? _a : [];
+            promises.push(promise);
+            return tests.set(key, promises);
         }, new Map());
-        if (error) {
-            await Promise.all(Array.from(eyes.entries(), async ([eyes]) => eyes === null || eyes === void 0 ? void 0 : eyes.abort({ logger })));
-            throw error;
-        }
-        else {
-            return Promise.all(Array.from(eyes.entries(), async ([eyes, renderer]) => {
+        return Promise.all(Array.from(tests.values(), async (promises) => {
+            var _a;
+            try {
+                const [{ eyes, renderer }] = await Promise.all(promises);
                 const [result] = await eyes.close({ settings, logger });
                 return { ...result, renderer };
-            }));
-        }
+            }
+            catch (error) {
+                await ((_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes.abort({ logger }));
+                throw error;
+            }
+        }));
     };
 }
 exports.makeClose = makeClose;

package/dist/ufg/open-eyes.js

@@ -62,7 +62,7 @@ function makeOpenEyes({ spec, core, client, logger: defaultLogger, }) {
                 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]);
+                    await Promise.race([((_b = queue[_c = index - 1]) !== null && _b !== void 0 ? _b : (queue[_c] = makeHolderPromise())), aborted]);
                 return check(options).finally(queue[index].resolve);
             });
             eyes.abort = utils.general.wrap(eyes.abort, async (abort, options) => {
@@ -78,7 +78,7 @@ function makeOpenEyes({ spec, core, client, logger: defaultLogger, }) {
             ;
             options.settings.index = index++;
             const results = await check(options);
-            storage.push(...results.map(result => result.promise));
+            storage.push(...results.map(result => ({ promise: result.promise, renderer: result.renderer })));
             return results;
         });
         let closed = false;
@@ -117,7 +117,32 @@ function makeOpenEyes({ spec, core, client, logger: defaultLogger, }) {
 }
 exports.makeOpenEyes = makeOpenEyes;
 function makeHolderPromise() {
-    let resolve, reject;
-    const promise = new Promise((...args) => ([resolve, reject] = args));
-    return { promise, resolve, reject };
+    let promise;
+    let resolve;
+    let reject;
+    let result;
+    return {
+        then(onFulfilled, onRejected) {
+            if (!promise) {
+                promise = new Promise((...args) => ([resolve, reject] = args));
+                if ((result === null || result === void 0 ? void 0 : result.status) === 'fulfilled')
+                    resolve();
+                else if ((result === null || result === void 0 ? void 0 : result.status) === 'rejected')
+                    reject(result.reason);
+            }
+            return promise.then(onFulfilled, onRejected);
+        },
+        resolve() {
+            if (resolve)
+                resolve();
+            else
+                result !== null && result !== void 0 ? result : (result = { status: 'fulfilled' });
+        },
+        reject(reason) {
+            if (reject)
+                reject(reason);
+            else
+                result !== null && result !== void 0 ? result : (result = { status: 'rejected', reason });
+        },
+    };
 }

package/dist/ufg/utils/generate-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.generateSelectors = void 0;
+const snippets = __importStar(require("@applitools/snippets"));
+const utils = __importStar(require("@applitools/utils"));
+async function generateSelectors({ 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 generatedSelector = generatedSelectors[offset].reduce((selector, value) => {
+            return selector ? { ...selector, shadow: { type: 'css', selector: value } } : { type: 'css', selector: value };
+        }, null);
+        offset += elements.length;
+        return { generatedSelector, originalSelector: elements[0].commonSelector };
+    });
+    return {
+        selectors,
+        cleanupGeneratedSelectors,
+    };
+    async function cleanupGeneratedSelectors() {
+        if (!mapping.elements.length)
+            return;
+        await context.execute(snippets.cleanupElementIds, [mapping.elements]);
+    }
+}
+exports.generateSelectors = generateSelectors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "1.0.9",
+  "version": "1.1.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -57,17 +57,17 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.0.5",
+    "@applitools/core-base": "1.0.7",
     "@applitools/dom-capture": "11.1.2",
-    "@applitools/dom-snapshot": "4.6.2",
-    "@applitools/driver": "1.9.34",
-    "@applitools/logger": "1.1.23",
-    "@applitools/nml-client": "1.2.4",
-    "@applitools/req": "1.1.7",
-    "@applitools/screenshoter": "3.5.5",
+    "@applitools/dom-snapshot": "4.6.3",
+    "@applitools/driver": "1.10.4",
+    "@applitools/logger": "1.1.25",
+    "@applitools/nml-client": "1.3.1",
+    "@applitools/req": "1.1.9",
+    "@applitools/screenshoter": "3.6.2",
     "@applitools/snippets": "2.4.5",
-    "@applitools/types": "1.5.16",
-    "@applitools/ufg-client": "1.0.5",
+    "@applitools/types": "1.5.18",
+    "@applitools/ufg-client": "1.0.7",
     "@applitools/utils": "1.3.12",
     "abort-controller": "3.0.0",
     "throat": "6.0.1"
@@ -75,8 +75,9 @@
   "devDependencies": {
     "@applitools/bongo": "^2.2.0",
     "@applitools/sdk-fake-eyes-server": "^2.1.3",
-    "@applitools/spec-driver-puppeteer": "^1.1.12",
-    "@applitools/spec-driver-selenium": "^1.3.24",
+    "@applitools/spec-driver-puppeteer": "^1.1.14",
+    "@applitools/spec-driver-selenium": "^1.4.1",
+    "@applitools/spec-driver-webdriverio": "^1.3.1",
     "@applitools/test-server": "^1.1.5",
     "@applitools/test-utils": "^1.5.1",
     "@types/mocha": "^9.1.1",
@@ -84,6 +85,7 @@
     "@types/selenium-webdriver": "^4.1.2",
     "@typescript-eslint/eslint-plugin": "^5.38.0",
     "@typescript-eslint/parser": "^5.38.0",
+    "chromedriver": "^106.0.0",
     "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-no-only-tests": "^3.0.0",
@@ -97,7 +99,8 @@
     "puppeteer": "^16.2.0",
     "selenium-webdriver": "^4.4.0",
     "ts-node": "^10.7.0",
-    "typescript": "^4.8.3"
+    "typescript": "^4.8.3",
+    "webdriverio": "^7.25.0"
   },
   "engines": {
     "node": ">=12.13.0"

package/types/classic/locate.d.ts

@@ -0,0 +1,16 @@
+import type { SpecDriver, Region } from '@applitools/types';
+import type { Eyes as BaseEyes } from '@applitools/types/base';
+import type { Target, LocateSettings } from '@applitools/types/classic';
+import { type Logger } from '@applitools/logger';
+declare type Options<TDriver, TContext, TElement, TSelector> = {
+    spec: SpecDriver<TDriver, TContext, TElement, TSelector>;
+    eyes: BaseEyes;
+    target: Target<TDriver>;
+    logger: Logger;
+};
+export declare function makeLocate<TDriver, TContext, TElement, TSelector>({ spec, eyes, target: defaultTarget, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TLocator extends string>({ target, settings, logger, }?: {
+    target?: Target<TDriver>;
+    settings?: LocateSettings<TLocator, TElement, TSelector>;
+    logger?: Logger;
+}) => Promise<Record<TLocator, Region[]>>;
+export {};

package/types/classic/utils/take-screenshot.d.ts

@@ -0,0 +1,15 @@
+import type { Region } from '@applitools/types';
+import { ScreenshotSettings } from '@applitools/types/classic';
+import { type Logger } from '@applitools/logger';
+import { type Driver, type Element } from '@applitools/driver';
+export declare type Screenshot = {
+    image: any;
+    region: Region;
+    scrollingElement: Element<unknown, unknown, unknown, unknown>;
+    restoreState(): Promise<void>;
+};
+export declare function takeScreenshot<TDriver, TContext, TElement, TSelector>({ driver, settings, logger, }: {
+    driver: Driver<TDriver, TContext, TElement, TSelector>;
+    settings: ScreenshotSettings<TElement, TSelector>;
+    logger: Logger;
+}): Promise<Screenshot>;

package/types/classic/utils/transform-check-settings.d.ts

@@ -1,10 +1,10 @@
 import type { CheckSettings as BaseCheckSettings } from '@applitools/types/base';
 import type { CheckSettings } from '@applitools/types/classic';
 import { type Logger } from '@applitools/logger';
-import { type Driver } from '@applitools/driver';
+import { type Context } from '@applitools/driver';
 import { type Screenshot } from '../../automation/utils/take-screenshot';
-export declare function transformCheckSettings<TDriver, TContext, TElement, TSelector>({ driver, settings, screenshot, logger, }: {
-    driver: Driver<TDriver, TContext, TElement, TSelector>;
+export declare function transformCheckSettings<TDriver, TContext, TElement, TSelector>({ context, settings, screenshot, logger, }: {
+    context: Context<TDriver, TContext, TElement, TSelector>;
     settings: CheckSettings<TElement, TSelector>;
     screenshot: Screenshot;
     logger: Logger;

package/types/eyes.d.ts

@@ -0,0 +1 @@
+export {};

package/types/server/req-eyes.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { Proxy } from '@applitools/types';
+import { Request } from 'node-fetch';
+import { Req, Options } from './req';
+import { Logger } from '@applitools/logger';
+export declare type ReqEyesConfig = {
+    serverUrl: string;
+    apiKey: string;
+    proxy?: Proxy;
+    agentId?: string;
+    connectionTimeout?: number;
+    removeSession?: boolean;
+};
+export declare type ReqEyesOptions = Options & {
+    name: string;
+    expected?: number | number[];
+};
+export declare type ReqEyes = Req & ((input: string | URL | Request, options?: ReqEyesOptions) => ReturnType<Req>);
+export declare function makeReqEyes({ config, logger }: {
+    config: ReqEyesConfig;
+    logger?: Logger;
+}): ReqEyes;

package/types/server/req.d.ts

@@ -0,0 +1,172 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import globalFetch, { Request, Response } from 'node-fetch';
+declare const stop: unique symbol;
+export declare type Options = {
+    /**
+     * Providing this value will allow usage of relative urls for input
+     * @example 'http://localhost:2107/api/'
+     */
+    baseUrl?: string;
+    /**
+     * Uppercase method name. This will override method provided in `Request` object
+     * @example 'GET'
+     */
+    method?: string;
+    /**
+     * Query parameters to add to the url, all undefined params won't be added.
+     * It won't override the whole `search` part of the url, but instead merge with it
+     * @example {string: 'value', number: 21, boolean: true, noop: undefined}
+     */
+    query?: Record<string, string | boolean | number | undefined>;
+    /**
+     * Headers to send in the request, all undefined headers won't be sent.
+     * This will merge with headers provided in `Request` object
+     * @example {'x-my-header': 'value', 'x-noop-header': undefined}
+     */
+    headers?: Record<string, string | undefined>;
+    /**
+     * Body of the request, plain objects will be transformed to JSON strings
+     * @example {data: true}
+     * @example Buffer.from('S3lyeWxv', 'base64')
+     */
+    body?: NodeJS.ReadableStream | ArrayBufferView | string | Record<string, any>;
+    /**
+     * Proxy settings for the request. Auth credentials specified in the object will override ones specified in url
+     * @example {url: 'http://localhost:2107', username: 'kyrylo', password: 'pass'}
+     */
+    proxy?: {
+        url: string;
+        username: string;
+        password: string;
+    };
+    /**
+     * Connection timeout in ms
+     * @example 7000
+     */
+    timeout?: number;
+    /**
+     * Retry settings for the request. If specified as an array the retries are applied in the order
+     * @see Retry
+     * @example {limit: 5, statuses: [500, 501], codes: ['ECONRESET'], timeout: 1000}
+     */
+    retry?: Retry | Retry[];
+    /**
+     * Hooks of the request
+     * @see Hooks
+     */
+    hooks?: Hooks | Hooks[];
+    fetch?: typeof globalFetch;
+};
+export declare type Retry = {
+    /**
+     * Max number of attempts for specified condition
+     */
+    limit?: number;
+    /**
+     * Timeout before retrying the request. If specified as an array each element specifies the timeout for specific attempt,
+     * and the last one will be default for all next attempts
+     * @example [1000, 1000, 5000, 10_000]
+     */
+    timeout?: number | number[];
+    /**
+     * Status codes of the response to retry on.
+     * @example [500]
+     */
+    statuses?: number[];
+    /**
+     * Error codes of the request to retry on.
+     * @example ['ECONRESET']
+     */
+    codes?: string[];
+    /**
+     * Number of the current attempt for specified condition
+     * @internal
+     */
+    attempt?: number;
+};
+export declare type Hooks = {
+    /**
+     * Hook that will be executed before sending the request, after all, modifications of the `Request` object are already passed
+     * @example
+     * ```
+     * {
+     *   beforeRequest({request}) {
+     *      request.headers.set('Expires', 'Tue, 24 Aug 2022 00:00:00 GMT')
+     *   }
+     * }
+     * ```
+     */
+    beforeRequest?(options: {
+        request: Request;
+        options: Options;
+    }): Request | void | Promise<Request | void>;
+    /**
+     * Hook that will be executed before retrying the request. If this hook will return {@link req.stop}
+     * it will prevent request from retrying and execution of other hooks
+     * @example
+     * ```
+     * {
+     *   async beforeRetry({request, response, attempt}) {
+     *      const data = await response?.json()
+     *      if (data.error) return req.stop
+     *      request.headers.set('x-attempt', attempt)
+     *   }
+     * }
+     * ```
+     */
+    beforeRetry?(options: {
+        request: Request;
+        attempt: number;
+        response?: Response;
+        error?: Error;
+        options: Options;
+    }): Request | typeof stop | void | Promise<Request | void | typeof stop>;
+    /**
+     * Hook that will be executed after getting the final response of the request (after all of the retries)
+     * @example
+     * ```
+     * {
+     *   async afterResponse({request, response, options}) {
+     *      if (!response.ok) return req(request, options)
+     *   }
+     * }
+     * ```
+     */
+    afterResponse?(options: {
+        request: Request;
+        response: Response;
+        options: Options;
+    }): Response | void | Promise<Response | void>;
+    /**
+     * Hook that will be executed after request will throw an error
+     * @example
+     * ```
+     * {
+     *   async afterError({request, error}) {
+     *      error.request = request
+     *   }
+     * }
+     * ```
+     */
+    afterError?(options: {
+        request: Request;
+        error: Error;
+        options: Options;
+    }): Error | void | Promise<Error | void>;
+};
+/**
+ * Helper function that will properly merge two {@link Options} objects
+ */
+export declare function mergeOptions(baseOption: Options, options: Options): Options;
+/**
+ * Helper function that will create {@link req} function with predefined options
+ * @example const req = makeReq({baseUrl: 'http://localhost:2107'})
+ */
+export declare function makeReq(baseOption?: Options): typeof req;
+export declare function req(input: string | URL | Request, options?: Options): Promise<Response>;
+export declare namespace req {
+    var stop: unique symbol;
+}
+export declare type Req = typeof req;
+export default req;

package/types/server/requests.d.ts

@@ -0,0 +1,73 @@
+import type { Region, TextRegion, Batch } from '@applitools/types';
+import type { Target, Core, Eyes, ServerSettings, CheckSettings, LocateSettings, LocateTextSettings, ExtractTextSettings, CloseSettings, DeleteTestSettings, CloseBatchSettings, CheckResult, TestResult, OpenSettings } from '@applitools/types/types/core-base';
+import { type Logger } from '@applitools/logger';
+import { type ReqEyes } from './req-eyes';
+interface AccountInfo {
+    renderUrl: string;
+    renderToken: string;
+    uploadUrl: string;
+    maxImageHeight: number;
+    maxImageArea: number;
+}
+interface Test {
+    testId: string;
+    batchId: string;
+    baselineId: string;
+    sessionId: string;
+    resultsUrl: string;
+    isNew: boolean;
+}
+export interface CoreRequests extends Core {
+    openEyes(options: {
+        settings: OpenSettings;
+    }): Promise<EyesRequests>;
+    getAccountInfo(options: {
+        settings: ServerSettings;
+    }): Promise<AccountInfo>;
+    getBatch(options: {
+        settings: ServerSettings & {
+            batchId: string;
+        };
+    }): Promise<Batch>;
+    closeBatch(options: {
+        settings: CloseBatchSettings;
+    }): Promise<void>;
+    deleteTest(options: {
+        settings: DeleteTestSettings;
+    }): Promise<void>;
+}
+export interface EyesRequests extends Eyes {
+    check(options: {
+        target: Target;
+        settings?: CheckSettings;
+    }): Promise<CheckResult[]>;
+    checkAndClose(options: {
+        target: Target;
+        settings?: CheckSettings;
+    }): Promise<TestResult[]>;
+    locate<TLocator extends string>(options: {
+        target: Target;
+        settings: LocateSettings<TLocator>;
+    }): Promise<Record<TLocator, Region[]>>;
+    locateText<TPattern extends string>(options: {
+        target: Target;
+        settings: LocateTextSettings<TPattern>;
+    }): Promise<Record<TPattern, TextRegion[]>>;
+    extractText(options: {
+        target: Target;
+        settings: ExtractTextSettings;
+    }): Promise<string[]>;
+    close(options: {
+        settings: CloseSettings;
+    }): Promise<TestResult[]>;
+    abort(): Promise<TestResult[]>;
+}
+export declare function makeCoreCommands({ logger }: {
+    logger?: Logger;
+}): CoreRequests;
+export declare function makeEyesCommands({ test, req, logger }: {
+    test: Test;
+    req: ReqEyes;
+    logger?: Logger;
+}): EyesRequests;
+export {};

package/types/ufg/abort.d.ts

@@ -4,10 +4,13 @@ import type { TestResult } from '@applitools/types/ufg';
 import { type Logger } from '@applitools/logger';
 import { type AbortController } from 'abort-controller';
 declare type Options = {
-    storage: Promise<{
-        eyes: BaseEyes;
+    storage: {
         renderer: Renderer;
-    }>[];
+        promise: Promise<{
+            eyes: BaseEyes;
+            renderer: Renderer;
+        }>;
+    }[];
     controller: AbortController;
     logger: Logger;
 };

package/types/ufg/close.d.ts

@@ -3,10 +3,13 @@ import type { Eyes as BaseEyes } from '@applitools/types/base';
 import type { CloseSettings, TestResult } from '@applitools/types/ufg';
 import { type Logger } from '@applitools/logger';
 declare type Options = {
-    storage: Promise<{
-        eyes: BaseEyes;
+    storage: {
         renderer: Renderer;
-    }>[];
+        promise: Promise<{
+            eyes: BaseEyes;
+            renderer: Renderer;
+        }>;
+    }[];
     logger: Logger;
 };
 export declare function makeClose({ storage, logger: defaultLogger }: Options): ({ settings, logger, }?: {

package/types/ufg/utils/generate-selectors.d.ts

@@ -0,0 +1,12 @@
+import type { Selector } from '@applitools/types';
+import { type Context } from '@applitools/driver';
+export declare function generateSelectors<TElement, TSelector>({ context, elementReferences, }: {
+    context: Context<unknown, unknown, TElement, TSelector>;
+    elementReferences: (TElement | Selector<TSelector>)[];
+}): Promise<{
+    selectors: {
+        generatedSelector: Selector;
+        originalSelector: Selector;
+    }[];
+    cleanupGeneratedSelectors(): Promise<void>;
+}>;