@applitools/eyes-images 4.22.1 → 4.23.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 (4) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/api.js +2 -2
  3. package/package.json +8 -8
  4. package/types/index.d.ts +349 -72
package/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ # Change Log
2
+
3
+ ## Unreleased
4
+
5
+ ## 0.0.1
6
+
7
+ ### Features
8
+ - Created
9
+ ### Bug fixes
package/dist/api.js CHANGED
@@ -32,8 +32,8 @@ __exportStar(require("@applitools/eyes"), exports);
32
32
  const sdk = { agentId: `eyes.images.javascript/${require('../package.json').version}` };
33
33
  class Eyes extends eyes.Eyes {
34
34
  }
35
- exports.Eyes = Eyes;
36
35
  Eyes._sdk = sdk;
36
+ exports.Eyes = Eyes;
37
37
  class Configuration extends eyes.Configuration {
38
38
  }
39
39
  exports.Configuration = Configuration;
@@ -49,6 +49,6 @@ exports.CheckSettings = CheckSettings;
49
49
  exports.Target = eyes.TargetImage;
50
50
  class BatchClose extends eyes.BatchClose {
51
51
  }
52
- exports.BatchClose = BatchClose;
53
52
  BatchClose._sdk = sdk;
53
+ exports.BatchClose = BatchClose;
54
54
  exports.closeBatch = eyes.closeBatch(sdk);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-images",
3
- "version": "4.22.1",
3
+ "version": "4.23.1",
4
4
  "description": "The simplest implementation of Applitools Eyes SDK, uploads images for validation",
5
5
  "keywords": [
6
6
  "eyes-images",
@@ -45,12 +45,12 @@
45
45
  ],
46
46
  "scripts": {
47
47
  "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
48
- "build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
48
+ "build": "node ../../node_modules/.bin/tspc --project ./tsconfig.build.json",
49
49
  "generate:tests": "coverage-tests generate ./test/coverage/config.js --name 'eyes-images'",
50
50
  "test": "yarn test:coverage",
51
51
  "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-images' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15}",
52
52
  "test:sanity": "echo 'create sanity suite'",
53
- "report": "bongo report --name 'js_images'",
53
+ "report": "bongo report --name 'js_images' --group 'images'",
54
54
  "deps": "bongo deps",
55
55
  "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='images' -f links='types test-utils core-base core eyes utils'",
56
56
  "gh:publish": "gh workflow run publish-images.yml --ref $(git rev-parse --abbrev-ref HEAD)",
@@ -60,13 +60,13 @@
60
60
  "postpublish": "bongo send-release-notification --name 'js_images'"
61
61
  },
62
62
  "dependencies": {
63
- "@applitools/eyes": "1.0.2"
63
+ "@applitools/eyes": "1.2.11"
64
64
  },
65
65
  "devDependencies": {
66
- "@applitools/api-extractor": "^1.2.12",
67
- "@applitools/bongo": "^3.0.2",
68
- "@applitools/sdk-coverage-tests": "^3.0.0",
69
- "@applitools/test-utils": "^1.5.14",
66
+ "@applitools/api-extractor": "^1.2.21",
67
+ "@applitools/bongo": "^3.0.4",
68
+ "@applitools/sdk-coverage-tests": "^3.0.2",
69
+ "@applitools/test-utils": "^1.5.17",
70
70
  "@types/node": "^12.20.55"
71
71
  },
