@applitools/eyes-testcafe 1.14.3 → 1.15.3

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 ## Unreleased
 
 
+## 1.15.3 - 2022/1/24
+
+- updated 'Agent ID' to 'eyes.testcafe' (from 'eyes.webdriverio')
+- updated to @applitools/eyes-api@1.1.7 (from 1.1.6)
+- updated to @applitools/eyes-sdk-core@13.0.0 (from 12.24.13)
+- updated to @applitools/visual-grid-client@15.8.62 (from 15.8.60)
+
+## 1.15.2 - 2022/1/14
+
+- remove `esModuleInterop` ts compile option
+
+## 1.15.1 - 2022/1/13
+
+- set failTestcafeOnDiff default value to true
+- updated to @applitools/eyes-api@1.1.6 (from 1.1.0)
+- updated to @applitools/eyes-sdk-core@12.24.9 (from 12.23.3)
+- updated to @applitools/utils@1.2.11 (from 1.2.2)
+- updated to @applitools/visual-grid-client@15.8.55 (from 15.8.24)
+- updated to @applitools/eyes-sdk-core@12.24.13 (from 12.24.9)
+- updated to @applitools/visual-grid-client@15.8.60 (from 15.8.55)
+
+## 1.15.0 - 2021/9/6
+
+- updated to @applitools/eyes-api@1.1.0 (from 1.0.7)
+- updated to @applitools/eyes-sdk-core@12.23.3 (from 12.21.5)
+- updated to @applitools/utils@1.2.2 (from 1.2.0)
+- updated to @applitools/visual-grid-client@15.8.24 (from 15.8.13)
+
 ## 1.14.3 - 2021/7/14
 
 - fix issue with `Eyes` being exported as a type from legacy type definition file

package/README.md

