@applitools/eyes-webdriverio 5.38.0 → 5.38.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/api.js +6 -3
  3. package/package.json +4 -4
  4. package/types/index.d.ts +90 -94
package/CHANGELOG.md CHANGED
@@ -10,6 +10,18 @@
10
10
 
11
11
 
12
12
 
13
+ ## 5.38.2 - 2022/12/1
14
+
15
+ ### Features
16
+ ### Bug fixes
17
+ - Fixed issue with element scroll position not being restored after screenshot is taken on native platforms
18
+
19
+ ## 5.38.1 - 2022/11/29
20
+
21
+ ### Features
22
+ - Added `ignoreColors` method to `CheckSettings` to set a match level
23
+ ### Bug fixes
24
+
13
25
  ## 5.38.0 - 2022/11/17
14
26
 
15
27
  ### Features
package/dist/api.js CHANGED
@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
26
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = exports.By = void 0;
29
+ exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Configuration = exports.Eyes = exports.By = void 0;
30
30
  const core_1 = require("@applitools/core");
31
31
  const api = __importStar(require("@applitools/eyes-api"));
32
32
  const spec = __importStar(require("@applitools/spec-driver-webdriverio"));
@@ -45,10 +45,13 @@ class Configuration extends api.Configuration {
45
45
  }
46
46
  exports.Configuration = Configuration;
47
47
  Configuration._spec = sdk;
48
- class CheckSettings extends api.CheckSettingsAutomation {
48
+ class CheckSettingsAutomation extends api.CheckSettingsAutomation {
49
+ }
50
+ exports.CheckSettingsAutomation = CheckSettingsAutomation;
51
+ CheckSettingsAutomation._spec = sdk;
52
+ class CheckSettings extends CheckSettingsAutomation {
49
53
  }
50
54
  exports.CheckSettings = CheckSettings;
51
- CheckSettings._spec = sdk;
52
55
  exports.Target = { ...api.Target, spec: sdk };
53
56
  class BatchClose extends api.BatchClose {
54
57
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.38.0",
3
+ "version": "5.38.2",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -116,9 +116,9 @@
116
116
  }
117
117
  },
118
118
  "dependencies": {
119
- "@applitools/core": "1.2.12",
120
- "@applitools/eyes-api": "1.10.4",
121
- "@applitools/spec-driver-webdriverio": "1.4.6"
119
+ "@applitools/core": "1.2.15",
120
+ "@applitools/eyes-api": "1.10.7",
121
+ "@applitools/spec-driver-webdriverio": "1.4.7"
122
122
  },
