@applitools/eyes-cypress 3.28.0 → 3.28.2

package/CHANGELOG.md

@@ -12,6 +12,19 @@
 
 
 
+## 3.28.2 - 2023/1/17
+
+### Features
+### Bug fixes
+- Fix types to include region options when passing an element
+- Add support for region options for coded floating and accessibility when using elements
+
+## 3.28.1 - 2023/1/5
+
+### Features
+### Bug fixes
+- Wrong url when running `cypress run`
+
 ## 3.28.0 - 2022/12/28
 
 ### Features

package/bin/eyes-setup.js

@@ -1,31 +1,31 @@
 #!/usr/bin/env node
-'use strict';
+'use strict'
 
-const chalk = require('chalk');
-const handlePlugin = require('../src/setup/handlePlugin');
-const handleCommands = require('../src/setup/handleCommands');
-const {handleTypeScript} = require('../src/setup/handleTypeScript');
-const getCypressVersion = require('../src/setup/getCypressVersion');
-const getCypressPaths = require('../src/setup/getCypressPaths');
+const chalk = require('chalk')
+const handlePlugin = require('../src/setup/handlePlugin')
+const handleCommands = require('../src/setup/handleCommands')
+const {handleTypeScript} = require('../src/setup/handleTypeScript')
+const getCypressVersion = require('../src/setup/getCypressVersion')
+const getCypressPaths = require('../src/setup/getCypressPaths')
 
-const cwd = process.cwd();
-const semver = require('semver');
-const {version} = require('../package');
+const cwd = process.cwd()
+const semver = require('semver')
+const {version} = require('../package')
 
-console.log(chalk.cyan('Setup Eyes-Cypress', version));
+console.log(chalk.cyan('Setup Eyes-Cypress', version))
 
-const cypressVersion = getCypressVersion();
-console.log(chalk.cyan(`Cypress version: ${cypressVersion}`));
+const cypressVersion = getCypressVersion()
+console.log(chalk.cyan(`Cypress version: ${cypressVersion}`))
 
-const isCypress10 = semver.satisfies(cypressVersion, '>=10.0.0');
+const isCypress10 = semver.satisfies(cypressVersion, '>=10.0.0')
 try {
-  const {plugin, support, typescript} = getCypressPaths({cwd, isCypress10});
-  handlePlugin(plugin);
-  handleCommands(support);
-  handleTypeScript(typescript);
+  const {plugin, support, typescript} = getCypressPaths({cwd, isCypress10})
+  handlePlugin(plugin)
+  handleCommands(support)
+  handleTypeScript(typescript)
 } catch (err) {
-  console.log(chalk.red(`Setup error:\n${err.message}`));
-  process.exit(1);
+  console.log(chalk.red(`Setup error:\n${err.message}`))
+  process.exit(1)
 }
 
-console.log(chalk.cyan('Setup done!'));
+console.log(chalk.cyan('Setup done!'))

package/dist/browser/spec-driver.js

