@applitools/eyes-cypress 3.32.2 → 3.33.0

package/CHANGELOG.md

@@ -12,6 +12,14 @@
 
 
 
+## 3.33.0 - 2023/5/23
+
+### Features
+- Add support for reloading the page when using layoutBreakpoints
+- Internal improvements
+- Start universal core in the plugin process
+### Bug fixes
+
 ## 3.32.2 - 2023/5/3
 
 ### Features

package/dist/browser/spec-driver.js

@@ -10,6 +10,9 @@ function executeScript(context, script, arg) {
         const prepScirpt = script.replace('function(arg)', 'function func(arg)');
         scriptToExecute = prepScirpt.concat(' return func(arg)');
     }
+    if (!context.defaultView) {
+        context = fallBackToMainContext();
+    }
     const executor = new context.defaultView.Function('arg', scriptToExecute);
     return executor(arg);
 }
@@ -22,6 +25,9 @@ function parentContext(context) {
     if (!context) {
         throw new Error('Context is not accessible');
     }
+    else if (!context.defaultView) {
+        return fallBackToMainContext();
+    }
     return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
 }
 exports.parentContext = parentContext;
@@ -87,6 +93,9 @@ function getTitle(context) {
 }
 exports.getTitle = getTitle;
 function getUrl(context) {
+    if (context && !context.location) {
+        context = fallBackToMainContext();
+    }
     return context.location.href;
 }
 exports.getUrl = getUrl;
@@ -94,3 +103,8 @@ function getCookies() {
     return Cypress.automation('get:cookies', {});
 }
 exports.getCookies = getCookies;
+function fallBackToMainContext() {
+    const context = mainContext();
+    context['applitools-marker'] = 'root-context';
+    return context;
+}

package/dist/browser/transformCypressCheckSettings.js

