@applitools/eyes-playwright 1.30.2 → 1.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CHANGELOG.md +89 -0
  2. package/README.md +2 -2
  3. package/dist/fixture/cli.js +1 -1
  4. package/dist/fixture/defaults/eyesConfiguration.js +3 -4
  5. package/dist/fixture/getEyes.js +7 -1
  6. package/dist/fixture/images/link.svg +0 -1
  7. package/dist/fixture/index.js +7 -3
  8. package/dist/fixture/reportRenderer.js +344 -60
  9. package/dist/fixture/reporterStyle.css +17 -4
  10. package/package.json +5 -5
  11. package/types/index.d.ts +284 -261
package/types/index.d.ts CHANGED
@@ -455,100 +455,75 @@ export type Target = TargetImage & TargetAutomation;
455
455
  export const Target: TargetImage & TargetAutomation;
456
456
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
457
457
  export type ConfigurationPlain = {
458
- debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
458
+ accessibilityValidation?: undefined | AccessibilitySettings;
459
459
  agentId?: undefined | string;
460
460
  apiKey?: undefined | string;
461
- serverUrl?: undefined | string;
462
- proxy?: undefined | ProxySettingsPlain;
463
- autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
464
- isDisabled?: undefined | boolean;
465
- connectionTimeout?: undefined | number;
466
- removeSession?: undefined | boolean;
467
461
  appName?: undefined | string;
468
- testName?: undefined | string;
469
- displayName?: undefined | string;
470
- viewportSize?: undefined | RectangleSizePlain;
471
- sessionType?: undefined | SessionTypePlain;
472
- properties?: undefined | Array<PropertyDataPlain>;
462
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
463
+ baselineBranchName?: undefined | string;
464
+ baselineEnvName?: undefined | string;
473
465
  batch?: undefined | BatchInfoPlain;
466
+ branchName?: undefined | string;
467
+ browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
468
+ captureStatusBar?: undefined | boolean;
469
+ compareWithParentBranch?: undefined | boolean;
470
+ concurrentSessions?: undefined | number;
471
+ connectionTimeout?: undefined | number;
472
+ cut?: undefined | CutProviderPlain;
473
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
474
474
  defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
475
- hostApp?: undefined | string;
476
- hostOS?: undefined | string;
477
- hostAppInfo?: undefined | string;
478
- hostOSInfo?: undefined | string;
479
475
  deviceInfo?: undefined | string;
480
- baselineEnvName?: undefined | string;
476
+ disableBrowserFetching?: undefined | boolean;
477
+ disableNMLUrlCache?: undefined | boolean;
478
+ displayName?: undefined | string;
479
+ dontCloseBatches?: undefined | boolean;
480
+ enablePatterns?: undefined | boolean;
481
481
  environmentName?: undefined | string;
482
- branchName?: undefined | string;
483
- parentBranchName?: undefined | string;
482
+ forceFullPageScreenshot?: undefined | boolean;
484
483
  gitMergeBaseTimestamp?: undefined | string;
485
- baselineBranchName?: undefined | string;
486
- compareWithParentBranch?: undefined | boolean;
484
+ hideCaret?: undefined | boolean;
485
+ hideScrollbars?: undefined | boolean;
486
+ hostApp?: undefined | string;
487
+ hostAppInfo?: undefined | string;
488
+ hostOS?: undefined | string;
489
+ hostOSInfo?: undefined | string;
487
490
  ignoreBaseline?: undefined | boolean;
491
+ ignoreCaret?: undefined | boolean;
492
+ ignoreDisplacements?: undefined | boolean;
488
493
  ignoreGitMergeBase?: undefined | boolean;
494
+ isDisabled?: undefined | boolean;
495
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
496
+ matchLevel?: undefined | MatchLevelPlain;
497
+ matchTimeout?: undefined | number;
498
+ mobileOptions?: undefined | { keepNavigationBar?: undefined | boolean; };
499
+ parentBranchName?: undefined | string;
500
+ properties?: undefined | Array<PropertyDataPlain>;
501
+ proxy?: undefined | ProxySettingsPlain;
502
+ removeSession?: undefined | boolean;
503
+ rotation?: undefined | ImageRotationPlain;
504
+ saveDiffs?: undefined | boolean;
489
505
  saveFailedTests?: undefined | boolean;
490
506
  saveNewTests?: undefined | boolean;
491
- saveDiffs?: undefined | boolean;
492
- dontCloseBatches?: undefined | boolean;
507
+ scaleRatio?: undefined | number;
508
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
493
509
  sendDom?: undefined | boolean;
494
- matchTimeout?: undefined | number;
495
- forceFullPageScreenshot?: undefined | boolean;
496
- waitBeforeScreenshots?: undefined | number;
510
+ serverUrl?: undefined | string;
511
+ sessionType?: undefined | SessionTypePlain;
497
512
  stitchMode?: undefined | StitchModePlain;
498
- hideScrollbars?: undefined | boolean;
499
- hideCaret?: undefined | boolean;
500
513
  stitchOverlap?: undefined | number;
501
- scrollRootElement?: undefined | Element | EyesSelector<Selector>;
502
- cut?: undefined | CutProviderPlain;
503
- rotation?: undefined | ImageRotationPlain;
504
- scaleRatio?: undefined | number;
505
- concurrentSessions?: undefined | number;
506
- browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
514
+ testName?: undefined | string;
515
+ useDom?: undefined | boolean;
516
+ viewportSize?: undefined | RectangleSizePlain;
507
517
  visualGridOptions?: undefined | Record<string, any>;
508
- layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
509
- disableBrowserFetching?: undefined | boolean;
510
518
  waitBeforeCapture?: undefined | number;
511
- disableNMLUrlCache?: undefined | boolean;
512
- captureStatusBar?: undefined | boolean;
519
+ waitBeforeScreenshots?: undefined | number;
513
520
  };
