@applitools/eyes-nightwatch 1.15.0 → 1.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +7 -8
  2. package/dist/index.js +4 -3
  3. package/dist/spec-driver.js +5 -4
  4. package/package.json +23 -35
  5. package/types/index.d.ts +189 -66
package/CHANGELOG.md CHANGED
@@ -1,15 +1,14 @@
1
- # Change Log
2
-
3
- ## Unreleased
4
-
5
-
6
-
7
-
8
-
1
+ # Changelog
9
2
 
3
+ ## [1.15.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-nightwatch-v1.15.0...js/eyes-nightwatch@1.15.1) (2023-06-14)
10
4
 
11
5
 
6
+ ### Dependencies
12
7
 
8
+ * update some dependencies
9
+ * The following workspace dependencies were updated
10
+ * dependencies
11
+ * @applitools/eyes bumped from 1.2.14 to 1.2.16
13
12
 
14
13
  ## 1.15.0 - 2023/4/19
15
14
 
package/dist/index.js CHANGED
@@ -13,13 +13,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
13
13
  var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
+ var _a;
16
17
  Object.defineProperty(exports, "__esModule", { value: true });
17
18
  __exportStar(require("./api"), exports);
18
- if (!process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION) {
19
+ if (!process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION) {
19
20
  try {
20
- const { version } = require('nightwatch/package.json');
21
+ const { version } = (_a = process.env.APPLITOOLS_FRAMEWORK_VERSION) !== null && _a !== void 0 ? _a : require('nightwatch/package.json');
21
22
  const [major] = version.split('.', 1);
22
- process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION = major;
23
+ process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION = major;
23
24
  }
24
25
  catch {
25
26
  // NOTE: ignore error
package/dist/spec-driver.js CHANGED
@@ -148,7 +148,7 @@ async function findElement(driver, selector, parent) {
148
148
  parent = isShadowRoot(parent) ? transformShadowRoot(parent) : parent;
149
149
  element = await spec.findElement(driver, { using: selector.locateStrategy, value: selector.selector }, parent);
150
150
  }
151
- else if (!(Number(process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION) < 2)) {
151
+ else if (!(Number.parseInt(process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION) < 2)) {
152
152
  try {
153
153
  element = await originalDriver.findElement(selector);
154
154
  }
@@ -166,7 +166,7 @@ async function findElements(driver, selector, parent) {
166
166
  parent = isShadowRoot(parent) ? transformShadowRoot(parent) : parent;
167
167
  elements = await spec.findElements(driver, { using: selector.locateStrategy, value: selector.selector }, parent);
168
168
  }
169
- else if (!(Number(process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION) < 2)) {
169
+ else if (!(Number.parseInt(process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION) < 2)) {
170
170
  try {
171
171
  elements = await originalDriver.findElements(selector);
172
172
  }
@@ -185,7 +185,7 @@ async function build(env) {
185
185
  var _a;
186
186
  const Nightwatch = require('nightwatch');
187
187
  const parseEnv = require('@applitools/test-utils/src/parse-env');
188
- const { browser = '', capabilities, url, configurable = true, args = [], headless, logLevel = 'silent', } = parseEnv({ ...env, legacy: (_a = env.legacy) !== null && _a !== void 0 ? _a : process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION === '1' });
188
+ const { browser = '', capabilities, url, configurable = true, args = [], headless, logLevel = 'silent', } = parseEnv({ ...env, legacy: (_a = env.legacy) !== null && _a !== void 0 ? _a : process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION === '1' });
189
189
  const options = {
190
190
  capabilities: { browserName: browser, ...capabilities },
191
191
  webdriver: {
@@ -200,6 +200,7 @@ async function build(env) {
200
200
  start_process: false,
201
201
  },
202
202
  output: logLevel !== 'silent',
203
+ config: null,
203
204
  useAsync: true,
204
205
  };
205
206
  if (configurable) {
@@ -222,7 +223,7 @@ async function build(env) {
222
223
  options.capabilities.browserName = null;
223
224
  if (options.capabilities.browserName !== 'firefox')
224
225
  options.selenium = options.webdriver;
225
- if (Number(process.env.APPLITOOLS_NIGHTWATCH_MAJOR_VERSION) < 2) {
226
+ if (Number.parseInt(process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION) < 2) {
226
227
  options.desiredCapabilities = options.capabilities;
227
228
  const client = Nightwatch.client(options);
228
229
  client.isES6AsyncTestcase = true;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-nightwatch",
3
- "version": "1.15.0",
3
+ "version": "1.15.1",
4
4
  "description": "Applitools Eyes SDK for Nightwatch.js",
5
5
  "keywords": [
6
6
  "eyes-nightwatch",
@@ -30,9 +30,6 @@
30
30
  "name": "Applitools Team",
31
31
  "email": "team@applitools.com"
32
32
  },
33
- "aliases": [
34
- "nightwatch"
35
- ],
36
33
  "main": "./dist/index.js",
37
34
  "types": "./types/index.d.ts",
38
35
  "files": [
@@ -41,53 +38,44 @@
41
38
  "types"
42
39
  ],
43
40
  "scripts": {
44
- "lint": "node ../../node_modules/.bin/eslint '**/*.ts' '**/*.js'",
45
- "build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
41
+ "lint": "run --top-level eslint '**/*.ts' '**/*.js'",
42
+ "build": "run --top-level tspc --project ./tsconfig.build.json",
46
43
  "generate:tests": "coverage-tests generate ./test/coverage/config.js --name 'eyes-nightwatch'",
47
44
  "test": "yarn test:it && yarn test:e2e && yarn test:coverage",
48
- "test:it": "MOCHA_GROUP=it node ../../node_modules/.bin/mocha './test/it/*.spec.ts' -r @applitools/test-utils/mocha-hooks/docker",
49
- "test:e2e": "yarn test:e2e:nightwatch && yarn test:e2e:cucumber",
50
- "test:e2e:cucumber": "cucumber-js test/e2e/cucumber/features/*.feature --require test/e2e/cucumber/cucumber.config.js --require test/e2e/cucumber/step_definitions",
51
- "test:e2e:nightwatch": "nightwatch --config test/e2e/nightwatch.conf.js --eyes-config applitools.config.js test/e2e/*.spec.js",
45
+ "test:it": "MOCHA_GROUP=it run --top-level mocha './test/it/*.spec.ts' -r @applitools/test-utils/mocha-hooks/docker",
46
+ "test:e2e": "nightwatch --config test/e2e/nightwatch.conf.js --eyes-config applitools.config.js test/e2e/*.spec.js",
47
+ "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-nightwatch' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generic/*.spec.js' -r @applitools/test-utils/mocha-hooks/docker --parallel --jobs ${MOCHA_JOBS:-15} --exit",
48
+ "setup": "run --top-level browsers:setup",
49
+ "up:framework": "run --top-level add-silent nightwatch",
52
50
  "report": "bongo report --name 'nightwatch'",
53
- "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-nightwatch' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' -r @applitools/test-utils/mocha-hooks/docker --parallel --jobs ${MOCHA_JOBS:-15} --exit",
54
- "test:sanity": "yarn test:it",
55
- "setup": "yarn docker:setup",
56
- "docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
57
- "docker:teardown": "docker-compose down",
58
- "upgrade:framework": "if [ ! -z $APPLITOOLS_NIGHTWATCH_MAJOR_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile nightwatch@$APPLITOOLS_NIGHTWATCH_MAJOR_VERSION; echo \"$packagejson\" > package.json; fi",
59
- "deps": "bongo deps",
60
- "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='nightwatch' -f links='eyes-sdk-core eyes types test-utils utils driver snippets screenshoter visual-grid-client'",
61
- "gh:publish": "gh workflow run publish-nightwatch.yml --ref $(git rev-parse --abbrev-ref HEAD)",
62
- "preversion": "bongo preversion --verifyPendingChanges",
63
- "version": "bongo version --withPendingChanges",
64
- "postversion": "bongo postversion",
65
- "postpublish": "bongo send-release-notification --name 'nightwatch'"
51
+ "notify": "dlx --package @applitools/bongo bongo send-release-notification --name 'nightwatch'"
66
52
  },
67
53
  "dependencies": {
68
- "@applitools/driver": "1.11.43",
69
- "@applitools/eyes": "1.2.1",
70
- "@applitools/spec-driver-webdriver": "1.0.24",
71
- "@applitools/utils": "1.3.32",
54
+ "@applitools/driver": "1.12.1",
55
+ "@applitools/eyes": "1.2.16",
56
+ "@applitools/spec-driver-webdriver": "1.0.33",
57
+ "@applitools/utils": "1.3.37",
72
58
  "webdriver": "7.27.0"
73
59
  },
74
60
  "devDependencies": {
75
- "@applitools/api-extractor": "1.2.14",
76
- "@applitools/bongo": "^3.0.3",
77
- "@applitools/sdk-coverage-tests": "3.0.2",
78
- "@applitools/test-utils": "1.5.16",
61
+ "@applitools/api-extractor": "^1.2.21",
62
+ "@applitools/bongo": "^4.0.0",
63
+ "@applitools/sdk-coverage-tests": "^3.0.2",
64
+ "@applitools/test-utils": "^1.5.17",
79
65
  "@types/nightwatch": "^2.3.16",
80
66
  "@types/node": "^12.20.55",
81
- "chromedriver": "^110.0.0",
67
+ "chromedriver": "^114.0.1",
82
68
  "cucumber": "6.0.7",
83
69
  "geckodriver": "^3.0.1",
84
- "nightwatch": "^2.5.4",
85
- "nightwatch-api": "^3.0.2"
70
+ "nightwatch": "^2.6.21"
86
71
  },
87
72
  "peerDependencies": {
88
73
  "nightwatch": ">=1.3.4"
89
74
  },
90
75
  "engines": {
91
76
  "node": ">=12.13.0"
77
+ },
78
+ "publishConfig": {
79
+ "access": "public"
92
80
  }
93
- }
81
+ }
package/types/index.d.ts CHANGED
@@ -32,10 +32,13 @@ export class Eyes {
32
32
  off(handler: (...args: Array<any>) => any): void;
33
33
  getExecutionCloudUrl(): Promise<string>;
34
34
  open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
35
- open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
35
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<Driver>;
36
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<Driver>;
36
37
  open(config?: undefined | ConfigurationPlain): Promise<void>;
37
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
38
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
38
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<void>;
39
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<void>;
40
+ check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
41
+ check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
39
42
  check(target: {
40
43
  image: string | URL | Buffer;
41
44
  name?: undefined | string;
@@ -46,15 +49,23 @@ export class Eyes {
46
49
  }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
47
50
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
48
51
  checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
49
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
52
+ checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
53
+ checkFrame(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
54
+ checkFrame(element: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
50
55
  checkElement(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
51
56
  checkElementBy(selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
52
57
  checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
53
- checkRegion(image: string | URL | Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
58
+ checkRegion(image: string, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
59
+ checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
60
+ checkRegion(image: Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
54
61
  checkRegionByElement(element: Element, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
55
62
  checkRegionBy(selector: EyesSelector<Selector>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
56
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
57
- checkImage(image: string | URL | Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
63
+ checkRegionInFrame(frame: number, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
64
+ checkRegionInFrame(frame: Element, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
65
+ checkRegionInFrame(frame: EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
66
+ checkImage(image: string, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
67
+ checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
68
+ checkImage(image: Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
58
69
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
59
70
  extractTextRegions<TPattern extends string>(target: {
60
71
  image: string | URL | Buffer;
@@ -88,14 +99,17 @@ export class Eyes {
88
99
  getViewportSize(): Promise<RectangleSize>;
89
100
  setViewportSize(size: RectangleSizePlain): Promise<void>;
90
101
  getScrollRootElement(): Element | EyesSelector<Selector>;
91
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
92
- setLogHandler(handler: LogHandlerPlain | LogHandler): void;
102
+ setScrollRootElement(scrollRootElement: Element): void;
103
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): void;
104
+ setLogHandler(handler: LogHandlerPlain): void;
105
+ setLogHandler(handler: LogHandler): void;
93
106
  getLogHandler(): LogHandler;
94
107
  setCutProvider(cutProvider: CutProvider): void;
95
108
  setImageCut(cutProvider: CutProvider): void;
96
109
  getIsCutProviderExplicitlySet(): boolean;
97
110
  getRotation(): ImageRotation;
98
- setRotation(rotation: ImageRotationPlain | ImageRotation): void;
111
+ setRotation(rotation: ImageRotationPlain): void;
112
+ setRotation(rotation: ImageRotation): void;
99
113
  getScaleRatio(): number;
100
114
  setScaleRatio(scaleRatio: number): void;
101
115
  getSaveDebugScreenshots(): boolean;
@@ -108,7 +122,8 @@ export class Eyes {
108
122
  clearProperties(): Configuration;
109
123
  getBatch(): BatchInfo;
110
124
  setBatch(batch: BatchInfoPlain): void;
111
- setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
125
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string): void;
126
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | Date): void;
112
127
  getApiKey(): string;
113
128
  setApiKey(apiKey: string): void;
114
129
  getTestName(): string;
@@ -178,7 +193,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
178
193
  scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
179
194
  fully?: undefined | boolean;
180
195
  disableBrowserFetching?: undefined | boolean;
181
- layoutBreakpoints?: undefined | boolean | Array<number>;
196
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
182
197
  visualGridOptions?: undefined | { [key: string]: any; };
183
198
  nmgOptions?: undefined | { [key: string]: any; };
184
199
  hooks?: undefined | { beforeCaptureScreenshot: string; };
@@ -188,17 +203,25 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
188
203
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
189
204
  };
190
205
  export class CheckSettingsAutomation {
191
- constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
192
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
193
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
206
+ constructor(settings?: undefined | CheckSettingsAutomation);
207
+ constructor(settings?: undefined | CheckSettingsAutomationPlain);
208
+ region(region: RegionPlain): CheckSettingsAutomation;
209
+ region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
210
+ shadow(selector: string): CheckSettingsAutomation;
211
+ shadow(selector: Selector): CheckSettingsAutomation;
212
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
194
213
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
195
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
196
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
197
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
214
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
215
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
216
+ webview(webview?: undefined | string): CheckSettingsAutomation;
217
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
218
+ scrollRootElement(scrollRootElement: Element): CheckSettingsAutomation;
219
+ scrollRootElement(scrollRootElement: (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
198
220
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
199
221
  stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
200
222
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
201
- layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
223
+ layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
224
+ layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
202
225
  hook(name: string, script: string): CheckSettingsAutomation;
203
226
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
204
227
  webHook(script: string): CheckSettingsAutomation;
@@ -211,19 +234,29 @@ export class CheckSettingsAutomation {
211
234
  renderId(renderId: string): CheckSettingsAutomation;
212
235
  timeout(timeout: number): CheckSettingsAutomation;
213
236
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
214
- lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
237
+ lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
238
+ lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
215
239
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
216
240
  name(name: string): CheckSettingsAutomation;
217
241
  withName(name: string): CheckSettingsAutomation;
218
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
242
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
243
+ ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
244
+ ignoreRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
219
245
  ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
220
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
246
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
247
+ ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
221
248
  ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
222
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
249
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
250
+ layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
251
+ layoutRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
223
252
  layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
224
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
253
+ strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
254
+ strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
255
+ strictRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
225
256
  strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
226
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
257
+ contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
258
+ contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
259
+ contentRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
227
260
  contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
228
261
  floatingRegion(region: {
229
262
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
@@ -240,7 +273,8 @@ export class CheckSettingsAutomation {
240
273
  maxLeftOffset?: undefined | number;
241
274
  maxRightOffset?: undefined | number;
242
275
  }): CheckSettingsAutomation;
243
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
276
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
277
+ floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
244
278
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
245
279
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
246
280
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -254,7 +288,8 @@ export class CheckSettingsAutomation {
254
288
  regionId?: undefined | string;
255
289
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
256
290
  }): CheckSettingsAutomation;
257
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
291
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
292
+ floating(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
258
293
  floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
259
294
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
260
295
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -268,7 +303,16 @@ export class CheckSettingsAutomation {
268
303
  regionId?: undefined | string;
269
304
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
270
305
  }): CheckSettingsAutomation;
271
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
306
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
307
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
308
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsAutomation;
309
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "RegularText"): CheckSettingsAutomation;
310
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsAutomation;
311
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "LargeText"): CheckSettingsAutomation;
312
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsAutomation;
313
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "BoldText"): CheckSettingsAutomation;
314
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
315
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
272
316
  accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
273
317
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
274
318
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -294,11 +338,16 @@ export class CheckSettings extends CheckSettingsAutomation {
294
338
  }
295
339
  export type TargetAutomation = {
296
340
  window(): CheckSettingsAutomation;
297
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
341
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
342
+ region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
298
343
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
299
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
300
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
301
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
344
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
345
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
346
+ shadow(selector: string): CheckSettingsAutomation;
347
+ shadow(selector: Selector): CheckSettingsAutomation;
348
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
349
+ webview(webview?: undefined | string): CheckSettingsAutomation;
350
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
302
351
  };
303
352
  export const Target: TargetImage & TargetAutomation;
304
353
  export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
@@ -352,7 +401,7 @@ export type ConfigurationPlain = {
352
401
  concurrentSessions?: undefined | number;
353
402
  browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
354
403
  visualGridOptions?: undefined | Record<string, any>;
355
- layoutBreakpoints?: undefined | boolean | Array<number>;
404
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
356
405
  disableBrowserFetching?: undefined | boolean;
357
406
  waitBeforeCapture?: undefined | number;
358
407
  };
@@ -550,7 +599,8 @@ export class Configuration implements Required<ConfigurationPlain> {
550
599
  get scrollRootElement(): Element | EyesSelector<Selector>;
551
600
  set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
552
601
  getScrollRootElement(): Element | EyesSelector<Selector>;
553
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
602
+ setScrollRootElement(scrollRootElement: Element): Configuration;
603
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
554
604
  get cut(): CutProviderPlain;
555
605
  set cut(cut: CutProviderPlain);
556
606
  getCut(): CutProviderPlain;
@@ -558,7 +608,8 @@ export class Configuration implements Required<ConfigurationPlain> {
558
608
  get rotation(): ImageRotationPlain;
559
609
  set rotation(rotation: ImageRotationPlain);
560
610
  getRotation(): ImageRotation;
561
- setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration;
611
+ setRotation(rotation: ImageRotationPlain): Configuration;
612
+ setRotation(rotation: ImageRotation): Configuration;
562
613
  get scaleRatio(): number;
563
614
  set scaleRatio(scaleRatio: number);
564
615
  getScaleRatio(): number;
@@ -572,20 +623,45 @@ export class Configuration implements Required<ConfigurationPlain> {
572
623
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
573
624
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
574
625
  addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
575
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
576
- addBrowser(width: number, height: number, name?: undefined | "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"): Configuration;
577
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
578
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
579
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
626
+ addBrowser(browserInfo: DesktopBrowserInfo): Configuration;
627
+ addBrowser(browserInfo: ChromeEmulationInfo): Configuration;
628
+ addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }): Configuration;
629
+ addBrowser(browserInfo: IOSDeviceInfo): Configuration;
630
+ addBrowser(browserInfo: AndroidDeviceInfo): Configuration;
631
+ addBrowser(width: number, height: number, name?: undefined | "chrome"): Configuration;
632
+ addBrowser(width: number, height: number, name?: undefined | "chrome-one-version-back"): Configuration;
633
+ addBrowser(width: number, height: number, name?: undefined | "chrome-two-versions-back"): Configuration;
634
+ addBrowser(width: number, height: number, name?: undefined | "firefox"): Configuration;
635
+ addBrowser(width: number, height: number, name?: undefined | "firefox-one-version-back"): Configuration;
636
+ addBrowser(width: number, height: number, name?: undefined | "firefox-two-versions-back"): Configuration;
637
+ addBrowser(width: number, height: number, name?: undefined | "ie"): Configuration;
638
+ addBrowser(width: number, height: number, name?: undefined | "ie10"): Configuration;
639
+ addBrowser(width: number, height: number, name?: undefined | "edge"): Configuration;
640
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium"): Configuration;
641
+ addBrowser(width: number, height: number, name?: undefined | "edgelegacy"): Configuration;
642
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-one-version-back"): Configuration;
643
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-two-versions-back"): Configuration;
644
+ addBrowser(width: number, height: number, name?: undefined | "safari"): Configuration;
645
+ addBrowser(width: number, height: number, name?: undefined | "safari-earlyaccess"): Configuration;
646
+ addBrowser(width: number, height: number, name?: undefined | "safari-one-version-back"): Configuration;
647
+ addBrowser(width: number, height: number, name?: undefined | "safari-two-versions-back"): Configuration;
648
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape"): Configuration;
649
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait"): Configuration;
650
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
651
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
652
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
653
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
580
654
  get visualGridOptions(): { [key: string]: any; };
581
655
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
582
656
  getVisualGridOptions(): { [key: string]: any; };
583
657
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
584
658
  setVisualGridOption(key: string, value: any): Configuration;
585
- get layoutBreakpoints(): boolean | Array<number>;
586
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number>);
587
- getLayoutBreakpoints(): boolean | Array<number>;
588
- setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number>): Configuration;
659
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
660
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
661
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
662
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
663
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
664
+ setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
589
665
  get disableBrowserFetching(): boolean;
590
666
  set disableBrowserFetching(disableBrowserFetching: boolean);
591
667
  getDisableBrowserFetching(): boolean;
@@ -851,7 +927,11 @@ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: unde
851
927
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
852
928
  constructor(settings: AccessibilityMatchSettingsPlain);
853
929
  constructor(region: RegionPlain);
854
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
930
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast");
931
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "RegularText");
932
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "LargeText");
933
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "BoldText");
934
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "GraphicalObject");
855
935
  get region(): RegionPlain;
856
936
  set region(region: RegionPlain);
857
937
  getRegion(): Region;
@@ -881,7 +961,8 @@ export type BatchInfoPlain = {
881
961
  export class BatchInfo implements Required<BatchInfoPlain> {
882
962
  constructor();
883
963
  constructor(batch?: undefined | BatchInfoPlain);
884
- constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
964
+ constructor(name?: undefined | string, startedAt?: undefined | string, id?: undefined | string);
965
+ constructor(name?: undefined | string, startedAt?: undefined | Date, id?: undefined | string);
885
966
  get id(): string;
886
967
  set id(id: string);
887
968
  getId(): string;
@@ -897,7 +978,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
897
978
  get startedAt(): string | Date;
898
979
  set startedAt(startedAt: string | Date);
899
980
  getStartedAt(): string | Date;
900
- setStartedAt(startedAt: string | Date): BatchInfo;
981
+ setStartedAt(startedAt: string): BatchInfo;
982
+ setStartedAt(startedAt: Date): BatchInfo;
901
983
  get notifyOnCompletion(): boolean;
902
984
  set notifyOnCompletion(notifyOnCompletion: boolean);
903
985
  getNotifyOnCompletion(): boolean;
@@ -948,7 +1030,15 @@ export type CheckSettingsImagePlain = {
948
1030
  densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
949
1031
  };
950
1032
  export class CheckSettingsImage {
951
- constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
1033
+ constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
1034
+ image: string | URL | Buffer;
1035
+ name?: undefined | string;
1036
+ dom?: undefined | string;
1037
+ locationInViewport?: undefined | LocationPlain;
1038
+ locationInView?: undefined | LocationPlain;
1039
+ fullViewSize?: undefined | RectangleSizePlain;
1040
+ });
1041
+ constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
952
1042
  image: string | URL | Buffer;
953
1043
  name?: undefined | string;
954
1044
  dom?: undefined | string;
@@ -956,25 +1046,38 @@ export class CheckSettingsImage {
956
1046
  locationInView?: undefined | LocationPlain;
957
1047
  fullViewSize?: undefined | RectangleSizePlain;
958
1048
  });
959
- image(image: string | URL | Buffer): CheckSettingsImage;
1049
+ image(image: string): CheckSettingsImage;
1050
+ image(image: URL): CheckSettingsImage;
1051
+ image(image: Buffer): CheckSettingsImage;
960
1052
  buffer(imageBuffer: Buffer): CheckSettingsImage;
961
1053
  base64(imageBase64: Buffer): CheckSettingsImage;
962
1054
  path(imagePath: string): CheckSettingsImage;
963
- url(imageUrl: string | URL): CheckSettingsImage;
1055
+ url(imageUrl: string): CheckSettingsImage;
1056
+ url(imageUrl: URL): CheckSettingsImage;
964
1057
  name(name: string): CheckSettingsImage;
965
1058
  withDom(dom: string): CheckSettingsImage;
966
1059
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
967
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1060
+ region(region: LegacyRegionPlain): CheckSettingsImage;
1061
+ region(region: RegionPlain): CheckSettingsImage;
968
1062
  withName(name: string): CheckSettingsImage;
969
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1063
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1064
+ ignoreRegion(region: RegionPlain): CheckSettingsImage;
1065
+ ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
970
1066
  ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
971
- ignore(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1067
+ ignore(region: LegacyRegionPlain): CheckSettingsImage;
1068
+ ignore(region: RegionPlain): CheckSettingsImage;
972
1069
  ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
973
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1070
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1071
+ layoutRegion(region: RegionPlain): CheckSettingsImage;
1072
+ layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
974
1073
  layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
975
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1074
+ strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1075
+ strictRegion(region: RegionPlain): CheckSettingsImage;
1076
+ strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
976
1077
  strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
977
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1078
+ contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1079
+ contentRegion(region: RegionPlain): CheckSettingsImage;
1080
+ contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
978
1081
  contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
979
1082
  floatingRegion(region: {
980
1083
  region: RegionPlain;
@@ -991,7 +1094,8 @@ export class CheckSettingsImage {
991
1094
  maxLeftOffset?: undefined | number;
992
1095
  maxRightOffset?: undefined | number;
993
1096
  }): CheckSettingsImage;
994
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1097
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1098
+ floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
995
1099
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
996
1100
  region: RegionPlain;
997
1101
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1005,7 +1109,8 @@ export class CheckSettingsImage {
1005
1109
  regionId?: undefined | string;
1006
1110
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1007
1111
  }): CheckSettingsImage;
1008
- floating(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1112
+ floating(region: LegacyRegionPlain): CheckSettingsImage;
1113
+ floating(region: RegionPlain): CheckSettingsImage;
1009
1114
  floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
1010
1115
  region: RegionPlain;
1011
1116
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1019,7 +1124,16 @@ export class CheckSettingsImage {
1019
1124
  regionId?: undefined | string;
1020
1125
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
1021
1126
  }): CheckSettingsImage;
1022
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
1127
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1128
+ accessibilityRegion(region: RegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1129
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1130
+ accessibilityRegion(region: RegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1131
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1132
+ accessibilityRegion(region: RegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1133
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1134
+ accessibilityRegion(region: RegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1135
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1136
+ accessibilityRegion(region: RegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1023
1137
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
1024
1138
  region: RegionPlain;
1025
1139
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1042,11 +1156,14 @@ export class CheckSettingsImage {
1042
1156
  variationGroupId(variationGroupId: string): CheckSettingsImage;
1043
1157
  }
1044
1158
  export type TargetImage = {
1045
- image(image: string | URL | Buffer): CheckSettingsImage;
1159
+ image(image: string): CheckSettingsImage;
1160
+ image(image: URL): CheckSettingsImage;
1161
+ image(image: Buffer): CheckSettingsImage;
1046
1162
  buffer(imageBuffer: Buffer): CheckSettingsImage;
1047
1163
  base64(imageBase64: string): CheckSettingsImage;
1048
1164
  path(imagePath: string): CheckSettingsImage;
1049
- url(imageUrl: string | URL): CheckSettingsImage;
1165
+ url(imageUrl: string): CheckSettingsImage;
1166
+ url(imageUrl: URL): CheckSettingsImage;
1050
1167
  };
1051
1168
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
1052
1169
  export class CutProvider implements Required<{
@@ -1238,7 +1355,14 @@ export class Location implements Required<LocationPlain> {
1238
1355
  setY(y: number): void;
1239
1356
  }
1240
1357
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1241
- export type CustomLogHandlerPlain = { log(message: any): void; };
1358
+ export type CustomLogHandlerPlain = {
1359
+ log(message: any): void;
1360
+ warn?(message: any): void;
1361
+ error?(message: any): void;
1362
+ fatal?(message: any): void;
1363
+ open?(): void;
1364
+ close?(): void;
1365
+ };
1242
1366
  export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1243
1367
  export type ConsoleLogHandlerPlain = { type: "console"; };
1244
1368
  export abstract class LogHandler implements CustomLogHandlerPlain {
@@ -1348,7 +1472,7 @@ export type DesktopBrowserInfo = { name?: undefined | "chrome" | "chrome-one-ver
1348
1472
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1349
1473
  export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1350
1474
  export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1351
- export type RunnerOptionsPlain = { testConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1475
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1352
1476
  export class RunnerOptionsFluent {
1353
1477
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1354
1478
  }
@@ -1511,7 +1635,8 @@ export class TestResults implements Required<TestResultsPlain> {
1511
1635
  setAccessibilityStatus(_accessibilityStatus: TestAccessibilityStatus): void;
1512
1636
  get startedAt(): string;
1513
1637
  getStartedAt(): Date;
1514
- setStartedAt(_startedAt: string | Date): void;
1638
+ setStartedAt(_startedAt: string): void;
1639
+ setStartedAt(_startedAt: Date): void;
1515
1640
  get duration(): number;
1516
1641
  getDuration(): number;
1517
1642
  setDuration(_duration: number): void;
@@ -1615,8 +1740,6 @@ export class Logger {
1615
1740
  fatal(...messages: Array<any>): void;
1616
1741
  open(): void;
1617
1742
  close(): void;
1618
- tag(name: string, value: any): void;
1619
- extend(label?: undefined | string): Logger;
1620
1743
  }
1621
1744
  export abstract class EyesRunner {
1622
1745
  constructor(options?: undefined | RunnerOptionsPlain);