123
123
  "devDependencies": {
124
124
  "@applitools/api-extractor": "1.2.11",
package/types/index.d.ts CHANGED
@@ -36,7 +36,7 @@ export class Eyes {
36
36
  open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
37
37
  open(config?: ConfigurationPlain): Promise<void>;
38
38
  open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
39
- check(name: string, checkSettings: CheckSettingsImage | CheckSettings): Promise<MatchResult>;
39
+ check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
40
40
  check(target: {
41
41
  image: string | URL | Buffer;
42
42
  name?: string;
@@ -45,7 +45,7 @@ export class Eyes {
45
45
  locationInView?: LocationPlain;
46
46
  fullViewSize?: RectangleSizePlain;
47
47
  }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
48
- check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
48
+ check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
49
49
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
50
50
  extractTextRegions<TPattern extends string>(target: {
51
51
  image: string | URL | Buffer;
@@ -417,7 +417,7 @@ export class Configuration implements Required<ConfigurationPlain> {
417
417
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
418
418
  }
419
419
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
420
- export type CheckSettingsPlain = CheckSettingsImagePlain & {
420
+ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
421
421
  frames?: Array<{ 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>; }); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
422
422
  webview?: string | boolean;
423
423
  scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
@@ -431,7 +431,86 @@ export type CheckSettingsPlain = CheckSettingsImagePlain & {
431
431
  waitBeforeCapture?: number;
432
432
  lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
433
433
  };
434
- export class CheckSettings extends CheckSettings {
434
+ export class CheckSettingsAutomation {
435
+ constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
436
+ region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
437
+ shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
438
+ 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>; }); }): CheckSettingsAutomation;
439
+ 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>; })): CheckSettingsAutomation;
440
+ webview(webview?: string | boolean): CheckSettingsAutomation;
441
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
442
+ fully(fully?: boolean): CheckSettingsAutomation;
443
+ disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
444
+ layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
445
+ hook(name: string, script: string): CheckSettingsAutomation;
446
+ beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
447
+ ufgOption(key: string, value: any): CheckSettingsAutomation;
448
+ ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
449
+ renderId(renderId: string): CheckSettingsAutomation;
450
+ timeout(timeout: number): CheckSettingsAutomation;
451
+ waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
452
+ lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
453
+ name(name: string): CheckSettingsAutomation;
454
+ withName(name: string): CheckSettingsAutomation;
455
+ ignoreRegion(region: 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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
456
+ ignoreRegions(...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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
457
+ layoutRegion(region: 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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
458
+ layoutRegions(...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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
459
+ strictRegion(region: 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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
460
+ strictRegions(...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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
461
+ contentRegion(region: 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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
462
+ contentRegions(...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>; })); padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
463
+ floatingRegion(region: {
464
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
465
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
466
+ regionId?: string;
467
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
468
+ }): CheckSettingsAutomation;
469
+ floatingRegion(region: {
470
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
471
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
472
+ regionId?: string;
473
+ maxUpOffset?: number;
474
+ maxDownOffset?: number;
475
+ maxLeftOffset?: number;
476
+ maxRightOffset?: number;
477
+ }): CheckSettingsAutomation;
478
+ 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): CheckSettingsAutomation;
479
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
480
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
481
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
482
+ regionId?: string;
483
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
484
+ }>): CheckSettingsAutomation;
485
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
486
+ accessibilityRegion(region: {
487
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
488
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
489
+ regionId?: string;
490
+ type?: AccessibilityRegionTypePlain;
491
+ }): CheckSettingsAutomation;
492
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
493
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
494
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
495
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
496
+ regionId?: string;
497
+ type?: AccessibilityRegionTypePlain;
498
+ }>): CheckSettingsAutomation;
499
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
500
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
501
+ layout(): CheckSettingsAutomation;
502
+ exact(): CheckSettingsAutomation;
503
+ strict(): CheckSettingsAutomation;
504
+ ignoreColors(): CheckSettingsAutomation;
505
+ enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
506
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
507
+ ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
508
+ useDom(useDom?: boolean): CheckSettingsAutomation;
509
+ sendDom(sendDom?: boolean): CheckSettingsAutomation;
510
+ pageId(pageId: string): CheckSettingsAutomation;
511
+ variationGroupId(variationGroupId: string): CheckSettingsAutomation;
512
+ }
513
+ export class CheckSettings extends CheckSettingsAutomation {
435
514
  }
436
515
  export const Target: TargetImage & TargetAutomation<Element, Selector>;
