@applitools/eyes-cypress 3.26.0 → 3.26.1

package/CHANGELOG.md

@@ -8,6 +8,16 @@
 
 
 
+## 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

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,77 +1,74 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.26.0",
-  "main": "index.js",
+  "version": "3.26.1",
+  "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'",
     "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",
-    "lint": "eslint \"**/*.js\"",
-    "test": "yarn test:unit && yarn test:it && yarn test:e2e && yarn test:ts && yarn test:coverage",
+    "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.4.1",
-    "@applitools/eyes-universal": "2.5.15",
+    "@applitools/eyes-api": "1.5.2",
+    "@applitools/eyes-universal": "2.6.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.5",
-    "@applitools/visual-grid-client": "15.12.28",
-    "body-parser": "1.19.0",
+    "@applitools/logger": "1.1.8",
+    "@applitools/visual-grid-client": "15.12.38",
     "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.1.0",
+    "@applitools/bongo": "^2.1.1",
     "@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.3",
-    "@applitools/utils": "1.3.0",
-    "@types/node": "17.0.13",
+    "@applitools/types": "^1.4.5",
+    "@applitools/utils": "1.3.3",
+    "@types/node": "12",
     "@types/ws": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^5.10.2",
     "@typescript-eslint/parser": "^5.10.2",
@@ -93,9 +90,7 @@
     "prettier": "1.19.1",
     "typescript": "4.6.4"
   },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
+  "engines": {
+    "node": ">=12.13.0"
   }
 }

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/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/eyes-index.d.ts

@@ -1,48 +0,0 @@
-/// <reference types="Cypress" />
-/// <reference types="@applitools/visual-grid-client" />
-import {TestResultsSummary} from '@applitools/eyes-api';
-
-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(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
-
-      /**
-       * 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<TestResultsSummary>
-    }
-  }
-}