@applitools/eyes-webdriverio 5.39.0 → 5.39.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 (7) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/legacy.js +4 -4
  3. package/dist/service.js +1 -1
  4. package/package.json +17 -15
  5. package/types/index.d.ts +337 -344
  6. package/types/service.d.ts +19 -33
  7. package/types/v8.d.ts +1 -0
package/CHANGELOG.md CHANGED
@@ -10,6 +10,13 @@
10
10
 
11
11
 
12
12
 
13
+ ## 5.39.1 - 2023/1/5
14
+
15
+ ### Features
16
+ - Upgrade to wdio@8
17
+ ### Bug fixes
18
+ - Additional internal event logs
19
+
13
20
  ## 5.39.0 - 2022/12/21
14
21
 
15
22
  ### Features
package/dist/legacy.js CHANGED
@@ -2,10 +2,6 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.By = void 0;
4
4
  class By {
5
- constructor(value, using = 'css selector') {
6
- this.value = value;
7
- this.using = using;
8
- }
9
5
  static css(css) {
10
6
  return new By(css);
11
7
  }
@@ -33,6 +29,10 @@ class By {
33
29
  static xPath(xpath) {
34
30
  return By.xpath(xpath);
35
31
  }
32
+ constructor(value, using = 'css selector') {
33
+ this.value = value;
34
+ this.using = using;
35
+ }
36
36
  toString() {
37
37
  return `${this.using}:${this.value}`;
38
38
  }
package/dist/service.js CHANGED
@@ -52,7 +52,7 @@ class EyesService {
52
52
  }
53
53
  async _eyesOpen() {
54
54
  if (!this._eyes.isOpen) {
55
- this._testResults = null;
55
+ this._testResults = undefined;
56
56
  await this._eyes.open(browser);
57
57
  }
58
58
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.39.0",
3
+ "version": "5.39.1",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -89,7 +89,7 @@
89
89
  ],
90
90
  "scripts": {
91
91
  "lint": "eslint '**/*.ts'",
92
- "build": "ttsc --project tsconfig$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo .v${APPLITOOLS_WEBDRIVERIO_VERSION%%.*}).json",
92
+ "build": "ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
93
93
  "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5'",
94
94
  "test": "yarn test:service && yarn test:coverage",
95
95
  "test:sanity": "echo 'create sanity suite'",
@@ -101,7 +101,7 @@
101
101
  "setup": "yarn docker:setup",
102
102
  "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
103
103
  "docker:teardown": "docker-compose down",
104
- "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION; echo \"$packagejson\" > package.json; fi",
104
+ "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION webdriver@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
105
105
  "deps": "bongo deps",
106
106
  "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
107
107
  "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
@@ -116,9 +116,9 @@
116
116
  }
117
117
  },
118
118
  "dependencies": {
119
- "@applitools/core": "1.3.3",
120
- "@applitools/eyes-api": "1.11.2",
121
- "@applitools/spec-driver-webdriverio": "1.4.12"
119
+ "@applitools/core": "1.3.7",
120
+ "@applitools/eyes-api": "1.11.6",
121
+ "@applitools/spec-driver-webdriverio": "1.4.18"
122
122
  },
123
123
  "devDependencies": {
124
124
  "@applitools/api-extractor": "1.2.11",
@@ -126,21 +126,23 @@
126
126
  "@applitools/scripts": "1.2.0",
127
127
  "@applitools/sdk-coverage-tests": "^2.7.10",
128
128
  "@applitools/sdk-shared": "0.9.15",
129
- "@applitools/test-utils": "1.5.4",
129
+ "@applitools/test-utils": "1.5.6",
130
130
  "@types/mocha": "^9.1.1",
131
- "@types/node": "12",
131
+ "@types/node": "16",
132
132
  "@typescript-eslint/eslint-plugin": "^5.27.0",
133
133
  "@typescript-eslint/parser": "^5.27.0",
134
- "@wdio/cli": "^7.16.5",
135
- "@wdio/dot-reporter": "^7.16.4",
136
- "@wdio/local-runner": "^7.16.5",
137
- "@wdio/mocha-framework": "^7.16.4",
134
+ "@wdio/cli": "^8.0.15",
135
+ "@wdio/dot-reporter": "^8.0.14",
136
+ "@wdio/globals": "^8.0.15",
137
+ "@wdio/local-runner": "^8.0.15",
138
+ "@wdio/mocha-framework": "^8.0.14",
138
139
  "chromedriver": "^105.0.1",
139
140
  "eslint": "^8.16.0",
140
141
  "eslint-config-prettier": "^8.5.0",
141
142
  "eslint-plugin-mocha-no-only": "^1.1.1",
142
143
  "eslint-plugin-node": "^11.1.0",
143
144
  "eslint-plugin-prettier": "^4.0.0",
145
+ "expect-webdriverio": "^4.0.1",
144
146
  "geckodriver": "^1.20.0",
145
147
  "husky": "^4.3.8",
146
148
  "mocha": "^9.2.2",
@@ -148,11 +150,11 @@
148
150
  "spec-xunit-file": "0.0.1-3",
149
151
  "ts-node": "^10.8.0",
150
152
  "ttypescript": "^1.5.13",
151
- "typescript": "^4.7.2",
152
- "webdriverio": "^7.19.7"
153
+ "typescript": "^4.9.4",
154
+ "webdriverio": "^8.0.15"
153
155
  },
154
156
  "peerDependencies": {
155
- "webdriverio": "5.0.0 - 7.x.x"
157
+ "webdriverio": "5.0.0 - 8.x.x"
156
158
  },
157
159
  "engines": {
158
160
  "node": ">=12.13.0"
package/types/index.d.ts CHANGED
@@ -13,13 +13,13 @@ export class By {
13
13
  readonly using: string;
14
14
  toString(): string;
15
15
  }
16
- export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: never; };
17
- export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: never; };
18
- export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: never; };
16
+ export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: undefined; };
17
+ export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: undefined; };
18
+ export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: undefined; };
19
19
  export class Eyes {
20
20
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
21
- constructor(runner?: EyesRunner, config?: ConfigurationPlain);
22
- constructor(config?: ConfigurationPlain);
21
+ constructor(runner?: undefined | EyesRunner, config?: undefined | ConfigurationPlain);
22
+ constructor(config?: undefined | ConfigurationPlain);
23
23
  get logger(): Logger;
24
24
  getLogger(): Logger;
25
25
  get runner(): EyesRunner;
@@ -32,44 +32,44 @@ export class Eyes {
32
32
  setConfiguration(config: ConfigurationPlain): void;
33
33
  get isOpen(): boolean;
34
34
  getIsOpen(): boolean;
35
- open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
36
- open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
37
- open(config?: ConfigurationPlain): Promise<void>;
38
- open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
35
+ open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
36
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
37
+ open(config?: undefined | ConfigurationPlain): Promise<void>;
38
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
39
39
  check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
40
40
  check(target: {
41
41
  image: string | URL | Buffer;
42
- name?: string;
43
- dom?: string;
44
- locationInViewport?: LocationPlain;
45
- locationInView?: LocationPlain;
46
- fullViewSize?: RectangleSizePlain;
47
- }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
48
- check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
42
+ name?: undefined | string;
43
+ dom?: undefined | string;
44
+ locationInViewport?: undefined | LocationPlain;
45
+ locationInView?: undefined | LocationPlain;
46
+ fullViewSize?: undefined | RectangleSizePlain;
47
+ }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
48
+ check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
49
49
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
50
50
  extractTextRegions<TPattern extends string>(target: {
51
51
  image: string | URL | Buffer;
52
- size?: { width: number; height: number; };
53
- name?: string;
54
- source?: string;
55
- dom?: string;
56
- locationInViewport?: { x: number; y: number; };
57
- locationInView?: { x: number; y: number; };
58
- fullViewSize?: { width: number; height: number; };
52
+ size?: undefined | { width: number; height: number; };
53
+ name?: undefined | string;
54
+ source?: undefined | string;
55
+ dom?: undefined | string;
56
+ locationInViewport?: undefined | { x: number; y: number; };
57
+ locationInView?: undefined | { x: number; y: number; };
58
+ fullViewSize?: undefined | { width: number; height: number; };
59
59
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
60
60
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
61
61
  extractText(target: {
62
62
  image: string | URL | Buffer;
63
- size?: { width: number; height: number; };
64
- name?: string;
65
- source?: string;
66
- dom?: string;
67
- locationInViewport?: { x: number; y: number; };
68
- locationInView?: { x: number; y: number; };
69
- fullViewSize?: { width: number; height: number; };
63
+ size?: undefined | { width: number; height: number; };
64
+ name?: undefined | string;
65
+ source?: undefined | string;
66
+ dom?: undefined | string;
67
+ locationInViewport?: undefined | { x: number; y: number; };
68
+ locationInView?: undefined | { x: number; y: number; };
69
+ fullViewSize?: undefined | { width: number; height: number; };
70
70
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
71
71
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
72
- close(throwErr?: boolean): Promise<TestResults>;
72
+ close(throwErr?: undefined | boolean): Promise<TestResults>;
73
73
  abort(): Promise<TestResults>;
74
74
  getViewportSize(): Promise<RectangleSize>;
75
75
  setViewportSize(size: RectangleSizePlain): Promise<void>;
@@ -94,7 +94,7 @@ export class Eyes {
94
94
  clearProperties(): Configuration;
95
95
  getBatch(): BatchInfo;
96
96
  setBatch(batch: BatchInfoPlain): void;
97
- setBatch(name: string, id?: string, startedAt?: string | Date): void;
97
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
98
98
  getApiKey(): string;
99
99
  setApiKey(apiKey: string): void;
100
100
  getTestName(): string;
@@ -128,7 +128,7 @@ export class Eyes {
128
128
  getParentBranchName(): string;
129
129
  setParentBranchName(parentBranchName: string): void;
130
130
  setProxy(proxy: ProxySettingsPlain): void;
131
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
131
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): void;
132
132
  setProxy(isEnabled: false): void;
133
133
  getProxy(): ProxySettings;
134
134
  getSaveDiffs(): boolean;
@@ -153,56 +153,56 @@ export class Eyes {
153
153
  setStitchOverlap(stitchOverlap: number): void;
154
154
  }
155
155
  export type ConfigurationPlain = {
156
- agentId?: string;
157
- apiKey?: string;
158
- serverUrl?: string;
159
- proxy?: ProxySettingsPlain;
160
- autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
161
- isDisabled?: boolean;
162
- appName?: string;
163
- testName?: string;
164
- displayName?: string;
165
- viewportSize?: RectangleSizePlain;
166
- sessionType?: SessionTypePlain;
167
- properties?: Array<PropertyDataPlain>;
168
- batch?: BatchInfoPlain;
169
- defaultMatchSettings?: ImageMatchSettingsPlain;
170
- hostApp?: string;
171
- hostOS?: string;
172
- hostAppInfo?: string;
173
- hostOSInfo?: string;
174
- deviceInfo?: string;
175
- baselineEnvName?: string;
176
- environmentName?: string;
177
- branchName?: string;
178
- parentBranchName?: string;
179
- baselineBranchName?: string;
180
- compareWithParentBranch?: boolean;
181
- ignoreBaseline?: boolean;
182
- ignoreGitMergeBase?: boolean;
183
- saveFailedTests?: boolean;
184
- saveNewTests?: boolean;
185
- saveDiffs?: boolean;
186
- sendDom?: boolean;
187
- matchTimeout?: number;
188
- forceFullPageScreenshot?: boolean;
189
- waitBeforeScreenshots?: number;
190
- stitchMode?: StitchModePlain;
191
- hideScrollbars?: boolean;
192
- hideCaret?: boolean;
193
- stitchOverlap?: number;
194
- scrollRootElement?: Element | EyesSelector<Selector>;
195
- cut?: CutProviderPlain;
196
- rotation?: ImageRotationPlain;
197
- scaleRatio?: number;
198
- waitBeforeCapture?: number;
199
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
200
- visualGridOptions?: Record<string, any>;
201
- layoutBreakpoints?: boolean | Array<number>;
202
- disableBrowserFetching?: boolean;
156
+ agentId?: undefined | string;
157
+ apiKey?: undefined | string;
158
+ serverUrl?: undefined | string;
159
+ proxy?: undefined | ProxySettingsPlain;
160
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
161
+ isDisabled?: undefined | boolean;
162
+ appName?: undefined | string;
163
+ testName?: undefined | string;
164
+ displayName?: undefined | string;
165
+ viewportSize?: undefined | RectangleSizePlain;
166
+ sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
167
+ properties?: undefined | Array<PropertyDataPlain>;
168
+ batch?: undefined | BatchInfoPlain;
169
+ defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
170
+ hostApp?: undefined | string;
171
+ hostOS?: undefined | string;
172
+ hostAppInfo?: undefined | string;
173
+ hostOSInfo?: undefined | string;
174
+ deviceInfo?: undefined | string;
175
+ baselineEnvName?: undefined | string;
176
+ environmentName?: undefined | string;
177
+ branchName?: undefined | string;
178
+ parentBranchName?: undefined | string;
179
+ baselineBranchName?: undefined | string;
180
+ compareWithParentBranch?: undefined | boolean;
181
+ ignoreBaseline?: undefined | boolean;
182
+ ignoreGitMergeBase?: undefined | boolean;
183
+ saveFailedTests?: undefined | boolean;
184
+ saveNewTests?: undefined | boolean;
185
+ saveDiffs?: undefined | boolean;
186
+ sendDom?: undefined | boolean;
187
+ matchTimeout?: undefined | number;
188
+ forceFullPageScreenshot?: undefined | boolean;
189
+ waitBeforeScreenshots?: undefined | number;
190
+ stitchMode?: undefined | "Scroll" | "CSS";
191
+ hideScrollbars?: undefined | boolean;
192
+ hideCaret?: undefined | boolean;
193
+ stitchOverlap?: undefined | number;
194
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
195
+ cut?: undefined | CutProviderPlain;
196
+ rotation?: undefined | ImageRotationPlain;
197
+ scaleRatio?: undefined | number;
198
+ waitBeforeCapture?: undefined | number;
199
+ browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
200
+ visualGridOptions?: undefined | Record<string, any>;
201
+ layoutBreakpoints?: undefined | boolean | Array<number>;
202
+ disableBrowserFetching?: undefined | boolean;
203
203
  };
204
204
  export class Configuration implements Required<ConfigurationPlain> {
205
- constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
205
+ constructor(config?: undefined | ConfigurationPlain, spec?: undefined | { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
206
206
  get appName(): string;
207
207
  set appName(appName: string);
208
208
  getAppName(): string;
@@ -247,12 +247,12 @@ export class Configuration implements Required<ConfigurationPlain> {
247
247
  set proxy(proxy: ProxySettingsPlain);
248
248
  getProxy(): ProxySettings;
249
249
  setProxy(proxy: ProxySettingsPlain): Configuration;
250
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
250
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): Configuration;
251
251
  setProxy(isEnabled: false): Configuration;
252
- get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
253
- set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
254
- getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
255
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
252
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
253
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
254
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
255
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
256
256
  get batch(): BatchInfoPlain;
257
257
  set batch(batch: BatchInfoPlain);
258
258
  getBatch(): BatchInfo;
@@ -394,14 +394,14 @@ export class Configuration implements Required<ConfigurationPlain> {
394
394
  setScaleRatio(scaleRatio: number): Configuration;
395
395
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
396
396
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
397
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
398
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
399
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
400
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
401
- addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
402
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
403
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
404
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
397
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
398
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
399
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
400
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
401
+ 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;
402
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
403
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
404
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
405
405
  get visualGridOptions(): { [key: string]: any; };
406
406
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
407
407
  getVisualGridOptions(): { [key: string]: any; };
@@ -416,33 +416,33 @@ export class Configuration implements Required<ConfigurationPlain> {
416
416
  getDisableBrowserFetching(): boolean;
417
417
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
418
418
  }
419
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
419
+ export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
420
420
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
421
- frames?: Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
422
- webview?: string | boolean;
423
- scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
424
- fully?: boolean;
425
- disableBrowserFetching?: boolean;
426
- layoutBreakpoints?: boolean | Array<number>;
427
- visualGridOptions?: { [key: string]: any; };
428
- nmgOptions?: { [key: string]: any; };
429
- hooks?: { beforeCaptureScreenshot: string; };
430
- renderId?: string;
431
- timeout?: number;
432
- waitBeforeCapture?: number;
433
- lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
421
+ frames?: undefined | Array<{ 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>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
422
+ webview?: undefined | string | boolean;
423
+ scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
424
+ fully?: undefined | boolean;
425
+ disableBrowserFetching?: undefined | boolean;
426
+ layoutBreakpoints?: undefined | boolean | Array<number>;
427
+ visualGridOptions?: undefined | { [key: string]: any; };
428
+ nmgOptions?: undefined | { [key: string]: any; };
429
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
430
+ renderId?: undefined | string;
431
+ timeout?: undefined | number;
432
+ waitBeforeCapture?: undefined | number;
433
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
434
434
  };
435
435
  export class CheckSettingsAutomation {
436
- constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
437
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
438
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
439
- frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettingsAutomation;
440
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
441
- webview(webview?: string | boolean): CheckSettingsAutomation;
442
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
443
- fully(fully?: boolean): CheckSettingsAutomation;
436
+ constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
437
+ region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
438
+ shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
439
+ 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;
440
+ 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;
441
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
442
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
443
+ fully(fully?: undefined | boolean): CheckSettingsAutomation;
444
444
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
445
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
445
+ layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
446
446
  hook(name: string, script: string): CheckSettingsAutomation;
447
447
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
448
448
  ufgOption(key: string, value: any): CheckSettingsAutomation;
@@ -452,64 +452,64 @@ export class CheckSettingsAutomation {
452
452
  renderId(renderId: string): CheckSettingsAutomation;
453
453
  timeout(timeout: number): CheckSettingsAutomation;
454
454
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
455
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
455
+ lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
456
456
  name(name: string): CheckSettingsAutomation;
457
457
  withName(name: string): CheckSettingsAutomation;
458
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
459
- ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
460
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
461
- layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
462
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
463
- strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
464
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
465
- contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
458
+ 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; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
459
+ 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; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
460
+ 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; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
461
+ 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; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
462
+ 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; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
463
+ 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; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
464
+ 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; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
465
+ 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; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
466
466
  floatingRegion(region: {
467
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
468
- padding?: number | { top: number; bottom: number; let: number; right: number; };
469
- regionId?: string;
470
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
467
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
468
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
469
+ regionId?: undefined | string;
470
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
471
471
  }): CheckSettingsAutomation;
472
472
  floatingRegion(region: {
473
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
474
- padding?: number | { top: number; bottom: number; let: number; right: number; };
475
- regionId?: string;
476
- maxUpOffset?: number;
477
- maxDownOffset?: number;
478
- maxLeftOffset?: number;
479
- maxRightOffset?: number;
473
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
474
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
475
+ regionId?: undefined | string;
476
+ maxUpOffset?: undefined | number;
477
+ maxDownOffset?: undefined | number;
478
+ maxLeftOffset?: undefined | number;
479
+ maxRightOffset?: undefined | number;
480
480
  }): CheckSettingsAutomation;
481
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsAutomation;
482
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
483
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
484
- padding?: number | { top: number; bottom: number; let: number; right: number; };
485
- regionId?: string;
486
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
481
+ 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;
482
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
483
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
484
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
485
+ regionId?: undefined | string;
486
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
487
487
  }>): CheckSettingsAutomation;
488
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
488
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
489
489
  accessibilityRegion(region: {
490
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
491
- padding?: number | { top: number; bottom: number; let: number; right: number; };
492
- regionId?: string;
493
- type?: AccessibilityRegionTypePlain;
490
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
491
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
492
+ regionId?: undefined | string;
493
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
494
494
  }): CheckSettingsAutomation;
495
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
496
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
497
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
498
- padding?: number | { top: number; bottom: number; let: number; right: number; };
499
- regionId?: string;
500
- type?: AccessibilityRegionTypePlain;
495
+ 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;
496
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
497
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
498
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
499
+ regionId?: undefined | string;
500
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
501
501
  }>): CheckSettingsAutomation;
502
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
502
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
503
503
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
504
504
  layout(): CheckSettingsAutomation;
505
505
  exact(): CheckSettingsAutomation;
506
506
  strict(): CheckSettingsAutomation;
507
507
  ignoreColors(): CheckSettingsAutomation;
508
- enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
509
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
510
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
511
- useDom(useDom?: boolean): CheckSettingsAutomation;
512
- sendDom(sendDom?: boolean): CheckSettingsAutomation;
508
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
509
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
510
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
511
+ useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
512
+ sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
513
513
  pageId(pageId: string): CheckSettingsAutomation;
514
514
  variationGroupId(variationGroupId: string): CheckSettingsAutomation;
515
515
  }
@@ -517,15 +517,15 @@ export class CheckSettings extends CheckSettingsAutomation {
517
517
  }
518
518
  export const Target: TargetImage & TargetAutomation<Element, Selector>;
519
519
  export class BatchClose {
520
- static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
521
- constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
520
+ static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
521
+ constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
522
522
  close(): Promise<void>;
523
523
  setBatchIds(batchIds: Array<string>): BatchClose;
524
524
  setUrl(serverUrl: string): BatchClose;
525
525
  setApiKey(apiKey: string): BatchClose;
526
526
  setProxy(proxy: ProxySettingsPlain): BatchClose;
527
527
  }
528
- export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
528
+ export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
529
529
  export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
530
530
  export enum AccessibilityGuidelinesVersion {
531
531
  WCAG_2_0 = 'WCAG_2_0',
@@ -746,24 +746,24 @@ export enum TestResultsStatus {
746
746
  export class EyesError extends Error {
747
747
  }
748
748
  export class TestFailedError extends EyesError {
749
- constructor(message: string, results?: TestResultsPlain);
749
+ constructor(message: string, results?: undefined | TestResultsPlain);
750
750
  constructor(results: TestResultsPlain);
751
751
  get testResults(): TestResultsPlain;
752
752
  getTestResults(): TestResults;
753
753
  }
754
754
  export class DiffsFoundError extends TestFailedError {
755
- constructor(message: string, results?: TestResultsPlain);
755
+ constructor(message: string, results?: undefined | TestResultsPlain);
756
756
  constructor(results: TestResultsPlain);
757
757
  }
758
758
  export class NewTestError extends TestFailedError {
759
- constructor(message: string, results?: TestResultsPlain);
759
+ constructor(message: string, results?: undefined | TestResultsPlain);
760
760
  constructor(results: TestResultsPlain);
761
761
  }
762
- export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
762
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
763
763
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
764
764
  constructor(settings: AccessibilityMatchSettingsPlain);
765
765
  constructor(region: RegionPlain);
766
- constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
766
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
767
767
  get region(): RegionPlain;
768
768
  set region(region: RegionPlain);
769
769
  getRegion(): Region;
@@ -781,19 +781,19 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
781
781
  getType(): AccessibilityRegionType;
782
782
  setType(type: AccessibilityRegionTypePlain): void;
783
783
  }
784
- export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; };
784
+ export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
785
785
  export type BatchInfoPlain = {
786
- id?: string;
787
- name?: string;
788
- sequenceName?: string;
789
- startedAt?: string | Date;
790
- notifyOnCompletion?: boolean;
791
- properties?: Array<PropertyDataPlain>;
786
+ id?: undefined | string;
787
+ name?: undefined | string;
788
+ sequenceName?: undefined | string;
789
+ startedAt?: undefined | string | Date;
790
+ notifyOnCompletion?: undefined | boolean;
791
+ properties?: undefined | Array<PropertyDataPlain>;
792
792
  };
793
793
  export class BatchInfo implements Required<BatchInfoPlain> {
794
794
  constructor();
795
- constructor(batch?: BatchInfoPlain);
796
- constructor(name?: string, startedAt?: string | Date, id?: string);
795
+ constructor(batch?: undefined | BatchInfoPlain);
796
+ constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
797
797
  get id(): string;
798
798
  set id(id: string);
799
799
  getId(): string;
@@ -822,50 +822,50 @@ export class BatchInfo implements Required<BatchInfoPlain> {
822
822
  addProperty(prop: PropertyDataPlain): BatchInfo;
823
823
  }
824
824
  export type CheckSettingsImagePlain = {
825
- name?: string;
826
- region?: RegionPlain;
827
- matchLevel?: MatchLevelPlain;
828
- useDom?: boolean;
829
- sendDom?: boolean;
830
- enablePatterns?: boolean;
831
- ignoreDisplacements?: boolean;
832
- ignoreMismatch?: boolean;
833
- ignoreCaret?: boolean;
834
- ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
835
- layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
836
- strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
837
- contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
838
- floatingRegions?: Array<RegionPlain | {
825
+ name?: undefined | string;
826
+ region?: undefined | RegionPlain;
827
+ matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
828
+ useDom?: undefined | boolean;
829
+ sendDom?: undefined | boolean;
830
+ enablePatterns?: undefined | boolean;
831
+ ignoreDisplacements?: undefined | boolean;
832
+ ignoreMismatch?: undefined | boolean;
833
+ ignoreCaret?: undefined | boolean;
834
+ ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
835
+ layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
836
+ strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
837
+ contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
838
+ floatingRegions?: undefined | Array<RegionPlain | {
839
839
  region: RegionPlain;
840
- padding?: number | { top: number; bottom: number; let: number; right: number; };
841
- regionId?: string;
842
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
840
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
841
+ regionId?: undefined | string;
842
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
843
843
  } | {
844
844
  region: RegionPlain;
845
- padding?: number | { top: number; bottom: number; let: number; right: number; };
846
- regionId?: string;
847
- maxUpOffset?: number;
848
- maxDownOffset?: number;
849
- maxLeftOffset?: number;
850
- maxRightOffset?: number;
845
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
846
+ regionId?: undefined | string;
847
+ maxUpOffset?: undefined | number;
848
+ maxDownOffset?: undefined | number;
849
+ maxLeftOffset?: undefined | number;
850
+ maxRightOffset?: undefined | number;
851
851
  }>;
852
- accessibilityRegions?: Array<RegionPlain | {
852
+ accessibilityRegions?: undefined | Array<RegionPlain | {
853
853
  region: RegionPlain;
854
- padding?: number | { top: number; bottom: number; let: number; right: number; };
855
- regionId?: string;
856
- type?: AccessibilityRegionTypePlain;
854
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
855
+ regionId?: undefined | string;
856
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
857
857
  }>;
858
- pageId?: string;
859
- variationGroupId?: string;
858
+ pageId?: undefined | string;
859
+ variationGroupId?: undefined | string;
860
860
  };
861
861
  export class CheckSettingsImage {
862
- constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
862
+ constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
863
863
  image: string | URL | Buffer;
864
- name?: string;
865
- dom?: string;
866
- locationInViewport?: LocationPlain;
867
- locationInView?: LocationPlain;
868
- fullViewSize?: RectangleSizePlain;
864
+ name?: undefined | string;
865
+ dom?: undefined | string;
866
+ locationInViewport?: undefined | LocationPlain;
867
+ locationInView?: undefined | LocationPlain;
868
+ fullViewSize?: undefined | RectangleSizePlain;
869
869
  });
870
870
  image(image: string | URL | Buffer): CheckSettingsImage;
871
871
  buffer(imageBuffer: Buffer): CheckSettingsImage;
@@ -877,49 +877,49 @@ export class CheckSettingsImage {
877
877
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
878
878
  region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
879
879
  withName(name: string): CheckSettingsImage;
880
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
881
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
882
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
883
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
884
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
885
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
886
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
887
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
880
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
881
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
882
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
883
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
884
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
885
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
886
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
887
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
888
888
  floatingRegion(region: {
889
889
  region: RegionPlain;
890
- padding?: number | { top: number; bottom: number; let: number; right: number; };
891
- regionId?: string;
892
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
890
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
891
+ regionId?: undefined | string;
892
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
893
893
  }): CheckSettingsImage;
894
894
  floatingRegion(region: {
895
895
  region: RegionPlain;
896
- padding?: number | { top: number; bottom: number; let: number; right: number; };
897
- regionId?: string;
898
- maxUpOffset?: number;
899
- maxDownOffset?: number;
900
- maxLeftOffset?: number;
901
- maxRightOffset?: number;
896
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
897
+ regionId?: undefined | string;
898
+ maxUpOffset?: undefined | number;
899
+ maxDownOffset?: undefined | number;
900
+ maxLeftOffset?: undefined | number;
901
+ maxRightOffset?: undefined | number;
902
902
  }): CheckSettingsImage;
903
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
903
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
904
904
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
905
905
  region: RegionPlain;
906
- padding?: number | { top: number; bottom: number; let: number; right: number; };
907
- regionId?: string;
908
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
906
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
907
+ regionId?: undefined | string;
908
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
909
909
  }>): CheckSettingsImage;
910
910
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
911
911
  accessibilityRegion(region: {
912
912
  region: RegionPlain;
913
- padding?: number | { top: number; bottom: number; let: number; right: number; };
914
- regionId?: string;
915
- type?: AccessibilityRegionTypePlain;
913
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
914
+ regionId?: undefined | string;
915
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
916
916
  }): CheckSettingsImage;
917
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
917
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
918
918
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
919
919
  region: RegionPlain;
920
- padding?: number | { top: number; bottom: number; let: number; right: number; };
921
- regionId?: string;
922
- type?: AccessibilityRegionTypePlain;
920
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
921
+ regionId?: undefined | string;
922
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
923
923
  }>): CheckSettingsImage;
924
924
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
925
925
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
@@ -927,11 +927,11 @@ export class CheckSettingsImage {
927
927
  exact(): CheckSettingsImage;
928
928
  strict(): CheckSettingsImage;
929
929
  ignoreColors(): CheckSettingsImage;
930
- enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
931
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
932
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
933
- useDom(useDom?: boolean): CheckSettingsImage;
934
- sendDom(sendDom?: boolean): CheckSettingsImage;
930
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
931
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
932
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
933
+ useDom(useDom?: undefined | boolean): CheckSettingsImage;
934
+ sendDom(sendDom?: undefined | boolean): CheckSettingsImage;
935
935
  pageId(pageId: string): CheckSettingsImage;
936
936
  variationGroupId(variationGroupId: string): CheckSettingsImage;
937
937
  }
@@ -944,11 +944,11 @@ export type TargetImage = {
944
944
  };
945
945
  export type TargetAutomation<TElement, TSelector> = {
946
946
  window(): CheckSettingsAutomation;
947
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
948
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettingsAutomation;
949
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettingsAutomation;
950
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
951
- webview(webview?: string | boolean): CheckSettingsAutomation;
947
+ region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })))): CheckSettingsAutomation;
948
+ frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); }): CheckSettingsAutomation;
949
+ frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })), scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }))): CheckSettingsAutomation;
950
+ shadow(selector: string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }): CheckSettingsAutomation;
951
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
952
952
  };