437
516
  export class BatchClose {
@@ -844,7 +923,7 @@ export class CheckSettingsImage {
844
923
  layout(): CheckSettingsImage;
845
924
  exact(): CheckSettingsImage;
846
925
  strict(): CheckSettingsImage;
847
- content(): CheckSettingsImage;
926
+ ignoreColors(): CheckSettingsImage;
848
927
  enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
849
928
  ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
850
929
  ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
@@ -853,89 +932,6 @@ export class CheckSettingsImage {
853
932
  pageId(pageId: string): CheckSettingsImage;
854
933
  variationGroupId(variationGroupId: string): CheckSettingsImage;
855
934
  }
856
- export type CheckSettingsAutomationPlain<TElement, TSelector> = CheckSettingsImagePlain & {
857
- frames?: Array<{ frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); } | (number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))>;
858
- webview?: string | boolean;
859
- scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; });
860
- fully?: boolean;
861
- disableBrowserFetching?: boolean;
862
- layoutBreakpoints?: boolean | Array<number>;
863
- visualGridOptions?: { [key: string]: any; };
864
- hooks?: { beforeCaptureScreenshot: string; };
865
- renderId?: string;
866
- timeout?: number;
867
- waitBeforeCapture?: number;
868
- lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
869
- };
870
- export class CheckSettingsAutomation<TElement = unknown, TSelector = unknown> {
871
- constructor(settings?: CheckSettings | CheckSettingsPlain, spec?: { isElement(value: any): value is TElement; isSelector(value: any): value is TSelector; });
872
- region(region: RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }))): CheckSettings;
873
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettings;
874
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettings;
875
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettings;
876
- webview(webview?: string | boolean): CheckSettings;
877
- scrollRootElement(scrollRootElement: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettings;
878
- fully(fully?: boolean): CheckSettings;
879
- disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
880
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
881
- hook(name: string, script: string): CheckSettings;
882
- beforeRenderScreenshotHook(script: string): CheckSettings;
883
- ufgOption(key: string, value: any): CheckSettings;
884
- ufgOptions(options: { [key: string]: any; }): CheckSettings;
885
- renderId(renderId: string): CheckSettings;
886
- timeout(timeout: number): CheckSettings;
887
- waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
888
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
889
- name(name: string): CheckSettings;
890
- withName(name: string): CheckSettings;
891
- ignoreRegion(region: any): CheckSettings;
892
- ignoreRegions(...regions: Array<any>): CheckSettings;
893
- layoutRegion(region: any): CheckSettings;
894
- layoutRegions(...regions: Array<any>): CheckSettings;
895
- strictRegion(region: any): CheckSettings;
896
- strictRegions(...regions: Array<any>): CheckSettings;
897
- contentRegion(region: any): CheckSettings;
898
- contentRegions(...regions: Array<any>): CheckSettings;
899
- floatingRegion(region: {
900
- region: any;
901
- padding?: number | { top: number; bottom: number; let: number; right: number; };
902
- regionId?: string;
903
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
904
- }): CheckSettings;
905
- floatingRegion(region: {
906
- region: any;
907
- padding?: number | { top: number; bottom: number; let: number; right: number; };
908
- regionId?: string;
909
- maxUpOffset?: number;
910
- maxDownOffset?: number;
911
- maxLeftOffset?: number;
912
- maxRightOffset?: number;
913
- }): CheckSettings;
914
- floatingRegion(region: any, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettings;
915
- floatingRegions(...regions: Array<any>): CheckSettings;
916
- floatingRegions(maxOffset: number, ...regions: Array<any>): CheckSettings;
917
- accessibilityRegion(region: {
918
- region: any;
919
- padding?: number | { top: number; bottom: number; let: number; right: number; };
920
- regionId?: string;
921
- type?: AccessibilityRegionTypePlain;
922
- }): CheckSettings;
923
- accessibilityRegion(region: any, type?: AccessibilityRegionTypePlain): CheckSettings;
924
- accessibilityRegions(...regions: Array<any>): CheckSettings;
925
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<any>): CheckSettings;
926
- matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
927
- layout(): CheckSettings;
928
- exact(): CheckSettings;
929
- strict(): CheckSettings;
930
- content(): CheckSettings;
931
- enablePatterns(enablePatterns?: boolean): CheckSettings;
932
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettings;
933
- ignoreCaret(ignoreCaret?: boolean): CheckSettings;
934
- useDom(useDom?: boolean): CheckSettings;
935
- sendDom(sendDom?: boolean): CheckSettings;
936
- pageId(pageId: string): CheckSettings;
937
- variationGroupId(variationGroupId: string): CheckSettings;
938
- }
939
935
  export type TargetImage = {
940
936
  image(image: string | URL | Buffer): CheckSettingsImage;
941
937
  buffer(imageBuffer: Buffer): CheckSettingsImage;
@@ -944,12 +940,12 @@ export type TargetImage = {
944
940
  url(imageUrl: string | URL): CheckSettingsImage;
945
941
  };
946
942
  export type TargetAutomation<TElement, TSelector> = {
947
- window(): CheckSettings;
948
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettings;
949
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettings;
950
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettings;
951
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettings;
952
- webview(webview?: string | boolean): CheckSettings;
943
+ window(): CheckSettingsAutomation;
944
+ region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
945
+ frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettingsAutomation;
946
+ frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettingsAutomation;
947
+ shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
948
+ webview(webview?: string | boolean): CheckSettingsAutomation;
953
949
  };
954
950
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
955
951
  export class CutProvider implements Required<{