@@ -35,7 +35,11 @@ function transformCypressCheckSettings(settings, refer) {
         renderers: (0, utils_1.transformBrowsers)(settings.browser),
         hooks: settings.scriptHooks,
         disableBrowserFetching: settings.disableBrowserFetching,
-        layoutBreakpoints: settings.layoutBreakpoints,
+        layoutBreakpoints: settings.layoutBreakpoints
+            ? utils.types.has(settings.layoutBreakpoints, 'breakpoints')
+                ? settings.layoutBreakpoints
+                : { breakpoints: settings.layoutBreakpoints }
+            : undefined,
         ufgOptions: settings.visualGridOptions,
         name: settings.tag,
         ignoreRegions: transformRegionsWithOptions(settings.ignore),

package/dist/browser/transformCypressConfig.js

@@ -1,7 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformCypressConfig = void 0;
 const utils_1 = require("./utils");
+const utils = __importStar(require("@applitools/utils"));
 function transformCypressConfig(config) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return {
@@ -39,7 +63,11 @@ function transformCypressConfig(config) {
             ignoreCaret: config.ignoreCaret,
             ignoreDisplacements: config.ignoreDisplacements,
             accessibilitySettings: (0, utils_1.transformAccessibilityValidation)(config.accessibilityValidation),
-            layoutBreakpoints: config.layoutBreakpoints,
+            layoutBreakpoints: config.layoutBreakpoints
+                ? utils.types.has(config.layoutBreakpoints, 'breakpoints')
+                    ? config.layoutBreakpoints
+                    : { breakpoints: config.layoutBreakpoints }
+                : undefined,
             sendDom: config.sendDom,
             useDom: config.useDom,
             enablePatterns: config.enablePatterns,

package/dist/plugin/handleTestResults.js

@@ -12,7 +12,6 @@ const path_1 = require("path");
 function printTestResults(testResultsArr) {
     const logger = (0, logger_1.makeLogger)({
         level: testResultsArr.resultConfig.showLogs ? 'info' : 'silent',
-        label: 'eyes',
     });
     if (!testResultsArr.testResults)
         return;

package/dist/plugin/index.js

@@ -8,8 +8,8 @@ const config_1 = __importDefault(require("./config"));
 const server_1 = __importDefault(require("./server"));
 const logger_1 = require("@applitools/logger");
 const { config, eyesConfig } = (0, config_1.default)();
-const logger = (0, logger_1.makeLogger)({ level: config.showLogs ? 'info' : 'silent', label: 'eyes' });
-const startServer = (0, server_1.default)({ logger, eyesConfig });
+const logger = (0, logger_1.makeLogger)({ level: config.showLogs ? 'info' : 'silent' });
+const startServer = (0, server_1.default)({ logger, eyesConfig, config });
 const pluginExport = (0, pluginExport_1.default)({
     startServer,
     eyesConfig: Object.assign({}, eyesConfig, { appliConfFile: config }),

package/dist/plugin/server.js

@@ -8,12 +8,11 @@ const core_1 = require("@applitools/core");
 const handleTestResults_1 = __importDefault(require("./handleTestResults"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
-const semver_1 = require("semver");
 const https_1 = require("https");
 const ws_1 = require("ws");
-const which_1 = __importDefault(require("which"));
 const util_1 = require("util");
-function makeStartServer({ logger, eyesConfig }) {
+const PUBLIC_CLOUD = 'https://eyesapi.applitools.com';
+function makeStartServer({ logger, eyesConfig, config, }) {
     return async function startServer(options) {
         const key = fs_1.default.readFileSync(path_1.default.resolve(__dirname, '../../src/pem/server.key'));
         const cert = fs_1.default.readFileSync(path_1.default.resolve(__dirname, '../../src/pem/server.cert'));
@@ -24,20 +23,13 @@ function makeStartServer({ logger, eyesConfig }) {
         await (0, util_1.promisify)(https.listen.bind(https))();
         const port = https.address().port;
         const wss = new ws_1.Server({ server: https, path: '/eyes', maxPayload: 254 * 1024 * 1024 });
-        wss.on('close', () => https.close());
-        const forkOptions = {
-            detached: true,
-        };
-        const cypressVersion = require('cypress/package.json').version;
-        const isCypressVersionBelow7 = (0, semver_1.lt)(cypressVersion, '7.0.0');
-        const isNodeVersionSystem = !!(options === null || options === void 0 ? void 0 : options.nodeVersion) && options.nodeVersion !== 'system';
-        if (isCypressVersionBelow7 || isNodeVersionSystem) {
-            forkOptions.execPath = await (0, which_1.default)('node');
-        }
-        const { port: universalPort, close: closeUniversalServer } = await (0, core_1.makeCoreServerProcess)({
+        wss.on('close', () => {
+            https.close();
+            closeUniversalServer();
+        });
+        const { port: universalPort, close: closeUniversalServer } = await (0, core_1.makeCoreServer)({
             idleTimeout: 0,
-            shutdownMode: 'stdin',
-            forkOptions,
+            printStdout: true,
             singleton: false,
             portResolutionMode: 'random',
             debug: eyesConfig.universalDebug,
@@ -57,6 +49,24 @@ function makeStartServer({ logger, eyesConfig }) {
             socketWithClient.on('message', (message) => {
                 const msg = JSON.parse(message);
                 logger.log('==> ', message.toString().slice(0, 1000));
+                if (msg.name === 'Core.makeCore') {
+                    logger.log('==> ', 'Core.logEvent');
+                    socketWithUniversal.request('Core.logEvent', {
+                        settings: {
+                            serverUrl: config.serverUrl ? config.serverUrl : PUBLIC_CLOUD,
+                            apiKey: config.apiKey,
+                            agentId: `eyes.cypress/${require('../../package.json').version}`,
+                            proxy: config.proxy,
+                            level: 'Notice',
+                            event: {
+                                type: 'CypressTestingType',
+                                testingType: (options === null || options === void 0 ? void 0 : options.testingType) === 'component' ? 'component' : 'e2e',
+                                cypressVersion: require('cypress/package.json').version,
+                            },
+                        },
+                        logger,
+                    });
+                }
                 if (msg.name === 'Core.makeSDK') {
                     const newMessage = Buffer.from(JSON.stringify({
                         name: msg.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.32.2",
+  "version": "3.33.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
@@ -47,7 +47,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 test:ts:run:legacy && yarn test:ts:run:9",
-    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic && yarn && unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
     "test:e2e": "mkdir -p test/fixtures/testAppCopies && 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",
@@ -69,29 +69,27 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "2.5.10",
-    "@applitools/eyes-api": "1.13.12",
+    "@applitools/core": "3.1.0",
+    "@applitools/eyes": "1.2.13",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.1.52",
-    "@applitools/utils": "1.3.35",
+    "@applitools/logger": "2.0.1",
+    "@applitools/utils": "1.3.37",
     "boxen": "5.1.2",
     "chalk": "3.0.0",
     "semver": "7.3.8",
     "uuid": "8.3.2",
-    "which": "2.0.2",
     "ws": "8.5.0"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.21",
-    "@applitools/bongo": "^3.0.3",
+    "@applitools/bongo": "^3.0.4",
     "@applitools/sdk-coverage-tests": "^3.0.2",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.1.31",
-    "@applitools/test-utils": "1.5.16",
+    "@applitools/test-server": "1.2.1",
+    "@applitools/test-utils": "1.5.17",
     "@types/node": "12",
     "@types/semver": "^7.3.13",
     "@types/uuid": "^9.0.0",
-    "@types/which": "^2.0.1",
     "@types/ws": "^8.2.2",
     "chai": "4.2.0",
     "chai-spies": "1.0.0",

package/src/browser/commands.js

@@ -4,7 +4,7 @@ const spec = require('../../dist/browser/spec-driver')
 const Refer = require('./refer')
 const Socket = require('./socket')
 const {socketCommands} = require('./socketCommands')
-const {TestResultsSummary} = require('@applitools/eyes-api')
+const {TestResultsSummaryData: TestResultsSummary} = require('@applitools/eyes/dist/output/TestResultsSummary')
 const refer = new Refer()
 const socket = new Socket()
 const throwErr = Cypress.config('failCypressOnDiff')

package/src/browser/spec-driver.ts

@@ -11,7 +11,10 @@ export function executeScript(context: Context, script: string, arg: any): any {
     const prepScirpt = script.replace('function(arg)', 'function func(arg)')
     scriptToExecute = prepScirpt.concat(' return func(arg)')
   }
-
+  if (!context.defaultView) {
+    // after reload the window is null
+    context = fallBackToMainContext()
+  }
   const executor = new context.defaultView.Function('arg', scriptToExecute)
   return executor(arg)
 }
@@ -25,6 +28,9 @@ export function parentContext(context: Context): Context {
   // 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')
+  } else if (!context.defaultView) {
+    // after reload the window is null
+    return fallBackToMainContext()
   }
 
   return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument
@@ -92,6 +98,10 @@ export function getTitle(context: Context): string {
 }
 
 export function getUrl(context: Context): string {
+  if (context && !context.location) {
+    // after reload, the location is null
+    context = fallBackToMainContext()
+  }
   return context.location.href
 }
 
@@ -100,6 +110,13 @@ export function getCookies(): Array<any> {
   return Cypress.automation('get:cookies', {})
 }
 
+function fallBackToMainContext(): Context {
+  const context = mainContext()
+  //@ts-ignore
+  context['applitools-marker'] = 'root-context'
+  return context
+}
+
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 
 // export function visit(page: Driver, url: string): Promise<void>; (??)

package/src/browser/transformCypressCheckSettings.ts

@@ -26,7 +26,11 @@ export function transformCypressCheckSettings(settings: CypressCheckSettings, re
     renderers: transformBrowsers(settings.browser),
     hooks: settings.scriptHooks,
     disableBrowserFetching: settings.disableBrowserFetching,
-    layoutBreakpoints: settings.layoutBreakpoints,
+    layoutBreakpoints: settings.layoutBreakpoints
+      ? utils.types.has(settings.layoutBreakpoints, 'breakpoints')
+        ? settings.layoutBreakpoints
+        : {breakpoints: settings.layoutBreakpoints}
+      : undefined,
     ufgOptions: settings.visualGridOptions,
     name: settings.tag,
     ignoreRegions: transformRegionsWithOptions(settings.ignore),

package/src/browser/transformCypressConfig.ts

@@ -1,6 +1,7 @@
 import type {CypressEyesConfig} 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'> {
   return {
@@ -38,7 +39,11 @@ export function transformCypressConfig(config: CypressEyesConfig): Config<SpecTy
       ignoreCaret: config.ignoreCaret,
       ignoreDisplacements: config.ignoreDisplacements,
       accessibilitySettings: transformAccessibilityValidation(config.accessibilityValidation),
-      layoutBreakpoints: config.layoutBreakpoints,
+      layoutBreakpoints: config.layoutBreakpoints
+        ? utils.types.has(config.layoutBreakpoints, 'breakpoints')
+          ? config.layoutBreakpoints
+          : {breakpoints: config.layoutBreakpoints}
+        : undefined,
       sendDom: config.sendDom,
       useDom: config.useDom,
       enablePatterns: config.enablePatterns,

package/src/expose.ts

@@ -7,7 +7,7 @@
  * correct types for the SDK just like all other conventional SDK's.
  **/
 /// <reference types="cypress" />
-import type * as api from '@applitools/eyes-api'
+import type * as api from '@applitools/eyes'
 import type * as core from '@applitools/core'
 import {
   type EyesSelector,
@@ -15,7 +15,7 @@ import {
   type DeviceName,
   type ScreenOrientationPlain,
   type AccessibilityRegionTypePlain,
-} from '@applitools/eyes-api'
+} from '@applitools/eyes'
 
 export type MaybeArray<T> = T | T[]
 export type {EyesSelector, TestResultsStatus, DeviceName, ScreenOrientationPlain}

package/src/plugin/handleTestResults.ts

@@ -8,7 +8,6 @@ import {resolve} from 'path'
 function printTestResults(testResultsArr: any) {
   const logger = makeLogger({
     level: testResultsArr.resultConfig.showLogs ? 'info' : 'silent',
-    label: 'eyes',
   })
   if (!testResultsArr.testResults) return
   const {passed, failed, diffs} = getErrorsAndDiffs(testResultsArr.testResults)

package/src/plugin/index.ts

@@ -28,9 +28,9 @@ export type EyesPluginConfig = {
 }
 
 const {config, eyesConfig} = makeConfig()
-const logger = makeLogger({level: config.showLogs ? 'info' : 'silent', label: 'eyes'})
+const logger = makeLogger({level: config.showLogs ? 'info' : 'silent'})
 
-const startServer = makeStartServer({logger, eyesConfig})
+const startServer = makeStartServer({logger, eyesConfig, config})
 
 const pluginExport = makePluginExport({
   startServer,

package/src/plugin/server.ts

@@ -1,16 +1,15 @@
 import connectSocket, {type SocketWithUniversal} from './webSocket'
-import {type CloseBatchSettings, makeCoreServerProcess} from '@applitools/core'
+import {type CloseBatchSettings, makeCoreServer} from '@applitools/core'
 import handleTestResults from './handleTestResults'
 import path from 'path'
 import fs from 'fs'
-import {lt as semverLt} from 'semver'
 import {Server as HttpsServer} from 'https'
 import {Server as WSServer} from 'ws'
-import which from 'which'
 import {type Logger} from '@applitools/logger'
 import {AddressInfo} from 'net'
 import {promisify} from 'util'
 import {EyesPluginConfig} from './index'
+
 export type StartServerReturn = {
   server: Omit<SocketWithUniversal, 'disconnect' | 'ref' | 'unref' | 'send' | 'request' | 'setPassthroughListener'>
   port: number
@@ -18,8 +17,16 @@ export type StartServerReturn = {
   closeBatches: (settings: CloseBatchSettings | CloseBatchSettings[]) => Promise<void>
   closeUniversalServer: () => void
 }
-
-export default function makeStartServer({logger, eyesConfig}: {logger: Logger; eyesConfig: EyesPluginConfig}) {
+const PUBLIC_CLOUD = 'https://eyesapi.applitools.com'
+export default function makeStartServer({
+  logger,
+  eyesConfig,
+  config,
+}: {
+  logger: Logger
+  eyesConfig: EyesPluginConfig
+  config: any
+}) {
   return async function startServer(options?: Cypress.PluginConfigOptions): Promise<StartServerReturn> {
     const key = fs.readFileSync(path.resolve(__dirname, '../../src/pem/server.key'))
     const cert = fs.readFileSync(path.resolve(__dirname, '../../src/pem/server.cert'))
@@ -32,39 +39,14 @@ export default function makeStartServer({logger, eyesConfig}: {logger: Logger; e
     const port = (https.address() as AddressInfo).port
     const wss = new WSServer({server: https, path: '/eyes', maxPayload: 254 * 1024 * 1024})
 
-    wss.on('close', () => https.close())
-
-    const forkOptions: {
-      detached: boolean
-      execPath?: string
-    } = {
-      detached: true,
-    }
-
-    const cypressVersion = require('cypress/package.json').version
-
-    // `cypress` version below `7.0.0` has an old Electron version which not support async shell process.
-    // By passing `execPath` with the node process cwd it will switch the `node` process to be the like the OS have
-    // and will not use the unsupported `Cypress Helper.app` with the not supported shell process Electron
-    const isCypressVersionBelow7 = semverLt(cypressVersion, '7.0.0')
-
-    // `nodeVersion` property set the way the `node` process will be executed
-    // if set to `system` it will use the `node` process that the OS have
-    // if set to `bundled` it will use the `node` process that the `Cypress Helper.app` have
-    //
-    // [doc link](https://docs.cypress.io/guides/references/configuration#Node-version)
-    //
-    // this is why if `nodeVersion` exits and not set to `system` we need to tell to the `universal` server the `execPath` to `node`
-    const isNodeVersionSystem = !!options?.nodeVersion && options.nodeVersion !== 'system'
-
-    if (isCypressVersionBelow7 || isNodeVersionSystem) {
-      forkOptions.execPath = await which('node')
-    }
+    wss.on('close', () => {
+      https.close()
+      closeUniversalServer()
+    })
 
-    const {port: universalPort, close: closeUniversalServer} = await makeCoreServerProcess({
+    const {port: universalPort, close: closeUniversalServer} = await makeCoreServer({
       idleTimeout: 0,
-      shutdownMode: 'stdin',
-      forkOptions,
+      printStdout: true,
       singleton: false,
       portResolutionMode: 'random',
       debug: eyesConfig.universalDebug,
@@ -89,6 +71,24 @@ export default function makeStartServer({logger, eyesConfig}: {logger: Logger; e
       socketWithClient.on('message', (message: string) => {
         const msg = JSON.parse(message)
         logger.log('==> ', message.toString().slice(0, 1000))
+        if (msg.name === 'Core.makeCore') {
+          logger.log('==> ', 'Core.logEvent')
+          socketWithUniversal.request('Core.logEvent', {
+            settings: {
+              serverUrl: config.serverUrl ? config.serverUrl : PUBLIC_CLOUD,
+              apiKey: config.apiKey,
+              agentId: `eyes.cypress/${require('../../package.json').version}`,
+              proxy: config.proxy,
+              level: 'Notice',
+              event: {
+                type: 'CypressTestingType',
+                testingType: options?.testingType === 'component' ? 'component' : 'e2e',
+                cypressVersion: require('cypress/package.json').version,
+              },
+            },
+            logger,
+          })
+        }
         if (msg.name === 'Core.makeSDK') {
           const newMessage = Buffer.from(
             JSON.stringify({

package/types/expose.d.ts

@@ -190,7 +190,7 @@ export type CypressCheckSettings = {
     scrollRootElement?: Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
     fully?: boolean;
     disableBrowserFetching?: boolean;
-    layoutBreakpoints?: boolean | Array<number>;
+    layoutBreakpoints?: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: boolean; };
     visualGridOptions?: { [key: string]: any; };
     nmgOptions?: { [key: string]: any; };
     hooks?: { beforeCaptureScreenshot: string; };
@@ -331,12 +331,12 @@ export type CypressEyesConfig = {
     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;
-    waitBeforeCapture?: number;
     concurrentSessions?: number;
     browsersInfo?: Array<{ name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "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 S22" | "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 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" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "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>;
+    layoutBreakpoints?: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: boolean; };
     disableBrowserFetching?: boolean;
+    waitBeforeCapture?: number;
     browser?: MaybeArray<{ name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "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 S22" | "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 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" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "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;
@@ -388,9 +388,9 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
     getIsAborted(): boolean;
     setIsAborted(_isAborted: boolean): void;
     getAppUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
-    setAppUrls(_appUrls: { readonly batch?: string; readonly session?: string; }): void;
+    setAppUrls(_appUrls: { readonly batch: string; readonly session: string; }): void;
     getApiUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
-    setApiUrls(_apiUrls: { readonly batch?: string; readonly session?: string; }): void;
+    setApiUrls(_apiUrls: { readonly batch: string; readonly session: string; }): void;
     getStepsInfo(): Array<{
         getName(): string;
         setName(value: string): void;
@@ -401,7 +401,7 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
         getHasCurrentImage(): boolean;
         setHasCurrentImage(hasCurrentImage: boolean): void;
         getAppUrls(): { getStep(): string; setStep(step: string): void; getStepEditor(): string; setStepEditor(stepEditor: string): void; };
-        setAppUrls(appUrls: { readonly step?: string; readonly stepEditor?: string; }): void;
+        setAppUrls(appUrls: { readonly step: string; readonly stepEditor: string; }): void;
         getApiUrls(): {
             getBaselineImage(): string;
             setBaselineImage(setBaselineImage: string): void;
@@ -415,29 +415,29 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
             setDiffImage(diffImage: string): void;
         };
         setApiUrls(apiUrls: {
-            readonly baselineImage?: string;
-            readonly currentImage?: string;
-            readonly checkpointImage?: string;
-            readonly checkpointImageThumbnail?: string;
-            readonly diffImage?: string;
+            readonly baselineImage: string;
+            readonly currentImage: string;
+            readonly checkpointImage: string;
+            readonly checkpointImageThumbnail: string;
+            readonly diffImage: string;
         }): void;
         getRenderId(): Array<string>;
         setRenderId(renderId: Array<string>): void;
     }>;
     setStepsInfo(_stepInfo: Array<{
-        readonly name?: string;
-        readonly isDifferent?: boolean;
-        readonly hasBaselineImage?: boolean;
-        readonly hasCurrentImage?: boolean;
-        readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
-        readonly apiUrls?: {
-            readonly baselineImage?: string;
-            readonly currentImage?: string;
-            readonly checkpointImage?: string;
-            readonly checkpointImageThumbnail?: string;
-            readonly diffImage?: string;
+        readonly name: string;
+        readonly isDifferent: boolean;
+        readonly hasBaselineImage: boolean;
+        readonly hasCurrentImage: boolean;
+        readonly appUrls: { readonly step: string; readonly stepEditor: string; };
+        readonly apiUrls: {
+            readonly baselineImage: string;
+            readonly currentImage: string;
+            readonly checkpointImage: string;
+            readonly checkpointImageThumbnail: string;
+            readonly diffImage: string;
         };
-        readonly renderId?: Array<string>;
+        readonly renderId: Array<string>;
     }>): void;
     getSteps(): number;
     setSteps(_steps: number): void;
@@ -498,9 +498,9 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
     getIsAborted(): boolean;
     setIsAborted(_isAborted: boolean): void;
     getAppUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
-    setAppUrls(_appUrls: { readonly batch?: string; readonly session?: string; }): void;
+    setAppUrls(_appUrls: { readonly batch: string; readonly session: string; }): void;
     getApiUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
-    setApiUrls(_apiUrls: { readonly batch?: string; readonly session?: string; }): void;
+    setApiUrls(_apiUrls: { readonly batch: string; readonly session: string; }): void;
     getStepsInfo(): Array<{
         getName(): string;
         setName(value: string): void;
@@ -511,7 +511,7 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
         getHasCurrentImage(): boolean;
         setHasCurrentImage(hasCurrentImage: boolean): void;
         getAppUrls(): { getStep(): string; setStep(step: string): void; getStepEditor(): string; setStepEditor(stepEditor: string): void; };
-        setAppUrls(appUrls: { readonly step?: string; readonly stepEditor?: string; }): void;
+        setAppUrls(appUrls: { readonly step: string; readonly stepEditor: string; }): void;
         getApiUrls(): {
             getBaselineImage(): string;
             setBaselineImage(setBaselineImage: string): void;
@@ -525,29 +525,29 @@ export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResult
             setDiffImage(diffImage: string): void;
         };
         setApiUrls(apiUrls: {
-            readonly baselineImage?: string;
-            readonly currentImage?: string;
-            readonly checkpointImage?: string;
-            readonly checkpointImageThumbnail?: string;
-            readonly diffImage?: string;
+            readonly baselineImage: string;
+            readonly currentImage: string;
+            readonly checkpointImage: string;
+            readonly checkpointImageThumbnail: string;
+            readonly diffImage: string;
         }): void;
         getRenderId(): Array<string>;
         setRenderId(renderId: Array<string>): void;
     }>;
     setStepsInfo(_stepInfo: Array<{
-        readonly name?: string;
-        readonly isDifferent?: boolean;
-        readonly hasBaselineImage?: boolean;
-        readonly hasCurrentImage?: boolean;
-        readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
-        readonly apiUrls?: {
-            readonly baselineImage?: string;
-            readonly currentImage?: string;
-            readonly checkpointImage?: string;
-            readonly checkpointImageThumbnail?: string;
-            readonly diffImage?: string;
+        readonly name: string;
+        readonly isDifferent: boolean;
+        readonly hasBaselineImage: boolean;
+        readonly hasCurrentImage: boolean;
+        readonly appUrls: { readonly step: string; readonly stepEditor: string; };
+        readonly apiUrls: {
+            readonly baselineImage: string;
+            readonly currentImage: string;
+            readonly checkpointImage: string;
+            readonly checkpointImageThumbnail: string;
+            readonly diffImage: string;
         };
-        readonly renderId?: Array<string>;
+        readonly renderId: Array<string>;
     }>): void;
     getSteps(): number;
     setSteps(_steps: number): void;