514
521
  export class Configuration implements Required<ConfigurationPlain> {
515
522
  constructor(config?: undefined | ConfigurationPlain);
516
- get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
517
- set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
518
- getSaveDebugScreenshots(): boolean;
519
- setSaveDebugScreenshots(save: boolean): Configuration;
520
- getDebugScreenshotsPath(): string;
521
- setDebugScreenshotsPath(path: string): Configuration;
522
- getDebugScreenshotsPrefix(): string;
523
- setDebugScreenshotsPrefix(prefix: string): Configuration;
524
- get appName(): string;
525
- set appName(appName: string);
526
- getAppName(): string;
527
- setAppName(appName: string): Configuration;
528
- get testName(): string;
529
- set testName(testName: string);
530
- getTestName(): string;
531
- setTestName(testName: string): Configuration;
532
- get displayName(): string;
533
- set displayName(displayName: string);
534
- getDisplayName(): string;
535
- setDisplayName(displayName: string): Configuration;
536
- get isDisabled(): boolean;
537
- set isDisabled(isDisabled: boolean);
538
- getIsDisabled(): boolean;
539
- setIsDisabled(isDisabled: boolean): Configuration;
540
- get matchTimeout(): number;
541
- set matchTimeout(matchTimeout: number);
542
- getMatchTimeout(): number;
543
- setMatchTimeout(matchTimeout: number): Configuration;
544
- get sessionType(): SessionTypePlain;
545
- set sessionType(sessionType: SessionTypePlain);
546
- getSessionType(): SessionType;
547
- setSessionType(sessionType: SessionTypePlain): Configuration;
548
- get viewportSize(): RectangleSizePlain;
549
- set viewportSize(viewportSize: RectangleSizePlain);
550
- getViewportSize(): RectangleSize;
551
- setViewportSize(viewportSize: RectangleSizePlain): Configuration;
523
+ get accessibilityValidation(): AccessibilitySettings;
524
+ set accessibilityValidation(accessibilityValidation: AccessibilitySettings);
525
+ getAccessibilityValidation(): AccessibilitySettings;
526
+ setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
552
527
  get agentId(): string;
553
528
  set agentId(agentId: string);
554
529
  getAgentId(): string;
@@ -557,237 +532,285 @@ export class Configuration implements Required<ConfigurationPlain> {
557
532
  set apiKey(apiKey: string);
558
533
  getApiKey(): string;
559
534
  setApiKey(apiKey: string): Configuration;
560
- get serverUrl(): string;
561
- set serverUrl(serverUrl: string);
562
- getServerUrl(): string;
563
- setServerUrl(serverUrl: string): Configuration;
564
- get proxy(): ProxySettingsPlain;
565
- set proxy(proxy: ProxySettingsPlain);
566
- getProxy(): ProxySettings;
567
- setProxy(proxy: ProxySettingsPlain): Configuration;
568
- setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
569
- setProxy(isEnabled: false): Configuration;
535
+ get appName(): string;
536
+ set appName(appName: string);
537
+ getAppName(): string;
538
+ setAppName(appName: string): Configuration;
570
539
  get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
571
540
  set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
572
541
  getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
573
542
  setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
574
- get connectionTimeout(): number;
575
- set connectionTimeout(connectionTimeout: number);
576
- getConnectionTimeout(): number;
577
- setConnectionTimeout(connectionTimeout: number): Configuration;
578
- get removeSession(): boolean;
579
- set removeSession(removeSession: boolean);
580
- getRemoveSession(): boolean;
581
- setRemoveSession(removeSession: boolean): Configuration;
582
- get batch(): BatchInfoPlain;
583
- set batch(batch: BatchInfoPlain);
584
- getBatch(): BatchInfo;
585
- setBatch(batch: BatchInfoPlain): Configuration;
586
- get properties(): Array<PropertyDataPlain>;
587
- set properties(properties: Array<PropertyDataPlain>);
588
- getProperties(): Array<PropertyData>;
589
- setProperties(properties: Array<PropertyDataPlain>): Configuration;
590
- addProperty(name: string, value: string): Configuration;
591
- addProperty(prop: PropertyDataPlain): Configuration;
592
- clearProperties(): Configuration;
543
+ get baselineBranchName(): string;
544
+ set baselineBranchName(baselineBranchName: string);
545
+ getBaselineBranchName(): string;
546
+ setBaselineBranchName(baselineBranchName: string): Configuration;
593
547
  get baselineEnvName(): string;
594
548
  set baselineEnvName(baselineEnvName: string);
595
549
  getBaselineEnvName(): string;
596
550
  setBaselineEnvName(baselineEnvName: string): Configuration;
597
- get environmentName(): string;
598
- set environmentName(environmentName: string);
599
- getEnvironmentName(): string;
600
- setEnvironmentName(environmentName: string): Configuration;
551
+ get batch(): BatchInfoPlain;
552
+ set batch(batch: BatchInfoPlain);
553
+ getBatch(): BatchInfo;
554
+ setBatch(batch: BatchInfoPlain): Configuration;
601
555
  get branchName(): string;
602
556
  set branchName(branchName: string);
603
557
  getBranchName(): string;
604
558
  setBranchName(branchName: string): Configuration;
605
- get parentBranchName(): string;
606
- set parentBranchName(parentBranchName: string);
607
- getParentBranchName(): string;
608
- setParentBranchName(parentBranchName: string): Configuration;
609
- get baselineBranchName(): string;
610
- set baselineBranchName(baselineBranchName: string);
611
- getBaselineBranchName(): string;
612
- setBaselineBranchName(baselineBranchName: string): Configuration;
613
- get gitMergeBaseTimestamp(): string;
614
- set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
615
- getGitMergeBaseTimestamp(): string;
616
- setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
559
+ get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
560
+ set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>);
561
+ getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
562
+ setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
563
+ addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
564
+ addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
565
+ addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
566
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
567
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
568
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
569
+ addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
570
+ addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
571
+ addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
572
+ addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
573
+ addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
574
+ addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
575
+ addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
576
+ addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
577
+ addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
578
+ addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
579
+ addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
580
+ addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
581
+ addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
582
+ addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
583
+ addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
584
+ addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
585
+ addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
586
+ addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
587
+ addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
588
+ addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
589
+ addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
590
+ addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
591
+ addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
592
+ get captureStatusBar(): boolean;
593
+ set captureStatusBar(captureStatusBar: boolean);
594
+ getCaptureStatusBar(): boolean;
595
+ setCaptureStatusBar(captureStatusBar: boolean): Configuration;
617
596
  get compareWithParentBranch(): boolean;
618
597
  set compareWithParentBranch(compareWithParentBranch: boolean);
619
598
  getCompareWithParentBranch(): boolean;
620
599
  setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
621
- get ignoreGitMergeBase(): boolean;
622
- set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
623
- getIgnoreGitMergeBase(): boolean;
624
- setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
625
- get ignoreBaseline(): boolean;
626
- set ignoreBaseline(ignoreBaseline: boolean);
627
- getIgnoreBaseline(): boolean;
628
- setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
629
- get saveFailedTests(): boolean;
630
- set saveFailedTests(saveFailedTests: boolean);
631
- getSaveFailedTests(): boolean;
632
- setSaveFailedTests(saveFailedTests: boolean): Configuration;
633
- get saveNewTests(): boolean;
634
- set saveNewTests(saveNewTests: boolean);
635
- getSaveNewTests(): boolean;
636
- setSaveNewTests(saveNewTests: boolean): Configuration;
637
- get saveDiffs(): boolean;
638
- set saveDiffs(saveDiffs: boolean);
639
- getSaveDiffs(): boolean;
640
- setSaveDiffs(saveDiffs: boolean): Configuration;
641
- get sendDom(): boolean;
642
- set sendDom(sendDom: boolean);
643
- getSendDom(): boolean;
644
- setSendDom(sendDom: boolean): Configuration;
645
- get hostApp(): string;
646
- set hostApp(hostApp: string);
647
- getHostApp(): string;
648
- setHostApp(hostApp: string): Configuration;
649
- get hostOS(): string;
650
- set hostOS(hostOS: string);
651
- getHostOS(): string;
652
- setHostOS(hostOS: string): Configuration;
653
- get hostAppInfo(): string;
654
- set hostAppInfo(hostAppInfo: string);
655
- getHostAppInfo(): string;
656
- setHostAppInfo(hostAppInfo: string): Configuration;
657
- get hostOSInfo(): string;
658
- set hostOSInfo(hostOSInfo: string);
659
- getHostOSInfo(): string;
660
- setHostOSInfo(hostOSInfo: string): Configuration;
661
- get deviceInfo(): string;
662
- set deviceInfo(deviceInfo: string);
663
- getDeviceInfo(): string;
664
- setDeviceInfo(deviceInfo: string): Configuration;
600
+ get concurrentSessions(): number;
601
+ set concurrentSessions(concurrentSessions: number);
602
+ getConcurrentSessions(): number;
603
+ setConcurrentSessions(concurrentSessions: number): Configuration;
604
+ get connectionTimeout(): number;
605
+ set connectionTimeout(connectionTimeout: number);
606
+ getConnectionTimeout(): number;
607
+ setConnectionTimeout(connectionTimeout: number): Configuration;
608
+ get cut(): CutProviderPlain;
609
+ set cut(cut: CutProviderPlain);
610
+ getCut(): CutProviderPlain;
611
+ setCut(cut: CutProviderPlain): Configuration;
612
+ get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
613
+ set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
614
+ getSaveDebugScreenshots(): boolean;
615
+ setSaveDebugScreenshots(save: boolean): Configuration;
616
+ getDebugScreenshotsPath(): string;
617
+ setDebugScreenshotsPath(path: string): Configuration;
618
+ getDebugScreenshotsPrefix(): string;
619
+ setDebugScreenshotsPrefix(prefix: string): Configuration;
665
620
  get defaultMatchSettings(): ImageMatchSettingsPlain;
666
621
  set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
667
622
  getDefaultMatchSettings(): ImageMatchSettingsPlain;
668
623
  setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
669
- getMatchLevel(): MatchLevel;
670
- setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
671
- getAccessibilityValidation(): AccessibilitySettings;
672
- setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
673
- getUseDom(): boolean;
674
- setUseDom(useDom: boolean): Configuration;
624
+ get deviceInfo(): string;
625
+ set deviceInfo(deviceInfo: string);
626
+ getDeviceInfo(): string;
627
+ setDeviceInfo(deviceInfo: string): Configuration;
628
+ get disableBrowserFetching(): boolean;
629
+ set disableBrowserFetching(disableBrowserFetching: boolean);
630
+ getDisableBrowserFetching(): boolean;
631
+ setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
632
+ get disableNMLUrlCache(): boolean;
633
+ set disableNMLUrlCache(disableNMLUrlCache: boolean);
634
+ getDisableNMLUrlCache(): boolean;
635
+ setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
636
+ get displayName(): string;
637
+ set displayName(displayName: string);
638
+ getDisplayName(): string;
639
+ setDisplayName(displayName: string): Configuration;
640
+ get dontCloseBatches(): boolean;
641
+ set dontCloseBatches(dontCloseBatches: boolean);
642
+ getDontCloseBatches(): boolean;
643
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
644
+ get enablePatterns(): boolean;
645
+ set enablePatterns(enablePatterns: boolean);
675
646
  getEnablePatterns(): boolean;
676
647
  setEnablePatterns(enablePatterns: boolean): Configuration;
677
- getIgnoreDisplacements(): boolean;
678
- setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
679
- getIgnoreCaret(): boolean;
680
- setIgnoreCaret(ignoreCaret: boolean): Configuration;
648
+ get environmentName(): string;
649
+ set environmentName(environmentName: string);
650
+ getEnvironmentName(): string;
651
+ setEnvironmentName(environmentName: string): Configuration;
681
652
  get forceFullPageScreenshot(): boolean;
682
653
  set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
683
654
  getForceFullPageScreenshot(): boolean;
684
655
  setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
685
- get waitBeforeScreenshots(): number;
686
- set waitBeforeScreenshots(waitBeforeScreenshots: number);
687
- getWaitBeforeScreenshots(): number;
688
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
689
- get waitBeforeCapture(): number;
690
- set waitBeforeCapture(waitBeforeCapture: number);
691
- getWaitBeforeCapture(): number;
692
- setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
693
- get stitchMode(): StitchModePlain;
694
- set stitchMode(stitchMode: StitchModePlain);
695
- getStitchMode(): StitchMode;
696
- setStitchMode(stitchMode: StitchModePlain): Configuration;
697
- get hideScrollbars(): boolean;
698
- set hideScrollbars(hideScrollbars: boolean);
699
- getHideScrollbars(): boolean;
700
- setHideScrollbars(hideScrollbars: boolean): Configuration;
656
+ get gitMergeBaseTimestamp(): string;
657
+ set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
658
+ getGitMergeBaseTimestamp(): string;
659
+ setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
701
660
  get hideCaret(): boolean;
702
661
  set hideCaret(hideCaret: boolean);
703
662
  getHideCaret(): boolean;
704
663
  setHideCaret(hideCaret: boolean): Configuration;
705
- get stitchOverlap(): number;
706
- set stitchOverlap(stitchOverlap: number);
707
- getStitchOverlap(): number;
708
- setStitchOverlap(stitchOverlap: number): Configuration;
709
- get scrollRootElement(): Element | EyesSelector<Selector>;
710
- set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
711
- getScrollRootElement(): Element | EyesSelector<Selector>;
712
- setScrollRootElement(scrollRootElement: Element): Configuration;
713
- setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
714
- get cut(): CutProviderPlain;
715
- set cut(cut: CutProviderPlain);
716
- getCut(): CutProviderPlain;
717
- setCut(cut: CutProviderPlain): Configuration;
664
+ get hideScrollbars(): boolean;
665
+ set hideScrollbars(hideScrollbars: boolean);
666
+ getHideScrollbars(): boolean;
667
+ setHideScrollbars(hideScrollbars: boolean): Configuration;
668
+ get hostApp(): string;
669
+ set hostApp(hostApp: string);
670
+ getHostApp(): string;
671
+ setHostApp(hostApp: string): Configuration;
672
+ get hostAppInfo(): string;
673
+ set hostAppInfo(hostAppInfo: string);
674
+ getHostAppInfo(): string;
675
+ setHostAppInfo(hostAppInfo: string): Configuration;
676
+ get hostOS(): string;
677
+ set hostOS(hostOS: string);
678
+ getHostOS(): string;
679
+ setHostOS(hostOS: string): Configuration;
680
+ get hostOSInfo(): string;
681
+ set hostOSInfo(hostOSInfo: string);
682
+ getHostOSInfo(): string;
683
+ setHostOSInfo(hostOSInfo: string): Configuration;
684
+ get ignoreBaseline(): boolean;
685
+ set ignoreBaseline(ignoreBaseline: boolean);
686
+ getIgnoreBaseline(): boolean;
687
+ setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
688
+ get ignoreCaret(): boolean;
689
+ set ignoreCaret(ignoreCaret: boolean);
690
+ getIgnoreCaret(): boolean;
691
+ setIgnoreCaret(ignoreCaret: boolean): Configuration;
692
+ get ignoreDisplacements(): boolean;
693
+ set ignoreDisplacements(ignoreDisplacements: boolean);
694
+ getIgnoreDisplacements(): boolean;
695
+ setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
696
+ get ignoreGitMergeBase(): boolean;
697
+ set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
698
+ getIgnoreGitMergeBase(): boolean;
699
+ setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
700
+ get isDisabled(): boolean;
701
+ set isDisabled(isDisabled: boolean);
702
+ getIsDisabled(): boolean;
703
+ setIsDisabled(isDisabled: boolean): Configuration;
704
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
705
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
706
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
707
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
708
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
709
+ setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
710
+ get matchLevel(): MatchLevelPlain;
711
+ set matchLevel(matchLevel: MatchLevelPlain);
712
+ getMatchLevel(): MatchLevel;
713
+ setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
714
+ get matchTimeout(): number;
715
+ set matchTimeout(matchTimeout: number);
716
+ getMatchTimeout(): number;
717
+ setMatchTimeout(matchTimeout: number): Configuration;
718
+ get mobileOptions(): { keepNavigationBar?: undefined | boolean; };
719
+ set mobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; });
720
+ getMobileOptions(): { keepNavigationBar?: undefined | boolean; };
721
+ setMobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; }): Configuration;
722
+ get parentBranchName(): string;
723
+ set parentBranchName(parentBranchName: string);
724
+ getParentBranchName(): string;
725
+ setParentBranchName(parentBranchName: string): Configuration;
726
+ get properties(): Array<PropertyDataPlain>;
727
+ set properties(properties: Array<PropertyDataPlain>);
728
+ getProperties(): Array<PropertyData>;
729
+ setProperties(properties: Array<PropertyDataPlain>): Configuration;
730
+ addProperty(name: string, value: string): Configuration;
731
+ addProperty(prop: PropertyDataPlain): Configuration;
732
+ clearProperties(): Configuration;
733
+ get proxy(): ProxySettingsPlain;
734
+ set proxy(proxy: ProxySettingsPlain);
735
+ getProxy(): ProxySettings;
736
+ setProxy(proxy: ProxySettingsPlain): Configuration;
737
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
738
+ setProxy(isEnabled: false): Configuration;
739
+ get removeSession(): boolean;
740
+ set removeSession(removeSession: boolean);
741
+ getRemoveSession(): boolean;
742
+ setRemoveSession(removeSession: boolean): Configuration;
718
743
  get rotation(): ImageRotationPlain;