@@ -3,9 +3,7 @@ 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) {
     let scriptToExecute;
-    if (script.includes('dom-snapshot') ||
-        script.includes('dom-capture') ||
-        script.includes('dom-shared')) {
+    if (script.includes('dom-snapshot') || script.includes('dom-capture') || script.includes('dom-shared')) {
         scriptToExecute = script;
     }
     else {
@@ -26,7 +24,6 @@ function parentContext(context) {
     if (!context) {
         throw new Error('Context is not accessible');
     }
-    ;
     return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
 }
 exports.parentContext = parentContext;
@@ -43,7 +40,7 @@ function getViewportSize() {
     const currWindow = cy.state('window');
     const viewportSize = {
         width: currWindow.innerWidth || currWindow.document.documentElement.clientWidth || currWindow.document.body.clientWidth,
-        height: currWindow.innerHeight || currWindow.document.documentElement.clientHeight || currWindow.document.body.clientHeight
+        height: currWindow.innerHeight || currWindow.document.documentElement.clientHeight || currWindow.document.body.clientHeight,
     };
     return viewportSize;
 }

package/index.d.ts

@@ -6,6 +6,7 @@ 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>
+type ElementWithOptions = {element: Element, regionId?: string, padding?: any}
 
 interface CypressCheckSettings extends api.CheckSettingsAutomationPlain<Element, Selector>{
   tag?: CypressCheckSettings['name']
@@ -14,12 +15,12 @@ interface CypressCheckSettings extends api.CheckSettingsAutomationPlain<Element,
   selector?: Selector
   element?: Element
 
-  ignore?: MaybeArray<NonNullable<CypressCheckSettings['ignoreRegions']>[number] | LegacyRegion>
-  layout?: MaybeArray<NonNullable<CypressCheckSettings['layoutRegions']>[number] | LegacyRegion>
-  content?: MaybeArray<NonNullable<CypressCheckSettings['contentRegions']>[number] | LegacyRegion>
-  strict?: MaybeArray<NonNullable<CypressCheckSettings['strictRegions']>[number] | LegacyRegion>
-  floating?: MaybeArray<NonNullable<CypressCheckSettings['floatingRegions']>[number] | (({element: Element} | Selector | LegacyRegion) & {maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number})>
-  accessibility?: MaybeArray<NonNullable<CypressCheckSettings['accessibilityRegions']>[number] | (({element: Element} | Selector | LegacyRegion) & {accessibilityType?: api.AccessibilityRegionTypePlain})>
+  ignore?: MaybeArray<NonNullable<CypressCheckSettings['ignoreRegions']>[number] | LegacyRegion | ElementWithOptions>
+  layout?: MaybeArray<NonNullable<CypressCheckSettings['layoutRegions']>[number] | LegacyRegion| ElementWithOptions>
+  content?: MaybeArray<NonNullable<CypressCheckSettings['contentRegions']>[number] | LegacyRegion| ElementWithOptions>
+  strict?: MaybeArray<NonNullable<CypressCheckSettings['strictRegions']>[number] | LegacyRegion | ElementWithOptions>
+  floating?: MaybeArray<NonNullable<CypressCheckSettings['floatingRegions']>[number] | ((ElementWithOptions | Selector | LegacyRegion) & {maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number})>
+  accessibility?: MaybeArray<NonNullable<CypressCheckSettings['accessibilityRegions']>[number] | ((ElementWithOptions | Selector | LegacyRegion) & {accessibilityType?: api.AccessibilityRegionTypePlain})>
   scriptHooks?: CypressCheckSettings['hooks']
   ignoreCaret?: boolean
   ignoreDisplacements?: boolean

package/index.js

@@ -1,2 +1,2 @@
-'use strict';
-module.exports = require('./src/plugin/startPlugin');
+'use strict'
+module.exports = require('./src/plugin/startPlugin')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.28.0",
+  "version": "3.28.2",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -56,11 +56,11 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "1.3.6",
-    "@applitools/eyes-api": "1.11.5",
+    "@applitools/core": "1.4.0",
+    "@applitools/eyes-api": "1.12.0",
     "@applitools/eyes-universal": "2.18.0",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.36",
+    "@applitools/logger": "1.1.40",
     "chalk": "3.0.0",
     "semver": "7.3.8",
     "uuid": "8.3.2",
@@ -68,13 +68,13 @@
     "ws": "8.5.0"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.2.0",
+    "@applitools/bongo": "^2.2.2",
     "@applitools/scripts": "1.2.0",
     "@applitools/sdk-coverage-tests": "^2.7.10",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.16",
-    "@applitools/test-utils": "1.5.5",
-    "@applitools/utils": "1.3.22",
+    "@applitools/test-server": "1.1.20",
+    "@applitools/test-utils": "1.5.8",
+    "@applitools/utils": "1.3.26",
     "@types/node": "12",
     "@types/which": "^2.0.1",
     "@types/ws": "^8.2.2",
@@ -85,16 +85,18 @@
     "cookie-parser": "1.4.4",
     "cypress": "9.7.0",
     "eslint": "8.10.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-mocha-no-only": "1.1.0",
-    "eslint-plugin-node": "7.0.1",
-    "eslint-plugin-prettier": "2.7.0",
+    "eslint-plugin-no-only-tests": "^3.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "husky": "4.3.8",
     "lodash.omit": "4.5.0",
     "mocha": "8.0.1",
     "morgan": "1.9.1",
     "ncp": "2.0.0",
     "node-fetch": "2.6.0",
-    "prettier": "1.19.1",
+    "prettier": "^2.6.2",
     "typescript": "4.8.4"
   },
   "engines": {

package/src/browser/commands.js

@@ -1,45 +1,44 @@
 /* global Cypress,cy,after */
-'use strict';
-const spec = require('../../dist/browser/spec-driver');
-const Refer = require('./refer');
-const Socket = require('./socket');
-const {socketCommands} = require('./socketCommands');
-const {eyesOpenMapValues} = require('./eyesOpenMapping');
-const {eyesCheckMapValues} = require('./eyesCheckMapping');
-const {TestResultsSummary} = require('@applitools/eyes-api');
-const refer = new Refer();
-const socket = new Socket();
-const throwErr = Cypress.config('failCypressOnDiff');
-socketCommands(socket, refer);
-let connectedToUniversal = false;
+'use strict'
+const spec = require('../../dist/browser/spec-driver')
+const Refer = require('./refer')
+const Socket = require('./socket')
+const {socketCommands} = require('./socketCommands')
+const {eyesOpenMapValues} = require('./eyesOpenMapping')
+const {eyesCheckMapValues} = require('./eyesCheckMapping')
+const {TestResultsSummary} = require('@applitools/eyes-api')
+const refer = new Refer()
+const socket = new Socket()
+const throwErr = Cypress.config('failCypressOnDiff')
+socketCommands(socket, refer)
+let connectedToUniversal = false
 
 let manager,
   eyes,
-  closePromiseArr = [];
+  closePromiseArr = []
 
 function getGlobalConfigProperty(prop) {
-  const property = Cypress.config(prop);
-  const shouldParse = ['eyesBrowser', 'eyesLayoutBreakpoints'];
-  return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined;
+  const property = Cypress.config(prop)
+  const shouldParse = ['eyesBrowser', 'eyesLayoutBreakpoints']
+  return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined
 }
 
 const shouldUseBrowserHooks =
   !getGlobalConfigProperty('eyesIsDisabled') &&
-  (getGlobalConfigProperty('isInteractive') ||
-    !getGlobalConfigProperty('eyesIsGlobalHooksSupported'));
+  (getGlobalConfigProperty('isInteractive') || !getGlobalConfigProperty('eyesIsGlobalHooksSupported'))
 
 Cypress.Commands.add('eyesGetAllTestResults', () => {
-  Cypress.log({name: 'Eyes: getAllTestResults'});
+  Cypress.log({name: 'Eyes: getAllTestResults'})
   return cy.then({timeout: 86400000}, async () => {
     if (isCurrentTestDisabled) {
-      isCurrentTestDisabled = false;
-      return;
+      isCurrentTestDisabled = false
+      return
     }
-    await Promise.all(closePromiseArr);
-    const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
+    await Promise.all(closePromiseArr)
+    const summary = await socket.request('EyesManager.closeManager', {manager, throwErr})
 
     const deleteTest = ({settings: {testId, batchId, secretToken}}) => {
-      const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile');
+      const {serverUrl, proxy, apiKey} = Cypress.config('appliConfFile')
       return socket.request('Core.deleteTest', {
         settings: {
           testId,
@@ -49,22 +48,22 @@ Cypress.Commands.add('eyesGetAllTestResults', () => {
           proxy,
           apiKey,
         },
-      });
-    };
+      })
+    }
     summary.results = summary.results.map(res => {
-      return {...res, result: res.testResults, error: res.exception, renderer: res.browserInfo};
-    });
-    return new TestResultsSummary({summary, deleteTest});
-  });
-});
+      return {...res, result: res.testResults, error: res.exception, renderer: res.browserInfo}
+    })
+    return new TestResultsSummary({summary, deleteTest})
+  })
+})
 
 if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
   after(() => {
-    if (!manager) return;
+    if (!manager) return
     return cy.then({timeout: 86400000}, async () => {
       if (isCurrentTestDisabled) {
-        isCurrentTestDisabled = false;
-        return;
+        isCurrentTestDisabled = false
+        return
       }
       const resultConfig = {
         showLogs: Cypress.config('appliConfFile').showLogs,
@@ -73,63 +72,59 @@ if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
         tapDirPath: Cypress.config('appliConfFile').tapDirPath,
         tapFileName: Cypress.config('appliConfFile').tapFileName,
         shouldCreateTapFile: shouldUseBrowserHooks,
-      };
-      await Promise.all(closePromiseArr);
-      const summary = await socket.request('EyesManager.closeManager', {manager, throwErr});
-      const testResults = summary.results.map(({testResults}) => testResults);
-      const message = await socket.request('Test.printTestResults', {testResults, resultConfig});
+      }
+      await Promise.all(closePromiseArr)
+      const summary = await socket.request('EyesManager.closeManager', {manager, throwErr})
+      const testResults = summary.results.map(({testResults}) => testResults)
+      const message = await socket.request('Test.printTestResults', {testResults, resultConfig})
       if (
         !!getGlobalConfigProperty('eyesFailCypressOnDiff') &&
         message &&
         message.includes('Eyes-Cypress detected diffs or errors')
       ) {
-        throw new Error(message);
+        throw new Error(message)
       }
-    });
-  });
+    })
+  })
 }
 