953
953
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
954
954
  export class CutProvider implements Required<{
@@ -1000,15 +1000,15 @@ export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
1000
1000
  }
1001
1001
  export type FloatingMatchSettingsPlain = {
1002
1002
  region: RegionPlain;
1003
- maxUpOffset?: number;
1004
- maxDownOffset?: number;
1005
- maxLeftOffset?: number;
1006
- maxRightOffset?: number;
1003
+ maxUpOffset?: undefined | number;
1004
+ maxDownOffset?: undefined | number;
1005
+ maxLeftOffset?: undefined | number;
1006
+ maxRightOffset?: undefined | number;
1007
1007
  };
1008
1008
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
1009
1009
  constructor(settings: FloatingMatchSettingsPlain);
1010
1010
  constructor(region: RegionPlain);
1011
- constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
1011
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number);
1012
1012
  get region(): RegionPlain;
1013
1013
  set region(region: RegionPlain);
1014
1014
  getRegion(): Region;
@@ -1039,22 +1039,22 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1039
1039
  setMaxRightOffset(maxRightOffset: number): void;
1040
1040
  }
1041
1041
  export type ImageMatchSettingsPlain = {
1042
- exact?: ExactMatchSettingsPlain;
1043
- matchLevel?: MatchLevelPlain;
1044
- ignoreCaret?: boolean;
1045
- useDom?: boolean;
1046
- enablePatterns?: boolean;
1047
- ignoreDisplacements?: boolean;
1048
- ignoreRegions?: Array<RegionPlain>;
1049
- layoutRegions?: Array<RegionPlain>;
1050
- strictRegions?: Array<RegionPlain>;
1051
- contentRegions?: Array<RegionPlain>;
1052
- floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
1053
- accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1054
- accessibilitySettings?: AccessibilitySettings;
1042
+ exact?: undefined | ExactMatchSettingsPlain;
1043
+ matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
1044
+ ignoreCaret?: undefined | boolean;
1045
+ useDom?: undefined | boolean;
1046
+ enablePatterns?: undefined | boolean;
1047
+ ignoreDisplacements?: undefined | boolean;
1048
+ ignoreRegions?: undefined | Array<RegionPlain>;
1049
+ layoutRegions?: undefined | Array<RegionPlain>;
1050
+ strictRegions?: undefined | Array<RegionPlain>;
1051
+ contentRegions?: undefined | Array<RegionPlain>;
1052
+ floatingRegions?: undefined | Array<RegionPlain | FloatingMatchSettingsPlain>;
1053
+ accessibilityRegions?: undefined | Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1054
+ accessibilitySettings?: undefined | AccessibilitySettings;
1055
1055
  };