719
744
  set rotation(rotation: ImageRotationPlain);
720
745
  getRotation(): ImageRotation;
721
746
  setRotation(rotation: ImageRotationPlain): Configuration;
722
747
  setRotation(rotation: ImageRotation): Configuration;
748
+ get saveDiffs(): boolean;
749
+ set saveDiffs(saveDiffs: boolean);
750
+ getSaveDiffs(): boolean;
751
+ setSaveDiffs(saveDiffs: boolean): Configuration;
752
+ get saveFailedTests(): boolean;
753
+ set saveFailedTests(saveFailedTests: boolean);
754
+ getSaveFailedTests(): boolean;
755
+ setSaveFailedTests(saveFailedTests: boolean): Configuration;
756
+ get saveNewTests(): boolean;
757
+ set saveNewTests(saveNewTests: boolean);
758
+ getSaveNewTests(): boolean;
759
+ setSaveNewTests(saveNewTests: boolean): Configuration;
723
760
  get scaleRatio(): number;
724
761
  set scaleRatio(scaleRatio: number);
725
762
  getScaleRatio(): number;
726
763
  setScaleRatio(scaleRatio: number): Configuration;
727
- get concurrentSessions(): number;
728
- set concurrentSessions(concurrentSessions: number);
729
- getConcurrentSessions(): number;
730
- setConcurrentSessions(concurrentSessions: number): Configuration;
731
- get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
732
- set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>);
733
- getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
734
- setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
735
- addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
736
- addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
737
- addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
738
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
739
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
740
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
741
- addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
742
- addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
743
- addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
744
- addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
745
- addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
746
- addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
747
- addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
748
- addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
749
- addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
750
- addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
751
- addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
752
- addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
753
- addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
754
- addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
755
- addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
756
- addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
757
- addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
758
- addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
759
- addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
760
- addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
761
- addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
762
- addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
763
- addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
764
+ get scrollRootElement(): Element | EyesSelector<Selector>;
765
+ set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
766
+ getScrollRootElement(): Element | EyesSelector<Selector>;
767
+ setScrollRootElement(scrollRootElement: Element): Configuration;
768
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
769
+ get sendDom(): boolean;
770
+ set sendDom(sendDom: boolean);
771
+ getSendDom(): boolean;
772
+ setSendDom(sendDom: boolean): Configuration;
773
+ get serverUrl(): string;
774
+ set serverUrl(serverUrl: string);
775
+ getServerUrl(): string;
776
+ setServerUrl(serverUrl: string): Configuration;
777
+ get sessionType(): SessionTypePlain;
778
+ set sessionType(sessionType: SessionTypePlain);
779
+ getSessionType(): SessionType;
780
+ setSessionType(sessionType: SessionTypePlain): Configuration;
781
+ get stitchMode(): StitchModePlain;
782
+ set stitchMode(stitchMode: StitchModePlain);
783
+ getStitchMode(): StitchMode;
784
+ setStitchMode(stitchMode: StitchModePlain): Configuration;
785
+ get stitchOverlap(): number;
786
+ set stitchOverlap(stitchOverlap: number);
787
+ getStitchOverlap(): number;
788
+ setStitchOverlap(stitchOverlap: number): Configuration;
789
+ get testName(): string;
790
+ set testName(testName: string);
791
+ getTestName(): string;
792
+ setTestName(testName: string): Configuration;
793
+ get useDom(): boolean;
794
+ set useDom(useDom: boolean);
795
+ getUseDom(): boolean;
796
+ setUseDom(useDom: boolean): Configuration;
797
+ get viewportSize(): RectangleSizePlain;
798
+ set viewportSize(viewportSize: RectangleSizePlain);
799
+ getViewportSize(): RectangleSize;
800
+ setViewportSize(viewportSize: RectangleSizePlain): Configuration;
764
801
  get visualGridOptions(): { [key: string]: any; };