-let isCurrentTestDisabled;
+let isCurrentTestDisabled
 
-Cypress.Commands.add('eyesOpen', function(args = {}) {
-  Cypress.log({name: 'Eyes: open'});
-  Cypress.config('eyesOpenArgs', args);
-  const {title: testName} = this.currentTest || this.test || Cypress.currentTest;
+Cypress.Commands.add('eyesOpen', function (args = {}) {
+  Cypress.log({name: 'Eyes: open'})
+  Cypress.config('eyesOpenArgs', args)
+  const {title: testName} = this.currentTest || this.test || Cypress.currentTest
 
   if (Cypress.config('eyesIsDisabled') && args.isDisabled === false) {
     throw new Error(
       `Eyes-Cypress is disabled by an env variable or in the applitools.config.js file, but the "${testName}" test was passed isDisabled:false. A single test cannot be enabled when Eyes.Cypress is disabled through the global configuration. Please remove "isDisabled:false" from cy.eyesOpen() for this test, or enable Eyes.Cypress in the global configuration, either by unsetting the APPLITOOLS_IS_DISABLED env var, or by deleting 'isDisabled' from the applitools.config.js file.`,
-    );
+    )
   }
-  isCurrentTestDisabled = getGlobalConfigProperty('eyesIsDisabled') || args.isDisabled;
-  if (isCurrentTestDisabled) return;
+  isCurrentTestDisabled = getGlobalConfigProperty('eyesIsDisabled') || args.isDisabled
+  if (isCurrentTestDisabled) return
 
   return cy.then({timeout: 86400000}, async () => {
-    setRootContext();
-    const driver = refer.ref(cy.state('window').document);
+    setRootContext()
+    const driver = refer.ref(cy.state('window').document)
 
     if (!connectedToUniversal) {
-      socket.connect(`wss://localhost:${Cypress.config('eyesPort')}/eyes`);
-      connectedToUniversal = true;
+      socket.connect(`wss://localhost:${Cypress.config('eyesPort')}/eyes`)
+      connectedToUniversal = true
       socket.emit('Core.makeSDK', {
         name: 'eyes.cypress',
         version: require('../../package.json').version,
         commands: Object.keys(spec).concat(['isSelector', 'isDriver', 'isElement']), // TODO fix spec.isSelector and spec.isDriver and spec.isElement in driver utils
-      });
+      })
 
       manager =
         manager ||
         (await socket.request(
           'Core.makeManager',
-          Object.assign(
-            {},
-            {concurrency: Cypress.config('eyesTestConcurrency')},
-            {legacy: false, type: 'vg'},
-          ),
-        ));
+          Object.assign({}, {concurrency: Cypress.config('eyesTestConcurrency')}, {legacy: false, type: 'vg'}),
+        ))
     }
 
-    const appliConfFile = Cypress.config('appliConfFile');
+    const appliConfFile = Cypress.config('appliConfFile')
     const config = eyesOpenMapValues({
       args,
       appliConfFile,
@@ -140,48 +135,48 @@ Cypress.Commands.add('eyesOpen', function(args = {}) {
         height: Cypress.config('viewportHeight'),
         name: 'chrome',
       },
-    });
-    eyes = await socket.request('EyesManager.openEyes', {manager, driver, config});
-  });
-});
+    })
+    eyes = await socket.request('EyesManager.openEyes', {manager, driver, config})
+  })
+})
 
 Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
   cy.then({timeout: 86400000}, () => {
-    if (isCurrentTestDisabled) return;
+    if (isCurrentTestDisabled) return
 
-    setRootContext();
-    const driver = refer.ref(cy.state('window').document);
+    setRootContext()
+    const driver = refer.ref(cy.state('window').document)
 
-    Cypress.log({name: 'Eyes: check window'});
+    Cypress.log({name: 'Eyes: check window'})
 
-    const checkSettings = eyesCheckMapValues({args, refer});
+    const checkSettings = eyesCheckMapValues({args, refer})
 
     return socket.request('Eyes.check', {
       eyes,
       settings: checkSettings,
       driver,
-    });
+    })
   }),
-);
+)
 
 Cypress.Commands.add('eyesClose', () => {
   return cy.then({timeout: 86400000}, () => {
-    if (isCurrentTestDisabled) return;
+    if (isCurrentTestDisabled) return
 
-    Cypress.log({name: 'Eyes: close'});
+    Cypress.log({name: 'Eyes: close'})
     if (isCurrentTestDisabled) {
-      isCurrentTestDisabled = false;
-      return;
+      isCurrentTestDisabled = false
+      return
     }
 
     // intentionally not returning the result in order to not wait on the close promise
     const p = socket.request('Eyes.close', {eyes, throwErr: false}).catch(err => {
-      console.log('Error in cy.eyesClose', err);
-    });
-    closePromiseArr.push(p);
-  });
-});
+      console.log('Error in cy.eyesClose', err)
+    })
+    closePromiseArr.push(p)
+  })
+})
 
 function setRootContext() {
-  cy.state('window').document['applitools-marker'] = 'root-context';
+  cy.state('window').document['applitools-marker'] = 'root-context'
 }