1056
1056
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
1057
- constructor(settings?: ImageMatchSettingsPlain);
1057
+ constructor(settings?: undefined | ImageMatchSettingsPlain);
1058
1058
  get exact(): ExactMatchSettingsPlain;
1059
1059
  set exact(exact: ExactMatchSettingsPlain);
1060
1060
  getExact(): ExactMatchSettings;
@@ -1140,18 +1140,11 @@ export class Location implements Required<LocationPlain> {
1140
1140
  setY(y: number): void;
1141
1141
  }
1142
1142
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1143
- export type CustomLogHandlerPlain = {
1144
- log(message: any): void;
1145
- warn?(message: any): void;
1146
- error?(message: any): void;
1147
- fatal?(message: any): void;
1148
- open?(): void;
1149
- close?(): void;
1150
- };
1151
- export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1143
+ export type CustomLogHandlerPlain = { log(message: any): void; };
1144
+ export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1152
1145
  export type ConsoleLogHandlerPlain = { type: "console"; };
1153
1146
  export abstract class LogHandler implements CustomLogHandlerPlain {
1154
- constructor(verbose?: boolean);
1147
+ constructor(verbose?: undefined | boolean);
1155
1148
  get verbose(): boolean;
1156
1149
  set verbose(verbose: boolean);
1157
1150
  getIsVerbose(): boolean;
@@ -1162,7 +1155,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1162
1155
  abstract close(): void;
1163
1156
  }