@@ -72,39 +72,34 @@ test('Cookies', async t => {
 <br/>
 
 ### Index
-- [API](#API)
-  - [Open](#open)
-  - [CheckWindow](#checkWindow)
-    - [tag](#tag)
-    - [target](#target)
-    - [fully](#fully)
-    - [selector](#selector)
-    - [region](#region)
-    - [ignore](#ignore)
-    - [floating](#floating)
-    - [layout](#layout)
-    - [strict](#strict)
-    - [content](#content)
-    - [accessibility](#accessibility)
-    - [scriptHooks](#scriptHooks)
-    - [sendDom](#sendDom)
-  - [Close](#Close)
-  - [waitForResults](#waitForResults)
-  - [Best practices](#Best-practice-for-using-the-SDK)
-- [Concurrency](#Concurrency)
-  - [Running wih testcafe concurrency](#Running-wih-testcafe-concurrency)
-  - [Applitools concurrency](#Applitools-concurrency)
-- [Advanced configuration](#Advanced-configuration)
-  - [Scoped configuration](#configuration-properties)
-  - [Global configuration](#global-configuration-properties)
-  - [Examples](#Method-1-Arguments-for-eyesOpen)
-    - [Arguments for `eyesOpen`](#Method-1-Arguments-for-eyesOpen)
-    - [Environment variables](#Method-2-Environment-variables)
-    - [The `applitools.config.js` file](#Method-3-The-applitoolsconfigjs-file)
-- [Configuring the browser](#Configuring-the-browser)
-  - [Device emulation](#Device-emulation)
-  - [iOS device](#iOS-device)
-- [Troubleshooting](#Troubleshooting)
+- [Eyes-Testcafe](#eyes-testcafe)
+  - [Installation](#installation)
+  - [Applitools API key](#applitools-api-key)
+  - [Usage](#usage)
+    - [Example](#example)
+    - [Index](#index)
+- [API](#api)
+    - [**open**](#open)
+    - [**checkWindow**](#checkwindow)
+      - [Arguments to `eyes.checkWindow`](#arguments-to-eyescheckwindow)
+    - [**close**](#close)
+    - [**waitForResults**](#waitforresults)
+  - [Best practice for using the SDK](#best-practice-for-using-the-sdk)
+  - [Concurrency](#concurrency)
+    - [Running wih testcafe concurrency](#running-wih-testcafe-concurrency)
+    - [Applitools concurrency](#applitools-concurrency)
+  - [Advanced configuration](#advanced-configuration)
+      - [Configuration properties:](#configuration-properties)
+    - [Global configuration properties:](#global-configuration-properties)
+    - [Method 1: Arguments for `eyes.open`](#method-1-arguments-for-eyesopen)
+    - [Method 2: Environment variables](#method-2-environment-variables)
+    - [Method 3: The `applitools.config.js` file](#method-3-the-applitoolsconfigjs-file)
+  - [Configuring the browser](#configuring-the-browser)
+    - [Previous browser versions](#previous-browser-versions)
+    - [Getting a screenshot of multiple browsers in parallel](#getting-a-screenshot-of-multiple-browsers-in-parallel)
+    - [Device emulation](#device-emulation)
+    - [iOS device](#ios-device)
+  - [Troubleshooting](#troubleshooting)
 
 <br/><br/><br/>
 
@@ -161,6 +156,20 @@ eyes.checkWindow({ tag: 'your tag', target: 'your target mode' })
   (optional) In case [target](#target) is `region`, this should be the actual css, xpath or [a Testcafe Selector](https://devexpress.github.io/testcafe/documentation/test-api/selecting-page-elements/selectors/) to an element, and the screenshot would be the content of that element. For example:
 
   ```js
+      // Using a Testcafe Selector
+      import {Selector} from 'testcafe';
+      eyes.checkWindow({
+        target: 'region',
+        selector: Selector('.my-region')
+      });
+
+      // Using a Testcafe Selector to reference an element within a shadow DOM
+      import {Selector} from 'testcafe';
+      eyes.checkWindow({
+        target: 'region',
+        selector: Selector('#has-shadow-root').shadowRoot().find('.my-region')
+      });
+
       // The shorthand string version defaults to css selectors
       eyes.checkWindow({
         target: 'region',
@@ -176,13 +185,6 @@ eyes.checkWindow({ tag: 'your tag', target: 'your target mode' })
         }
       });
 
-      // Using a Testcafe Selector
-      import {Selector} from 'testcafe';
-      eyes.checkWindow({
-        target: 'region',
-        selector: Selector('.my-region')
-      });
-
       // Using an xpath selector
       eyes.checkWindow({
         target: 'region',

package/dist/api.js

@@ -13,18 +13,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = void 0;
 const eyes_sdk_core_1 = require("@applitools/eyes-sdk-core");
 const api = require("@applitools/eyes-api");
-const spec = require("./spec-driver");
 const legacy = require("./legacy");
+const spec = require("./spec-driver");
 process.env.APPLITOOLS_SCRIPT_RESULT_MAX_BYTE_LENGTH = '4718592';
 process.env.APPLITOOLS_SCRIPT_REMOVE_REVERSE_PROXY_URL_PREFIXES = 'true';
-const sdk = eyes_sdk_core_1.makeSDK({
-    name: 'eyes.webdriverio',
+const sdk = (0, eyes_sdk_core_1.makeSDK)({
+    name: 'eyes.testcafe',
     version: require('../package.json').version,
     spec,
     VisualGridClient: require('@applitools/visual-grid-client'),
 });
 __exportStar(require("@applitools/eyes-api"), exports);
-class Eyes extends legacy.TestCafeEyes(api.Eyes) {
+class Eyes extends legacy.LegacyTestCafeEyesMixin(api.Eyes) {
 }
 exports.Eyes = Eyes;
 Eyes._spec = sdk;
@@ -41,4 +41,3 @@ class BatchClose extends api.BatchClose {
 }
 exports.BatchClose = BatchClose;
 BatchClose._spec = sdk;
-//# sourceMappingURL=api.js.map

package/dist/index-legacy.js

@@ -2,4 +2,3 @@
 const index_1 = require("./index");
 index_1.Eyes.default = index_1.Eyes;
 module.exports = index_1.Eyes;
-//# sourceMappingURL=index-legacy.js.map

package/dist/index.js

@@ -13,4 +13,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const api_1 = require("./api");
 __exportStar(require("./api"), exports);
 exports.default = api_1.Eyes;
-//# sourceMappingURL=index.js.map

package/dist/legacy.js

@@ -11,21 +11,22 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformCheckSettings = exports.transformConfig = exports.TestCafeEyes = void 0;
+exports.transformCheckSettings = exports.transformConfig = exports.LegacyTestCafeEyesMixin = void 0;
 const utils = require("@applitools/utils");
 const api = require("@applitools/eyes-api");
 const fs = require("fs");
 const path = require("path");
 const spec = require("./spec-driver");
 const eyes_sdk_core_1 = require("@applitools/eyes-sdk-core");
-function TestCafeEyes(Eyes) {
+function LegacyTestCafeEyesMixin(Eyes) {
     return class TestCafeEyes extends Eyes {
         constructor(runnerOrConfigOrOptions, configOrRunner) {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             if (utils.types.isNull(runnerOrConfigOrOptions) || utils.types.has(runnerOrConfigOrOptions, 'configPath')) {
                 const testcafeConfig = eyes_sdk_core_1.ConfigUtils.getConfig({ configPath: runnerOrConfigOrOptions === null || runnerOrConfigOrOptions === void 0 ? void 0 : runnerOrConfigOrOptions.configPath });
                 const runner = (_a = runnerOrConfigOrOptions === null || runnerOrConfigOrOptions === void 0 ? void 0 : runnerOrConfigOrOptions.runner) !== null && _a !== void 0 ? _a : new api.VisualGridRunner({ testConcurrency: (_c = (_b = testcafeConfig.concurrency) !== null && _b !== void 0 ? _b : testcafeConfig.testConcurrency) !== null && _c !== void 0 ? _c : 1 });
                 super(runner, transformConfig(testcafeConfig));
+                (_d = testcafeConfig.failTestcafeOnDiff) !== null && _d !== void 0 ? _d : (testcafeConfig.failTestcafeOnDiff = true);
                 this._testcafeConfig = testcafeConfig;
             }
             else {
@@ -75,7 +76,7 @@ function TestCafeEyes(Eyes) {
         }
     };
 }
-exports.TestCafeEyes = TestCafeEyes;
+exports.LegacyTestCafeEyesMixin = LegacyTestCafeEyesMixin;
 function transformConfig(options) {
     const config = Object.assign({}, options);
     if (options.concurrency)
@@ -182,4 +183,3 @@ function transformCheckSettings(options) {
     return settings;
 }
 exports.transformCheckSettings = transformCheckSettings;
-//# sourceMappingURL=legacy.js.map

package/dist/spec-driver.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.hover = exports.type = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.setViewportSize = exports.getElementRect = exports.findElements = exports.findElement = exports.childContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.transformElement = exports.isSelector = exports.isElement = exports.isDriver = void 0;
-const utils = require("@applitools/utils");
+exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.hover = exports.type = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.setViewportSize = exports.findElements = exports.findElement = exports.childContext = exports.mainContext = exports.executeScript = exports.isStaleElementError = exports.extractSelector = exports.transformSelector = exports.transformElement = exports.isSelector = exports.isElement = exports.isDriver = void 0;
 const testcafe = require("testcafe");
 const fs = require("fs");
+const utils = require("@applitools/utils");
 function XPathSelector(selector, options) {
     const getElementsByXPath = testcafe.Selector(xpath => {
         const iterator = document.evaluate(xpath, document, null, XPathResult.UNORDERED_NODE_ITERATOR_TYPE, null);
@@ -17,14 +17,6 @@ function XPathSelector(selector, options) {
     }, options);
     return testcafe.Selector(getElementsByXPath(selector), options);
 }
-function transformSelector(selector) {
-    if (utils.types.has(selector, ['type', 'selector'])) {
-        if (selector.type === 'xpath')
-            return XPathSelector(selector.selector);
-        return testcafe.Selector(selector.selector);
-    }
-    return testcafe.Selector(selector);
-}
 function deserializeResult(result, elements) {
     if (!result) {
         return result;
@@ -120,15 +112,28 @@ function isElement(element) {
 }
 exports.isElement = isElement;
 function isSelector(selector) {
-    return (utils.types.has(selector, ['type', 'selector']) ||
-        utils.types.isString(selector) ||
-        Boolean(selector.addCustomMethods && selector.find && selector.parent));
+    if (!selector)
+        return;
+    return Boolean(selector.addCustomMethods && selector.find && selector.parent);
 }
 exports.isSelector = isSelector;
 function transformElement(element) {
     return utils.types.isFunction(element.selector) ? element.selector : element;
 }
 exports.transformElement = transformElement;
+function transformSelector(selector) {
+    if (utils.types.has(selector, 'selector')) {
+        let current = selector;
+        let transformed = selector.type === 'xpath' ? XPathSelector(current.selector) : testcafe.Selector(current.selector);
+        while (current.shadow) {
+            current = utils.types.has(current.shadow, 'selector') ? current.shadow : { selector: current.shadow };
+            transformed = transformed.shadowRoot().find(current.selector);
+        }
+        return transformed;
+    }
+    return testcafe.Selector(selector);
+}
+exports.transformSelector = transformSelector;
 function extractSelector(element) {
     return utils.types.isFunction(element.selector) ? element.selector : element;
 }
@@ -137,16 +142,6 @@ function isStaleElementError(_err) {
     return false;
 }
 exports.isStaleElementError = isStaleElementError;
-async function isEqualElements(t, element1, element2) {
-    if (!element1 || !element2)
-        return false;
-    const compareElements = testcafe.ClientFunction(() => element1() === element2(), {
-        boundTestRun: t,
-        dependencies: { element1, element2 },
-    });
-    return compareElements();
-}
-exports.isEqualElements = isEqualElements;
 async function executeScript(t, script, arg) {
     script = utils.types.isFunction(script) ? script.toString() : script;
     const { result, resultId, elementsCount } = await scriptRunner.with({
@@ -182,15 +177,14 @@ async function findElements(t, selector) {
     return Array.from({ length: await elements.count }, (_, index) => elements.nth(index));
 }
 exports.findElements = findElements;
-async function getElementRect(_t, element) {
-    const { left: x, top: y, width, height } = await element.boundingClientRect;
-    return { x, y, width, height };
-}
-exports.getElementRect = getElementRect;
 async function setViewportSize(t, size) {
     await t.resizeWindow(size.width, size.height);
 }
 exports.setViewportSize = setViewportSize;
+async function getDriverInfo(_t) {
+    return { features: { shadowSelector: true } };
+}
+exports.getDriverInfo = getDriverInfo;
 async function getTitle(t) {
     try {
         return await testcafe.Selector('title', { boundTestRun: t }).innerText;
@@ -259,4 +253,3 @@ function build() {
     return [undefined, () => void 0];
 }
 exports.build = build;
-//# sourceMappingURL=spec-driver.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-testcafe",
-  "version": "1.14.3",
+  "version": "1.15.3",
   "description": "Applitools Eyes SDK for TestCafe",
   "keywords": [
     "eyes-testcafe",
@@ -24,6 +24,11 @@
     "dist",
     "types"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/eyes-testcafe"
+  },
   "main": "./dist/index-legacy.js",
   "types": "./types/index-legacy.d.ts",
   "scripts": {
@@ -36,11 +41,9 @@
     "run:testcafe:8": "./node_modules/testcafe-8/bin/testcafe-with-v8-flag-filter.js",
     "run:testcafe:7": "./node_modules/testcafe-7/bin/testcafe-with-v8-flag-filter.js",
     "lint": "eslint '**/*.ts' '**/*.js'",
-    "build": "yarn build:dist && yarn build:types",
-    "build:dist": "tsc",
-    "build:types": "api-extractor ./src/index.ts --out ./types/index.d.ts",
+    "build": "ttsc",
     "generate:tests": "coverage-tests generate ./test/coverage/config.js --name 'eyes-testcafe'",
-    "test": "yarn build:dist && yarn test:it && yarn test:coverage",
+    "test": "yarn test:it && yarn test:coverage",
     "test:unit": "mocha --no-timeouts ./test/unit/*.spec.js",
     "test:it": "testcafe chrome:headless test/it && yarn test:it:firefox:headless",
     "test:it:chrome": "testcafe chrome test/it/spec-driver.spec.js",
@@ -54,8 +57,8 @@
     "test:coverage:custom": "yarn generate:tests && APPLITOOLS_USE_PRELOADED_CONFIG=true APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-testcafe (custom)' APPLITOOLS_BATCH_ID=$(uuidgen) testcafe chrome:headless test/custom --reporter spec,xunit:coverage-test-report.xml",
     "report": "coverage-tests report ./test/coverage/config.js --name 'eyes-testcafe'",
     "deps": "bongo deps",
-    "gh:test": "gh workflow run test.yml -f packages='testcafe' -f links='eyes-sdk-core eyes-api types utils sdk-shared visual-grid-client' -f linking-depth='1'",
-    "gh:publish": "gh workflow run publish.yml -f packages='testcafe'",
+    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='testcafe' -f links='eyes-sdk-core eyes-api types test-utils utils driver snippets screenshoter sdk-shared visual-grid-client' -f linking-depth=3",
+    "gh:publish": "gh workflow run publish-testcafe.yml --ref $(git rev-parse --abbrev-ref HEAD)",
     "preversion": "yarn deps && bongo preversion && yarn build",
     "version": "bongo version",
     "postversion": "bongo postversion"
@@ -66,19 +69,19 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.0.7",
-    "@applitools/eyes-sdk-core": "12.21.5",
-    "@applitools/utils": "1.2.0",
-    "@applitools/visual-grid-client": "15.8.13"
+    "@applitools/eyes-api": "1.1.7",
+    "@applitools/eyes-sdk-core": "13.0.0",
+    "@applitools/utils": "1.2.11",
+    "@applitools/visual-grid-client": "15.8.62"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "1.1.3",
-    "@applitools/scripts": "1.0.1",
-    "@applitools/sdk-coverage-tests": "^2.3.13",
-    "@applitools/sdk-release-kit": "^0.13.0",
-    "@applitools/sdk-shared": "0.9.3",
-    "@applitools/test-server": "1.0.3",
-    "@applitools/test-utils": "1.0.4",
+    "@applitools/api-extractor": "1.2.7",
+    "@applitools/scripts": "1.1.0",
+    "@applitools/sdk-coverage-tests": "^2.3.18",
+    "@applitools/sdk-release-kit": "^0.13.11",
+    "@applitools/sdk-shared": "0.9.11",
+    "@applitools/test-server": "1.0.8",
+    "@applitools/test-utils": "1.0.11",
     "@typescript-eslint/eslint-plugin": "^4.15.1",
     "@typescript-eslint/parser": "^4.15.1",
     "eslint": "^7.9.0",
@@ -90,12 +93,15 @@
     "husky": "^4.3.8",
     "mocha": "^8.0.1",
     "prettier": "^2.1.2",
-    "testcafe": "^1.10.0",
+    "testcafe": "^1.18.1",
     "testcafe-10": "npm:testcafe@^1.10.0",
     "testcafe-7": "npm:testcafe@1.7.1",
     "testcafe-8": "npm:testcafe@1.8.8",
     "testcafe-9": "npm:testcafe@1.9.4",
-    "testcafe-browser-provider-browserstack": "^1.13.2-alpha.1"
+    "testcafe-browser-provider-browserstack": "^1.13.2-alpha.1",
+    "ts-node": "^10.4.0",
+    "ttypescript": "^1.5.12",
+    "typescript": "^4.5.4"
   },
   "peerDependencies": {
     "testcafe": "^1.7.1"

package/types/index-legacy.d.ts

@@ -1,3 +1,2 @@
-import {Eyes} from './index'
-
-export default Eyes
+import { Eyes } from './index';
+export = Eyes;