765
802
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
766
803
  getVisualGridOptions(): { [key: string]: any; };
767
804
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
768
805
  setVisualGridOption(key: string, value: any): Configuration;
769
- get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
770
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
771
- getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
772
- setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
773
- setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
774
- setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
775
- get disableBrowserFetching(): boolean;
776
- set disableBrowserFetching(disableBrowserFetching: boolean);
777
- getDisableBrowserFetching(): boolean;
778
- setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
779
- get dontCloseBatches(): boolean;
780
- set dontCloseBatches(dontCloseBatches: boolean);
781
- getDontCloseBatches(): boolean;
782
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
783
- get disableNMLUrlCache(): boolean;
784
- set disableNMLUrlCache(disableNMLUrlCache: boolean);
785
- getDisableNMLUrlCache(): boolean;
786
- setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
787
- get captureStatusBar(): boolean;
788
- set captureStatusBar(captureStatusBar: boolean);
789
- getCaptureStatusBar(): boolean;
790
- setCaptureStatusBar(captureStatusBar: boolean): Configuration;
806
+ get waitBeforeCapture(): number;
807
+ set waitBeforeCapture(waitBeforeCapture: number);
808
+ getWaitBeforeCapture(): number;
809
+ setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
810
+ get waitBeforeScreenshots(): number;
811
+ set waitBeforeScreenshots(waitBeforeScreenshots: number);
812
+ getWaitBeforeScreenshots(): number;
813
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
791
814
  }
792
815
  export class BatchClose {
793
816
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;