@applitools/eyes-cypress 3.36.2 → 3.37.0

package/CHANGELOG.md

@@ -1,5 +1,151 @@
 # Changelog
 
+## [3.37.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-cypress@3.36.2...js/eyes-cypress@3.37.0) (2023-08-18)
+
+
+### Features
+
+* add the option to fail on diffs after all spec files ([#1844](https://github.com/applitools/eyes.sdk.javascript1/issues/1844)) ([ca2510d](https://github.com/applitools/eyes.sdk.javascript1/commit/ca2510d094a921c9561b9b9e9094d763a6abce2f))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.5.1
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+* @applitools/logger bumped to 2.0.8
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/socket bumped to 1.1.8
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/req bumped to 1.5.3
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/image bumped to 1.1.3
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/snippets bumped to 2.4.23
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+* @applitools/spec-driver-webdriver bumped to 1.0.42
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.56
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.1.73
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/driver bumped to 1.13.5
+  #### Bug Fixes
+
+  * optimize driver usage in close ([#1867](https://github.com/applitools/eyes.sdk.javascript1/issues/1867)) ([60dff6b](https://github.com/applitools/eyes.sdk.javascript1/commit/60dff6b160e69d3893c91a1125d668fa18b43072))
+
+
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/screenshoter bumped to 3.8.8
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/nml-client bumped to 1.5.8
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/tunnel-client bumped to 1.2.0
+  #### Features
+
+  * replace and destroy tunnels by tunnel id ([#1878](https://github.com/applitools/eyes.sdk.javascript1/issues/1878)) ([22bcc15](https://github.com/applitools/eyes.sdk.javascript1/commit/22bcc15b31457e3da56cdb6f73bee3dcb7e051a1))
+
+
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/ufg-client bumped to 1.7.1
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/ec-client bumped to 1.7.5
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/core-base bumped to 1.5.1
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/core bumped to 3.9.1
+  #### Bug Fixes
+
+  * optimize driver usage in close ([#1867](https://github.com/applitools/eyes.sdk.javascript1/issues/1867)) ([60dff6b](https://github.com/applitools/eyes.sdk.javascript1/commit/60dff6b160e69d3893c91a1125d668fa18b43072))
+
+
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/eyes bumped to 1.7.3
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+
 ## [3.36.2](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-cypress@3.36.1...js/eyes-cypress@3.36.2) (2023-08-10)
 
 

package/dist/browser/transformCypressConfig.js

@@ -43,7 +43,7 @@ function transformCypressConfig(config) {
                 sequenceName: (_e = config.batchSequenceName) !== null && _e !== void 0 ? _e : (_f = config.batch) === null || _f === void 0 ? void 0 : _f.sequenceName,
                 notifyOnCompletion: (_g = config.notifyOnCompletion) !== null && _g !== void 0 ? _g : (_h = config.batch) === null || _h === void 0 ? void 0 : _h.notifyOnCompletion,
             },
-            keepBatchOpen: !config.shouldUseBrowserHooks,
+            keepBatchOpen: !config.shouldDoPostSpecTasks,
             environmentName: config.envName,
             baselineBranchName: config.baselineBranchName,
             branchName: config.branchName,

package/dist/plugin/handleTestResults.js

@@ -16,7 +16,7 @@ function printTestResults(testResultsArr) {
     if (!testResultsArr.testResults)
         return;
     const { passed, failed, diffs } = (0, getErrorsAndDiffs_1.default)(testResultsArr.testResults);
-    if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.eyesFailCypressOnDiff) {
+    if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.shouldThrowError) {
         throw new Error((0, errorDigest_1.default)({
             passed,
             failed,

package/dist/plugin/hooks.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const handleTestResults_1 = __importDefault(require("./handleTestResults"));
-function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer, }) {
+function makeGlobalRunHooks({ closeManagers, closeBatches, closeUniversalServer, }) {
     return {
         'before:run': ({ config }) => {
             if (!config.isTextTerminal)
@@ -14,11 +14,8 @@ function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer,
             try {
                 if (!config.isTextTerminal)
                     return;
-                const summaries = await closeManager();
-                let testResults;
-                for (const summary of summaries) {
-                    testResults = summary.results.map(({ result }) => result);
-                }
+                const summaries = await closeManagers();
+                const testResults = summaries.map(({ results }) => results.map(({ result }) => result)).flat();
                 if (!config.appliConfFile.dontCloseBatches) {
                     await closeBatches({
                         batchId: config.appliConfFile.batchId || config.appliConfFile.batch.id,
@@ -33,6 +30,17 @@ function makeGlobalRunHooks({ closeManager, closeBatches, closeUniversalServer,
                         tapFileName: config.appliConfFile.tapFileName,
                     });
                 }
+                const resultConfig = {
+                    showLogs: config.appliConfFile.showLogs,
+                    shouldThrowError: config.appliConfFile.failCypressAfterAllSpecs,
+                };
+                if (config.appliConfFile.failCypressAfterAllSpecs) {
+                    // we want to throw an exception in case we have a least one test with diffs
+                    // we create a runner per spec file, therefore we could have multiple summeries
+                    for (const summary of summaries) {
+                        handleTestResults_1.default.printTestResults({ testResults: summary.results.map(({ result }) => result), resultConfig });
+                    }
+                }
             }
             finally {
                 await closeUniversalServer();

package/dist/plugin/pluginExport.js

@@ -61,10 +61,10 @@ function makePluginExport({ startServer, eyesConfig, }) {
             return new Promise(res => eyesServer.close(() => res()));
         };
         async function setupNodeEvents(origOn, cypressConfig) {
-            const { server, port, closeManager, closeBatches, closeUniversalServer } = await startServer(cypressConfig);
+            const { server, port, closeManagers, closeBatches, closeUniversalServer } = await startServer(cypressConfig);
             eyesServer = server;
             const globalHooks = (0, hooks_1.default)({
-                closeManager,
+                closeManagers,
                 closeBatches,
                 closeUniversalServer,
             });

package/dist/plugin/server.js

@@ -85,11 +85,11 @@ function makeStartServer({ logger, eyesConfig }) {
         return {
             server: wss,
             port,
-            closeManager,
+            closeManagers,
             closeBatches,
             closeUniversalServer,
         };
-        function closeManager() {
+        function closeManagers() {
             return Promise.all(managers.map(({ manager, socketWithUniversal }) => socketWithUniversal.request('EyesManager.getResults', {
                 manager,
                 settings: { throwErr: false, removeDuplicateTests: eyesConfig.eyesRemoveDuplicateTests },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.36.2",
+  "version": "3.37.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -42,7 +42,7 @@
     "cypress12": "../../node_modules/cypress12/bin/cypress",
     "test:ts:run:12": "yarn cypress12 run --project ./test/e2e/ts --config-file ./cypress-12.config.ts",
     "test:ts:run": "yarn cypress$APPLITOOLS_FRAMEWORK_VERSION run --project ./test/e2e/ts --config-file ./cypress-$APPLITOOLS_FRAMEWORK_VERSION.config.ts",
-    "test:coverage": "cd test/coverage && yarn && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:coverage": "cd test/generic && yarn && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
     "test:e2e": "mkdir -p test/fixtures/testAppCopies && run --top-level mocha --no-timeouts 'test/e2e/**/*.test.js'",
     "test:components": "cd test/components && yarn && npx cypress run --component",
     "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
@@ -54,11 +54,11 @@
     "setup": "run --top-level xvfb:setup"
   },
   "dependencies": {
-    "@applitools/core": "3.9.0",
-    "@applitools/eyes": "1.7.2",
+    "@applitools/core": "3.9.1",
+    "@applitools/eyes": "1.7.3",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "2.0.7",
-    "@applitools/utils": "1.5.0",
+    "@applitools/logger": "2.0.8",
+    "@applitools/utils": "1.5.1",
     "boxen": "5.1.2",
     "chalk": "3.0.0",
     "semver": "7.3.8",
@@ -67,8 +67,8 @@
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.21",
-    "@applitools/bongo": "^5.4.3",
-    "@applitools/generic": "^3.3.8",
+    "@applitools/bongo": "^5.6.1",
+    "@applitools/generic": "^3.3.9",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
@@ -89,7 +89,9 @@
     "mocha": "^10.2.0",
     "morgan": "1.9.1",
     "ncp": "2.0.0",
-    "node-fetch": "2.6.0"
+    "node-fetch": "2.6.0",
+    "strip-ansi": "^6.0.1",
+    "typescript": "^5.1.6"
   },
   "engines": {
     "node": ">=12.13.0"

package/src/browser/commands.js

@@ -41,10 +41,15 @@ function getGlobalConfigProperty(prop) {
   return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined
 }
 
-const shouldUseBrowserHooks =
+// tasks = tapFile and closeBatch
+const shouldDoPostSpecTasks =
   !getGlobalConfigProperty('eyesIsDisabled') &&
   (getGlobalConfigProperty('isInteractive') || !getGlobalConfigProperty('eyesIsGlobalHooksSupported'))
 
+const shouldCallAfterHook =
+  (shouldDoPostSpecTasks || Cypress.config('eyesFailCypressOnDiff')) &&
+  !Cypress.config('appliConfFile').failCypressAfterAllSpecs
+
 Cypress.Commands.add('eyesGetAllTestResults', () => {
   Cypress.log({name: 'Eyes: getAllTestResults'})
   return cy.then({timeout: 86400000}, async () => {
@@ -66,7 +71,7 @@ Cypress.Commands.add('eyesGetResults', (args = {}) => {
   })
 })
 
-if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
+if (shouldCallAfterHook) {
   after(() => {
     if (!manager) return
     return cy.then({timeout: 86400000}, async () => {
@@ -76,11 +81,11 @@ if (shouldUseBrowserHooks || Cypress.config('eyesFailCypressOnDiff')) {
       }
       const resultConfig = {
         showLogs: Cypress.config('appliConfFile').showLogs,
-        eyesFailCypressOnDiff: Cypress.config('eyesFailCypressOnDiff'),
+        shouldThrowError: Cypress.config('eyesFailCypressOnDiff'),
         isTextTerminal: Cypress.config('isTextTerminal'),
         tapDirPath: Cypress.config('appliConfFile').tapDirPath,
         tapFileName: Cypress.config('appliConfFile').tapFileName,
-        shouldCreateTapFile: shouldUseBrowserHooks,
+        shouldCreateTapFile: shouldDoPostSpecTasks,
       }
 
       const summary = await getSummary()
@@ -140,7 +145,7 @@ Cypress.Commands.add('eyesOpen', function (args = {}) {
     const mergedConfig = mergeCypressConfigs({globalConfig: appliConfFile, openConfig: {testName, ...args}})
     openAndGlobalConfig = transformCypressConfig({
       ...mergedConfig,
-      shouldUseBrowserHooks,
+      shouldDoPostSpecTasks,
       isComponentTest: Cypress.config('isComponent'),
     })
 

package/src/browser/transformCypressConfig.ts

@@ -1,9 +1,9 @@
-import type {CypressEyesConfig} from '../expose'
+import type {appliConfFile} from '../expose'
 import type {SpecType, Config} from '@applitools/core'
 import {transformBrowsers, transformAccessibilityValidation} from './utils'
 import * as utils from '@applitools/utils'
 
-export function transformCypressConfig(config: CypressEyesConfig): Config<SpecType, 'ufg'> {
+export function transformCypressConfig(config: appliConfFile): Config<SpecType, 'ufg'> {
   return {
     open: {
       apiKey: config.apiKey,
@@ -19,7 +19,7 @@ export function transformCypressConfig(config: CypressEyesConfig): Config<SpecTy
         sequenceName: config.batchSequenceName ?? config.batch?.sequenceName,
         notifyOnCompletion: config.notifyOnCompletion ?? config.batch?.notifyOnCompletion,
       },
-      keepBatchOpen: !config.shouldUseBrowserHooks,
+      keepBatchOpen: !config.shouldDoPostSpecTasks,
       environmentName: config.envName,
       baselineBranchName: config.baselineBranchName,
       branchName: config.branchName,

package/src/expose.ts

@@ -89,11 +89,16 @@ export type CypressEyesConfig = api.ConfigurationPlain<SpecType> & {
   scriptHooks?: {
     beforeCaptureScreenshot: string
   }
-  saveNewTests?: boolean
-  /** @internal */
-  shouldUseBrowserHooks?: boolean
-  /* @internal */
+}
+
+export type appliConfFile = CypressEyesConfig & {
+  failCypressAfterAllSpecs?: boolean
+  tapDirPath?: string
+  tapFileName?: string
+  showLogs?: boolean
+  shouldDoPostSpecTasks?: boolean
   isComponentTest?: boolean
+  saveNewTests?: boolean
 }
 
 export type CypressTestResultsSummary = api.TestResultsSummary

package/src/plugin/handleTestResults.ts

@@ -11,7 +11,7 @@ function printTestResults(testResultsArr: any) {
   })
   if (!testResultsArr.testResults) return
   const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults)
-  if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.eyesFailCypressOnDiff) {
+  if ((failed.length || diffs.length) && !!testResultsArr.resultConfig.shouldThrowError) {
     throw new Error(
       errorDigest({
         passed,

package/src/plugin/hooks.ts

@@ -1,27 +1,19 @@
 import handleTestResults from './handleTestResults'
 import {type StartServerReturn} from './server'
 export type EyesCypressAction = 'before:run' | 'after:run'
+import type {appliConfFile} from '../expose'
 
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Cypress {
     interface ResolvedConfigOptions {
-      appliConfFile: {
-        dontCloseBatches: boolean
-        batch: any
-        serverUrl: string
-        proxy: any // TODO: add proxy type
-        apiKey: string
-        batchId: string
-        tapDirPath: string
-        tapFileName: string
-      }
+      appliConfFile: appliConfFile
     }
   }
 }
 
 export default function makeGlobalRunHooks({
-  closeManager,
+  closeManagers,
   closeBatches,
   closeUniversalServer,
 }: Omit<StartServerReturn, 'server' | 'port'>): {
@@ -36,12 +28,10 @@ export default function makeGlobalRunHooks({
     'after:run': async ({config}: CypressCommandLine.CypressRunResult) => {
       try {
         if (!(config as Cypress.Config).isTextTerminal) return
-        const summaries = await closeManager()
+        const summaries = await closeManagers()
+
+        const testResults = summaries.map(({results}) => results.map(({result}) => result)).flat()
 
-        let testResults
-        for (const summary of summaries) {
-          testResults = summary.results.map(({result}: any) => result)
-        }
         if (!config.appliConfFile.dontCloseBatches) {
           await closeBatches({
             batchId: config.appliConfFile.batchId || config.appliConfFile.batch.id,
@@ -57,6 +47,17 @@ export default function makeGlobalRunHooks({
             tapFileName: config.appliConfFile.tapFileName,
           })
         }
+        const resultConfig = {
+          showLogs: config.appliConfFile.showLogs,
+          shouldThrowError: config.appliConfFile.failCypressAfterAllSpecs,
+        }
+        if (config.appliConfFile.failCypressAfterAllSpecs) {
+          // we want to throw an exception in case we have a least one test with diffs
+          // we create a runner per spec file, therefore we could have multiple summeries
+          for (const summary of summaries) {
+            handleTestResults.printTestResults({testResults: summary.results.map(({result}) => result), resultConfig})
+          }
+        }
       } finally {
         await closeUniversalServer()
       }

package/src/plugin/pluginExport.ts

@@ -72,11 +72,11 @@ export default function makePluginExport({
       origOn: Cypress.PluginEvents,
       cypressConfig: Cypress.PluginConfigOptions,
     ): Promise<EyesPluginConfig> {
-      const {server, port, closeManager, closeBatches, closeUniversalServer} = await startServer(cypressConfig)
+      const {server, port, closeManagers, closeBatches, closeUniversalServer} = await startServer(cypressConfig)
       eyesServer = server
 
       const globalHooks: any = makeGlobalRunHooks({
-        closeManager,
+        closeManagers,
         closeBatches,
         closeUniversalServer,
       })

package/src/plugin/server.ts

@@ -14,7 +14,7 @@ import {extractEnvironment} from '../plugin/extractEnvironment'
 export type StartServerReturn = {
   server: Omit<SocketWithUniversal, 'disconnect' | 'ref' | 'unref' | 'send' | 'request' | 'setPassthroughListener'>
   port: number
-  closeManager: () => Promise<any[]>
+  closeManagers: () => Promise<any[]>
   closeBatches: (settings: CloseBatchSettings | CloseBatchSettings[]) => Promise<void>
   closeUniversalServer: () => void
 }
@@ -103,12 +103,12 @@ export default function makeStartServer({logger, eyesConfig}: {logger: Logger; e
     return {
       server: wss,
       port,
-      closeManager,
+      closeManagers,
       closeBatches,
       closeUniversalServer,
     }
 
-    function closeManager() {
+    function closeManagers() {
       return Promise.all(
         managers.map(({manager, socketWithUniversal}) =>
           socketWithUniversal.request('EyesManager.getResults', {

package/types/expose.d.ts

@@ -84,8 +84,8 @@ export type Element = HTMLElement | JQuery;
 export type ElementWithOptions = { element: Element; regionId?: string; padding?: any; };
 export type SelectorWithOptions = { region: Selector; regionId?: string; padding?: number | LegacyRegion; };
 export type AccessibilityValidation = { level?: "AA" | "AAA"; guidelinesVersion?: "WCAG_2_0" | "WCAG_2_1"; };
-export type FloatingRegion = ((LegacyRegion | Selector | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }) | Array<(LegacyRegion | Selector | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>;
-export type accessibilityRegion = ((LegacyRegion | Selector | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; } | Array<((LegacyRegion | Selector | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; }>;
+export type FloatingRegion = ((Selector | LegacyRegion | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }) | Array<(Selector | LegacyRegion | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>;
+export type accessibilityRegion = ((Selector | LegacyRegion | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; } | Array<((Selector | LegacyRegion | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; }>;
 export type CypressCheckSettings = {
     name?: string;
     region?: LegacyRegion;
@@ -205,10 +205,10 @@ export type CypressCheckSettings = {
     target?: "window" | "region";
     selector?: Selector;
     element?: Element;
-    ignore?: MaybeArray<string | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | Element | ElementWithOptions | SelectorWithOptions>;
-    layout?: MaybeArray<string | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | Element | ElementWithOptions | SelectorWithOptions>;
-    content?: MaybeArray<string | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | Element | ElementWithOptions | SelectorWithOptions>;
-    strict?: MaybeArray<string | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | Element | ElementWithOptions | SelectorWithOptions>;
+    ignore?: MaybeArray<string | Element | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | LegacyRegion | ElementWithOptions | SelectorWithOptions>;
+    layout?: MaybeArray<string | Element | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | LegacyRegion | ElementWithOptions | SelectorWithOptions>;
+    content?: MaybeArray<string | Element | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | LegacyRegion | ElementWithOptions | SelectorWithOptions>;
+    strict?: MaybeArray<string | Element | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | LegacyRegion | ElementWithOptions | SelectorWithOptions>;
     floating?: FloatingRegion;
     accessibility?: accessibilityRegion;
     scriptHooks?: { beforeCaptureScreenshot: string; };
@@ -354,6 +354,152 @@ export type CypressEyesConfig = {
     useDom?: boolean;
     enablePatterns?: boolean;
     scriptHooks?: { beforeCaptureScreenshot: string; };
+};
+export type appliConfFile = {
+    debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
+    agentId?: string;
+    apiKey?: string;
+    serverUrl?: string;
+    proxy?: { url: string; username?: string; password?: string; };
+    autProxy?: {
+        url: string;
+        username?: string;
+        password?: string;
+        mode?: "Allow" | "Block";
+        domains?: Array<string>;
+    };
+    isDisabled?: boolean;
+    connectionTimeout?: number;
+    removeSession?: boolean;
+    appName?: string;
+    testName?: string;
+    displayName?: string;
+    viewportSize?: { width: number; height: number; };
+    sessionType?: "SEQUENTIAL" | "PROGRESSION";
+    properties?: Array<{ name: string; value: string; }>;
+    batch?: {
+        id?: string;
+        name?: string;
+        sequenceName?: string;
+        startedAt?: string | Date;
+        notifyOnCompletion?: boolean;
+        properties?: Array<{ name: string; value: string; }>;
+    };
+    defaultMatchSettings?: {
+        exact?: { minDiffIntensity: number; minDiffWidth: number; minDiffHeight: number; matchThreshold: number; };
+        matchLevel?: "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
+        ignoreCaret?: boolean;
+        useDom?: boolean;
+        enablePatterns?: boolean;
+        ignoreDisplacements?: boolean;
+        ignoreRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }>;
+        layoutRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }>;
+        strictRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }>;
+        contentRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }>;
+        floatingRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        } | {
+            region: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+            maxUpOffset?: number;
+            maxDownOffset?: number;
+            maxLeftOffset?: number;
+            maxRightOffset?: number;
+        }>;
+        accessibilityRegions?: Array<{
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        } | { region: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }; type?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }>;
+        accessibilitySettings?: AccessibilityValidation;
+    };
+    hostApp?: string;
+    hostOS?: string;
+    hostAppInfo?: string;
+    hostOSInfo?: string;
+    deviceInfo?: string;
+    baselineEnvName?: string;
+    environmentName?: string;
+    branchName?: string;
+    parentBranchName?: string;
+    baselineBranchName?: string;
+    compareWithParentBranch?: boolean;
+    ignoreBaseline?: boolean;
+    ignoreGitMergeBase?: boolean;
+    saveFailedTests?: boolean;
+    saveNewTests?: boolean;
+    saveDiffs?: boolean;
+    dontCloseBatches?: boolean;
+    sendDom?: boolean;
+    matchTimeout?: number;
+    forceFullPageScreenshot?: boolean;
+    waitBeforeScreenshots?: number;
+    stitchMode?: "Scroll" | "CSS" | "Resize";
+    hideScrollbars?: boolean;
+    hideCaret?: boolean;
+    stitchOverlap?: number;
+    scrollRootElement?: Element | EyesSelector<Selector>;
+    cut?: { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
+    rotation?: 0 | 270 | -270 | 180 | -180 | 90 | -90;
+    scaleRatio?: number;
+    concurrentSessions?: number;
+    browsersInfo?: Array<{ name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22" | "Galaxy S22 Ultra" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21 Plus" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; }>;
+    visualGridOptions?: Record<string, any>;
+    layoutBreakpoints?: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: boolean; };
+    disableBrowserFetching?: boolean;
+    waitBeforeCapture?: number;
+    browser?: MaybeArray<{ name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22" | "Galaxy S22 Ultra" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21 Plus" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { deviceName: DeviceName; screenOrientation?: ScreenOrientationPlain; name?: string; }>;
+    batchId?: string;
+    batchName?: string;
+    batchSequence?: string;
+    notifyOnCompletion?: boolean;
+    batchSequenceName?: string;
+    envName?: string;
+    accessibilityValidation?: AccessibilityValidation;
+    matchLevel?: "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
+    ignoreCaret?: boolean;
+    ignoreDisplacements?: boolean;
+    useDom?: boolean;
+    enablePatterns?: boolean;
+    scriptHooks?: { beforeCaptureScreenshot: string; };
+    failCypressAfterAllSpecs?: boolean;
+    tapDirPath?: string;
+    tapFileName?: string;
+    showLogs?: boolean;
+    shouldDoPostSpecTasks?: boolean;
     isComponentTest?: boolean;
 };
 export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResults(): {