72
72
  "engines": {
package/types/index.d.ts CHANGED
@@ -15,12 +15,26 @@ export class Eyes {
15
15
  setConfiguration(config: ConfigurationPlain): void;
16
16
  get isOpen(): boolean;
17
17
  getIsOpen(): boolean;
18
+ on(handler: (event: string, data?: undefined | Record<string, any>) => any): () => void;
19
+ on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
20
+ on(event: "setSizeEnded", handler: () => any): () => void;
21
+ on(event: "initStarted", handler: () => any): () => void;
22
+ on(event: "initEnded", handler: () => any): () => void;
23
+ on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
24
+ on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
25
+ on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
26
+ on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
27
+ off(event: string): void;
28
+ off(handler: (...args: Array<any>) => any): void;
18
29
  getExecutionCloudUrl(): Promise<string>;
19
30
  open(driver: never, config?: undefined | ConfigurationPlain): Promise<never>;
20
- open(driver: never, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<never>;
31
+ open(driver: never, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<never>;
32
+ open(driver: never, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<never>;
21
33
  open(config?: undefined | ConfigurationPlain): Promise<void>;
22
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
23
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
34
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<void>;
35
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<void>;
36
+ check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
37
+ check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
24
38
  check(target: {
25
39
  image: string | URL | Buffer;
26
40
  name?: undefined | string;
@@ -30,6 +44,22 @@ export class Eyes {
30
44
  fullViewSize?: undefined | RectangleSizePlain;
31
45
  }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
32
46
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
47
+ checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
48
+ checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
49
+ checkFrame(element: EyesSelector<never>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
50
+ checkElement(element: never, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
51
+ checkElementBy(selector: EyesSelector<never>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
52
+ checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
53
+ checkRegion(image: string, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
54
+ checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
55
+ checkRegion(image: Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
56
+ checkRegionByElement(element: never, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
57
+ checkRegionBy(selector: EyesSelector<never>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
58
+ checkRegionInFrame(frame: number, selector: EyesSelector<never>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
59
+ checkRegionInFrame(frame: EyesSelector<never>, selector: EyesSelector<never>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
60
+ checkImage(image: string, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
61
+ checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
62
+ checkImage(image: Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
33
63
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
34
64
  extractTextRegions<TPattern extends string>(target: {
35
65
  image: string | URL | Buffer;
@@ -41,6 +71,7 @@ export class Eyes {
41
71
  locationInView?: undefined | { x: number; y: number; };
42
72
  fullViewSize?: undefined | { width: number; height: number; };
43
73
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
74
+ extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & { image: string | URL | Buffer; }): Promise<Record<TPattern, Array<TextRegion>>>;
44
75
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
45
76
  extractText(target: {
46
77
  image: string | URL | Buffer;
@@ -52,22 +83,26 @@ export class Eyes {
52
83
  locationInView?: undefined | { x: number; y: number; };
53
84
  fullViewSize?: undefined | { width: number; height: number; };
54
85
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
86
+ extractText(settingsWithImage: Array<OCRRegion & { image: string | URL | Buffer; }>): Promise<Array<string>>;
55
87
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
56
88
  close(throwErr?: undefined | boolean): Promise<TestResults>;
57
89
  closeAsync(): Promise<void>;
58
90
  abort(): Promise<TestResults>;
59
91
  abortAsync(): Promise<void>;
92
+ abortIfNotClosed(): Promise<TestResultsPlain>;
60
93
  getViewportSize(): Promise<RectangleSize>;
61
94
  setViewportSize(size: RectangleSizePlain): Promise<void>;
62
95
  getScrollRootElement(): EyesSelector<never>;
63
96
  setScrollRootElement(scrollRootElement: EyesSelector<never>): void;
64
- setLogHandler(handler: LogHandlerPlain | LogHandler): void;
97
+ setLogHandler(handler: LogHandlerPlain): void;
98
+ setLogHandler(handler: LogHandler): void;
65
99
  getLogHandler(): LogHandler;
66
100
  setCutProvider(cutProvider: CutProvider): void;
67
101
  setImageCut(cutProvider: CutProvider): void;
68
102
  getIsCutProviderExplicitlySet(): boolean;
69
103
  getRotation(): ImageRotation;
70
- setRotation(rotation: ImageRotationPlain | ImageRotation): void;
104
+ setRotation(rotation: ImageRotationPlain): void;
105
+ setRotation(rotation: ImageRotation): void;
71
106
  getScaleRatio(): number;
72
107
  setScaleRatio(scaleRatio: number): void;
73
108
  getSaveDebugScreenshots(): boolean;
@@ -80,7 +115,8 @@ export class Eyes {
80
115
  clearProperties(): Configuration;
81
116
  getBatch(): BatchInfo;
82
117
  setBatch(batch: BatchInfoPlain): void;
83
- setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
118
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string): void;
119
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | Date): void;
84
120
  getApiKey(): string;
85
121
  setApiKey(apiKey: string): void;
86
122
  getTestName(): string;
@@ -89,6 +125,8 @@ export class Eyes {
89
125
  setAppName(appName: string): void;
90
126
  getBaselineBranchName(): string;
91
127
  setBaselineBranchName(baselineBranchName: string): void;
128
+ getBaselineName(): string;
129
+ setBaselineName(baselineName: string): void;
92
130
  getBaselineEnvName(): string;
93
131
  setBaselineEnvName(baselineEnvName: string): void;
94
132
  getBranchName(): string;
@@ -137,14 +175,21 @@ export class Eyes {
137
175
  setStitchMode(stitchMode: StitchModePlain): void;
138
176
  getStitchOverlap(): number;
139
177
  setStitchOverlap(stitchOverlap: number): void;
178
+ getSessionEventHandlers(): SessionEventHandlers;
179
+ addSessionEventHandler(handler: SessionEventHandler): void;
180
+ removeSessionEventHandler(handler: SessionEventHandler): void;
181
+ clearSessionEventHandlers(): void;
140
182
  }
141
183
  export type ConfigurationPlain = {
184
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
142
185
  agentId?: undefined | string;
143
186
  apiKey?: undefined | string;
144
187
  serverUrl?: undefined | string;
145
188
  proxy?: undefined | ProxySettingsPlain;
146
189
  autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
147
190
  isDisabled?: undefined | boolean;
191
+ connectionTimeout?: undefined | number;
192
+ removeSession?: undefined | boolean;
148
193
  appName?: undefined | string;
149
194
  testName?: undefined | string;
150
195
  displayName?: undefined | string;
@@ -169,6 +214,7 @@ export type ConfigurationPlain = {
169
214
  saveFailedTests?: undefined | boolean;
170
215
  saveNewTests?: undefined | boolean;
171
216
  saveDiffs?: undefined | boolean;
217
+ dontCloseBatches?: undefined | boolean;
172
218
  sendDom?: undefined | boolean;
173
219
  matchTimeout?: undefined | number;
174
220
  forceFullPageScreenshot?: undefined | boolean;
@@ -181,14 +227,23 @@ export type ConfigurationPlain = {
181
227
  cut?: undefined | CutProviderPlain;
182
228
  rotation?: undefined | ImageRotationPlain;
183
229
  scaleRatio?: undefined | number;
230
+ concurrentSessions?: undefined | number;
184
231
  browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
185
232
  visualGridOptions?: undefined | Record<string, any>;
186
- layoutBreakpoints?: undefined | boolean | Array<number>;
233
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
187
234
  disableBrowserFetching?: undefined | boolean;
188
235
  waitBeforeCapture?: undefined | number;
189
236
  };
190
237
  export class Configuration implements Required<ConfigurationPlain> {
191
238
  constructor(config?: undefined | ConfigurationPlain);
239
+ get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
240
+ set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
241
+ getSaveDebugScreenshots(): boolean;
242
+ setSaveDebugScreenshots(save: boolean): Configuration;
243
+ getDebugScreenshotsPath(): string;
244
+ setDebugScreenshotsPath(path: string): Configuration;
245
+ getDebugScreenshotsPrefix(): string;
246
+ setDebugScreenshotsPrefix(prefix: string): Configuration;
192
247
  get appName(): string;
193
248
  set appName(appName: string);
194
249
  getAppName(): string;
@@ -239,6 +294,14 @@ export class Configuration implements Required<ConfigurationPlain> {
239
294
  set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
240
295
  getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
241
296
  setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
297
+ get connectionTimeout(): number;
298
+ set connectionTimeout(connectionTimeout: number);
299
+ getConnectionTimeout(): number;
300
+ setConnectionTimeout(connectionTimeout: number): Configuration;
301
+ get removeSession(): boolean;
302
+ set removeSession(removeSession: boolean);
303
+ getRemoveSession(): boolean;
304
+ setRemoveSession(removeSession: boolean): Configuration;
242
305
  get batch(): BatchInfoPlain;
243
306
  set batch(batch: BatchInfoPlain);
244
307
  getBatch(): BatchInfo;
@@ -373,34 +436,68 @@ export class Configuration implements Required<ConfigurationPlain> {
373
436
  get rotation(): ImageRotationPlain;
374
437
  set rotation(rotation: ImageRotationPlain);
375
438
  getRotation(): ImageRotation;
376
- setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration;
439
+ setRotation(rotation: ImageRotationPlain): Configuration;
440
+ setRotation(rotation: ImageRotation): Configuration;
377
441
  get scaleRatio(): number;
378
442
  set scaleRatio(scaleRatio: number);
379
443
  getScaleRatio(): number;
380
444
  setScaleRatio(scaleRatio: number): Configuration;
445
+ get concurrentSessions(): number;
446
+ set concurrentSessions(concurrentSessions: number);
447
+ getConcurrentSessions(): number;
448
+ setConcurrentSessions(concurrentSessions: number): Configuration;
381
449
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
382
450
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
383
451
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
384
452
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
385
453
  addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
386
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
387
- 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;
388
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
389
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
390
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
454
+ addBrowser(browserInfo: DesktopBrowserInfo): Configuration;
455
+ addBrowser(browserInfo: ChromeEmulationInfo): Configuration;
456
+ addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }): Configuration;
457
+ addBrowser(browserInfo: IOSDeviceInfo): Configuration;
458
+ addBrowser(browserInfo: AndroidDeviceInfo): Configuration;
459
+ addBrowser(width: number, height: number, name?: undefined | "chrome"): Configuration;
460
+ addBrowser(width: number, height: number, name?: undefined | "chrome-one-version-back"): Configuration;
461
+ addBrowser(width: number, height: number, name?: undefined | "chrome-two-versions-back"): Configuration;
462
+ addBrowser(width: number, height: number, name?: undefined | "firefox"): Configuration;
463
+ addBrowser(width: number, height: number, name?: undefined | "firefox-one-version-back"): Configuration;
464
+ addBrowser(width: number, height: number, name?: undefined | "firefox-two-versions-back"): Configuration;
465
+ addBrowser(width: number, height: number, name?: undefined | "ie"): Configuration;
466
+ addBrowser(width: number, height: number, name?: undefined | "ie10"): Configuration;
467
+ addBrowser(width: number, height: number, name?: undefined | "edge"): Configuration;
468
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium"): Configuration;
469
+ addBrowser(width: number, height: number, name?: undefined | "edgelegacy"): Configuration;
470
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-one-version-back"): Configuration;
471
+ addBrowser(width: number, height: number, name?: undefined | "edgechromium-two-versions-back"): Configuration;
472
+ addBrowser(width: number, height: number, name?: undefined | "safari"): Configuration;
473
+ addBrowser(width: number, height: number, name?: undefined | "safari-earlyaccess"): Configuration;
474
+ addBrowser(width: number, height: number, name?: undefined | "safari-one-version-back"): Configuration;
475
+ addBrowser(width: number, height: number, name?: undefined | "safari-two-versions-back"): Configuration;
476
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape"): Configuration;
477
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait"): Configuration;
478
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
479
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
480
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
481
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
391
482
  get visualGridOptions(): { [key: string]: any; };
392
483
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
393
484
  getVisualGridOptions(): { [key: string]: any; };
394
485
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
395
486
  setVisualGridOption(key: string, value: any): Configuration;
396
- get layoutBreakpoints(): boolean | Array<number>;
397
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number>);
398
- getLayoutBreakpoints(): boolean | Array<number>;
399
- setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number>): Configuration;
487
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
488
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
489
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
490
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
491
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
492
+ setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
400
493
  get disableBrowserFetching(): boolean;
401
494
  set disableBrowserFetching(disableBrowserFetching: boolean);
402
495
  getDisableBrowserFetching(): boolean;
403
496
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
497
+ get dontCloseBatches(): boolean;
498
+ set dontCloseBatches(dontCloseBatches: boolean);
499
+ getDontCloseBatches(): boolean;
500
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
404
501
  }
405
502
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
406
503
  frames?: undefined | Array<{ frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); } | (number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>;
@@ -408,7 +505,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
408
505
  scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
409
506
  fully?: undefined | boolean;
410
507
  disableBrowserFetching?: undefined | boolean;
411
- layoutBreakpoints?: undefined | boolean | Array<number>;
508
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
412
509
  visualGridOptions?: undefined | { [key: string]: any; };
413
510
  nmgOptions?: undefined | { [key: string]: any; };
414
511
  hooks?: undefined | { beforeCaptureScreenshot: string; };
@@ -418,36 +515,58 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
418
515
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
419
516
  };
420
517
  export class CheckSettingsAutomation {
421
- constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
422
- region(region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
423
- shadow(selector: string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
518
+ constructor(settings?: undefined | CheckSettingsAutomation);
519
+ constructor(settings?: undefined | CheckSettingsAutomationPlain);
520
+ region(region: RegionPlain): CheckSettingsAutomation;
521
+ region(region: ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
522
+ shadow(selector: string): CheckSettingsAutomation;
523
+ shadow(selector: { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
424
524
  frame(context: { frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); }): CheckSettingsAutomation;
425
- frame(frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
426
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
525
+ frame(frame: number, scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
526
+ frame(frame: ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
527
+ webview(webview?: undefined | string): CheckSettingsAutomation;
528
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
427
529
  scrollRootElement(scrollRootElement: (string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })): CheckSettingsAutomation;
428
530
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
531
+ stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
429
532
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
430
- layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
533
+ layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
534
+ layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
431
535
  hook(name: string, script: string): CheckSettingsAutomation;
432
536
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
537
+ webHook(script: string): CheckSettingsAutomation;
433
538
  ufgOption(key: string, value: any): CheckSettingsAutomation;
434
539
  ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
540
+ visualGridOption(key: string, value: any): CheckSettingsAutomation;
541
+ visualGridOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
435
542
  nmgOption(key: string, value: any): CheckSettingsAutomation;
436
543
  nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
437
544
  renderId(renderId: string): CheckSettingsAutomation;
438
545
  timeout(timeout: number): CheckSettingsAutomation;
439
546
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
440
- lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
547
+ lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
548
+ lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
441
549
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
442
550
  name(name: string): CheckSettingsAutomation;
443
551
  withName(name: string): CheckSettingsAutomation;
444
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
552
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
553
+ ignoreRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
554
+ ignoreRegion(region: { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
445
555
  ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
446
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
556
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
557
+ ignore(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
558
+ ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>): CheckSettingsAutomation;
559
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
560
+ layoutRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
561
+ layoutRegion(region: { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
447
562
  layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
448
- strictRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
563
+ strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
564
+ strictRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
565
+ strictRegion(region: { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
449
566
  strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
450
- contentRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
567
+ contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
568
+ contentRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
569
+ contentRegion(region: { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
451
570
  contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
452
571
  floatingRegion(region: {
453
572
  region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
@@ -464,7 +583,8 @@ export class CheckSettingsAutomation {
464
583
  maxLeftOffset?: undefined | number;
465
584
  maxRightOffset?: undefined | number;
466
585
  }): CheckSettingsAutomation;
467
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
586
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
587
+ floatingRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
468
588
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | {
469
589
  region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
470
590
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -472,13 +592,37 @@ export class CheckSettingsAutomation {
472
592
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
473
593
  }>): CheckSettingsAutomation;
474
594
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>): CheckSettingsAutomation;
595
+ floating(region: {
596
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
597
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
598
+ regionId?: undefined | string;
599
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
600
+ }): CheckSettingsAutomation;
601
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
602
+ floating(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
603
+ floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | {
604
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
605
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
606
+ regionId?: undefined | string;
607
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
608
+ }>): CheckSettingsAutomation;
609
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>): CheckSettingsAutomation;
475
610
  accessibilityRegion(region: {
476
611
  region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
477
612
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
478
613
  regionId?: undefined | string;
479
614
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
480
615
  }): CheckSettingsAutomation;
481
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
616
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
617
+ accessibilityRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
618
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsAutomation;
619
+ accessibilityRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "RegularText"): CheckSettingsAutomation;
620
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsAutomation;
621
+ accessibilityRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "LargeText"): CheckSettingsAutomation;
622
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsAutomation;
623
+ accessibilityRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "BoldText"): CheckSettingsAutomation;
624
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
625
+ accessibilityRegion(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
482
626
  accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | {
483
627
  region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
484
628
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -491,6 +635,7 @@ export class CheckSettingsAutomation {
491
635
  exact(): CheckSettingsAutomation;
492
636
  strict(): CheckSettingsAutomation;
493
637
  ignoreColors(): CheckSettingsAutomation;
638
+ content(): CheckSettingsAutomation;
494
639
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
495
640
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
496
641
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
@@ -500,7 +645,7 @@ export class CheckSettingsAutomation {
500
645
  variationGroupId(variationGroupId: string): CheckSettingsAutomation;
501
646
  }
502
647
  export class CheckSettingsImage {
503
- constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
648
+ constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
504
649
  image: string | URL | Buffer;
505
650
  name?: undefined | string;
506
651
  dom?: undefined | string;
@@ -508,23 +653,46 @@ export class CheckSettingsImage {
508
653
  locationInView?: undefined | LocationPlain;
509
654
  fullViewSize?: undefined | RectangleSizePlain;
510
655
  });
511
- image(image: string | URL | Buffer): CheckSettingsImage;
656
+ constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
657
+ image: string | URL | Buffer;
658
+ name?: undefined | string;
659
+ dom?: undefined | string;
660
+ locationInViewport?: undefined | LocationPlain;
661
+ locationInView?: undefined | LocationPlain;
662
+ fullViewSize?: undefined | RectangleSizePlain;
663
+ });
664
+ image(image: string): CheckSettingsImage;
665
+ image(image: URL): CheckSettingsImage;
666
+ image(image: Buffer): CheckSettingsImage;
512
667
  buffer(imageBuffer: Buffer): CheckSettingsImage;
513
668
  base64(imageBase64: Buffer): CheckSettingsImage;
514
669
  path(imagePath: string): CheckSettingsImage;
515
- url(imageUrl: string | URL): CheckSettingsImage;
670
+ url(imageUrl: string): CheckSettingsImage;
671
+ url(imageUrl: URL): CheckSettingsImage;
516
672
  name(name: string): CheckSettingsImage;
517
673
  withDom(dom: string): CheckSettingsImage;
518
674
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
519
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
675
+ region(region: LegacyRegionPlain): CheckSettingsImage;
676
+ region(region: RegionPlain): CheckSettingsImage;
520
677
  withName(name: string): CheckSettingsImage;
521
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
678
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
679
+ ignoreRegion(region: RegionPlain): CheckSettingsImage;
680
+ ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
522
681
  ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
523
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
682
+ ignore(region: LegacyRegionPlain): CheckSettingsImage;
683
+ ignore(region: RegionPlain): CheckSettingsImage;
684
+ ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
685
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
686
+ layoutRegion(region: RegionPlain): CheckSettingsImage;
687
+ layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
524
688
  layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
525
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
689
+ strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
690
+ strictRegion(region: RegionPlain): CheckSettingsImage;
691
+ strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
526
692
  strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
527
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
693
+ contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
694
+ contentRegion(region: RegionPlain): CheckSettingsImage;
695
+ contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
528
696
  contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
529
697
  floatingRegion(region: {
530
698
  region: RegionPlain;
@@ -541,7 +709,8 @@ export class CheckSettingsImage {
541
709
  maxLeftOffset?: undefined | number;
542
710
  maxRightOffset?: undefined | number;
543
711
  }): CheckSettingsImage;
544
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
712
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
713
+ floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
545
714
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
546
715
  region: RegionPlain;
547
716
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -549,13 +718,37 @@ export class CheckSettingsImage {
549
718
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
550
719
  }>): CheckSettingsImage;
551
720
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
721
+ floating(region: {
722
+ region: RegionPlain;
723
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
724
+ regionId?: undefined | string;
725
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
726
+ }): CheckSettingsImage;
727
+ floating(region: LegacyRegionPlain): CheckSettingsImage;
728
+ floating(region: RegionPlain): CheckSettingsImage;
729
+ floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
730
+ region: RegionPlain;
731
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
732
+ regionId?: undefined | string;
733
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
734
+ }>): CheckSettingsImage;
735
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
552
736
  accessibilityRegion(region: {
553
737
  region: RegionPlain;
554
738
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
555
739
  regionId?: undefined | string;
556
740
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
557
741
  }): CheckSettingsImage;
558
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
742
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
743
+ accessibilityRegion(region: RegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
744
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
745
+ accessibilityRegion(region: RegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
746
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
747
+ accessibilityRegion(region: RegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
748
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
749
+ accessibilityRegion(region: RegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
750
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
751
+ accessibilityRegion(region: RegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
559
752
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
560
753
  region: RegionPlain;
561
754
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -568,6 +761,7 @@ export class CheckSettingsImage {
568
761
  exact(): CheckSettingsImage;
569
762
  strict(): CheckSettingsImage;
570
763
  ignoreColors(): CheckSettingsImage;
764
+ content(): CheckSettingsImage;
571
765
  enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
572
766
  ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
573
767
  ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
@@ -580,18 +774,25 @@ export class CheckSettings extends CheckSettingsImage {
580
774
  }
581
775
  export type TargetAutomation = {
582
776
  window(): CheckSettingsAutomation;
583
- region(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
777
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
778
+ region(region: (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
584
779
  frame(context: { frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); }): CheckSettingsAutomation;
585
- frame(frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
586
- shadow(selector: string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
587
- webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
780
+ frame(frame: number, scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
781
+ frame(frame: ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
782
+ shadow(selector: string): CheckSettingsAutomation;
783
+ shadow(selector: { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
784
+ webview(webview?: undefined | string): CheckSettingsAutomation;
785
+ webview(webview?: undefined | boolean): CheckSettingsAutomation;
588
786
  };
589
787
  export const Target: {
590
- image(image: string | URL | Buffer): CheckSettingsImage;
788
+ image(image: string): CheckSettingsImage;
789
+ image(image: URL): CheckSettingsImage;
790
+ image(image: Buffer): CheckSettingsImage;
591
791
  buffer(imageBuffer: Buffer): CheckSettingsImage;
592
792
  base64(imageBase64: string): CheckSettingsImage;
593
793
  path(imagePath: string): CheckSettingsImage;
594
- url(imageUrl: string | URL): CheckSettingsImage;
794
+ url(imageUrl: string): CheckSettingsImage;
795
+ url(imageUrl: URL): CheckSettingsImage;
595
796
  };
596
797
  export type OCRRegion = { target: RegionPlain | EyesSelector<never>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
597
798
  export class BatchClose {
@@ -850,7 +1051,11 @@ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: unde
850
1051
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
851
1052
  constructor(settings: AccessibilityMatchSettingsPlain);
852
1053
  constructor(region: RegionPlain);
853
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
1054
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast");
1055
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "RegularText");
1056
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "LargeText");
1057
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "BoldText");
1058
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "GraphicalObject");
854
1059
  get region(): RegionPlain;
855
1060
  set region(region: RegionPlain);
856
1061
  getRegion(): Region;
@@ -880,7 +1085,8 @@ export type BatchInfoPlain = {
880
1085
  export class BatchInfo implements Required<BatchInfoPlain> {
881
1086
  constructor();
882
1087
  constructor(batch?: undefined | BatchInfoPlain);
883
- constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
1088
+ constructor(name?: undefined | string, startedAt?: undefined | string, id?: undefined | string);
1089
+ constructor(name?: undefined | string, startedAt?: undefined | Date, id?: undefined | string);
884
1090
  get id(): string;
885
1091
  set id(id: string);
886
1092
  getId(): string;
@@ -896,7 +1102,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
896
1102
  get startedAt(): string | Date;
897
1103
  set startedAt(startedAt: string | Date);
898
1104
  getStartedAt(): string | Date;
899
- setStartedAt(startedAt: string | Date): BatchInfo;
1105
+ setStartedAt(startedAt: string): BatchInfo;
1106
+ setStartedAt(startedAt: Date): BatchInfo;
900
1107
  get notifyOnCompletion(): boolean;
901
1108
  set notifyOnCompletion(notifyOnCompletion: boolean);
902
1109
  getNotifyOnCompletion(): boolean;
@@ -947,11 +1154,14 @@ export type CheckSettingsImagePlain = {
947
1154
  densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
948
1155
  };
949
1156
  export type TargetImage = {
950
- image(image: string | URL | Buffer): CheckSettingsImage;
1157
+ image(image: string): CheckSettingsImage;
1158
+ image(image: URL): CheckSettingsImage;
1159
+ image(image: Buffer): CheckSettingsImage;
951
1160
  buffer(imageBuffer: Buffer): CheckSettingsImage;
952
1161
  base64(imageBase64: string): CheckSettingsImage;
953
1162
  path(imagePath: string): CheckSettingsImage;
954
- url(imageUrl: string | URL): CheckSettingsImage;
1163
+ url(imageUrl: string): CheckSettingsImage;
1164
+ url(imageUrl: URL): CheckSettingsImage;
955
1165
  };
956
1166
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
957
1167
  export class CutProvider implements Required<{
@@ -1143,7 +1353,14 @@ export class Location implements Required<LocationPlain> {
1143
1353
  setY(y: number): void;
1144
1354
  }
1145
1355
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1146
- export type CustomLogHandlerPlain = { log(message: any): void; };
1356
+ export type CustomLogHandlerPlain = {
1357
+ log(message: any): void;
1358
+ warn?(message: any): void;
1359
+ error?(message: any): void;
1360
+ fatal?(message: any): void;
1361
+ open?(): void;
1362
+ close?(): void;
1363
+ };
1147
1364
  export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1148
1365
  export type ConsoleLogHandlerPlain = { type: "console"; };
1149
1366
  export abstract class LogHandler implements CustomLogHandlerPlain {
@@ -1253,76 +1470,94 @@ export type DesktopBrowserInfo = { name?: undefined | "chrome" | "chrome-one-ver
1253
1470
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1254
1471
  export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1255
1472
  export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1256
- export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1473
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1257
1474
  export class RunnerOptionsFluent {
1258
1475
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1259
1476
  }
1260
1477
  export function RunnerOptions(): RunnerOptionsFluent;
1261
1478
  export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1262
1479
  export type ApiUrlsPlain = {
1263
- readonly baselineImage?: undefined | string;
1264
- readonly currentImage?: undefined | string;
1265
- readonly checkpointImage?: undefined | string;
1266
- readonly checkpointImageThumbnail?: undefined | string;
1267
- readonly diffImage?: undefined | string;
1480
+ readonly baselineImage: string;
1481
+ readonly currentImage: string;
1482
+ readonly checkpointImage: string;
1483
+ readonly checkpointImageThumbnail: string;
1484
+ readonly diffImage: string;
1268
1485
  };
1269
1486
  export class ApiUrls implements Required<ApiUrlsPlain> {
1270
1487
  get baselineImage(): string;
1271
1488
  getBaselineImage(): string;
1489
+ setBaselineImage(setBaselineImage: string): void;
1272
1490
  get currentImage(): string;
1273
1491
  getCurrentImage(): string;
1492
+ setCurrentImage(currentImage: string): void;
1274
1493
  get checkpointImage(): string;
1275
1494
  getCheckpointImage(): string;
1495
+ setCheckpointImage(checkpointImage: string): void;
1276
1496
  get checkpointImageThumbnail(): string;
1277
1497
  getCheckpointImageThumbnail(): string;
1498
+ setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1278
1499
  get diffImage(): string;
1279
1500
  getDiffImage(): string;
1501
+ setDiffImage(diffImage: string): void;
1280
1502
  }
1281
- export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
1503
+ export type AppUrlsPlain = { readonly step: string; readonly stepEditor: string; };
1282
1504
  export class AppUrls implements Required<AppUrlsPlain> {
1283
1505
  get step(): string;
1284
1506
  getStep(): string;
1507
+ setStep(step: string): void;
1285
1508
  get stepEditor(): string;
1286
1509
  getStepEditor(): string;
1510
+ setStepEditor(stepEditor: string): void;
1287
1511
  }
1288
1512
  export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1289
1513
  export class MatchResult implements Required<MatchResultPlain> {
1290
1514
  get asExpected(): boolean;
1291
1515
  getAsExpected(): boolean;
1516
+ setAsExpected(asExpected: boolean): void;
1292
1517
  get windowId(): number;
1293
1518
  getWindowId(): number;
1519
+ setWindowId(windowId: number): void;
1294
1520
  }
1295
- export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
1521
+ export type SessionUrlsPlain = { readonly batch: string; readonly session: string; };
1296
1522
  export class SessionUrls implements Required<SessionUrlsPlain> {
1297
1523
  get batch(): string;
1298
1524
  getBatch(): string;
1525
+ setBatch(batch: string): void;
1299
1526
  get session(): string;
1300
1527
  getSession(): string;
1528
+ setSession(session: string): void;
1301
1529
  }
1302
1530
  export type StepInfoPlain = {
1303
- readonly name?: undefined | string;
1304
- readonly isDifferent?: undefined | boolean;
1305
- readonly hasBaselineImage?: undefined | boolean;
1306
- readonly hasCurrentImage?: undefined | boolean;
1307
- readonly appUrls?: undefined | AppUrlsPlain;
1308
- readonly apiUrls?: undefined | ApiUrlsPlain;
1309
- readonly renderId?: undefined | Array<string>;
1531
+ readonly name: string;
1532
+ readonly isDifferent: boolean;
1533
+ readonly hasBaselineImage: boolean;
1534
+ readonly hasCurrentImage: boolean;
1535
+ readonly appUrls: AppUrlsPlain;
1536
+ readonly apiUrls: ApiUrlsPlain;
1537
+ readonly renderId: Array<string>;
1310
1538
  };
1311
1539
  export class StepInfo implements Required<StepInfoPlain> {
1312
1540
  get name(): string;
1313
1541
  getName(): string;
1542
+ setName(value: string): void;
1314
1543
  get isDifferent(): boolean;
1315
1544
  getIsDifferent(): boolean;
1545
+ setIsDifferent(value: boolean): void;
1316
1546
  get hasBaselineImage(): boolean;
1317
1547
  getHasBaselineImage(): boolean;
1548
+ setHasBaselineImage(value: boolean): void;
1318
1549
  get hasCurrentImage(): boolean;
1319
1550
  getHasCurrentImage(): boolean;
1551
+ setHasCurrentImage(hasCurrentImage: boolean): void;
1320
1552
  get appUrls(): AppUrlsPlain;
1321
1553
  getAppUrls(): AppUrls;
1554
+ setAppUrls(appUrls: AppUrlsPlain): void;
1322
1555
  get apiUrls(): ApiUrlsPlain;
1323
1556
  getApiUrls(): ApiUrls;
1557
+ setApiUrls(apiUrls: ApiUrlsPlain): void;
1324
1558
  get renderId(): Array<string>;
1325
1559
  getRenderId(): Array<string>;
1560
+ setRenderId(renderId: Array<string>): void;
1326
1561
  }
1327
1562
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1328
1563
  export type TestResultsPlain = {
@@ -1338,7 +1573,7 @@ export type TestResultsPlain = {
1338
1573
  readonly hostApp?: undefined | string;
1339
1574
  readonly hostDisplaySize?: undefined | RectangleSizePlain;
1340
1575
  readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
1341
- readonly startedAt?: undefined | string | Date;
1576
+ readonly startedAt?: undefined | string;
1342
1577
  readonly duration?: undefined | number;
1343
1578
  readonly isNew?: undefined | boolean;
1344
1579
  readonly isDifferent?: undefined | boolean;
@@ -1356,70 +1591,106 @@ export type TestResultsPlain = {
1356
1591
  readonly layoutMatches?: undefined | number;
1357
1592
  readonly noneMatches?: undefined | number;
1358
1593
  readonly url?: undefined | string;
1594
+ readonly server?: undefined | { serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; };
1595
+ readonly keepIfDuplicate?: undefined | boolean;
1359
1596
  };
1360
1597
  export class TestResults implements Required<TestResultsPlain> {
1361
1598
  get id(): string;
1362
1599
  getId(): string;
1600
+ setId(_id: string): void;
1363
1601
  get name(): string;
1364
1602
  getName(): string;
1603
+ setName(_name: string): void;
1365
1604
  get secretToken(): string;
1366
1605
  getSecretToken(): string;
1606
+ setSecretToken(_secretToken: string): void;
1367
1607
  get status(): TestResultsStatusPlain;
1368
1608
  getStatus(): TestResultsStatus;
1609
+ setStatus(_status: TestResultsStatus): void;
1369
1610
  get appName(): string;
1370
1611
  getAppName(): string;
1612
+ setAppName(_appName: string): void;
1371
1613
  get batchName(): string;
1372
1614
  getBatchName(): string;
1615
+ setBatchName(_batchName: string): void;
1373
1616
  get batchId(): string;
1374
1617
  getBatchId(): string;
1618
+ setBatchId(_batchId: string): void;
1375
1619
  get branchName(): string;
1376
1620
  getBranchName(): string;
1621
+ setBranchName(_branchName: string): void;
1377
1622
  get hostOS(): string;
1378
1623
  getHostOS(): string;
1624
+ setHostOS(_hostOS: string): void;
1379
1625
  get hostApp(): string;
1380
1626
  getHostApp(): string;
1627
+ setHostApp(_hostApp: string): void;
1381
1628
  get hostDisplaySize(): RectangleSizePlain;
1382
1629
  getHostDisplaySize(): RectangleSize;
1630
+ setHostDisplaySize(_hostDisplaySize: RectangleSizePlain): void;
1383
1631
  get accessibilityStatus(): TestAccessibilityStatus;
1384
1632
  getAccessibilityStatus(): TestAccessibilityStatus;
1385
- get startedAt(): string | Date;
1633
+ setAccessibilityStatus(_accessibilityStatus: TestAccessibilityStatus): void;
1634
+ get startedAt(): string;
1386
1635
  getStartedAt(): Date;
1636
+ setStartedAt(_startedAt: string): void;
1637
+ setStartedAt(_startedAt: Date): void;
1387
1638
  get duration(): number;
1388
1639
  getDuration(): number;
1640
+ setDuration(_duration: number): void;
1389
1641
  get isNew(): boolean;
1390
1642
  getIsNew(): boolean;
1643
+ setIsNew(_isNew: boolean): void;
1391
1644
  get isDifferent(): boolean;
1392
1645
  getIsDifferent(): boolean;
1646
+ setIsDifferent(_isDifferent: boolean): void;
1393
1647
  get isAborted(): boolean;
1394
1648
  getIsAborted(): boolean;
1649
+ setIsAborted(_isAborted: boolean): void;
1395
1650
  get appUrls(): SessionUrlsPlain;
1396
1651
  getAppUrls(): SessionUrls;
1652
+ setAppUrls(_appUrls: SessionUrlsPlain): void;
1397
1653
  get apiUrls(): SessionUrlsPlain;
1398
1654
  getApiUrls(): SessionUrls;
1655
+ setApiUrls(_apiUrls: SessionUrlsPlain): void;
1399
1656
  get stepsInfo(): Array<StepInfoPlain>;
1400
1657
  getStepsInfo(): Array<StepInfo>;
1658
+ setStepsInfo(_stepInfo: Array<StepInfoPlain>): void;
1401
1659
  get steps(): number;
1402
1660
  getSteps(): number;
1661
+ setSteps(_steps: number): void;
1403
1662
  get matches(): number;
1404
1663
  getMatches(): number;
1664
+ setMatches(_matches: number): void;
1405
1665
  get mismatches(): number;
1406
1666
  getMismatches(): number;
1667
+ setMismatches(_mismatches: number): void;
1407
1668
  get missing(): number;
1408
1669
  getMissing(): number;
1670
+ setMissing(_missing: number): void;
1409
1671
  get exactMatches(): number;
1410
1672
  getExactMatches(): number;
1673
+ setExactMatches(_exactMatches: number): void;
1411
1674
  get strictMatches(): number;
1412
1675
  getStrictMatches(): number;
1676
+ setStrictMatches(_strictMatches: number): void;
1413
1677
  get contentMatches(): number;
1414
1678
  getContentMatches(): number;
1679
+ setContentMatches(_contentMatches: number): void;
1415
1680
  get layoutMatches(): number;
1416
1681
  getLayoutMatches(): number;
1682
+ setLayoutMatches(_layoutMatches: number): void;
1417
1683
  get noneMatches(): number;
1418
1684
  getNoneMatches(): number;
1685
+ setNoneMatches(_noneMatches: number): void;
1419
1686
  get url(): string;
1420
1687
  getUrl(): string;
1688
+ setUrl(_url: string): void;
1689
+ get server(): { serverUrl: string; apiKey: string; agentId?: undefined | string; proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; }; };
1690
+ get keepIfDuplicate(): boolean;
1421
1691
  isPassed(): boolean;
1422
1692
  delete(): Promise<void>;
1693
+ deleteSession(): Promise<void>;
1423
1694
  }
1424
1695
  export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1425
1696
  export class TestResultContainer implements Required<TestResultContainerPlain> {
@@ -1467,17 +1738,23 @@ export class Logger {
1467
1738
  fatal(...messages: Array<any>): void;
1468
1739
  open(): void;
1469
1740
  close(): void;
1470
- tag(name: string, value: any): void;
1471
- extend(label?: undefined | string): Logger;
1472
1741
  }
1473
1742
  export abstract class EyesRunner {
1743
+ constructor(options?: undefined | RunnerOptionsPlain);
1744
+ abstract readonly type: "classic" | "ufg";
1474
1745
  getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1475
1746
  }
1476
1747
  export class ClassicRunner extends EyesRunner {
1748
+ readonly type: "classic";
1477
1749
  }
1478
1750
  export class VisualGridRunner extends EyesRunner {
1479
1751
  constructor(options?: undefined | RunnerOptionsPlain);
1752
+ constructor(options?: undefined | RunnerOptionsFluent);
1753
+ constructor(legacyConcurrency?: undefined | number);
1754
+ readonly type: "ufg";
1480
1755
  get testConcurrency(): undefined | number;
1756
+ get legacyConcurrency(): undefined | number;
1757
+ getConcurrentSessions(): undefined | number;
1481
1758
  }
1482
1759
  export abstract class SessionEventHandler {
1483
1760
  abstract initStarted(): any;