@applitools/eyes-puppeteer 1.16.0 → 1.17.0

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 (3) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/package.json +4 -4
  3. package/types/index.d.ts +181 -65
package/CHANGELOG.md CHANGED
@@ -11,6 +11,19 @@
11
11
 
12
12
 
13
13
 
14
+ ## 1.17.0 - 2023/5/13
15
+
16
+ ### Features
17
+ - Add support for reloading the page when using layoutBreakpoints
18
+ ### Bug fixes
19
+
20
+ ## 1.16.1 - 2023/5/3
21
+
22
+ ### Features
23
+ ### Bug fixes
24
+ - Fixed detection of emulated mobile drivers
25
+ - Fixed issue when on certain browser versions test didn't target a previously created baseline
26
+
14
27
  ## 1.16.0 - 2023/4/26
15
28
 
16
29
  ### Features
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-puppeteer",
3
- "version": "1.16.0",
3
+ "version": "1.17.0",
4
4
  "description": "Applitools Eyes SDK for Puppeteer",
5
5
  "keywords": [
6
6
  "eyes-puppeteer",
@@ -55,11 +55,11 @@
55
55
  "postpublish": "bongo send-release-notification --name 'puppeteer'"
56
56
  },
57
57
  "dependencies": {
58
- "@applitools/eyes": "1.2.4",
59
- "@applitools/spec-driver-puppeteer": "1.1.57"
58
+ "@applitools/eyes": "1.2.10",
59
+ "@applitools/spec-driver-puppeteer": "1.1.62"
60
60
  },
