@applitools/eyes-cypress 3.29.0 → 3.30.0

package/src/browser/eyesOpenMapping.js

@@ -14,8 +14,6 @@ const batchPropertiesRetriever = (args, appliConfFile) => {
   }
 }
 function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks}) {
-  let browsersInfo = args.browser || appliConfFile.browser
-  let accessibilitySettings = args.accessibilityValidation || appliConfFile.accessibilityValidation
   const batchProperties = batchPropertiesRetriever(args, appliConfFile)
   const batch = {
     id: batchProperties('batchId', 'id'),
@@ -45,18 +43,7 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     'batchSequenceName',
   ]
 
-  if (browsersInfo) {
-    if (Array.isArray(browsersInfo)) {
-      for (const [index, value] of browsersInfo.entries()) {
-        browsersInfo[index] = fillDefaultBrowserName(value)
-      }
-    } else {
-      browsersInfo = [fillDefaultBrowserName(browsersInfo)]
-    }
-  }
-
   const defaultMatchSettings = {
-    accessibilitySettings,
     matchLevel: args.matchLevel || appliConfFile.matchLevel,
     ignoreCaret: args.ignoreCaret || appliConfFile.ignoreCaret,
     useDom: args.useDom || appliConfFile.useDom,
@@ -75,27 +62,34 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
   }
 
   const mappedArgs = {
+    ...defaultMatchSettings,
     ...args,
-    browsersInfo,
-    defaultMatchSettings,
     batch,
   }
+  if (typeof args.viewportSize !== 'undefined' || typeof args.environment !== 'undefined') {
+    mappedArgs.environment = {viewportSize: args.viewportSize, ...args.environment}
+  }
 
-  return Object.assign({testName, dontCloseBatches: !shouldUseBrowserHooks}, appliConfFileCopy, mappedArgs)
+  return Object.assign({testName, keepBatchOpen: !shouldUseBrowserHooks}, appliConfFileCopy, mappedArgs)
 }
 
