@applitools/eyes-cypress 3.25.7 → 3.26.2

package/CHANGELOG.md

@@ -7,6 +7,35 @@
 
 
 
+
+
+## 3.26.2 - 2022/6/8
+
+### Features
+- add support for secure websocket
+- Allowed `` values in custom properties
+### Bug fixes
+- Fix incorrect test results when dealing with a page that contains CORS iframes
+- Fixed broken links to enums implementation in the README.md
+- Fix calling `waitBeforeCapture` when failed to set required viewport size
+
+## 3.26.1 - 2022/6/2
+
+### Features
+- Improve type definitions
+- Dorp support for Node.js versions <=12
+### Bug fixes
+- Support `cy.eyesGetAllTestResults` in TypeScript
+- Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
+- Improve error message when failed to set viewport size
+
+## 3.26.0 - 2022/5/19
+
+### Features
+- `cy.eyesCheckWindow` now supports passing DOM elements and jQuery object for target and regions.
+### Bug fixes
+- Support `cy.eyesGetAllTestResults` in TypeScript
+
 ## 3.25.7 - 2022/5/6
 
 ### Features

package/README.md

@@ -173,43 +173,66 @@ Applitools will take screenshots and perform the visual comparisons in the backg
 <br/>
 
 ### Index
-- [Commands](#Commands)
-  - [Open](#Open)
-  - [CheckWindow](#Check-window)
-    - [tag](#tag)
-    - [target](#target)
-    - [fully](#fully)
-    - [selector](#selector)
-    - [region](#region)
-    - [ignore](#ignore)
-    - [floating](#floating)
-    - [layout](#layout)
-    - [strict](#strict)
-    - [content](#content)
-    - [accessibility](#accessibility)
-    - [region in shadow DOM](#region-in-shadow-dom)
-    - [scriptHooks](#scriptHooks)
-    - [layoutBreakpoints](#layoutBreakpoints)
-    - [sendDom](#sendDom)
-    - [variationGroupId](#variationGroupId)
-    - [waitBeforeCapture](#waitBeforeCapture)
-  - [Close](#Close)
-  - [GetAllTestResults](#GetAllTestResults)
-  - [deletTestResults](#deleteTestResults)
-- [Concurrency](#Concurrency)
-- [Advanced configuration](#Advanced-configuration)
-  - [Scoped configuration](#Here-are-the-available-configuration-properties)
-  - [Global configuration](#global-configuration-properties)
-  - [Examples](#Method-1-Arguments-for-cyeyesOpen)
-    - [Arguments for `cy.eyesOpen`](#Method-1-Arguments-for-cyeyesOpen)
-    - [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)
-- [IDE Code Completion](#Intelligent-Code-Completion)
-  - [Triple slash directives](#1-Triple-slash-directives)
-  - [Reference type declarations via `tsconfig`](#2-Reference-type-declarations-via-tsconfig)
-- [Troubleshooting](#Troubleshooting)
+- [Eyes-Cypress](#eyes-cypress)
+  - [Installation](#installation)
+    - [Install npm package](#install-npm-package)
+    - [Configure plugin and commands](#configure-plugin-and-commands)
+      - [Automatic configuration](#automatic-configuration)
+      - [Manual configuration](#manual-configuration)
+        - [1. Configure Eyes-Cypress plugin](#1-configure-eyes-cypress-plugin)
+        - [2. Configure custom commands](#2-configure-custom-commands)
+        - [3. (Optional) TypeScript configuration](#3-optional-typescript-configuration)
+    - [Applitools API key](#applitools-api-key)
+    - [Eyes server URL (optional)](#eyes-server-url-optional)
+  - [Usage](#usage)
+    - [Example](#example)
+    - [Best practice for using the SDK](#best-practice-for-using-the-sdk)
+    - [Index](#index)
+    - [Commands](#commands)
+      - [Open](#open)
+      - [Check window](#check-window)
+        - [Arguments to `cy.eyesCheckWindow`](#arguments-to-cyeyescheckwindow)
+        - [`tag`](#tag)
+        - [`target`](#target)
+        - [`fully`](#fully)
+        - [`selector`](#selector)
+        - [`region`](#region)
+        - [`element`](#element)
+        - [`ignore`](#ignore)
+        - [`floating`](#floating)
+        - [`layout`](#layout)
+        - [`strict`](#strict)
+        - [`content`](#content)
+        - [`accessibility`](#accessibility)
+        - [`region in shadow DOM`](#region-in-shadow-dom)
+        - [`scriptHooks`](#scripthooks)
+        - [`layoutBreakpoints`](#layoutbreakpoints)
+        - [`sendDom`](#senddom)
+        - [`variationGroupId`](#variationgroupid)
+        - [`waitBeforeCapture`](#waitbeforecapture)
+        - [`useDom`](#usedom)
+        - [`enablePatterns`](#enablepatterns)
+        - [`matchLevel`](#matchlevel)
+        - [`visualGridOptions`](#visualgridoptions)
+      - [Close](#close)
+      - [GetAllTestResults](#getalltestresults)
+      - [deleteTestResults](#deletetestresults)
+  - [Concurrency](#concurrency)
+  - [Advanced configuration](#advanced-configuration)
+    - [Here are the available configuration properties:](#here-are-the-available-configuration-properties)
+    - [Global configuration properties:](#global-configuration-properties)
+    - [Method 1: Arguments for `cy.eyesOpen`](#method-1-arguments-for-cyeyesopen)
+    - [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)
+  - [Intelligent Code Completion](#intelligent-code-completion)
+      - [There are two ways you can add Eyes-Cypress intelliSense to your tests:](#there-are-two-ways-you-can-add-eyes-cypress-intellisense-to-your-tests)
+    - [1. Triple slash directives](#1-triple-slash-directives)
+    - [2. Reference type declarations via `tsconfig`](#2-reference-type-declarations-via-tsconfig)
 
 <br/><hr/><br/>
 
@@ -255,7 +278,7 @@ cy.eyesCheckWindow({ tag: 'Login screen', target: 'your target' })
 <br/> 1. `window` 
   This is the default value. If set then the captured image is of the entire page or the viewport, use [`fully`](#fully) for specifying what `window` mode to use.
 <br/>2. `region` 
-  If set then the captured image is of the parts of the page, use this parameter with [`region`](#region) or [`selector`](#selector) for specifying the areas to captured.
+  If set then the captured image is of the parts of the page, use this parameter with [`region`](#region), [`selector`](#selector), or [`element`](#element) for specifying the areas to captured.
 
 ##### `fully`
 
@@ -310,18 +333,72 @@ cy.eyesCheckWindow({ tag: 'Login screen', target: 'your target' })
   });
   ```
 
+##### `element`
+
+(optional): In case [`target`](#target) is `region`, this should be an instance of either an HTML element or a jQuery object. For example:
+
+  ```js
+// passing a jQuery object
+cy.get('body > div > h1')
+  .then($el => {
+      cy.eyesCheckWindow({
+        target: 'region',
+        element: $el
+      })
+  })
+
+// passing an HTML element
+cy.document()
+  .then(doc => {
+    const el = document.querySelector('div')
+    cy.eyesCheckWindow({
+      target: 'region',
+      element: el
+    })
+  })
+```
+
 ##### `ignore`
 
 (optional): A single or an array of regions to ignore when checking for visual differences. For example:
 
-  ```js
+```js
+// ignore region by coordinates
+cy.eyesCheckWindow({
+  ignore: {top: 100, left: 0, width: 1000, height: 100},
+});
+
+// ignore regions by selector
+cy.eyesCheckWindow({
+  ignore: {selector: '.some-div-to-ignore'} // all elements matching this selector would become ignore regions
+});
+
+// ignore regions by jQuery or DOM elements
+cy.get('.some-div-to-ignore').then($el => {
+  cy.eyesCheckWindow({
+    ignore: $el
+  });
+})
+
+// mix multiple ignore regions with different methods
+cy.eyesCheckWindow({
+  ignore: [
+    {top: 100, left: 0, width: 1000, height: 100},
+    {selector: '.some-div-to-ignore'}
+  ]
+});
+
+// mix multiple ignore regions with different methods including element
+cy.get('.some-div-to-ignore').then($el => {
   cy.eyesCheckWindow({
     ignore: [
       {top: 100, left: 0, width: 1000, height: 100},
       {selector: '.some-div-to-ignore'}
+      $el
     ]
   });
-  ```
+})
+```
 
 ##### `floating`
 
@@ -334,6 +411,15 @@ cy.eyesCheckWindow({
     {selector: '.some-div-to-float', maxUpOffset: 20, maxDownOffset: 20, maxLeftOffset: 20, maxRightOffset: 20}
   ]
 });
+
+// use jQuery or DOM elements
+cy.get('.some-div-to-float').then($el => {
+  cy.eyesCheckWindow({
+    floating: [
+        {element: $el, maxUpOffset: 20, maxDownOffset: 20, maxLeftOffset: 20, maxRightOffset: 20},
+    ]
+  })
+})
 ```
 
 ##### `layout`
@@ -347,6 +433,13 @@ cy.eyesCheckWindow({
       {selector: '.some-div-to-test-as-layout'}
     ]
   });
+
+    // use jQuery or DOM elements
+  cy.get('.some-div-to-test-as-layout').then($el => {
+      cy.eyesCheckWindow({
+        layout: $el
+    });
+  })
   ```
 
 ##### `strict`
@@ -360,6 +453,13 @@ cy.eyesCheckWindow({
       {selector: '.some-div-to-test-as-strict'}
     ]
   });
+
+  // use jQuery or DOM elements
+  cy.get('.some-div-to-test-as-strict').then($el => {
+      cy.eyesCheckWindow({
+        strict: $el
+    });
+  })
   ```
 
 ##### `content`
@@ -373,6 +473,13 @@ cy.eyesCheckWindow({
       {selector: '.some-div-to-test-as-content'}
     ]
   });
+
+  // use jQuery or DOM elements
+  cy.get('.some-div-to-test-as-content').then($el => {
+      cy.eyesCheckWindow({
+        content: $el
+    });
+  })
   ```
 
 ##### `accessibility`
@@ -387,6 +494,16 @@ cy.eyesCheckWindow({
       {accessibilityType: 'BoldText', top: 100, left: 0, width: 1000, height: 100},
     ]
   });
+
+// use jQuery or DOM elements
+  cy.get('.some-div').then($el => {
+     cy.eyesCheckWindow({
+    accessibility: [
+      {accessibilityType: 'RegularText', element: $el},
+    ]
+  });
+  })
+
   ```
 
   Possible accessibilityType values are: `IgnoreContrast`,`RegularText`,`LargeText`,`BoldText` and `GraphicalObject`.
@@ -733,7 +850,7 @@ cy.eyesOpen({
 
 Possible values for screen orientation are `landscape` and `portrait`, and if no value is specified, the default is `portrait`.
 
-The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/DeviceName.js
+The list of device names is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/DeviceName.ts
 
 In addition, it's possible to use chrome's device emulation with custom viewport sizes, pixel density and mobile mode, by passing `deviceScaleFactor` and `mobile` in addition to `width` and `height`. For example:
 
@@ -765,7 +882,7 @@ cy.eyesOpen({
 })
 ```
 
-The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/IosDeviceName.js
+The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
 
 Possible values for `iosVersion` are:
 

package/dist/browser/spec-driver.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
 function executeScript(context, script, arg) {
-    context = refreshContext(context);
     let scriptToExecute;
     if (script.includes('dom-snapshot') ||
         script.includes('dom-capture') ||
@@ -23,13 +22,20 @@ function mainContext() {
 }
 exports.mainContext = mainContext;
 function parentContext(context) {
-    if (!context)
-        return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+    // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+    if (!context) {
+        throw new Error('Context is not accessible');
+    }
+    ;
     return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
 }
 exports.parentContext = parentContext;
 function childContext(_context, element) {
-    return element.contentDocument; // null in case of cross origin iframe
+    if (element.contentDocument)
+        return element.contentDocument;
+    else {
+        throw new Error('Context is not accessible');
+    }
 }
 exports.childContext = childContext;
 function getViewportSize() {
@@ -55,7 +61,6 @@ function transformSelector(selector) {
 }
 exports.transformSelector = transformSelector;
 function findElement(context, selector, parent) {
-    context = refreshContext(context);
     const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
     const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
@@ -68,7 +73,6 @@ function findElement(context, selector, parent) {
 }
 exports.findElement = findElement;
 function findElements(context, selector, parent) {
-    context = refreshContext(context);
     const eyesSelector = selector;
     const root = parent !== null && parent !== void 0 ? parent : context;
     const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
@@ -86,12 +90,10 @@ function findElements(context, selector, parent) {
 }
 exports.findElements = findElements;
 function getTitle(context) {
-    context = refreshContext(context);
     return context.title;
 }
 exports.getTitle = getTitle;
 function getUrl(context) {
-    context = refreshContext(context);
     return context.location.href;
 }
 exports.getUrl = getUrl;
@@ -100,11 +102,6 @@ function getCookies() {
     return Cypress.automation('get:cookies', {});
 }
 exports.getCookies = getCookies;
-// we need to method to reset the context in case the user called open before visit
-function refreshContext(context) {
-    //@ts-ignore
-    return (context && context.defaultView) ? context : cy.state('window').document;
-}
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 // export function visit(page: Driver, url: string): Promise<void>; (??)
 // export function isStaleElementError(err: any): boolean;

package/index.d.ts

@@ -0,0 +1,89 @@
+/// <reference types="cypress" />
+
+import type * as types from '@applitools/types'
+import type * as api from '@applitools/eyes-api'
+
+type MaybeArray<T> = T | T[]
+
+type LegacyRegion = {left: number; top: number; width: number; height: number}
+type Selector = {selector: string; type?: 'css' | 'xpath', nodeType?: 'element' | 'shadow-root'} | 'string'
+type Element = HTMLElement | JQuery<HTMLElement>
+
+interface CypressCheckSettings extends types.CheckSettings<Element, Selector> {
+  tag?: CypressCheckSettings['name']
+
+  target?: 'window' | 'region'
+  selector?: Selector
+  element?: Element
+
+  ignore?: MaybeArray<CypressCheckSettings['ignoreRegions'][number] | LegacyRegion>
+  layout?: MaybeArray<CypressCheckSettings['layoutRegions'][number] | LegacyRegion>
+  content?: MaybeArray<CypressCheckSettings['contentRegions'][number] | LegacyRegion>
+  strict?: MaybeArray<CypressCheckSettings['strictRegions'][number] | LegacyRegion>
+  floating?: MaybeArray<CypressCheckSettings['floatingRegions'][number] | (({element: Element} | Selector | LegacyRegion) & {maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number})>
+  accessibility?: MaybeArray<CypressCheckSettings['accessibilityRegions'][number] | (({element: Element} | Selector | LegacyRegion) & {accessibilityType?: types.AccessibilityRegionType})>
+
+  scriptHooks?: CypressCheckSettings['hooks']
+}
+
+interface CypressEyesConfig extends types.EyesConfig<Element, Selector> {
+  browser?: MaybeArray<CypressEyesConfig['browsersInfo'][number] | {deviceName: string; screenOrientation?: types.ScreenOrientation; name?: string}>
+
+  batchId?: CypressEyesConfig['batch']['id']
+  batchName?: CypressEyesConfig['batch']['name']
+  batchSequence?: CypressEyesConfig['batch']['sequenceName']
+  notifyOnCompletion?: CypressEyesConfig['batch']['notifyOnCompletion']
+
+  envName?: CypressEyesConfig['environmentName']
+
+  ignoreCaret?: CypressEyesConfig['defaultMatchSettings']['ignoreCaret']
+  matchLevel?: CypressEyesConfig['defaultMatchSettings']['matchLevel']
+  accessibilitySettings?: CypressEyesConfig['defaultMatchSettings']['accessibilitySettings']
+  ignoreDisplacements?: CypressEyesConfig['defaultMatchSettings']['ignoreDisplacements']
+}
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Create an Applitools test.
+       * This will start a session with the Applitools server.
+       * @example
+       * cy.eyesOpen({ appName: 'My App' })
+      */
+      eyesOpen(config?: CypressEyesConfig): null
+
+      /**
+       * Generate a screenshot of the current page and add it to the Applitools Test.
+       * @example
+       * cy.eyesCheckWindow()
+       *
+       * OR
+       *
+       * cy.eyesCheckWindow({
+       *  target: 'region',
+       *  selector: '.my-element'
+       * });
+      */
+      eyesCheckWindow(tag?: string): null
+      eyesCheckWindow(settings?: CypressCheckSettings): null
+
+      /**
+       * Close the applitools test and check that all screenshots are valid.
+       * @example cy.eyesClose()
+      */
+      eyesClose(): null
+
+      /**
+       * Returns an object with the applitools test results from a given test / test file. This should be called after close.
+       * @example
+       * after(() => {
+       *  cy.eyesGetAllTestResults().then(summary => {
+       *    console.log(summary)
+       *  })
+       * })
+       */
+      eyesGetAllTestResults(): Chainable<api.TestResultsSummary>
+    }
+  }
+}

package/package.json

@@ -1,74 +1,74 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.25.7",
-  "main": "index.js",
+  "version": "3.26.2",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/eyes-cypress"
+  },
   "license": "SEE LICENSE IN LICENSE",
+  "main": "index.js",
+  "types": "./index.d.ts",
   "bin": {
     "eyes-setup": "./bin/eyes-setup.js"
   },
+  "files": [
+    "src",
+    "dist",
+    "bin",
+    "index.js",
+    "commands.js",
+    "index.d.ts"
+  ],
   "scripts": {
+    "lint": "eslint \"**/*.js\"",
     "build": "tsc",
-    "render": "run(){ npx cypress run --config integrationFolder=test/fixtures/testApp/cypress/render,pluginsFile=test/fixtures/testApp/cypress/plugins/index-render.js,supportFile=test/fixtures/testApp/cypress/support/index-run.js --env url=$1; }; run",
+    "generate:tests": "coverage-tests generate",
+    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn test:ts && yarn test:coverage",
     "test:unit": "mocha --no-timeouts 'test/unit/**/*.test.js'",
     "test:it": "mocha --no-timeouts 'test/it/**/*.test.js'",
     "test:e2e": "mkdir -p test/fixtures/testAppCopies && mocha --no-timeouts 'test/e2e/**/*.test.js'",
-    "lint": "eslint \"**/*.js\"",
-    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn test:coverage",
+    "test:ts:compile": "tsc --project test/e2e/ts/cypress",
+    "test:ts:run": "cypress run --config-file test/e2e/ts/cypress-ts.json",
+    "test:ts": "yarn test:ts:compile && yarn test:ts:run",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic &&  unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) cypress run",
     "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
     "cypress:new": "node_modules/cypress-new/bin/cypress open --config-file test/fixtures/cypress-play.json",
     "cypress:run": "cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
     "cypress:run:new": "node_modules/cypress-new/bin/cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
     "cypress:play": "cd test/fixtures/testApp && cypress run --config integrationFolder=cypress/integration-play,pluginsFile=cypress/plugins/index-play.js,supportFile=cypress/support/index-run.js --spec=cypress/integration-play/play.js",
+    "render": "run(){ npx cypress run --config integrationFolder=test/fixtures/testApp/cypress/render,pluginsFile=test/fixtures/testApp/cypress/plugins/index-render.js,supportFile=test/fixtures/testApp/cypress/support/index-run.js --env url=$1; }; run",
+    "prepublish:setup": "sudo apt-get install xvfb",
+    "deps": "bongo deps",
     "preversion": "yarn build && bongo preversion --skip-deps --verifyPendingChanges",
     "version": "bongo version --withPendingChanges",
-    "postversion": "bongo postversion --skip-release-notification",
-    "deps": "bongo deps",
-    "generate:tests": "coverage-tests generate",
-    "test:coverage": "yarn generate:tests && cd test/coverage/generic &&  unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) cypress run",
-    "prepublish:setup": "sudo apt-get install xvfb"
-  },
-  "files": [
-    "src",
-    "dist",
-    "bin",
-    "index.js",
-    "commands.js",
-    "eyes-index.d.ts"
-  ],
-  "types": "./eyes-index.d.ts",
-  "engines": {
-    "node": ">=8.0.0"
+    "postversion": "bongo postversion --skip-release-notification"
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
-    "directory": "packages/eyes-cypress"
+  "husky": {
+    "hooks": {
+      "pre-push": "yarn bongo lint"
+    }
   },
   "dependencies": {
-    "@applitools/dom-snapshot": "4.5.12",
-    "@applitools/eyes-api": "1.3.1",
-    "@applitools/eyes-universal": "2.5.1",
+    "@applitools/eyes-api": "1.5.4",
+    "@applitools/eyes-universal": "2.7.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.2",
-    "@applitools/visual-grid-client": "15.12.13",
-    "body-parser": "1.19.0",
+    "@applitools/logger": "1.1.10",
+    "@applitools/visual-grid-client": "15.12.41",
     "chalk": "3.0.0",
-    "cors": "2.8.5",
-    "express": "4.17.1",
-    "lodash.flatten": "4.4.0",
     "uuid": "8.3.2",
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.0.3",
+    "@applitools/bongo": "^2.1.4",
     "@applitools/scripts": "1.1.0",
     "@applitools/sdk-coverage-tests": "^2.3.18",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.0.8",
+    "@applitools/test-server": "1.0.10",
     "@applitools/test-utils": "1.3.2",
-    "@applitools/types": "^1.4.2",
-    "@applitools/utils": "1.2.14",
-    "@types/node": "17.0.13",
+    "@applitools/types": "^1.4.7",
+    "@applitools/utils": "1.3.6",
+    "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",
     "@typescript-eslint/parser": "^5.10.2",
@@ -88,11 +88,9 @@
     "ncp": "2.0.0",
     "node-fetch": "2.6.0",
     "prettier": "1.19.1",
-    "typescript": "3.9.2"
+    "typescript": "4.6.4"
   },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
+  "engines": {
+    "node": ">=12.13.0"
   }
 }

package/src/browser/commands.js

@@ -7,7 +7,6 @@ const {socketCommands} = require('./socketCommands');
 const {eyesOpenMapValues} = require('./eyesOpenMapping');
 const {eyesCheckMapValues} = require('./eyesCheckMapping');
 const {TestResultsSummary} = require('@applitools/eyes-api');
-
 const refer = new Refer(value => {
   if (!value || !value.constructor || !value.constructor.name) return false;
   const name = value.constructor.name;
@@ -111,7 +110,7 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
     const driver = refer.ref(cy.state('window').document);
 
     if (!connectedToUniversal) {
-      socket.connect(`ws://localhost:${Cypress.config('eyesPort')}/eyes`);
+      socket.connect(`wss://localhost:${Cypress.config('eyesPort')}/eyes`);
       connectedToUniversal = true;
       socket.emit('Core.makeSDK', {
         name: 'eyes.cypress',
@@ -148,19 +147,21 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
   });
 });
 
-Cypress.Commands.add('eyesCheckWindow', args =>
+Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
   cy.then({timeout: 86400000}, () => {
     if (isCurrentTestDisabled) return;
 
     setRootContext();
+    const driver = refer.ref(cy.state('window').document);
 
     Cypress.log({name: 'Eyes: check window'});
 
-    const checkSettings = eyesCheckMapValues({args});
+    const checkSettings = eyesCheckMapValues({args, refer});
 
     return socket.request('Eyes.check', {
       eyes,
       settings: checkSettings,
+      driver,
     });
   }),
 );

package/src/browser/eyesCheckMapping.js

@@ -1,8 +1,6 @@
-function eyesCheckMapValues({args}) {
-  return toCheckWindowConfiguration(args);
-}
-
-function toCheckWindowConfiguration(config = {}) {
+/* global Node */
+function eyesCheckMapValues({args, refer}) {
+  const config = args; // just did it for having less git changes at this moment
   const mappedValues = [
     'tag',
     'scriptHooks',
@@ -21,17 +19,28 @@ function toCheckWindowConfiguration(config = {}) {
   const checkSettings = {
     name: config.tag,
     hooks: config.scriptHooks,
-    ignoreRegions: config.ignore,
+    ignoreRegions: refElements(config.ignore),
     floatingRegions: convertFloatingRegion(config.floating),
-    strictRegions: config.strict,
-    layoutRegions: config.layout,
-    contentRegions: config.content,
+    strictRegions: refElements(config.strict),
+    layoutRegions: refElements(config.layout),
+    contentRegions: refElements(config.content),
     accessibilityRegions: convertAccessabilityRegions(config.accessibility),
   };
 
   if (config.target === 'region') {
     if (!Array.isArray(config.selector)) {
-      if (!config.hasOwnProperty('selector')) {
+      if (config.element) {
+        if (isHTMLElement(config.element)) {
+          regionSettings = {
+            region: refer.ref(config.element),
+          };
+        } else {
+          // JQuery element
+          regionSettings = {
+            region: refer.ref(config.element[0]),
+          };
+        }
+      } else if (!config.hasOwnProperty('selector')) {
         regionSettings = {
           region: config.region,
         };
@@ -66,39 +75,97 @@ function toCheckWindowConfiguration(config = {}) {
   }
 
   return Object.assign({}, checkSettings, regionSettings, config);
-}
 
-function convertAccessabilityRegions(accessibilityRegions) {
-  if (!accessibilityRegions) return accessibilityRegions;
+  // #region helper functions
 
-  return accessibilityRegions.map(region => ({
-    region: region.selector,
-    type: region.accessibilityType,
-  }));
-}
+  function convertAccessabilityRegions(accessibilityRegions) {
+    if (!accessibilityRegions) return accessibilityRegions;
+    const accessibility = [];
+
+    accessibilityRegions.map(region => {
+      const accessabilityRegion = {
+        type: region.accessibilityType,
+      };
+      if (region.hasOwnProperty('selector')) {
+        accessabilityRegion.region = region.selector;
+        accessibility.push(accessabilityRegion);
+      } else if (region.hasOwnProperty('element')) {
+        const elements = refElements(region.element);
+        for (const element of elements) {
+          accessibility.push(Object.assign({}, accessabilityRegion, {region: element}));
+        }
+      } else {
+        accessabilityRegion.region = {
+          top: region.top,
+          left: region.left,
+          width: region.width,
+          height: region.height,
+        };
+        accessibility.push(accessabilityRegion);
+      }
+    });
 
-function convertFloatingRegion(floatingRegions) {
-  if (!floatingRegions) return floatingRegions;
+    return accessibility;
+  }
 
-  return floatingRegions.map(region => {
-    const floatingRegion = {
-      maxDownOffset: region.maxDownOffset || 0,
-      maxLeftOffset: region.maxLeftOffset || 0,
-      maxUpOffset: region.maxUpOffset || 0,
-      maxRightOffset: region.maxRightOffset || 0,
-    };
-    if (region.hasOwnProperty('selector')) {
-      floatingRegion.region = region.selector;
-    } else {
-      floatingRegion.region = {
-        top: region.top,
-        left: region.left,
-        width: region.width,
-        height: region.height,
+  function convertFloatingRegion(floatingRegions) {
+    if (!floatingRegions) return floatingRegions;
+    const floating = [];
+
+    for (const region of floatingRegions) {
+      const floatingRegion = {
+        maxDownOffset: region.maxDownOffset || 0,
+        maxLeftOffset: region.maxLeftOffset || 0,
+        maxUpOffset: region.maxUpOffset || 0,
+        maxRightOffset: region.maxRightOffset || 0,
       };
+      if (region.hasOwnProperty('selector')) {
+        floatingRegion.region = region.selector;
+        floating.push(floatingRegion);
+      } else if (region.hasOwnProperty('element')) {
+        const elements = refElements(region.element);
+        for (const element of elements) {
+          floating.push(Object.assign({}, floatingRegion, {region: element}));
+        }
+      } else {
+        floatingRegion.region = {
+          top: region.top,
+          left: region.left,
+          width: region.width,
+          height: region.height,
+        };
+        floating.push(floatingRegion);
+      }
+    }
+    return floating;
+  }
+
+  function refElements(regions) {
+    if (!regions) return regions;
+    if (!Array.isArray(regions)) regions = [regions];
+    const elements = [];
+    for (const region of regions) {
+      if (isHTMLElement(region)) {
+        elements.push(refer.ref(region));
+      } else if (region.jquery) {
+        region.each(function() {
+          // there's a small chance that `this` is not an HTML element. So we just verify it.
+          elements.push(isHTMLElement(this) ? refer.ref(this) : this);
+        });
+      } else {
+        elements.push(region);
+      }
     }
-    return floatingRegion;
-  });
+    return elements;
+  }
+
+  // #endregion
+}
+
+function isHTMLElement(element) {
+  // Avoiding instanceof here since the element might come from an iframe, and `instanceof HTMLElement` would fail.
+  // This check looks naive, but if anyone passes something like {nodeType: 1} as a region, then I'm fine with them crashing :)
+  return element.nodeType && element.nodeType === Node.ELEMENT_NODE;
 }
 
 module.exports = {eyesCheckMapValues};

package/src/browser/spec-driver.ts

@@ -4,7 +4,6 @@ export type Context = Document & {__applitoolsBrand?: never};
 export type Element = HTMLElement & {__applitoolsBrand?: never};
 
 export function executeScript(context: Context, script: string, arg: any): any {     
-  context = refreshContext(context)
 
       let scriptToExecute;
       if (
@@ -28,13 +27,20 @@ export function mainContext(): Context {
 }
 
 export function parentContext(context: Context): Context {
-  if (!context) return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+  // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+  if (!context) {
+    throw new Error('Context is not accessible')
+  }; 
   
   return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument
 }
 
 export function childContext(_context: Context, element: HTMLIFrameElement): Context {
-  return element.contentDocument // null in case of cross origin iframe
+  if(element.contentDocument)
+    return element.contentDocument
+  else {
+    throw new Error('Context is not accessible')
+  }
 }
 
 export function getViewportSize(): Object {
@@ -60,7 +66,6 @@ export function transformSelector(selector: Selector): Selector {
 }
 
 export function findElement(context: Context, selector: Selector, parent?: Element) {
-  context = refreshContext(context)
   const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
   const sel = typeof selector === 'string' ? selector : eyesSelector.selector
@@ -72,7 +77,6 @@ export function findElement(context: Context, selector: Selector, parent?: Eleme
 }
 
 export function findElements(context: Context, selector: Selector, parent: Element){
-  context = refreshContext(context)
   const eyesSelector = (selector as EyesSelector)
   const root = parent ?? context
   const sel = typeof selector === 'string' ? selector : eyesSelector.selector
@@ -91,12 +95,10 @@ export function findElements(context: Context, selector: Selector, parent: Eleme
 }
 
 export function getTitle(context: Context): string {
-  context = refreshContext(context)
   return context.title
 }
 
 export function getUrl(context: Context): string {
-  context = refreshContext(context)
   return context.location.href
 }
 
@@ -105,11 +107,6 @@ export function getCookies(): Array<any> {
   return Cypress.automation('get:cookies', {})
 }
 
-// we need to method to reset the context in case the user called open before visit
-function refreshContext(context: Context) {
-  //@ts-ignore
-  return (context && context.defaultView) ? context : cy.state('window').document
-}
 
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 

package/src/plugin/config.js

@@ -1,11 +1,12 @@
 'use strict';
-const {configParams, ConfigUtils, TypeUtils} = require('@applitools/visual-grid-client');
+const utils = require('@applitools/utils');
+const {configParams, TypeUtils} = require('@applitools/visual-grid-client');
 const DEFAULT_TEST_CONCURRENCY = 5;
 const uuid = require('uuid');
 
 function makeConfig() {
-  const config = ConfigUtils.getConfig({
-    configParams: [
+  const config = utils.config.getConfig({
+    params: [
       ...configParams,
       'failCypressOnDiff',
       'tapDirPath',

package/src/plugin/server.js

@@ -1,21 +1,46 @@
 'use strict';
-const {makeHandler} = require('../../dist/plugin/handler');
 const connectSocket = require('./webSocket');
 const {makeServerProcess} = require('@applitools/eyes-universal');
 const {TestResults} = require('@applitools/visual-grid-client');
 const handleTestResults = require('./handleTestResults');
+const path = require('path');
+const fs = require('fs');
+const {Server: HttpsServer} = require('https');
+const {Server: WSServer} = require('ws');
 
 function makeStartServer({logger}) {
   return async function startServer() {
-    const {server, port} = await makeHandler({singleton: false});
+    const key = fs.readFileSync(path.resolve(__dirname, '../pem/server.key'));
+    const cert = fs.readFileSync(path.resolve(__dirname, '../pem/server.cert'));
+    let port;
 
-    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess();
+    const https = new HttpsServer({
+      key,
+      cert,
+    });
+    await https.listen(0, err => {
+      if (err) {
+        logger.log('error starting plugin server', err);
+      } else {
+        logger.log(`plugin server running at port: ${https.address().port}`);
+        port = https.address().port;
+      }
+    });
+
+    const wss = new WSServer({server: https, path: '/eyes', maxPayload: 254 * 1024 * 1024});
+
+    wss.on('close', () => https.close());
+
+    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
+      key: path.resolve(__dirname, '../pem/server.key'),
+      cert: path.resolve(__dirname, '../pem/server.cert'),
+    });
 
     const managers = [];
     let socketWithUniversal;
 
-    server.on('connection', socketWithClient => {
-      socketWithUniversal = connectSocket(`ws://localhost:${universalPort}/eyes`);
+    wss.on('connection', socketWithClient => {
+      socketWithUniversal = connectSocket(`wss://localhost:${universalPort}/eyes`);
 
       socketWithUniversal.setPassthroughListener(message => {
         logger.log('<== ', message.toString().slice(0, 1000));
@@ -69,7 +94,7 @@ function makeStartServer({logger}) {
     });
 
     return {
-      server,
+      server: wss,
       port,
       closeManager,
       closeBatches,

package/src/setup/getFilePath.js

@@ -6,12 +6,12 @@ function getFilePath(type, cypressConfig, cwd) {
   let filePath = {
     plugins: join('cypress', 'plugins', 'index.js'),
     support: join('cypress', 'support', 'index.js'),
-    typeScript: join('cypress', 'support', 'eyes-index.d.ts'),
+    typeScript: join('cypress', 'support', 'index.d.ts'),
   }[type];
 
   if (type === 'typeScript' && cypressConfig && cypressConfig[`supportFile`]) {
     const supportDir = dirname(cypressConfig[`supportFile`]);
-    filePath = resolve(supportDir, 'eyes-index.d.ts');
+    filePath = resolve(supportDir, 'index.d.ts');
   }
 
   filePath = (cypressConfig && cypressConfig[`${type}File`]) || filePath;

package/dist/plugin/handler.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeHandler = void 0;
-const http_1 = require("http");
-const ws_1 = require("ws");
-const { name, version } = require('../../package.json'); // TODO is the handshake needed at all?
-const TOKEN_HEADER = 'x-eyes-universal-token';
-const TOKEN = `${name}@${version}`;
-// TODO make default port 0 and return actual port
-async function makeHandler({ port = 31077, singleton = true, lazy = false } = {}) {
-    const http = new http_1.Server();
-    http.on('request', (request, response) => {
-        if (request.url === '/handshake') {
-            if (request.headers[TOKEN_HEADER] === TOKEN) {
-                response.writeHead(200, { [TOKEN_HEADER]: TOKEN });
-            }
-            else {
-                response.writeHead(400);
-            }
-            response.end();
-        }
-    });
-    http.listen(port, 'localhost');
-    return new Promise((resolve, reject) => {
-        http.on('listening', () => {
-            const ws = new ws_1.Server({ server: http, path: '/eyes' });
-            ws.on('close', () => http.close());
-            resolve({ server: ws, port });
-        });
-        http.on('error', async (err) => {
-            if (!lazy && err.code === 'EADDRINUSE') {
-                if (singleton && (await isHandshakable(port))) {
-                    return resolve({ port });
-                }
-                else {
-                    return resolve(await makeHandler({ port: port + 1, singleton }));
-                }
-            }
-            reject(err);
-        });
-    });
-}
-exports.makeHandler = makeHandler;
-async function isHandshakable(port) {
-    return new Promise(resolve => {
-        const handshake = http_1.request(`http://localhost:${port}/handshake`, {
-            headers: { [TOKEN_HEADER]: TOKEN },
-        });
-        handshake.on('response', ({ statusCode, headers }) => {
-            resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN);
-        });
-        handshake.on('error', () => resolve(false));
-        handshake.end();
-    });
-}

package/eyes-index.d.ts

@@ -1,34 +0,0 @@
-/// <reference types="Cypress" />
-/// <reference types="@applitools/visual-grid-client" />
-
-declare namespace Cypress {
-    interface Chainable {
-      /**
-       * Create an Applitools test.
-       * This will start a session with the Applitools server.
-       * @example
-       * cy.eyesOpen({ appName: 'My App' })
-      */
-      eyesOpen(options?: Eyes.Open.Options): null // add isDisabled
-
-      /**
-       * Generate a screenshot of the current page and add it to the Applitools Test.
-       * @example
-       * cy.eyesCheckWindow()
-       *
-       * OR
-       *
-       * cy.eyesCheckWindow({
-       *  target: 'region',
-       *  selector: '.my-element'
-       * });
-      */
-      eyesCheckWindow(config?: Eyes.Check.Options|String): null
-
-      /**
-       * Close the applitools test and check that all screenshots are valid.
-       * @example cy.eyesClose()
-      */
-      eyesClose(): null
-    }
-  }

package/src/plugin/handler.ts

@@ -1,58 +0,0 @@
-import {Server as HTTPServer, request} from 'http'
-import {Server as WSServer} from 'ws'
-
-const {name, version} = require('../../package.json') // TODO is the handshake needed at all?
-const TOKEN_HEADER = 'x-eyes-universal-token'
-const TOKEN = `${name}@${version}`
-
-// TODO make default port 0 and return actual port
-export async function makeHandler({port = 31077, singleton = true, lazy = false} = {}): Promise<{
-  server?: WSServer
-  port: number
-}> {
-  const http = new HTTPServer()
-  http.on('request', (request, response) => {
-    if (request.url === '/handshake') {
-      if (request.headers[TOKEN_HEADER] === TOKEN) {
-        response.writeHead(200, {[TOKEN_HEADER]: TOKEN})
-      } else {
-        response.writeHead(400)
-      }
-      response.end()
-    }
-  })
-
-  http.listen(port, 'localhost')
-
-  return new Promise((resolve, reject) => {
-    http.on('listening', () => {
-      const ws = new WSServer({server: http, path: '/eyes'})
-      ws.on('close', () => http.close())
-      resolve({server: ws, port})
-    })
-
-    http.on('error', async (err: Error & {code: string}) => {
-      if (!lazy && err.code === 'EADDRINUSE') {
-        if (singleton && (await isHandshakable(port))) {
-          return resolve({port})
-        } else {
-          return resolve(await makeHandler({port: port + 1, singleton}))
-        }
-      }
-      reject(err)
-    })
-  })
-}
-
-async function isHandshakable(port: number) {
-  return new Promise(resolve => {
-    const handshake = request(`http://localhost:${port}/handshake`, {
-      headers: {[TOKEN_HEADER]: TOKEN},
-    })
-    handshake.on('response', ({statusCode, headers}) => {
-      resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN)
-    })
-    handshake.on('error', () => resolve(false))
-    handshake.end()
-  })
-}