@applitools/eyes-selenium 4.58.0 → 4.58.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 (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/package.json +6 -6
  3. package/types/index.d.ts +72 -72
package/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@
3
3
  ## Unreleased
4
4
 
5
5
 
6
+ ## 4.58.1 - 2021/11/18
7
+
8
+ - updated to @applitools/eyes-sdk-core@12.24.2 (from 12.24.0)
9
+ - updated to @applitools/spec-driver-selenium@1.3.0 (from 1.2.0)
10
+ - updated to @applitools/visual-grid-client@15.8.47 (from 15.8.44)
11
+
6
12
  ## 4.58.0 - 2021/11/10
7
13
 
8
14
  - support cookies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-selenium",
3
- "version": "4.58.0",
3
+ "version": "4.58.1",
4
4
  "description": "Applitools Eyes SDK for Selenium WebDriver",
5
5
  "keywords": [
6
6
  "eyes-selenium",
@@ -66,16 +66,16 @@
66
66
  },
67
67
  "dependencies": {
68
68
  "@applitools/eyes-api": "1.1.6",
69
- "@applitools/eyes-sdk-core": "12.24.0",
70
- "@applitools/spec-driver-selenium": "1.2.0",
71
- "@applitools/visual-grid-client": "15.8.44"
69
+ "@applitools/eyes-sdk-core": "12.24.2",
70
+ "@applitools/spec-driver-selenium": "1.3.0",
71
+ "@applitools/visual-grid-client": "15.8.47"
72
72
  },
73
73
  "devDependencies": {
74
- "@applitools/api-extractor": "1.2.2",
74
+ "@applitools/api-extractor": "1.2.3",
75
75
  "@applitools/scripts": "1.0.1",
76
76
  "@applitools/sdk-coverage-tests": "2.3.16",
77
77
  "@applitools/sdk-release-kit": "0.13.4",
78
- "@applitools/sdk-shared": "0.9.8",
78
+ "@applitools/sdk-shared": "0.9.9",
79
79
  "@applitools/test-utils": "1.0.9",
80
80
  "@types/selenium-webdriver": "^4.0.11",
81
81
  "@typescript-eslint/eslint-plugin": "^4.15.1",
package/types/index.d.ts CHANGED
@@ -3,8 +3,8 @@ export type Element = import('selenium-webdriver').WebElement & { __applitoolsBr
3
3
  export type Selector = (import('selenium-webdriver').Locator | { using: string; value: string; }) & { __applitoolsBrand?: never; };
4
4
  export class Eyes {
5
5
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
6
- constructor(runner: EyesRunner, config: ConfigurationPlain);
7
- constructor(config: ConfigurationPlain);
6
+ constructor(runner?: EyesRunner, config?: ConfigurationPlain);
7
+ constructor(config?: ConfigurationPlain);
8
8
  get logger(): Logger;
9
9
  getLogger(): Logger;
10
10
  get runner(): EyesRunner;
@@ -17,7 +17,7 @@ export class Eyes {
17
17
  setConfiguration(config: ConfigurationPlain): void;
18
18
  get isOpen(): boolean;
19
19
  getIsOpen(): boolean;
20
- on(handler: (event: string, data: Record<string, any>) => any): () => void;
20
+ on(handler: (event: string, data?: Record<string, any>) => any): () => void;
21
21
  on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
22
22
  on(event: "setSizeEnded", handler: () => any): () => void;
23
23
  on(event: "initStarted", handler: () => any): () => void;
@@ -27,23 +27,23 @@ export class Eyes {
27
27
  on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
28
28
  on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
29
29
  off(event: string): void;
30
- off(handler: (args: Array<any>) => any): void;
31
- open(driver: Driver, config: ConfigurationPlain): Promise<Driver>;
32
- open(driver: Driver, appName: string, testName: string, viewportSize: RectangleSizePlain, sessionType: SessionTypePlain): Promise<Driver>;
33
- checkWindow(name: string, timeout: number, fully: boolean): Promise<MatchResult>;
34
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
35
- checkElement(element: Element, timeout: number, name: string): Promise<MatchResult>;
36
- checkElementBy(selector: EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
37
- checkRegion(region: RegionPlain, name: string, timeout: number): Promise<MatchResult>;
38
- checkRegionByElement(element: Element, name: string, timeout: number): Promise<MatchResult>;
39
- checkRegionBy(selector: EyesSelector<Selector>, name: string, timeout: number, fully: boolean): Promise<MatchResult>;
40
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout: number, name: string, fully: boolean): Promise<MatchResult>;
30
+ off(handler: (...args: Array<any>) => any): void;
31
+ open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
32
+ open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
33
+ checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
34
+ checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
35
+ checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
36
+ checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
37
+ checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
38
+ checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
39
+ checkRegionBy(selector: EyesSelector<Selector>, name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
40
+ checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResult>;
41
41
  check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
42
- check(checkSettings: CheckSettingsPlain): Promise<MatchResult>;
42
+ check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
43
43
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
44
44
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
45
45
  extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
46
- close(throwErr: boolean): Promise<TestResults>;
46
+ close(throwErr?: boolean): Promise<TestResults>;
47
47
  closeAsync(): Promise<void>;
48
48
  abort(): Promise<TestResults>;
49
49
  abortAsync(): Promise<void>;
@@ -71,7 +71,7 @@ export class Eyes {
71
71
  clearProperties(): Configuration;
72
72
  getBatch(): BatchInfo;
73
73
  setBatch(batch: BatchInfoPlain): void;
74
- setBatch(name: string, id: string, startedAt: string | Date): void;
74
+ setBatch(name: string, id?: string, startedAt?: string | Date): void;
75
75
  getApiKey(): string;
76
76
  setApiKey(apiKey: string): void;
77
77
  getTestName(): string;
@@ -107,7 +107,7 @@ export class Eyes {
107
107
  getParentBranchName(): string;
108
108
  setParentBranchName(parentBranchName: string): void;
109
109
  setProxy(proxy: ProxySettingsPlain): void;
110
- setProxy(url: string, username: string, password: string, isHttpOnly: boolean): void;
110
+ setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
111
111
  setProxy(isEnabled: false): void;
112
112
  getProxy(): ProxySettings;
113
113
  getSaveDiffs(): boolean;
@@ -190,7 +190,7 @@ export type ConfigurationPlain = {
190
190
  disableBrowserFetching?: boolean;
191
191
  };
192
192
  export class Configuration implements Required<ConfigurationPlain> {
193
- constructor(config: ConfigurationPlain);
193
+ constructor(config?: ConfigurationPlain);
194
194
  get logs(): LogHandlerPlain;
195
195
  set logs(logs: LogHandlerPlain);
196
196
  getShowLogs(): boolean;
@@ -249,7 +249,7 @@ export class Configuration implements Required<ConfigurationPlain> {
249
249
  set proxy(proxy: ProxySettingsPlain);
250
250
  getProxy(): ProxySettings;
251
251
  setProxy(proxy: ProxySettingsPlain): Configuration;
252
- setProxy(url: string, username: string, password: string, isHttpOnly: boolean): Configuration;
252
+ setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
253
253
  setProxy(isEnabled: false): Configuration;
254
254
  get connectionTimeout(): number;
255
255
  set connectionTimeout(connectionTimeout: number);
@@ -406,10 +406,10 @@ export class Configuration implements Required<ConfigurationPlain> {
406
406
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
407
407
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
408
408
  setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
409
- addBrowsers(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
409
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
410
410
  addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
411
- addBrowser(width: number, height: number, name: BrowserTypePlain): Configuration;
412
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation: ScreenOrientationPlain): Configuration;
411
+ addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
412
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
413
413
  get visualGridOptions(): { [key: string]: any; };
414
414
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
415
415
  getVisualGridOptions(): { [key: string]: any; };
@@ -463,23 +463,23 @@ export type CheckSettingsPlain = {
463
463
  waitBeforeCapture?: number;
464
464
  };
465
465
  export class CheckSettings {
466
- constructor(settings: CheckSettingsPlain);
466
+ constructor(settings?: CheckSettingsPlain);
467
467
  name(name: string): CheckSettings;
468
468
  withName(name: string): CheckSettings;
469
469
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
470
470
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
471
471
  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;
472
- 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;
472
+ 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;
473
473
  ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
474
- ignoreRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
474
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
475
475
  ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
476
- ignores(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
476
+ ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
477
477
  layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
478
- layoutRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
478
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
479
479
  strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
480
- strictRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
480
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
481
481
  contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
482
- contentRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
482
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
483
483
  floatingRegion(region: {
484
484
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
485
485
  maxUpOffset?: number;
@@ -487,15 +487,15 @@ export class CheckSettings {
487
487
  maxLeftOffset?: number;
488
488
  maxRightOffset?: number;
489
489
  }): CheckSettings;
490
- 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;
491
- floatingRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
490
+ 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;
491
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
492
492
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
493
493
  maxUpOffset?: number;
494
494
  maxDownOffset?: number;
495
495
  maxLeftOffset?: number;
496
496
  maxRightOffset?: number;
497
497
  }>): CheckSettings;
498
- floatingRegions(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
498
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
499
499
  floating(region: {
500
500
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
501
501
  maxUpOffset?: number;
@@ -504,33 +504,33 @@ export class CheckSettings {
504
504
  maxRightOffset?: number;
505
505
  }): CheckSettings;
506
506
  floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
507
- floatings(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
507
+ floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
508
508
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
509
509
  maxUpOffset?: number;
510
510
  maxDownOffset?: number;
511
511
  maxLeftOffset?: number;
512
512
  maxRightOffset?: number;
513
513
  }>): CheckSettings;
514
- floatings(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
514
+ floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
515
515
  accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
516
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type: AccessibilityRegionTypePlain): CheckSettings;
517
- 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;
518
- accessibilityRegions(type: AccessibilityRegionTypePlain, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
516
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
517
+ 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;
518
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
519
519
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
520
- fully(fully: boolean): CheckSettings;
521
- stitchContent(stitchContent: boolean): CheckSettings;
520
+ fully(fully?: boolean): CheckSettings;
521
+ stitchContent(stitchContent?: boolean): CheckSettings;
522
522
  matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
523
523
  layout(): CheckSettings;
524
524
  exact(): CheckSettings;
525
525
  strict(): CheckSettings;
526
526
  content(): CheckSettings;
527
- useDom(useDom: boolean): CheckSettings;
528
- sendDom(sendDom: boolean): CheckSettings;
529
- enablePatterns(enablePatterns: boolean): CheckSettings;
530
- ignoreDisplacements(ignoreDisplacements: boolean): CheckSettings;
531
- ignoreCaret(ignoreCaret: boolean): CheckSettings;
527
+ useDom(useDom?: boolean): CheckSettings;
528
+ sendDom(sendDom?: boolean): CheckSettings;
529
+ enablePatterns(enablePatterns?: boolean): CheckSettings;
530
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettings;
531
+ ignoreCaret(ignoreCaret?: boolean): CheckSettings;
532
532
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
533
- layoutBreakpoints(layoutBreakpoints: boolean | Array<number>): CheckSettings;
533
+ layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
534
534
  hook(name: string, script: string): CheckSettings;
535
535
  beforeRenderScreenshotHook(script: string): CheckSettings;
536
536
  webHook(script: string): CheckSettings;
@@ -545,12 +545,12 @@ export const Target: {
545
545
  window(): CheckSettings;
546
546
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
547
547
  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;
548
- 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;
548
+ 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;
549
549
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
550
550
  };
551
551
  export class BatchClose {
552
552
  static close(settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }): Promise<void>;
553
- constructor(options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; });
553
+ constructor(options?: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; });
554
554
  close(): Promise<void>;
555
555
  setBatchIds(batchIds: Array<string>): BatchClose;
556
556
  setUrl(serverUrl: string): BatchClose;
@@ -738,24 +738,24 @@ export enum TestResultsStatus {
738
738
  export class EyesError extends Error {
739
739
  }
740
740
  export class TestFailedError extends EyesError {
741
- constructor(message: string, results: TestResultsPlain);
741
+ constructor(message: string, results?: TestResultsPlain);
742
742
  constructor(results: TestResultsPlain);
743
743
  get testResults(): TestResultsPlain;
744
744
  getTestResults(): TestResults;
745
745
  }
746
746
  export class DiffsFoundError extends TestFailedError {
747
- constructor(message: string, results: TestResultsPlain);
747
+ constructor(message: string, results?: TestResultsPlain);
748
748
  constructor(results: TestResultsPlain);
749
749
  }
750
750
  export class NewTestError extends TestFailedError {
751
- constructor(message: string, results: TestResultsPlain);
751
+ constructor(message: string, results?: TestResultsPlain);
752
752
  constructor(results: TestResultsPlain);
753
753
  }
754
754
  export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
755
755
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
756
756
  constructor(settings: AccessibilityMatchSettingsPlain);
757
757
  constructor(region: RegionPlain);
758
- constructor(x: number, y: number, width: number, height: number, type: AccessibilityRegionTypePlain);
758
+ constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
759
759
  get region(): RegionPlain;
760
760
  set region(region: RegionPlain);
761
761
  getRegion(): Region;
@@ -784,8 +784,8 @@ export type BatchInfoPlain = {
784
784
  };
785
785
  export class BatchInfo implements Required<BatchInfoPlain> {
786
786
  constructor();
787
- constructor(batch: BatchInfoPlain);
788
- constructor(name: string, startedAt: string | Date, id: string);
787
+ constructor(batch?: BatchInfoPlain);
788
+ constructor(name?: string, startedAt?: string | Date, id?: string);
789
789
  get id(): string;
790
790
  set id(id: string);
791
791
  getId(): string;
@@ -870,7 +870,7 @@ export type FloatingMatchSettingsPlain = {
870
870
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
871
871
  constructor(settings: FloatingMatchSettingsPlain);
872
872
  constructor(region: RegionPlain);
873
- constructor(x: number, y: number, width: number, height: number, maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number);
873
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
874
874
  get region(): RegionPlain;
875
875
  set region(region: RegionPlain);
876
876
  getRegion(): Region;
@@ -916,7 +916,7 @@ export type ImageMatchSettingsPlain = {
916
916
  accessibilitySettings?: AccessibilitySettings;
917
917
  };
918
918
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
919
- constructor(settings: ImageMatchSettingsPlain);
919
+ constructor(settings?: ImageMatchSettingsPlain);
920
920
  get exact(): ExactMatchSettingsPlain;
921
921
  set exact(exact: ExactMatchSettingsPlain);
922
922
  getExact(): ExactMatchSettings;
@@ -1013,7 +1013,7 @@ export type CustomLogHandlerPlain = {
1013
1013
  export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1014
1014
  export type ConsoleLogHandlerPlain = { type: "console"; };
1015
1015
  export abstract class LogHandler implements CustomLogHandlerPlain {
1016
- constructor(verbose: boolean);
1016
+ constructor(verbose?: boolean);
1017
1017
  get verbose(): boolean;
1018
1018
  set verbose(verbose: boolean);
1019
1019
  getIsVerbose(): boolean;
@@ -1024,7 +1024,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1024
1024
  abstract close(): void;
1025
1025
  }
1026
1026
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1027
- constructor(verbose: boolean, filename: string, append: boolean);
1027
+ constructor(verbose?: boolean, filename?: string, append?: boolean);
1028
1028
  readonly type: "file";
1029
1029
  readonly filename: string;
1030
1030
  readonly append: boolean;
@@ -1060,7 +1060,7 @@ export class PropertyData implements Required<PropertyDataPlain> {
1060
1060
  export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1061
1061
  export class ProxySettings implements Required<ProxySettingsPlain> {
1062
1062
  constructor(proxy: ProxySettingsPlain);
1063
- constructor(url: string, username: string, password: string, isHttpOnly: boolean);
1063
+ constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1064
1064
  get url(): string;
1065
1065
  getUri(): string;
1066
1066
  getUrl(): string;
@@ -1368,29 +1368,29 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1368
1368
  }
1369
1369
  export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1370
1370
  export class Logger {
1371
- constructor(options: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1372
- constructor(show: boolean);
1371
+ constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1372
+ constructor(show?: boolean);
1373
1373
  getLogHandler(): LogHandler;
1374
1374
  setLogHandler(handler: LogHandlerPlain): void;
1375
- verbose(messages: Array<any>): void;
1376
- log(messages: Array<any>): void;
1377
- warn(messages: Array<any>): void;
1378
- error(messages: Array<any>): void;
1379
- fatal(messages: Array<any>): void;
1375
+ verbose(...messages: Array<any>): void;
1376
+ log(...messages: Array<any>): void;
1377
+ warn(...messages: Array<any>): void;
1378
+ error(...messages: Array<any>): void;
1379
+ fatal(...messages: Array<any>): void;
1380
1380
  open(): void;
1381
1381
  close(): void;
1382
- extend(label: string, color: string | Array<string>): Logger;
1382
+ extend(label?: string, color?: string | Array<string>): Logger;
1383
1383
  }
1384
1384
  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>;
1385
1385
  export abstract class EyesRunner {
1386
- getAllTestResults(throwErr: boolean): Promise<TestResultsSummary>;
1386
+ getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1387
1387
  }
1388
1388
  export class ClassicRunner extends EyesRunner {
1389
1389
  }
1390
1390
  export class VisualGridRunner extends EyesRunner {
1391
- constructor(options: RunnerOptionsPlain);
1392
- constructor(options: RunnerOptionsFluent);
1393
- constructor(legacyConcurrency: number);
1391
+ constructor(options?: RunnerOptionsPlain);
1392
+ constructor(options?: RunnerOptionsFluent);
1393
+ constructor(legacyConcurrency?: number);
1394
1394
  get testConcurrency(): number;
1395
1395
  get legacyConcurrency(): number;
1396
1396
  getConcurrentSessions(): number;
@@ -1420,7 +1420,7 @@ export class SessionEventHandlers extends SessionEventHandler {
1420
1420
  }
1421
1421
  export class RemoteSessionEventHandler extends SessionEventHandler {
1422
1422
  constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1423
- constructor(serverUrl: string, accessKey: string, timeout: number);
1423
+ constructor(serverUrl: string, accessKey?: string, timeout?: number);
1424
1424
  get serverUrl(): string;
1425
1425
  set serverUrl(serverUrl: string);
1426
1426
  getServerUrl(): string;