@applitools/eyes-webdriverio 5.34.1 → 5.34.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 +72 -72
package/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@
3
3
  ## Unreleased
4
4
 
5
5
 
6
+ ## 5.34.2 - 2021/11/18
7
+
8
+ - updated to @applitools/eyes-sdk-core@12.24.2 (from 12.24.1)
9
+ - updated to @applitools/spec-driver-webdriverio@1.2.1 (from 1.2.0)
10
+ - updated to @applitools/visual-grid-client@15.8.47 (from 15.8.45)
11
+
6
12
  ## 5.34.1 - 2021/11/14
7
13
 
8
14
  - updated to @applitools/eyes-sdk-core@12.24.1 (from 12.24.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.34.1",
3
+ "version": "5.34.2",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -107,12 +107,12 @@
107
107
  },
108
108
  "dependencies": {
109
109
  "@applitools/eyes-api": "1.1.6",
110
- "@applitools/eyes-sdk-core": "12.24.1",
111
- "@applitools/spec-driver-webdriverio": "1.2.0",
112
- "@applitools/visual-grid-client": "15.8.45"
110
+ "@applitools/eyes-sdk-core": "12.24.2",
111
+ "@applitools/spec-driver-webdriverio": "1.2.1",
112
+ "@applitools/visual-grid-client": "15.8.47"
113
113
  },