-function fillDefaultBrowserName(browser) {
-  if (!browser.iosDeviceInfo && !browser.chromeEmulationInfo) {
-    if (!browser.name) {
-      browser.name = 'chrome'
-    }
-    if (browser.deviceName) {
-      browser = {chromeEmulationInfo: browser}
+function eyesOpenToCheckMapValues(args) {
+  const {browser, waitBeforeCapture, layoutBreakpoints, accessibilityValidation} = args
+
+  const openToCheckSettingsArgs = {
+    browser,
+    waitBeforeCapture,
+    layoutBreakpoints,
+  }
+
+  if (accessibilityValidation) {
+    const {level, guidelinesVersion} = accessibilityValidation
+    openToCheckSettingsArgs.accessibilitySettings = {
+      level,
+      version: guidelinesVersion,
     }
-    return browser
-  } else {
-    return browser
   }
+  return openToCheckSettingsArgs
 }
 
-module.exports = {eyesOpenMapValues}
+module.exports = {eyesOpenMapValues, eyesOpenToCheckMapValues}

package/src/expose.ts

@@ -8,6 +8,7 @@
  **/
 /// <reference types="cypress" />
 import type * as api from '@applitools/eyes-api'
+import type * as core from '@applitools/core'
 import {type EyesSelector, type TestResultsStatus} from '@applitools/eyes-api'
 
 export type {EyesSelector, TestResultsStatus}
@@ -15,11 +16,12 @@ export type {EyesSelector, TestResultsStatus}
 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 Selector = {selector: string; type?: 'css' | 'xpath'; nodeType?: 'element' | 'shadow-root'} | string
 type Element = HTMLElement | JQuery<HTMLElement>
 type ElementWithOptions = {element: Element; regionId?: string; padding?: any}
+type SpecType = core.SpecType<unknown, unknown, Element, Selector>
 
-export type CypressCheckSettings = api.CheckSettingsAutomationPlain<Element, Selector> & {
+export type CypressCheckSettings = api.CheckSettingsAutomationPlain<SpecType> & {
   tag?: CypressCheckSettings['name']
 
   target?: 'window' | 'region'
@@ -47,7 +49,7 @@ export type CypressCheckSettings = api.CheckSettingsAutomationPlain<Element, Sel
   ignoreCaret?: boolean
   ignoreDisplacements?: boolean
 }
-export type CypressEyesConfig = api.ConfigurationPlain<Element, Selector> & {
+export type CypressEyesConfig = api.ConfigurationPlain<SpecType> & {
   browser?: MaybeArray<
     | NonNullable<CypressEyesConfig['browsersInfo']>[number]
     | {deviceName: string; screenOrientation?: api.ScreenOrientationPlain; name?: string}

package/src/plugin/hooks.ts

@@ -35,7 +35,7 @@ export default function makeGlobalRunHooks({closeManager, closeBatches, closeUni
 
         let testResults
         for (const summary of summaries) {
-          testResults = summary.results.map(({testResults}: any) => testResults)
+          testResults = summary.results.map(({result}: any) => result)
         }
         if (!config.appliConfFile.dontCloseBatches) {
           await closeBatches({
@@ -47,7 +47,7 @@ export default function makeGlobalRunHooks({closeManager, closeBatches, closeUni
         }
 
         if (config.appliConfFile.tapDirPath) {
-          await handleTestResults.handleBatchResultsFile(testResults, {
+          handleTestResults.handleBatchResultsFile(testResults, {
             tapDirPath: config.appliConfFile.tapDirPath,
             tapFileName: config.appliConfFile.tapFileName,
           })

package/src/plugin/pluginExport.ts

@@ -55,7 +55,7 @@ export default function makePluginExport({startServer, eyesConfig}: any) {
       return pluginInitArgs
     }
     return function getCloseServer() {
-      return eyesServer.close()
+      return new Promise<void>(res => eyesServer.close(() => res()))
     }
 
     async function setupNodeEvents(

package/src/plugin/server.ts

@@ -1,7 +1,5 @@
 import connectSocket, {type SocketWithUniversal} from './webSocket'
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import {makeServerProcess} from '@applitools/eyes-universal'
+import {makeCoreServerProcess} from '@applitools/core'
 import handleTestResults from './handleTestResults'
 import path from 'path'
 import fs from 'fs'
@@ -44,7 +42,7 @@ export default function makeStartServer({logger}: {logger: Logger}) {
       forkOptions.execPath = await which('node')
     }
 
-    const {port: universalPort, close: closeUniversalServer} = await makeServerProcess({
+    const {port: universalPort, close: closeUniversalServer} = await makeCoreServerProcess({
       idleTimeout: 0,
       shutdownMode: 'stdin',
       forkOptions,
@@ -126,16 +124,13 @@ export default function makeStartServer({logger}: {logger: Logger}) {
     function closeManager() {
       return Promise.all(
         managers.map(({manager, socketWithUniversal}) =>
-          socketWithUniversal.request('EyesManager.closeManager', {
-            manager,
-            throwErr: false,
-          }),
+          socketWithUniversal.request('EyesManager.getResults', {manager, settings: {throwErr: false}}),
         ),
       )
     }
     function closeBatches(settings: any) {
       if (socketWithUniversal)
-        return socketWithUniversal.request('Core.closeBatches', {settings}).catch((err: Error) => {
+        return socketWithUniversal.request('Core.closeBatch', {settings}).catch((err: Error) => {
           logger.log('@@@', err)
         })
     }

package/src/setup/handlePlugin.js

@@ -25,7 +25,7 @@ export default ${chalk.green.bold('eyesPlugin(')}definedConfig({
   //...
 })${chalk.green.bold(')')}
 
-For more information, visit Eyes-Cypress documentation https://www.npmjs.com/package/@applitools/eyes-cypress (manual configuration section)
+For more information, visit Eyes-Cypress documentation https://applitools.com/docs/api-ref/sdk-api/cypress/typescript
 `,
         {padding: 1, borderColor: 'cyan'},
       ),