@applitools/eyes-selenium 4.65.1 → 4.65.2

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 +6 -0
  2. package/package.json +5 -5
  3. package/types/index.d.ts +155 -3
package/CHANGELOG.md CHANGED
@@ -8,6 +8,12 @@
8
8
 
9
9
 
10
10
 
11
+ ## 4.65.2 - 2023/4/11
12
+
13
+ ### Features
14
+ - Make `locate` to return coordinates that could be directly used with the driver
15
+ ### Bug fixes
16
+
11
17
  ## 4.65.1 - 2023/4/5
12
18
 
13
19
  ### Features
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-selenium",
3
- "version": "4.65.1",
3
+ "version": "4.65.2",
4
4
  "description": "Applitools Eyes SDK for Selenium WebDriver",
5
5
  "keywords": [
6
6
  "eyes-selenium",
@@ -61,13 +61,13 @@
61
61
  "postpublish": "bongo send-release-notification --name 'js_selenium_4'"
62
62
  },
63
63
  "dependencies": {
64
- "@applitools/eyes": "1.1.3",
65
- "@applitools/spec-driver-selenium": "1.5.37"
64
+ "@applitools/eyes": "1.1.5",
65
+ "@applitools/spec-driver-selenium": "1.5.39"
66
66
  },
67
67
  "devDependencies": {
68
- "@applitools/api-extractor": "1.2.12",
68
+ "@applitools/api-extractor": "1.2.14",
69
69
  "@applitools/bongo": "^3.0.3",
70
- "@applitools/sdk-coverage-tests": "3.0.0",
70
+ "@applitools/sdk-coverage-tests": "3.0.2",
71
71
  "@applitools/test-utils": "1.5.16",
72
72
  "@types/node": "^12.20.55",
73
73
  "@types/selenium-webdriver": "^4.1.1",
package/types/index.d.ts CHANGED
@@ -19,6 +19,17 @@ export class Eyes {
19
19
  setConfiguration(config: ConfigurationPlain): void;
20
20
  get isOpen(): boolean;
21
21
  getIsOpen(): boolean;
22
+ on(handler: (event: string, data?: undefined | Record<string, any>) => any): () => void;
23
+ on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
24
+ on(event: "setSizeEnded", handler: () => any): () => void;
25
+ on(event: "initStarted", handler: () => any): () => void;
26
+ on(event: "initEnded", handler: () => any): () => void;
27
+ on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
28
+ on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
29
+ on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
30
+ on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
31
+ off(event: string): void;
32
+ off(handler: (...args: Array<any>) => any): void;
22
33
  getExecutionCloudUrl(): Promise<string>;
23
34
  open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
24
35
  open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
@@ -34,6 +45,16 @@ export class Eyes {
34
45
  fullViewSize?: undefined | RectangleSizePlain;
35
46
  }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
36
47
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
48
+ checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
49
+ checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
50
+ checkElement(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
51
+ checkElementBy(selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
52
+ checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
53
+ checkRegion(image: string | URL | Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
54
+ checkRegionByElement(element: Element, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
55
+ checkRegionBy(selector: EyesSelector<Selector>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
56
+ checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
57
+ checkImage(image: string | URL | Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
37
58
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
38
59
  extractTextRegions<TPattern extends string>(target: {
39
60
  image: string | URL | Buffer;
@@ -45,6 +66,7 @@ export class Eyes {
45
66
  locationInView?: undefined | { x: number; y: number; };
46
67
  fullViewSize?: undefined | { width: number; height: number; };
47
68
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
69
+ extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & { image: string | URL | Buffer; }): Promise<Record<TPattern, Array<TextRegion>>>;
48
70
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
49
71
  extractText(target: {
50
72
  image: string | URL | Buffer;
@@ -56,11 +78,13 @@ export class Eyes {
56
78
  locationInView?: undefined | { x: number; y: number; };
57
79
  fullViewSize?: undefined | { width: number; height: number; };
58
80
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
81
+ extractText(settingsWithImage: Array<OCRRegion & { image: string | URL | Buffer; }>): Promise<Array<string>>;
59
82
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
60
83
  close(throwErr?: undefined | boolean): Promise<TestResults>;
61
84
  closeAsync(): Promise<void>;
62
85
  abort(): Promise<TestResults>;
63
86
  abortAsync(): Promise<void>;
87
+ abortIfNotClosed(): Promise<TestResultsPlain>;
64
88
  getViewportSize(): Promise<RectangleSize>;
65
89
  setViewportSize(size: RectangleSizePlain): Promise<void>;
66
90
  getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -93,6 +117,8 @@ export class Eyes {
93
117
  setAppName(appName: string): void;
94
118
  getBaselineBranchName(): string;
95
119
  setBaselineBranchName(baselineBranchName: string): void;
120
+ getBaselineName(): string;
121
+ setBaselineName(baselineName: string): void;
96
122
  getBaselineEnvName(): string;
97
123
  setBaselineEnvName(baselineEnvName: string): void;
98
124
  getBranchName(): string;
@@ -141,6 +167,10 @@ export class Eyes {
141
167
  setStitchMode(stitchMode: StitchModePlain): void;
142
168
  getStitchOverlap(): number;
143
169
  setStitchOverlap(stitchOverlap: number): void;
170
+ getSessionEventHandlers(): SessionEventHandlers;
171
+ addSessionEventHandler(handler: SessionEventHandler): void;
172
+ removeSessionEventHandler(handler: SessionEventHandler): void;
173
+ clearSessionEventHandlers(): void;
144
174
  }
145
175
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
146
176
  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>; })))>;
@@ -166,12 +196,16 @@ export class CheckSettingsAutomation {
166
196
  webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
167
197
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
168
198
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
199
+ stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
169
200
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
170
201
  layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
171
202
  hook(name: string, script: string): CheckSettingsAutomation;
172
203
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
204
+ webHook(script: string): CheckSettingsAutomation;
173
205
  ufgOption(key: string, value: any): CheckSettingsAutomation;
174
206
  ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
207
+ visualGridOption(key: string, value: any): CheckSettingsAutomation;
208
+ visualGridOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
175
209
  nmgOption(key: string, value: any): CheckSettingsAutomation;
176
210
  nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
177
211
  renderId(renderId: string): CheckSettingsAutomation;
@@ -183,6 +217,8 @@ export class CheckSettingsAutomation {
183
217
  withName(name: string): CheckSettingsAutomation;
184
218
  ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
185
219
  ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
220
+ ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
221
+ ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
186
222
  layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
187
223
  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;
188
224
  strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
@@ -212,6 +248,20 @@ export class CheckSettingsAutomation {
212
248
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
213
249
  }>): CheckSettingsAutomation;
214
250
  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;
251
+ floating(region: {
252
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
253
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
254
+ regionId?: undefined | string;
255
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
256
+ }): CheckSettingsAutomation;
257
+ floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
258
+ floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
259
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
260
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
261
+ regionId?: undefined | string;
262
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
263
+ }>): CheckSettingsAutomation;
264
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
215
265
  accessibilityRegion(region: {
216
266
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
217
267
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -231,6 +281,7 @@ export class CheckSettingsAutomation {
231
281
  exact(): CheckSettingsAutomation;
232
282
  strict(): CheckSettingsAutomation;
233
283
  ignoreColors(): CheckSettingsAutomation;
284
+ content(): CheckSettingsAutomation;
234
285
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
235
286
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
236
287
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
@@ -252,12 +303,15 @@ export type TargetAutomation = {
252
303
  export const Target: TargetImage & TargetAutomation;
253
304
  export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
254
305
  export type ConfigurationPlain = {
306
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
255
307
  agentId?: undefined | string;
256
308
  apiKey?: undefined | string;
257
309
  serverUrl?: undefined | string;
258
310
  proxy?: undefined | ProxySettingsPlain;
259
311
  autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
260
312
  isDisabled?: undefined | boolean;
313
+ connectionTimeout?: undefined | number;
314
+ removeSession?: undefined | boolean;
261
315
  appName?: undefined | string;
262
316
  testName?: undefined | string;
263
317
  displayName?: undefined | string;
@@ -282,6 +336,7 @@ export type ConfigurationPlain = {
282
336
  saveFailedTests?: undefined | boolean;
283
337
  saveNewTests?: undefined | boolean;
284
338
  saveDiffs?: undefined | boolean;
339
+ dontCloseBatches?: undefined | boolean;
285
340
  sendDom?: undefined | boolean;
286
341
  matchTimeout?: undefined | number;
287
342
  forceFullPageScreenshot?: undefined | boolean;
@@ -294,6 +349,7 @@ export type ConfigurationPlain = {
294
349
  cut?: undefined | CutProviderPlain;
295
350
  rotation?: undefined | ImageRotationPlain;
296
351
  scaleRatio?: undefined | number;
352
+ concurrentSessions?: undefined | number;
297
353
  browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
298
354
  visualGridOptions?: undefined | Record<string, any>;
299
355
  layoutBreakpoints?: undefined | boolean | Array<number>;
@@ -302,6 +358,14 @@ export type ConfigurationPlain = {
302
358
  };
303
359
  export class Configuration implements Required<ConfigurationPlain> {
304
360
  constructor(config?: undefined | ConfigurationPlain);
361
+ get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
362
+ set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
363
+ getSaveDebugScreenshots(): boolean;
364
+ setSaveDebugScreenshots(save: boolean): Configuration;
365
+ getDebugScreenshotsPath(): string;
366
+ setDebugScreenshotsPath(path: string): Configuration;
367
+ getDebugScreenshotsPrefix(): string;
368
+ setDebugScreenshotsPrefix(prefix: string): Configuration;
305
369
  get appName(): string;
306
370
  set appName(appName: string);
307
371
  getAppName(): string;
@@ -352,6 +416,14 @@ export class Configuration implements Required<ConfigurationPlain> {
352
416
  set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
353
417
  getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
354
418
  setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
419
+ get connectionTimeout(): number;
420
+ set connectionTimeout(connectionTimeout: number);
421
+ getConnectionTimeout(): number;
422
+ setConnectionTimeout(connectionTimeout: number): Configuration;
423
+ get removeSession(): boolean;
424
+ set removeSession(removeSession: boolean);
425
+ getRemoveSession(): boolean;
426
+ setRemoveSession(removeSession: boolean): Configuration;
355
427
  get batch(): BatchInfoPlain;
356
428
  set batch(batch: BatchInfoPlain);
357
429
  getBatch(): BatchInfo;
@@ -491,6 +563,10 @@ export class Configuration implements Required<ConfigurationPlain> {
491
563
  set scaleRatio(scaleRatio: number);
492
564
  getScaleRatio(): number;
493
565
  setScaleRatio(scaleRatio: number): Configuration;
566
+ get concurrentSessions(): number;
567
+ set concurrentSessions(concurrentSessions: number);
568
+ getConcurrentSessions(): number;
569
+ setConcurrentSessions(concurrentSessions: number): Configuration;
494
570
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
495
571
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
496
572
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
@@ -514,6 +590,10 @@ export class Configuration implements Required<ConfigurationPlain> {
514
590
  set disableBrowserFetching(disableBrowserFetching: boolean);
515
591
  getDisableBrowserFetching(): boolean;
516
592
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
593
+ get dontCloseBatches(): boolean;
594
+ set dontCloseBatches(dontCloseBatches: boolean);
595
+ getDontCloseBatches(): boolean;
596
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
517
597
  }
518
598
  export class BatchClose {
519
599
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
@@ -888,6 +968,8 @@ export class CheckSettingsImage {
888
968
  withName(name: string): CheckSettingsImage;
889
969
  ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
890
970
  ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
971
+ ignore(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
972
+ ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
891
973
  layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
892
974
  layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
893
975
  strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
@@ -917,6 +999,20 @@ export class CheckSettingsImage {
917
999
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
918
1000
  }>): CheckSettingsImage;
919
1001
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1002
+ floating(region: {
1003
+ region: RegionPlain;
1004
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1005
+ regionId?: undefined | string;
1006
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1007
+ }): CheckSettingsImage;
1008
+ floating(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
1009
+ floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
1010
+ region: RegionPlain;
1011
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1012
+ regionId?: undefined | string;
1013
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1014
+ }>): CheckSettingsImage;
1015
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
920
1016
  accessibilityRegion(region: {
921
1017
  region: RegionPlain;
922
1018
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -936,6 +1032,7 @@ export class CheckSettingsImage {
936
1032
  exact(): CheckSettingsImage;
937
1033
  strict(): CheckSettingsImage;
938
1034
  ignoreColors(): CheckSettingsImage;
1035
+ content(): CheckSettingsImage;
939
1036
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
940
1037
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
941
1038
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
@@ -1267,35 +1364,46 @@ export type ApiUrlsPlain = {
1267
1364
  export class ApiUrls implements Required<ApiUrlsPlain> {
1268
1365
  get baselineImage(): string;
1269
1366
  getBaselineImage(): string;
1367
+ setBaselineImage(setBaselineImage: string): void;
1270
1368
  get currentImage(): string;
1271
1369
  getCurrentImage(): string;
1370
+ setCurrentImage(currentImage: string): void;
1272
1371
  get checkpointImage(): string;
1273
1372
  getCheckpointImage(): string;
1373
+ setCheckpointImage(checkpointImage: string): void;
1274
1374
  get checkpointImageThumbnail(): string;
1275
1375
  getCheckpointImageThumbnail(): string;
1376
+ setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1276
1377
  get diffImage(): string;
1277
1378
  getDiffImage(): string;
1379
+ setDiffImage(diffImage: string): void;
1278
1380
  }
1279
1381
  export type AppUrlsPlain = { readonly step: string; readonly stepEditor: string; };
1280
1382
  export class AppUrls implements Required<AppUrlsPlain> {
1281
1383
  get step(): string;
1282
1384
  getStep(): string;
1385
+ setStep(step: string): void;
1283
1386
  get stepEditor(): string;
1284
1387
  getStepEditor(): string;
1388
+ setStepEditor(stepEditor: string): void;
1285
1389
  }
1286
1390
  export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1287
1391
  export class MatchResult implements Required<MatchResultPlain> {
1288
1392
  get asExpected(): boolean;
1289
1393
  getAsExpected(): boolean;
1394
+ setAsExpected(asExpected: boolean): void;
1290
1395
  get windowId(): number;
1291
1396
  getWindowId(): number;
1397
+ setWindowId(windowId: number): void;
1292
1398
  }
1293
1399
  export type SessionUrlsPlain = { readonly batch: string; readonly session: string; };
1294
1400
  export class SessionUrls implements Required<SessionUrlsPlain> {
1295
1401
  get batch(): string;
1296
1402
  getBatch(): string;
1403
+ setBatch(batch: string): void;
1297
1404
  get session(): string;
1298
1405
  getSession(): string;
1406
+ setSession(session: string): void;
1299
1407
  }
1300
1408
  export type StepInfoPlain = {
1301
1409
  readonly name: string;
@@ -1309,18 +1417,25 @@ export type StepInfoPlain = {
1309
1417
  export class StepInfo implements Required<StepInfoPlain> {
1310
1418
  get name(): string;
1311
1419
  getName(): string;
1420
+ setName(value: string): void;
1312
1421
  get isDifferent(): boolean;
1313
1422
  getIsDifferent(): boolean;
1423
+ setIsDifferent(value: boolean): void;
1314
1424
  get hasBaselineImage(): boolean;
1315
1425
  getHasBaselineImage(): boolean;
1426
+ setHasBaselineImage(value: boolean): void;
1316
1427
  get hasCurrentImage(): boolean;
1317
1428
  getHasCurrentImage(): boolean;
1429
+ setHasCurrentImage(hasCurrentImage: boolean): void;
1318
1430
  get appUrls(): AppUrlsPlain;
1319
1431
  getAppUrls(): AppUrls;
1432
+ setAppUrls(appUrls: AppUrlsPlain): void;
1320
1433
  get apiUrls(): ApiUrlsPlain;
1321
1434
  getApiUrls(): ApiUrls;
1435
+ setApiUrls(apiUrls: ApiUrlsPlain): void;
1322
1436
  get renderId(): Array<string>;
1323
1437
  getRenderId(): Array<string>;
1438
+ setRenderId(renderId: Array<string>): void;
1324
1439
  }
1325
1440
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1326
1441
  export type TestResultsPlain = {
@@ -1354,74 +1469,105 @@ export type TestResultsPlain = {
1354
1469
  readonly layoutMatches?: undefined | number;
1355
1470
  readonly noneMatches?: undefined | number;
1356
1471
  readonly url?: undefined | string;
1357
- readonly server: { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
1358
- readonly keepIfDuplicate: boolean;
1472
+ readonly server?: undefined | { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
1473
+ readonly keepIfDuplicate?: undefined | boolean;
1359
1474
  };
1360
1475
  export class TestResults implements Required<TestResultsPlain> {
1361
1476
  get id(): string;
1362
1477
  getId(): string;
1478
+ setId(_id: string): void;
1363
1479
  get name(): string;
1364
1480
  getName(): string;
1481
+ setName(_name: string): void;
1365
1482
  get secretToken(): string;
1366
1483
  getSecretToken(): string;
1484
+ setSecretToken(_secretToken: string): void;
1367
1485
  get status(): TestResultsStatusPlain;
1368
1486
  getStatus(): TestResultsStatus;
1487
+ setStatus(_status: TestResultsStatus): void;
1369
1488
  get appName(): string;
1370
1489
  getAppName(): string;
1490
+ setAppName(_appName: string): void;
1371
1491
  get batchName(): string;
1372
1492
  getBatchName(): string;
1493
+ setBatchName(_batchName: string): void;
1373
1494
  get batchId(): string;
1374
1495
  getBatchId(): string;
1496
+ setBatchId(_batchId: string): void;
1375
1497
  get branchName(): string;
1376
1498
  getBranchName(): string;
1499
+ setBranchName(_branchName: string): void;
1377
1500
  get hostOS(): string;
1378
1501
  getHostOS(): string;
1502
+ setHostOS(_hostOS: string): void;
1379
1503
  get hostApp(): string;
1380
1504
  getHostApp(): string;
1505
+ setHostApp(_hostApp: string): void;
1381
1506
  get hostDisplaySize(): RectangleSizePlain;
1382
1507
  getHostDisplaySize(): RectangleSize;
1508
+ setHostDisplaySize(_hostDisplaySize: RectangleSizePlain): void;
1383
1509
  get accessibilityStatus(): TestAccessibilityStatus;
1384
1510
  getAccessibilityStatus(): TestAccessibilityStatus;
1511
+ setAccessibilityStatus(_accessibilityStatus: TestAccessibilityStatus): void;
1385
1512
  get startedAt(): string;
1386
1513
  getStartedAt(): Date;
1514
+ setStartedAt(_startedAt: string | Date): void;
1387
1515
  get duration(): number;
1388
1516
  getDuration(): number;
1517
+ setDuration(_duration: number): void;
1389
1518
  get isNew(): boolean;
1390
1519
  getIsNew(): boolean;
1520
+ setIsNew(_isNew: boolean): void;
1391
1521
  get isDifferent(): boolean;
1392
1522
  getIsDifferent(): boolean;
1523
+ setIsDifferent(_isDifferent: boolean): void;
1393
1524
  get isAborted(): boolean;
1394
1525
  getIsAborted(): boolean;
1526
+ setIsAborted(_isAborted: boolean): void;
1395
1527
  get appUrls(): SessionUrlsPlain;
1396
1528
  getAppUrls(): SessionUrls;
1529
+ setAppUrls(_appUrls: SessionUrlsPlain): void;
1397
1530
  get apiUrls(): SessionUrlsPlain;
1398
1531
  getApiUrls(): SessionUrls;
1532
+ setApiUrls(_apiUrls: SessionUrlsPlain): void;
1399
1533
  get stepsInfo(): Array<StepInfoPlain>;
1400
1534
  getStepsInfo(): Array<StepInfo>;
1535
+ setStepsInfo(_stepInfo: Array<StepInfoPlain>): void;
1401
1536
  get steps(): number;
1402
1537
  getSteps(): number;
1538
+ setSteps(_steps: number): void;
1403
1539
  get matches(): number;
1404
1540
  getMatches(): number;
1541
+ setMatches(_matches: number): void;
1405
1542
  get mismatches(): number;
1406
1543
  getMismatches(): number;
1544
+ setMismatches(_mismatches: number): void;
1407
1545
  get missing(): number;
1408
1546
  getMissing(): number;
1547
+ setMissing(_missing: number): void;
1409
1548
  get exactMatches(): number;
1410
1549
  getExactMatches(): number;
1550
+ setExactMatches(_exactMatches: number): void;
1411
1551
  get strictMatches(): number;
1412
1552
  getStrictMatches(): number;
1553
+ setStrictMatches(_strictMatches: number): void;
1413
1554
  get contentMatches(): number;
1414
1555
  getContentMatches(): number;
1556
+ setContentMatches(_contentMatches: number): void;
1415
1557
  get layoutMatches(): number;
1416
1558
  getLayoutMatches(): number;
1559
+ setLayoutMatches(_layoutMatches: number): void;
1417
1560
  get noneMatches(): number;
1418
1561
  getNoneMatches(): number;
1562
+ setNoneMatches(_noneMatches: number): void;
1419
1563
  get url(): string;
1420
1564
  getUrl(): string;
1565
+ setUrl(_url: string): void;
1421
1566
  get server(): { serverUrl: string; apiKey: string; agentId?: undefined | string; proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; }; };
1422
1567
  get keepIfDuplicate(): boolean;
1423
1568
  isPassed(): boolean;
1424
1569
  delete(): Promise<void>;
1570
+ deleteSession(): Promise<void>;
1425
1571
  }
1426
1572
  export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1427
1573
  export class TestResultContainer implements Required<TestResultContainerPlain> {
@@ -1473,15 +1619,21 @@ export class Logger {
1473
1619
  extend(label?: undefined | string): Logger;
1474
1620
  }
1475
1621
  export abstract class EyesRunner {
1622
+ constructor(options?: undefined | RunnerOptionsPlain);
1476
1623
  abstract readonly type: "classic" | "ufg";
1477
1624
  getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1478
1625
  }
1479
1626
  export class ClassicRunner extends EyesRunner {
1480
- constructor(options?: undefined | RunnerOptionsPlain);
1627
+ readonly type: "classic";
1481
1628
  }
1482
1629
  export class VisualGridRunner extends EyesRunner {
1483
1630
  constructor(options?: undefined | RunnerOptionsPlain);
1631
+ constructor(options?: undefined | RunnerOptionsFluent);
1632
+ constructor(legacyConcurrency?: undefined | number);
1633
+ readonly type: "ufg";
1484
1634
  get testConcurrency(): undefined | number;
1635
+ get legacyConcurrency(): undefined | number;
1636
+ getConcurrentSessions(): undefined | number;
1485
1637
  }
1486
1638
  export abstract class SessionEventHandler {
1487
1639
  abstract initStarted(): any;