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