61
61
  "devDependencies": {
62
- "@applitools/api-extractor": "1.2.19",
62
+ "@applitools/api-extractor": "1.2.21",
63
63
  "@applitools/bongo": "^3.0.3",
64
64
  "@applitools/sdk-coverage-tests": "3.0.2",
65
65
  "@applitools/test-utils": "1.5.16",
package/types/index.d.ts CHANGED
@@ -33,10 +33,13 @@ export class Eyes {
33
33
  off(handler: (...args: Array<any>) => any): void;
34
34
  getExecutionCloudUrl(): Promise<string>;
35
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>;
36
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<Driver>;
37
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<Driver>;
37
38
  open(config?: undefined | ConfigurationPlain): Promise<void>;
38
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
39
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
39
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<void>;
40
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<void>;
41
+ check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
42
+ check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
40
43
  check(target: {
41
44
  image: string | URL | Buffer;
42
45
  name?: undefined | string;
@@ -47,15 +50,23 @@ export class Eyes {
47
50
  }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
48
51
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
49
52
  checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
50
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
53
+ checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
54
+ checkFrame(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
55
+ checkFrame(element: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
51
56
  checkElement(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
52
57
  checkElementBy(selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
53
58
  checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
54
- checkRegion(image: string | URL | Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
59
+ checkRegion(image: string, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
60
+ checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
61
+ checkRegion(image: Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
55
62
  checkRegionByElement(element: Element, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
56
63
  checkRegionBy(selector: EyesSelector<Selector>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
57
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
58
- checkImage(image: string | URL | Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
64
+ checkRegionInFrame(frame: number, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
65
+ checkRegionInFrame(frame: Element, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
66
+ checkRegionInFrame(frame: EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
67
+ checkImage(image: string, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
68
+ checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
69
+ checkImage(image: Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
59
70
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
60
71
  extractTextRegions<TPattern extends string>(target: {
61
72
  image: string | URL | Buffer;
@@ -89,14 +100,17 @@ export class Eyes {
89
100
  getViewportSize(): Promise<RectangleSize>;
90
101
  setViewportSize(size: RectangleSizePlain): Promise<void>;
91
102
  getScrollRootElement(): Element | EyesSelector<Selector>;
92
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
93
- setLogHandler(handler: LogHandlerPlain | LogHandler): void;
103
+ setScrollRootElement(scrollRootElement: Element): void;
104
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): void;
105
+ setLogHandler(handler: LogHandlerPlain): void;
106
+ setLogHandler(handler: LogHandler): void;
94
107
  getLogHandler(): LogHandler;
95
108
  setCutProvider(cutProvider: CutProvider): void;
96
109
  setImageCut(cutProvider: CutProvider): void;
97
110
  getIsCutProviderExplicitlySet(): boolean;
98
111
  getRotation(): ImageRotation;
99
- setRotation(rotation: ImageRotationPlain | ImageRotation): void;
112
+ setRotation(rotation: ImageRotationPlain): void;
113
+ setRotation(rotation: ImageRotation): void;
100
114
  getScaleRatio(): number;
101
115
  setScaleRatio(scaleRatio: number): void;
102
116
  getSaveDebugScreenshots(): boolean;
@@ -109,7 +123,8 @@ export class Eyes {
109
123
  clearProperties(): Configuration;
110
124
  getBatch(): BatchInfo;
111
125
  setBatch(batch: BatchInfoPlain): void;
112
- setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
126
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string): void;
127
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | Date): void;
113
128
  getApiKey(): string;
114
129
  setApiKey(apiKey: string): void;
115
130
  getTestName(): string;
@@ -179,7 +194,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
179
194
  scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
180
195
  fully?: undefined | boolean;
181
196
  disableBrowserFetching?: undefined | boolean;
182
- layoutBreakpoints?: undefined | boolean | Array<number>;
197
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
183
198
  visualGridOptions?: undefined | { [key: string]: any; };
184
199
  nmgOptions?: undefined | { [key: string]: any; };
185
200
  hooks?: undefined | { beforeCaptureScreenshot: string; };
@@ -189,17 +204,25 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
189
204
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
190
205
  };
191
206
  export class CheckSettingsAutomation {
192
- constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
193
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
194
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
207
+ constructor(settings?: undefined | CheckSettingsAutomation);
208
+ constructor(settings?: undefined | CheckSettingsAutomationPlain);
209
+ region(region: RegionPlain): CheckSettingsAutomation;
210
+ region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
211
+ shadow(selector: string): CheckSettingsAutomation;
212
+ shadow(selector: Selector): CheckSettingsAutomation;
213
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
195
214
  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;
196
- 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;
197
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
198
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
215
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
216
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
217
+ webview(webview?: undefined | string): CheckSettingsAutomation;
218
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
219
+ scrollRootElement(scrollRootElement: Element): CheckSettingsAutomation;
220
+ scrollRootElement(scrollRootElement: (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
199
221
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
200
222
  stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
201
223
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
202
- layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
224
+ layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
225
+ layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
203
226
  hook(name: string, script: string): CheckSettingsAutomation;
204
227
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
205
228
  webHook(script: string): CheckSettingsAutomation;
@@ -212,19 +235,29 @@ export class CheckSettingsAutomation {
212
235
  renderId(renderId: string): CheckSettingsAutomation;
213
236
  timeout(timeout: number): CheckSettingsAutomation;
214
237
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
215
- lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
238
+ lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
239
+ lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
216
240
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
217
241
  name(name: string): CheckSettingsAutomation;
218
242
  withName(name: string): CheckSettingsAutomation;
219
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
243
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
244
+ ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
245
+ ignoreRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
220
246
  ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
221
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
247
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
248
+ ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
222
249
  ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
223
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
250
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
251
+ layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
252
+ layoutRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
224
253
  layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
225
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
254
+ strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
255
+ strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
256
+ strictRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
226
257
  strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
227
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
258
+ contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
259
+ contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
260
+ contentRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
228
261
  contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
229
262
  floatingRegion(region: {
230
263
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
@@ -241,7 +274,8 @@ export class CheckSettingsAutomation {
241
274
  maxLeftOffset?: undefined | number;
242
275
  maxRightOffset?: undefined | number;
243
276
  }): CheckSettingsAutomation;
244
- 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;
277
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
278
+ floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
245
279
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
246
280
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
247
281
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -255,7 +289,8 @@ export class CheckSettingsAutomation {
255
289
  regionId?: undefined | string;
256
290
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
257
291
  }): CheckSettingsAutomation;
258
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
292
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
293
+ floating(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
259
294
  floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
260
295
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
261
296
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -269,7 +304,16 @@ export class CheckSettingsAutomation {
269
304
  regionId?: undefined | string;
270
305
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
271
306
  }): CheckSettingsAutomation;
272
- 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;
307
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
308
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
309
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsAutomation;
310
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "RegularText"): CheckSettingsAutomation;
311
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsAutomation;
312
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "LargeText"): CheckSettingsAutomation;
313
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsAutomation;
314
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "BoldText"): CheckSettingsAutomation;
315
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
316
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
273
317
  accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
274
318
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
275
319
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -295,11 +339,16 @@ export class CheckSettings extends CheckSettingsAutomation {
295
339
  }
296
340
  export type TargetAutomation = {
297
341
  window(): CheckSettingsAutomation;
298
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
342
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
343
+ region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
299
344
  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;
300
- 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;
301
- shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
302
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
345
+ frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
346
+ frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
347
+ shadow(selector: string): CheckSettingsAutomation;
348
+ shadow(selector: Selector): CheckSettingsAutomation;
349
+ shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
350
+ webview(webview?: undefined | string): CheckSettingsAutomation;
351
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
303
352
  };
304
353
  export const Target: TargetImage & TargetAutomation;
305
354
  export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
@@ -353,7 +402,7 @@ export type ConfigurationPlain = {
353
402
  concurrentSessions?: undefined | number;
354
403
  browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
355
404
  visualGridOptions?: undefined | Record<string, any>;
356
- layoutBreakpoints?: undefined | boolean | Array<number>;
405
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
357
406
  disableBrowserFetching?: undefined | boolean;
358
407
  waitBeforeCapture?: undefined | number;
359
408
  };
@@ -551,7 +600,8 @@ export class Configuration implements Required<ConfigurationPlain> {
551
600
  get scrollRootElement(): Element | EyesSelector<Selector>;
552
601
  set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
553
602
  getScrollRootElement(): Element | EyesSelector<Selector>;
554
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
603
+ setScrollRootElement(scrollRootElement: Element): Configuration;
604
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
555
605
  get cut(): CutProviderPlain;
556
606
  set cut(cut: CutProviderPlain);
557
607
  getCut(): CutProviderPlain;
@@ -559,7 +609,8 @@ export class Configuration implements Required<ConfigurationPlain> {
559
609
  get rotation(): ImageRotationPlain;
560
610
  set rotation(rotation: ImageRotationPlain);
561
611
  getRotation(): ImageRotation;
562
- setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration;
612
+ setRotation(rotation: ImageRotationPlain): Configuration;
613
+ setRotation(rotation: ImageRotation): Configuration;
563
614
  get scaleRatio(): number;
564
615
  set scaleRatio(scaleRatio: number);
565
616
  getScaleRatio(): number;
@@ -573,20 +624,45 @@ export class Configuration implements Required<ConfigurationPlain> {
573
624
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
574
625
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
575
626
  addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
576
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
577
- 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;
578
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
579
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
580
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
627
+ addBrowser(browserInfo: DesktopBrowserInfo): Configuration;
628
+ addBrowser(browserInfo: ChromeEmulationInfo): Configuration;
629
+ addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }): Configuration;
630
+ addBrowser(browserInfo: IOSDeviceInfo): Configuration;
631
+ addBrowser(browserInfo: AndroidDeviceInfo): Configuration;
632
+ addBrowser(width: number, height: number, name?: undefined | "chrome"): Configuration;
633
+ addBrowser(width: number, height: number, name?: undefined | "chrome-one-version-back"): Configuration;
634
+ addBrowser(width: number, height: number, name?: undefined | "chrome-two-versions-back"): Configuration;
635
+ addBrowser(width: number, height: number, name?: undefined | "firefox"): Configuration;
636
+ addBrowser(width: number, height: number, name?: undefined | "firefox-one-version-back"): Configuration;
637
+ addBrowser(width: number, height: number, name?: undefined | "firefox-two-versions-back"): Configuration;
638
+ addBrowser(width: number, height: number, name?: undefined | "ie"): Configuration;
639
+ addBrowser(width: number, height: number, name?: undefined | "ie10"): Configuration;
640
+ addBrowser(width: number, height: number, name?: undefined | "edge"): Configuration;
641
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium"): Configuration;
642
+ addBrowser(width: number, height: number, name?: undefined | "edgelegacy"): Configuration;
643
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-one-version-back"): Configuration;
644
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-two-versions-back"): Configuration;
645
+ addBrowser(width: number, height: number, name?: undefined | "safari"): Configuration;
646
+ addBrowser(width: number, height: number, name?: undefined | "safari-earlyaccess"): Configuration;
647
+ addBrowser(width: number, height: number, name?: undefined | "safari-one-version-back"): Configuration;
648
+ addBrowser(width: number, height: number, name?: undefined | "safari-two-versions-back"): Configuration;
649
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape"): Configuration;
650
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait"): Configuration;
651
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
652
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
653
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
654
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
581
655
  get visualGridOptions(): { [key: string]: any; };
582
656
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
583
657
  getVisualGridOptions(): { [key: string]: any; };
584
658
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
585
659
  setVisualGridOption(key: string, value: any): Configuration;
586
- get layoutBreakpoints(): boolean | Array<number>;
587
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number>);
588
- getLayoutBreakpoints(): boolean | Array<number>;
589
- setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number>): Configuration;
660
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
661
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
662
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
663
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
664
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
665
+ setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
590
666
  get disableBrowserFetching(): boolean;
591
667
  set disableBrowserFetching(disableBrowserFetching: boolean);
592
668
  getDisableBrowserFetching(): boolean;
@@ -852,7 +928,11 @@ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: unde
852
928
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
853
929
  constructor(settings: AccessibilityMatchSettingsPlain);
854
930
  constructor(region: RegionPlain);
855
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
931
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast");
932
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "RegularText");
933
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "LargeText");
934
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "BoldText");
935
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "GraphicalObject");
856
936
  get region(): RegionPlain;
857
937
  set region(region: RegionPlain);
858
938
  getRegion(): Region;
@@ -882,7 +962,8 @@ export type BatchInfoPlain = {
882
962
  export class BatchInfo implements Required<BatchInfoPlain> {
883
963
  constructor();
884
964
  constructor(batch?: undefined | BatchInfoPlain);
885
- constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
965
+ constructor(name?: undefined | string, startedAt?: undefined | string, id?: undefined | string);
966
+ constructor(name?: undefined | string, startedAt?: undefined | Date, id?: undefined | string);
886
967
  get id(): string;
887
968
  set id(id: string);
888
969
  getId(): string;
@@ -898,7 +979,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
898
979
  get startedAt(): string | Date;
899
980
  set startedAt(startedAt: string | Date);
900
981
  getStartedAt(): string | Date;
901
- setStartedAt(startedAt: string | Date): BatchInfo;
982
+ setStartedAt(startedAt: string): BatchInfo;
983
+ setStartedAt(startedAt: Date): BatchInfo;
902
984
  get notifyOnCompletion(): boolean;
903
985
  set notifyOnCompletion(notifyOnCompletion: boolean);
904
986
  getNotifyOnCompletion(): boolean;
@@ -949,7 +1031,15 @@ export type CheckSettingsImagePlain = {
949
1031
  densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
950
1032
  };
951
1033
  export class CheckSettingsImage {
952
- constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
1034
+ constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
1035
+ image: string | URL | Buffer;
1036
+ name?: undefined | string;
1037
+ dom?: undefined | string;
1038
+ locationInViewport?: undefined | LocationPlain;
1039
+ locationInView?: undefined | LocationPlain;
1040
+ fullViewSize?: undefined | RectangleSizePlain;
1041
+ });
1042
+ constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
953
1043
  image: string | URL | Buffer;
954
1044
  name?: undefined | string;
955
1045
  dom?: undefined | string;
@@ -957,25 +1047,38 @@ export class CheckSettingsImage {
957
1047
  locationInView?: undefined | LocationPlain;
958
1048
  fullViewSize?: undefined | RectangleSizePlain;
959
1049
  });
960
- image(image: string | URL | Buffer): CheckSettingsImage;
1050
+ image(image: string): CheckSettingsImage;
1051
+ image(image: URL): CheckSettingsImage;
1052
+ image(image: Buffer): CheckSettingsImage;
961
1053
  buffer(imageBuffer: Buffer): CheckSettingsImage;
962
1054
  base64(imageBase64: Buffer): CheckSettingsImage;
963
1055
  path(imagePath: string): CheckSettingsImage;
964
- url(imageUrl: string | URL): CheckSettingsImage;
1056
+ url(imageUrl: string): CheckSettingsImage;
1057
+ url(imageUrl: URL): CheckSettingsImage;
965
1058
  name(name: string): CheckSettingsImage;
966
1059
  withDom(dom: string): CheckSettingsImage;
967
1060
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
968
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1061
+ region(region: LegacyRegionPlain): CheckSettingsImage;
1062
+ region(region: RegionPlain): CheckSettingsImage;
969
1063
  withName(name: string): CheckSettingsImage;
970
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1064
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1065
+ ignoreRegion(region: RegionPlain): CheckSettingsImage;
1066
+ ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
971
1067
  ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
972
- ignore(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1068
+ ignore(region: LegacyRegionPlain): CheckSettingsImage;
1069
+ ignore(region: RegionPlain): CheckSettingsImage;
973
1070
  ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
974
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1071
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1072
+ layoutRegion(region: RegionPlain): CheckSettingsImage;
1073
+ layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
975
1074
  layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
976
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1075
+ strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1076
+ strictRegion(region: RegionPlain): CheckSettingsImage;
1077
+ strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
977
1078
  strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
978
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1079
+ contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1080
+ contentRegion(region: RegionPlain): CheckSettingsImage;
1081
+ contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
979
1082
  contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
980
1083
  floatingRegion(region: {
981
1084
  region: RegionPlain;
@@ -992,7 +1095,8 @@ export class CheckSettingsImage {
992
1095
  maxLeftOffset?: undefined | number;
993
1096
  maxRightOffset?: undefined | number;
994
1097
  }): CheckSettingsImage;
995
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1098
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1099
+ floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
996
1100
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
997
1101
  region: RegionPlain;
998
1102
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1006,7 +1110,8 @@ export class CheckSettingsImage {
1006
1110
  regionId?: undefined | string;
1007
1111
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1008
1112
  }): CheckSettingsImage;
1009
- floating(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1113
+ floating(region: LegacyRegionPlain): CheckSettingsImage;
1114
+ floating(region: RegionPlain): CheckSettingsImage;
1010
1115
  floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
1011
1116
  region: RegionPlain;
1012
1117
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1020,7 +1125,16 @@ export class CheckSettingsImage {
1020
1125
  regionId?: undefined | string;
1021
1126
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
1022
1127
  }): CheckSettingsImage;
1023
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
1128
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1129
+ accessibilityRegion(region: RegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1130
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1131
+ accessibilityRegion(region: RegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1132
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1133
+ accessibilityRegion(region: RegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1134
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1135
+ accessibilityRegion(region: RegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1136
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1137
+ accessibilityRegion(region: RegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1024
1138
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
1025
1139
  region: RegionPlain;
1026
1140
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1043,11 +1157,14 @@ export class CheckSettingsImage {
1043
1157
  variationGroupId(variationGroupId: string): CheckSettingsImage;
1044
1158
  }
1045
1159
  export type TargetImage = {
1046
- image(image: string | URL | Buffer): CheckSettingsImage;
1160
+ image(image: string): CheckSettingsImage;
1161
+ image(image: URL): CheckSettingsImage;
1162
+ image(image: Buffer): CheckSettingsImage;
1047
1163
  buffer(imageBuffer: Buffer): CheckSettingsImage;
1048
1164
  base64(imageBase64: string): CheckSettingsImage;
1049
1165
  path(imagePath: string): CheckSettingsImage;
1050
- url(imageUrl: string | URL): CheckSettingsImage;
1166
+ url(imageUrl: string): CheckSettingsImage;
1167
+ url(imageUrl: URL): CheckSettingsImage;
1051
1168
  };
1052
1169
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
1053
1170
  export class CutProvider implements Required<{
@@ -1519,7 +1636,8 @@ export class TestResults implements Required<TestResultsPlain> {
1519
1636
  setAccessibilityStatus(_accessibilityStatus: TestAccessibilityStatus): void;
1520
1637
  get startedAt(): string;
1521
1638
  getStartedAt(): Date;
1522
- setStartedAt(_startedAt: string | Date): void;
1639
+ setStartedAt(_startedAt: string): void;
1640
+ setStartedAt(_startedAt: Date): void;
1523
1641
  get duration(): number;
1524
1642
  getDuration(): number;
1525
1643
  setDuration(_duration: number): void;
@@ -1589,7 +1707,7 @@ export class TestResultContainer implements Required<TestResultContainerPlain> {
1589
1707
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1590
1708
  export class TestResultsSummary implements Iterable<TestResultContainer> {
1591
1709
  getAllResults(): Array<TestResultContainer>;
1592
- '__@iterator@107'(): Iterator<TestResultContainer, any, undefined>;
1710
+ [Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
1593
1711
  }
1594
1712
  export type TextRegion = {
1595
1713
  x: number;
@@ -1623,8 +1741,6 @@ export class Logger {
1623
1741
  fatal(...messages: Array<any>): void;
1624
1742
  open(): void;
1625
1743
  close(): void;
1626
- tag(name: string, value: any): void;
1627
- extend(label?: undefined | string): Logger;
1628
1744
  }
1629
1745
  export abstract class EyesRunner {
1630
1746
  constructor(options?: undefined | RunnerOptionsPlain);