1164
1157
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1165
- constructor(verbose?: boolean, filename?: string, append?: boolean);
1158
+ constructor(verbose?: undefined | boolean, filename?: undefined | string, append?: undefined | boolean);
1166
1159
  readonly type: "file";
1167
1160
  readonly filename: string;
1168
1161
  readonly append: boolean;
@@ -1181,7 +1174,7 @@ export class NullLogHandler extends LogHandler {
1181
1174
  open(): void;
1182
1175
  close(): void;
1183
1176
  }
1184
- export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
1177
+ export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: undefined | boolean; firstOnly?: undefined | boolean; language?: undefined | string; };
1185
1178
  export type PropertyDataPlain = { name: string; value: string; };
1186
1179
  export class PropertyData implements Required<PropertyDataPlain> {
1187
1180
  constructor(property: PropertyDataPlain);
@@ -1195,10 +1188,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
1195
1188
  getValue(): string;
1196
1189
  setValue(value: string): void;
1197
1190
  }
1198
- export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1191
+ export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; isHttpOnly?: undefined | boolean; };
1199
1192
  export class ProxySettings implements Required<ProxySettingsPlain> {
1200
1193
  constructor(proxy: ProxySettingsPlain);
1201
- constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1194
+ constructor(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean);
1202
1195
  get url(): string;
1203
1196
  getUri(): string;
1204
1197
  getUrl(): string;
@@ -1253,22 +1246,22 @@ export class Region implements Required<RegionPlain> {
1253
1246
  getHeight(): number;
1254
1247
  setHeight(height: number): void;
1255
1248
  }
1256
- export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1257
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1258
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1259
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1260
- export type RunnerOptionsPlain = { testConcurrency?: number; };
1249
+ export type DesktopBrowserInfo = { 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"; width: number; height: number; };
1250
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1251
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1252
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1253
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1261
1254
  export class RunnerOptionsFluent {
1262
1255
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1263
1256
  }
1264
1257
  export function RunnerOptions(): RunnerOptionsFluent;
1265
1258
  export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1266
1259
  export type ApiUrlsPlain = {
1267
- readonly baselineImage?: string;
1268
- readonly currentImage?: string;
1269
- readonly checkpointImage?: string;
1270
- readonly checkpointImageThumbnail?: string;
1271
- readonly diffImage?: string;
1260
+ readonly baselineImage?: undefined | string;
1261
+ readonly currentImage?: undefined | string;
1262
+ readonly checkpointImage?: undefined | string;
1263
+ readonly checkpointImageThumbnail?: undefined | string;
1264
+ readonly diffImage?: undefined | string;
1272
1265
  };
1273
1266
  export class ApiUrls implements Required<ApiUrlsPlain> {
1274
1267
  get baselineImage(): string;
@@ -1282,21 +1275,21 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
1282
1275
  get diffImage(): string;
1283
1276
  getDiffImage(): string;
1284
1277
  }
1285
- export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1278
+ export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
1286
1279
  export class AppUrls implements Required<AppUrlsPlain> {
1287
1280
  get step(): string;
1288
1281
  getStep(): string;
1289
1282
  get stepEditor(): string;
1290
1283
  getStepEditor(): string;
1291
1284
  }
1292
- export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1285
+ export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1293
1286
  export class MatchResult implements Required<MatchResultPlain> {
1294
1287
  get asExpected(): boolean;
1295
1288
  getAsExpected(): boolean;
1296
1289
  get windowId(): number;
1297
1290
  getWindowId(): number;
1298
1291
  }
1299
- export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1292
+ export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
1300
1293
  export class SessionUrls implements Required<SessionUrlsPlain> {
1301
1294
  get batch(): string;
1302
1295
  getBatch(): string;
@@ -1304,13 +1297,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
1304
1297
  getSession(): string;
1305
1298
  }
1306
1299
  export type StepInfoPlain = {
1307
- readonly name?: string;
1308
- readonly isDifferent?: boolean;
1309
- readonly hasBaselineImage?: boolean;
1310
- readonly hasCurrentImage?: boolean;
1311
- readonly appUrls?: AppUrlsPlain;
1312
- readonly apiUrls?: ApiUrlsPlain;
1313
- readonly renderId?: Array<string>;
1300
+ readonly name?: undefined | string;
1301
+ readonly isDifferent?: undefined | boolean;
1302
+ readonly hasBaselineImage?: undefined | boolean;
1303
+ readonly hasCurrentImage?: undefined | boolean;
1304
+ readonly appUrls?: undefined | AppUrlsPlain;
1305
+ readonly apiUrls?: undefined | ApiUrlsPlain;
1306
+ readonly renderId?: undefined | Array<string>;
1314
1307
  };
1315
1308
  export class StepInfo implements Required<StepInfoPlain> {
1316
1309
  get name(): string;
@@ -1330,36 +1323,36 @@ export class StepInfo implements Required<StepInfoPlain> {
1330
1323
  }
1331
1324
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1332
1325
  export type TestResultsPlain = {
1333
- readonly id?: string;
1334
- readonly name?: string;
1335
- readonly secretToken?: string;
1336
- readonly status?: TestResultsStatusPlain;
1337
- readonly appName?: string;
1338
- readonly batchId?: string;
1339
- readonly batchName?: string;
1340
- readonly branchName?: string;
1341
- readonly hostOS?: string;
1342
- readonly hostApp?: string;
1343
- readonly hostDisplaySize?: RectangleSizePlain;
1344
- readonly accessibilityStatus?: TestAccessibilityStatus;
1345
- readonly startedAt?: string | Date;
1346
- readonly duration?: number;
1347
- readonly isNew?: boolean;
1348
- readonly isDifferent?: boolean;
1349
- readonly isAborted?: boolean;
1350
- readonly appUrls?: SessionUrlsPlain;
1351
- readonly apiUrls?: SessionUrlsPlain;
1352
- readonly stepsInfo?: Array<StepInfoPlain>;
1353
- readonly steps?: number;
1354
- readonly matches?: number;
1355
- readonly mismatches?: number;
1356
- readonly missing?: number;
1357
- readonly exactMatches?: number;
1358
- readonly strictMatches?: number;
1359
- readonly contentMatches?: number;
1360
- readonly layoutMatches?: number;
1361
- readonly noneMatches?: number;
1362
- readonly url?: string;
1326
+ readonly id?: undefined | string;
1327
+ readonly name?: undefined | string;
1328
+ readonly secretToken?: undefined | string;
1329
+ readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
1330
+ readonly appName?: undefined | string;
1331
+ readonly batchId?: undefined | string;
1332
+ readonly batchName?: undefined | string;
1333
+ readonly branchName?: undefined | string;
1334
+ readonly hostOS?: undefined | string;
1335
+ readonly hostApp?: undefined | string;
1336
+ readonly hostDisplaySize?: undefined | RectangleSizePlain;
1337
+ readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
1338
+ readonly startedAt?: undefined | string | Date;
1339
+ readonly duration?: undefined | number;
1340
+ readonly isNew?: undefined | boolean;
1341
+ readonly isDifferent?: undefined | boolean;
1342
+ readonly isAborted?: undefined | boolean;
1343
+ readonly appUrls?: undefined | SessionUrlsPlain;
1344
+ readonly apiUrls?: undefined | SessionUrlsPlain;
1345
+ readonly stepsInfo?: undefined | Array<StepInfoPlain>;
1346
+ readonly steps?: undefined | number;
1347
+ readonly matches?: undefined | number;
1348
+ readonly mismatches?: undefined | number;
1349
+ readonly missing?: undefined | number;
1350
+ readonly exactMatches?: undefined | number;
1351
+ readonly strictMatches?: undefined | number;
1352
+ readonly contentMatches?: undefined | number;
1353
+ readonly layoutMatches?: undefined | number;
1354
+ readonly noneMatches?: undefined | number;
1355
+ readonly url?: undefined | string;
1363
1356
  };
1364
1357
  export class TestResults implements Required<TestResultsPlain> {
1365
1358
  get id(): string;
@@ -1425,14 +1418,14 @@ export class TestResults implements Required<TestResultsPlain> {
1425
1418
  isPassed(): boolean;
1426
1419
  delete(): Promise<void>;
1427
1420
  }
1428
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
1421
+ export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo; };
1429
1422
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1430
1423
  get testResults(): TestResultsPlain;
1431
1424
  getTestResults(): TestResults;
1432
1425
  get exception(): Error;
1433
1426
  getException(): Error;
1434
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1435
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1427
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1428
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1436
1429
  }
1437
1430
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1438
1431
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1458,10 +1451,10 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1458
1451
  get asExpected(): boolean;
1459
1452
  getAsExpected(): boolean;
1460
1453
  }
1461
- export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1454
+ export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; };
1462
1455
  export class Logger {
1463
- constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1464
- constructor(show?: boolean);
1456
+ constructor(options?: undefined | { show?: undefined | boolean; label?: undefined | string; handler?: undefined | LogHandlerPlain; });
1457
+ constructor(show?: undefined | boolean);
1465
1458
  getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
1466
1459
  setLogHandler(handler: LogHandlerPlain): void;
1467
1460
  verbose(...messages: Array<any>): void;
@@ -1472,15 +1465,15 @@ export class Logger {
1472
1465
  open(): void;
1473
1466
  close(): void;
1474
1467
  tag(name: string, value: any): void;
1475
- extend(label?: string): Logger;
1468
+ extend(label?: undefined | string): Logger;
1476
1469
  }
1477
1470
  export abstract class EyesRunner {
1478
- getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1471
+ getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1479
1472
  }
1480
1473
  export class ClassicRunner extends EyesRunner {
1481
1474
  }
1482
1475
  export class VisualGridRunner extends EyesRunner {
1483
- constructor(options?: RunnerOptionsPlain);
1476
+ constructor(options?: undefined | RunnerOptionsPlain);
1484
1477
  get testConcurrency(): number;
1485
1478
  }
1486
1479
  export abstract class SessionEventHandler {
@@ -1507,8 +1500,8 @@ export class SessionEventHandlers extends SessionEventHandler {
1507
1500
  validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1508
1501
  }
1509
1502
  export class RemoteSessionEventHandler extends SessionEventHandler {
1510
- constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1511
- constructor(serverUrl: string, accessKey?: string, timeout?: number);
1503
+ constructor(options: { serverUrl: string; accessKey?: undefined | string; timeout?: undefined | number; });
1504
+ constructor(serverUrl: string, accessKey?: undefined | string, timeout?: undefined | number);
1512
1505
  get serverUrl(): string;
1513
1506
  set serverUrl(serverUrl: string);
1514
1507
  getServerUrl(): string;
package/types/service.d.ts CHANGED
@@ -1,34 +1,20 @@
1
- import type {
2
- Element,
3
- Selector,
4
- Eyes,
5
- ConfigurationPlain,
6
- Configuration,
7
- CheckSettingsPlain,
8
- CheckSettings,
9
- TestResults,
10
- TestResultsSummary,
11
- } from './index'
12
-
13
- declare global {
14
- namespace WebdriverIO {
15
- interface ServiceOption extends ConfigurationPlain {
16
- useVisualGrid?: boolean
17
- concurrency?: number
18
- eyes?: ServiceOption
19
- }
20
- interface Browser {
21
- getEyes(): Eyes
22
- eyesCheck(checkSettings?: CheckSettingsPlain): Promise<void>
23
- eyesCheck(title: string, checkSettings: CheckSettings): Promise<void>
24
- eyesSetScrollRootElement(element: Element | Selector): void
25
- eyesAddProperty(key: string, value: string): void
26
- eyesClearProperties(): void
27
- eyesGetTestResults(): Promise<TestResults>
28
- eyesSetConfiguration(configuration: ConfigurationPlain): void
29
- eyesGetConfiguration(): Configuration
30
- eyesGetIsOpen(): boolean
31
- eyesGetAllTestResults(throwErr: boolean): Promise<TestResultsSummary>
32
- }
33
- }
1
+ import { ConfigurationPlain } from './api';
2
+ interface EyesServiceOptions extends ConfigurationPlain {
3
+ useVisualGrid?: boolean;
4
+ concurrency?: number;
5
+ eyes?: EyesServiceOptions;
34
6
  }
7
+ declare class EyesService {
8
+ private _eyes;
9
+ private _appName?;
10
+ private _testResults?;
11
+ constructor({ useVisualGrid, concurrency, eyes, ...config }: EyesServiceOptions);
12
+ private _eyesOpen;
13
+ private _eyesClose;
14
+ beforeSession(config: Record<string, unknown>): void;
15
+ before(): void;
16
+ beforeTest(test: any): void;
17
+ afterTest(): Promise<void>;
18
+ after(): Promise<void>;
19
+ }
20
+ export = EyesService;
package/types/v8.d.ts ADDED
@@ -0,0 +1 @@
1
+ /// <reference types="@applitools/spec-driver-webdriverio/v8"/>