@applitools/core 1.0.9 → 1.1.0

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

@@ -51,6 +51,7 @@ async function takeScreenshot({ driver, settings, logger, }) {
         },
         debug: settings.debugImages,
         logger,
+        webview: settings.webview,
     });
 }
 exports.takeScreenshot = takeScreenshot;

package/dist/check.js

@@ -22,9 +22,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const utils = __importStar(require("@applitools/utils"));
+const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ eyes, logger: defaultLogger, }) {
     return async function check({ target, settings = {}, config, logger = defaultLogger, } = {}) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
@@ -48,6 +52,9 @@ function makeCheck({ eyes, logger: defaultLogger, }) {
             (_p = (_u = settings.lazyLoad).maxAmountToScroll) !== null && _p !== void 0 ? _p : (_u.maxAmountToScroll = 15000);
         }
         (_q = settings.waitBetweenStitches) !== null && _q !== void 0 ? _q : (settings.waitBetweenStitches = utils.types.isObject(settings.lazyLoad) ? settings.lazyLoad.waitingTime : 100);
+        if (settings.matchLevel === 'Content') {
+            logger.console.log(chalk_1.default.yellow(`The "Content" match level value has been deprecated, use "IgnoreColors" instead.`));
+        }
         const results = await eyes.check({ target: target, settings, logger });
         return results;
     };

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/take-dom-snapshots.js

@@ -31,8 +31,8 @@ var __importDefault = (this && this.__importDefault) || function (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"));
+const chalk_1 = __importDefault(require("chalk"));
 __exportStar(require("./take-dom-snapshot"), exports);
 async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
     var _a, _b, _c, _d;

package/dist/ufg/utils/take-native-app-snapshot.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.takeNativeAppSnapshot = exports.getBrokerURL = void 0;
+const nml_client_1 = require("@applitools/nml-client");
+async function getBrokerURL(driver) {
+    if (!driver.isIOS)
+        return false;
+    try {
+        const element = await driver.element({
+            type: 'xpath',
+            selector: '//XCUIElementTypeOther[@name="Applitools_View"]',
+        });
+        const result = JSON.parse(await element.getText());
+        return result.nextPath;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.getBrokerURL = getBrokerURL;
+async function takeNativeAppSnapshot(options) {
+    const nmlSnapshot = await (0, nml_client_1.takeSnapshot)(options.driver);
+    const snapshot = {
+        platformName: nmlSnapshot.resourceMap.metadata.platformName,
+        vhsHash: nmlSnapshot.resourceMap.vhs,
+        vhsCompatibilityParams: undefined,
+    };
+    if (options.driver.isIOS) {
+        snapshot.vhsCompatibilityParams = {
+            UIKitLinkTimeVersionNumber: nmlSnapshot.metadata.UIKitLinkTimeVersionNumber,
+            UIKitRunTimeVersionNumber: nmlSnapshot.metadata.UIKitRunTimeVersionNumber,
+        };
+    }
+    return { snapshots: snapshot };
+}
+exports.takeNativeAppSnapshot = takeNativeAppSnapshot;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "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.6",
     "@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/driver": "1.10.3",
+    "@applitools/logger": "1.1.24",
+    "@applitools/nml-client": "1.3.0",
+    "@applitools/req": "1.1.8",
+    "@applitools/screenshoter": "3.6.0",
     "@applitools/snippets": "2.4.5",
-    "@applitools/types": "1.5.16",
-    "@applitools/ufg-client": "1.0.5",
+    "@applitools/types": "1.5.17",
+    "@applitools/ufg-client": "1.0.6",
     "@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.13",
+    "@applitools/spec-driver-selenium": "^1.4.0",
+    "@applitools/spec-driver-webdriverio": "^1.3.0",
     "@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/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/take-native-app-snapshot.d.ts

@@ -0,0 +1,5 @@
+export declare function getBrokerURL(driver: any): Promise<any>;
+export declare function takeNativeAppSnapshot(options: {
+    driver: any;
+    logger: any;
+}): Promise<any>;