114
114
  "devDependencies": {
115
- "@applitools/api-extractor": "1.2.2",
115
+ "@applitools/api-extractor": "1.2.3",
116
116
  "@applitools/scripts": "1.0.1",
117
117
  "@applitools/sdk-coverage-tests": "^2.3.16",
118
118
  "@applitools/sdk-release-kit": "^0.13.4",
package/types/index.d.ts CHANGED
@@ -18,8 +18,8 @@ export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | {
18
18
  export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: never; };
19
19
  export class Eyes {
20
20
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
21
- constructor(runner: EyesRunner, config: ConfigurationPlain);
22
- constructor(config: ConfigurationPlain);
21
+ constructor(runner?: EyesRunner, config?: ConfigurationPlain);
22
+ constructor(config?: ConfigurationPlain);
23
23
  get logger(): Logger;
24
24
  getLogger(): Logger;
25
25
  get runner(): EyesRunner;
@@ -32,7 +32,7 @@ export class Eyes {
32
32
  setConfiguration(config: ConfigurationPlain): void;
33
33
  get isOpen(): boolean;
34
34
  getIsOpen(): boolean;
35
- on(handler: (event: string, data: Record<string, any>) => any): () => void;
35
+ on(handler: (event: string, data?: Record<string, any>) => any): () => void;
36
36
  on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
37
37
  on(event: "setSizeEnded", handler: () => any): () => void;
38
38
  on(event: "initStarted", handler: () => any): () => void;
@@ -42,23 +42,23 @@ export class Eyes {
42
42
  on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
43
43
  on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
44
44
  off(event: string): void;
45
- off(handler: (args: Array<any>) => any): void;
46
- open(driver: Driver, config: ConfigurationPlain): Promise<Driver>;
47
- open(driver: Driver, appName: string, testName: string, viewportSize: RectangleSizePlain, sessionType: SessionTypePlain): Promise<Driver>;
48
- checkWindow(name: string, timeout: number, fully: boolean): Promise<MatchResult>;
49
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
50
- checkElement(element: Element, timeout: number, name: string): Promise<MatchResult>;
51
- checkElementBy(selector: EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
52
- checkRegion(region: RegionPlain, name: string, timeout: number): Promise<MatchResult>;
53
- checkRegionByElement(element: Element, name: string, timeout: number): Promise<MatchResult>;
54
- checkRegionBy(selector: EyesSelector<Selector>, name: string, timeout: number, fully: boolean): Promise<MatchResult>;
55
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout: number, name: string, fully: boolean): Promise<MatchResult>;
45
+ off(handler: (...args: Array<any>) => any): void;
46
+ open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
47
+ open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
48
+ checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
49
+ checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
50
+ checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
51
+ checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
52
+ checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
53
+ checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
54
+ checkRegionBy(selector: EyesSelector<Selector>, name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
55
+ checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResult>;
56
56
  check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
57
- check(checkSettings: CheckSettingsPlain): Promise<MatchResult>;
57
+ check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
58
58
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
59
59
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
60
60
  extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
61
- close(throwErr: boolean): Promise<TestResults>;
61
+ close(throwErr?: boolean): Promise<TestResults>;
62
62
  closeAsync(): Promise<void>;
63
63
  abort(): Promise<TestResults>;
64
64
  abortAsync(): Promise<void>;
@@ -86,7 +86,7 @@ export class Eyes {
86
86
  clearProperties(): Configuration;
87
87
  getBatch(): BatchInfo;
88
88
  setBatch(batch: BatchInfoPlain): void;
89
- setBatch(name: string, id: string, startedAt: string | Date): void;
89
+ setBatch(name: string, id?: string, startedAt?: string | Date): void;
90
90
  getApiKey(): string;
91
91
  setApiKey(apiKey: string): void;
92
92
  getTestName(): string;
@@ -122,7 +122,7 @@ export class Eyes {
122
122
  getParentBranchName(): string;
123
123
  setParentBranchName(parentBranchName: string): void;
124
124
  setProxy(proxy: ProxySettingsPlain): void;
125
- setProxy(url: string, username: string, password: string, isHttpOnly: boolean): void;
125
+ setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
126
126
  setProxy(isEnabled: false): void;
127
127
  getProxy(): ProxySettings;
128
128
  getSaveDiffs(): boolean;
@@ -205,7 +205,7 @@ export type ConfigurationPlain = {
205
205
  disableBrowserFetching?: boolean;
206
206
  };
207
207
  export class Configuration implements Required<ConfigurationPlain> {
208
- constructor(config: ConfigurationPlain);
208
+ constructor(config?: ConfigurationPlain);
209
209
  get logs(): LogHandlerPlain;
210
210
  set logs(logs: LogHandlerPlain);
211
211
  getShowLogs(): boolean;
@@ -264,7 +264,7 @@ export class Configuration implements Required<ConfigurationPlain> {
264
264
  set proxy(proxy: ProxySettingsPlain);
265
265
  getProxy(): ProxySettings;
266
266
  setProxy(proxy: ProxySettingsPlain): Configuration;
267
- setProxy(url: string, username: string, password: string, isHttpOnly: boolean): Configuration;
267
+ setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
268
268
  setProxy(isEnabled: false): Configuration;
269
269
  get connectionTimeout(): number;
270
270
  set connectionTimeout(connectionTimeout: number);
@@ -421,10 +421,10 @@ export class Configuration implements Required<ConfigurationPlain> {
421
421
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
422
422
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
423
423
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
424
- addBrowsers(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
424
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
425
425
  addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
426
- addBrowser(width: number, height: number, name: BrowserTypePlain): Configuration;
427
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation: ScreenOrientationPlain): Configuration;
426
+ addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
427
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
428
428
  get visualGridOptions(): { [key: string]: any; };
429
429
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
430
430
  getVisualGridOptions(): { [key: string]: any; };
@@ -478,23 +478,23 @@ export type CheckSettingsPlain = {
478
478
  waitBeforeCapture?: number;
479
479
  };
480
480
  export class CheckSettings {
481
- constructor(settings: CheckSettingsPlain);
481
+ constructor(settings?: CheckSettingsPlain);
482
482
  name(name: string): CheckSettings;
483
483
  withName(name: string): CheckSettings;
484
484
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
485
485
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
486
486
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
487
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
487
+ frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
488
488
  ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
489
- ignoreRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
489
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
490
490
  ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
491
- ignores(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
491
+ ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
492
492
  layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
493
- layoutRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
493
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
494
494
  strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
495
- strictRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
495
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
496
496
  contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
497
- contentRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
497
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
498
498
  floatingRegion(region: {
499
499
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
500
500
  maxUpOffset?: number;
@@ -502,15 +502,15 @@ export class CheckSettings {
502
502
  maxLeftOffset?: number;
503
503
  maxRightOffset?: number;
504
504
  }): CheckSettings;
505
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number): CheckSettings;
506
- floatingRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
505
+ floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettings;
506
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
507
507
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
508
508
  maxUpOffset?: number;
509
509
  maxDownOffset?: number;
510
510
  maxLeftOffset?: number;
511
511
  maxRightOffset?: number;
512
512
  }>): CheckSettings;
513
- floatingRegions(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
513
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
514
514
  floating(region: {
515
515
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
516
516
  maxUpOffset?: number;
@@ -519,33 +519,33 @@ export class CheckSettings {
519
519
  maxRightOffset?: number;
520
520
  }): CheckSettings;
521
521
  floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
522
- floatings(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
522
+ floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
523
523
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
524
524
  maxUpOffset?: number;
525
525
  maxDownOffset?: number;
526
526
  maxLeftOffset?: number;
527
527
  maxRightOffset?: number;
528
528
  }>): CheckSettings;
529
- floatings(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
529
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
530
530
  accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
531
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type: AccessibilityRegionTypePlain): CheckSettings;
532
- accessibilityRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings;
533
- accessibilityRegions(type: AccessibilityRegionTypePlain, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
531
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
532
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings;
533
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
534
534
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
535
- fully(fully: boolean): CheckSettings;
536
- stitchContent(stitchContent: boolean): CheckSettings;
535
+ fully(fully?: boolean): CheckSettings;
536
+ stitchContent(stitchContent?: boolean): CheckSettings;
537
537
  matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
538
538
  layout(): CheckSettings;
539
539
  exact(): CheckSettings;
540
540
  strict(): CheckSettings;
541
541
  content(): CheckSettings;
542
- useDom(useDom: boolean): CheckSettings;
543
- sendDom(sendDom: boolean): CheckSettings;
544
- enablePatterns(enablePatterns: boolean): CheckSettings;
545
- ignoreDisplacements(ignoreDisplacements: boolean): CheckSettings;
546
- ignoreCaret(ignoreCaret: boolean): CheckSettings;
542
+ useDom(useDom?: boolean): CheckSettings;
543
+ sendDom(sendDom?: boolean): CheckSettings;
544
+ enablePatterns(enablePatterns?: boolean): CheckSettings;
545
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettings;
546
+ ignoreCaret(ignoreCaret?: boolean): CheckSettings;
547
547
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
548
- layoutBreakpoints(layoutBreakpoints: boolean | Array<number>): CheckSettings;
548
+ layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
549
549
  hook(name: string, script: string): CheckSettings;
550
550
  beforeRenderScreenshotHook(script: string): CheckSettings;
551
551
  webHook(script: string): CheckSettings;
@@ -560,12 +560,12 @@ export const Target: {
560
560
  window(): CheckSettings;
561
561
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
562
562
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
563
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
563
+ frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
564
564
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
565
565
  };
566
566
  export class BatchClose {
567
567
  static close(settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }): Promise<void>;
568
- constructor(options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; });
568
+ constructor(options?: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; });
569
569
  close(): Promise<void>;
570
570
  setBatchIds(batchIds: Array<string>): BatchClose;
571
571
  setUrl(serverUrl: string): BatchClose;
@@ -753,24 +753,24 @@ export enum TestResultsStatus {
753
753
  export class EyesError extends Error {
754
754
  }
755
755
  export class TestFailedError extends EyesError {
756
- constructor(message: string, results: TestResultsPlain);
756
+ constructor(message: string, results?: TestResultsPlain);
757
757
  constructor(results: TestResultsPlain);
758
758
  get testResults(): TestResultsPlain;
759
759
  getTestResults(): TestResults;
760
760
  }
761
761
  export class DiffsFoundError extends TestFailedError {
762
- constructor(message: string, results: TestResultsPlain);
762
+ constructor(message: string, results?: TestResultsPlain);
763
763
  constructor(results: TestResultsPlain);
764
764
  }
765
765
  export class NewTestError extends TestFailedError {
766
- constructor(message: string, results: TestResultsPlain);
766
+ constructor(message: string, results?: TestResultsPlain);
767
767
  constructor(results: TestResultsPlain);
768
768
  }
769
769
  export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
770
770
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
771
771
  constructor(settings: AccessibilityMatchSettingsPlain);
772
772
  constructor(region: RegionPlain);
773
- constructor(x: number, y: number, width: number, height: number, type: AccessibilityRegionTypePlain);
773
+ constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
774
774
  get region(): RegionPlain;
775
775
  set region(region: RegionPlain);
776
776
  getRegion(): Region;
@@ -799,8 +799,8 @@ export type BatchInfoPlain = {
799
799
  };
800
800
  export class BatchInfo implements Required<BatchInfoPlain> {
801
801
  constructor();
802
- constructor(batch: BatchInfoPlain);
803
- constructor(name: string, startedAt: string | Date, id: string);
802
+ constructor(batch?: BatchInfoPlain);
803
+ constructor(name?: string, startedAt?: string | Date, id?: string);
804
804
  get id(): string;
805
805
  set id(id: string);
806
806
  getId(): string;
@@ -885,7 +885,7 @@ export type FloatingMatchSettingsPlain = {
885
885
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
886
886
  constructor(settings: FloatingMatchSettingsPlain);
887
887
  constructor(region: RegionPlain);
888
- constructor(x: number, y: number, width: number, height: number, maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number);
888
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
889
889
  get region(): RegionPlain;
890
890
  set region(region: RegionPlain);
891
891
  getRegion(): Region;
@@ -931,7 +931,7 @@ export type ImageMatchSettingsPlain = {
931
931
  accessibilitySettings?: AccessibilitySettings;
932
932
  };
933
933
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
934
- constructor(settings: ImageMatchSettingsPlain);
934
+ constructor(settings?: ImageMatchSettingsPlain);
935
935
  get exact(): ExactMatchSettingsPlain;
936
936
  set exact(exact: ExactMatchSettingsPlain);
937
937
  getExact(): ExactMatchSettings;
@@ -1028,7 +1028,7 @@ export type CustomLogHandlerPlain = {
1028
1028
  export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1029
1029
  export type ConsoleLogHandlerPlain = { type: "console"; };
1030
1030
  export abstract class LogHandler implements CustomLogHandlerPlain {
1031
- constructor(verbose: boolean);
1031
+ constructor(verbose?: boolean);
1032
1032
  get verbose(): boolean;
1033
1033
  set verbose(verbose: boolean);
1034
1034
  getIsVerbose(): boolean;
@@ -1039,7 +1039,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1039
1039
  abstract close(): void;
1040
1040
  }
1041
1041
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1042
- constructor(verbose: boolean, filename: string, append: boolean);
1042
+ constructor(verbose?: boolean, filename?: string, append?: boolean);
1043
1043
  readonly type: "file";
1044
1044
  readonly filename: string;
1045
1045
  readonly append: boolean;
@@ -1075,7 +1075,7 @@ export class PropertyData implements Required<PropertyDataPlain> {
1075
1075
  export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1076
1076
  export class ProxySettings implements Required<ProxySettingsPlain> {
1077
1077
  constructor(proxy: ProxySettingsPlain);
1078
- constructor(url: string, username: string, password: string, isHttpOnly: boolean);
1078
+ constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1079
1079
  get url(): string;
1080
1080
  getUri(): string;
1081
1081
  getUrl(): string;
@@ -1383,29 +1383,29 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1383
1383
  }
1384
1384
  export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1385
1385
  export class Logger {
1386
- constructor(options: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1387
- constructor(show: boolean);
1386
+ constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1387
+ constructor(show?: boolean);
1388
1388
  getLogHandler(): LogHandler;
1389
1389
  setLogHandler(handler: LogHandlerPlain): void;
1390
- verbose(messages: Array<any>): void;
1391
- log(messages: Array<any>): void;
1392
- warn(messages: Array<any>): void;
1393
- error(messages: Array<any>): void;
1394
- fatal(messages: Array<any>): void;
1390
+ verbose(...messages: Array<any>): void;
1391
+ log(...messages: Array<any>): void;
1392
+ warn(...messages: Array<any>): void;
1393
+ error(...messages: Array<any>): void;
1394
+ fatal(...messages: Array<any>): void;
1395
1395
  open(): void;
1396
1396
  close(): void;
1397
- extend(label: string, color: string | Array<string>): Logger;
1397
+ extend(label?: string, color?: string | Array<string>): Logger;
1398
1398
  }
1399
1399
  export function closeBatch(spec: { closeBatches(options: { settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }; }): Promise<void>; }): (options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
1400
1400
  export abstract class EyesRunner {
1401
- getAllTestResults(throwErr: boolean): Promise<TestResultsSummary>;
1401
+ getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1402
1402
  }
1403
1403
  export class ClassicRunner extends EyesRunner {
1404
1404
  }
1405
1405
  export class VisualGridRunner extends EyesRunner {
1406
- constructor(options: RunnerOptionsPlain);
1407
- constructor(options: RunnerOptionsFluent);
1408
- constructor(legacyConcurrency: number);
1406
+ constructor(options?: RunnerOptionsPlain);
1407
+ constructor(options?: RunnerOptionsFluent);
1408
+ constructor(legacyConcurrency?: number);
1409
1409
  get testConcurrency(): number;
1410
1410
  get legacyConcurrency(): number;
1411
1411
  getConcurrentSessions(): number;
@@ -1435,7 +1435,7 @@ export class SessionEventHandlers extends SessionEventHandler {
1435
1435
  }
1436
1436
  export class RemoteSessionEventHandler extends SessionEventHandler {
1437
1437
  constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1438
- constructor(serverUrl: string, accessKey: string, timeout: number);
1438
+ constructor(serverUrl: string, accessKey?: string, timeout?: number);
1439
1439
  get serverUrl(): string;
1440
1440
  set serverUrl(serverUrl: string);
1441
1441
  getServerUrl(): string;