@applitools/eyes-selenium 4.60.2 → 4.62.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 (5) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +58 -39
  3. package/dist/api.js +7 -4
  4. package/package.json +6 -6
  5. package/types/index.d.ts +222 -103
package/CHANGELOG.md CHANGED
@@ -8,6 +8,32 @@
8
8
 
9
9
 
10
10
 
11
+ ## 4.62.0 - 2022/12/21
12
+
13
+ ### Features
14
+ - Added new selector extensions `child` and `fallback`
15
+ - Mark target element with `data-applitools-scroll` attribute before capture dom
16
+ - Added new iOS device - 'iPad Pro (11-inch) (4th generation)'
17
+ - Use user agent metadata to improve browser environment detection logic
18
+ - Use APPLITOOLS_CONCURRENCY env variable to specify concurrency
19
+ - Added `ignoreColors` method to `CheckSettings` to set a match level
20
+ - Added `nmgOptions` to `CheckSettings`
21
+ ### Bug fixes
22
+ - Fixed bug that caused `extractText` to throw, due to fractional size of the target region
23
+ - Fix dontCloseBatches mapping
24
+ - Fixed issue when current context is not being preserved in ufg mode
25
+ - Fixed issue when helper lib inputs were not cleaned up before calling new command
26
+ - Fixed issue with element scroll position not being restored after screenshot is taken on native platforms
27
+ - Handle fake shadowRoot with UFG
28
+ - Handed error during polling in long requests to eyes server
29
+
30
+ ## 4.61.0 - 2022/10/18
31
+
32
+ ### Features
33
+ - Drop support for Android 9 and Android 10 specific devices
34
+ ### Bug fixes
35
+ - Fixed error that was happening when test results were deleted
36
+
11
37
  ## 4.60.2 - 2022/10/13
12
38
 
13
39
  ### Features
package/README.md CHANGED
@@ -7,54 +7,58 @@
7
7
  </div>
8
8
  <br/>
9
9
 
10
- ## Table of contents
10
+ ### Table of contents
11
11
 
12
12
  - [Installation](#installation)
13
13
  - [Applitools API key](#applitools-api-key)
14
14
  - [Usage](#usage)
15
15
  - [Getting started with the API](#getting-started-with-the-api)
16
- * [Eyes constructor](#eyes-constructor)
17
- * [open](#open)
18
- + [Visual tests and baselines](#visual-tests-and-baselines)
19
- + [Batches](#batches)
20
- * [check](#check)
21
- + [Arguments to `eyes.check`](#arguments-to-eyescheck)
22
- - [`tag`](#tag)
23
- - [`checkSettings`](#checksettings)
24
- * [Page screenshot](#page-screenshot)
25
- * [Region screenshot](#region-screenshot)
26
- * [Switching into frames](#switching-into-frames)
27
- * [Ignore Regions](#ignore-regions)
28
- * [Floating Regions](#floating-regions)
29
- * [Content/Strict/Layout Regions](#content-strict-layout-regions)
30
- * [Accessiblity Regions](#accessiblity-regions)
31
- * [Scroll root element](#scroll-root-element)
32
- * [Variation group ID](#variation-group-id)
33
- * [Other checkSettings configuration](#other-checksettings-configuration)
34
- * [close](#close)
16
+ - [Eyes constructor](#eyes-constructor)
17
+ - [open](#open)
18
+ - [Visual tests and baselines](#visual-tests-and-baselines)
19
+ - [Batches](#batches)
20
+ - [check](#check)
21
+ - [`checkSettings`](#checksettings)
22
+ - [Page screenshot](#page-screenshot)
23
+ - [Region screenshot](#region-screenshot)
24
+ - [Switching into frames](#switching-into-frames)
25
+ - [Ignore Regions](#ignore-regions)
26
+ - [Floating Regions](#floating-regions)
27
+ - [Content/Strict/Layout Regions](#contentstrictlayout-regions)
28
+ - [Accessiblity Regions](#accessiblity-regions)
29
+ - [Scroll root element](#scroll-root-element)
30
+ - [Tag (`withName`)](#tag-withname)
31
+ - [Variation group ID](#variation-group-id)
32
+ - [Lazy loading (`lazyLoad`)](#lazy-loading-lazyload)
33
+ - [Other checkSettings configuration](#other-checksettings-configuration)
34
+ - [close](#close)
35
35
  - [Runners](#runners)
36
- * [Purpose of runners](#purpose-of-runners)
37
- + [1. Use the Ultrafast grid](#1-use-the-ultra-fast-grid)
38
- + [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
36
+ - [Purpose of runners](#purpose-of-runners)
37
+ - [1. Use the Ultrafast grid](#1-use-the-ultrafast-grid)
38
+ - [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
39
39
  - [Visual locators](#visual-locators)
40
+ - [](#)
40
41
  - [Recipes for common tasks](#recipes-for-common-tasks)
41
- * [Configure Server URL](#configure-server-url)
42
- * [Configure Proxy](#configure-proxy)
43
- * [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
44
- * [Organize tests in batches](#organize-tests-in-batches)
45
- + [Method 1: environment variable](#method-1--environment-variable)
46
- + [Method 2: `eyes.setBatch`](#method-2--eyessetbatch)
47
- * [Stitch mode](#stitch-mode)
48
- + [Background information](#background-information)
42
+ - [Configure Server URL](#configure-server-url)
43
+ - [Configure Proxy](#configure-proxy)
44
+ - [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
45
+ - [Organize tests in batches](#organize-tests-in-batches)
46
+ - [Method 1: environment variable](#method-1-environment-variable)
47
+ - [Method 2: `eyes.setBatch`](#method-2-eyessetbatch)
48
+ - [Stitch mode](#stitch-mode)
49
+ - [Background information](#background-information)
49
50
  - [1. Stitch mode: Scroll](#1-stitch-mode-scroll)
50
51
  - [2. Stitch mode: CSS](#2-stitch-mode-css)
51
- * [Stitch overlap](#stitch-overlap)
52
- * [Match level](#match-level)
53
- * [Ignore displacements](#ignore-displacements)
54
- * [Test properties](#test-properties)
55
- * [Test results](#test-results)
56
- * [Logging](#logging)
57
- * [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultra-fast-grid)
52
+ - [Stitch overlap](#stitch-overlap)
53
+ - [Match level](#match-level)
54
+ - [Ignore displacements](#ignore-displacements)
55
+ - [Test properties](#test-properties)
56
+ - [Test results](#test-results)
57
+ - [Logging](#logging)
58
+ - [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultrafast-grid)
59
+ - [Desktop browsers](#desktop-browsers)
60
+ - [Chrome device emulation](#chrome-device-emulation)
61
+ - [iOS device](#ios-device)
58
62
 
59
63
 
60
64
  ## Installation
@@ -797,7 +801,7 @@ It's possible to provide additional information about each test in custom fields
797
801
  This is done by calling `setProperties` on the configuration, and providing it with an array of properties with the structure `{name, value}`. For example:
798
802
 
799
803
  ```js
800
- const {Eyes, Target} = require('@applitools/eyes-selenium')
804
+ const {Eyes} = require('@applitools/eyes-selenium')
801
805
 
802
806
  const eyes = new Eyes()
803
807
 
@@ -806,6 +810,21 @@ configuration.setProperties([{name: 'my custom property', value: 'some value'}])
806
810
  eyes.setConfiguration(configuration)
807
811
  ```
808
812
 
813
+ The test properties could also be specified per batch by calling `setProperties` on the batch info, and providing it with an array of properties with the structure `{name, value}`. For example:
814
+
815
+ ```js
816
+ const {Eyes, BatchInfo} = require('@applitools/eyes-selenium')
817
+
818
+ const eyes = new Eyes()
819
+
820
+ const batch = new BatchInfo()
821
+ batch.setProperties([{name: 'my custom batch property', value: 'some value'}])
822
+
823
+ const configuration = eyes.getConfiguration()
824
+ configuration.setBatch(batch)
825
+ eyes.setConfiguration(configuration)
826
+ ```
827
+
809
828
  ### Test results
810
829
 
811
830
  The results of the test can be consumed as the return value from `eyes.close`. Here's an example for creating a formatted output string out of the `TestResults` object:
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 = void 0;
29
+ exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Configuration = exports.Eyes = 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-selenium"));
@@ -43,11 +43,14 @@ class Configuration extends api.Configuration {
43
43
  }
44
44
  exports.Configuration = Configuration;
45
45
  Configuration._spec = sdk;
46
- class CheckSettings extends api.CheckSettings {
46
+ class CheckSettingsAutomation extends api.CheckSettingsAutomation {
47
+ }
48
+ exports.CheckSettingsAutomation = CheckSettingsAutomation;
49
+ CheckSettingsAutomation._spec = sdk;
50
+ class CheckSettings extends CheckSettingsAutomation {
47
51
  }
48
52
  exports.CheckSettings = CheckSettings;
49
- CheckSettings._spec = sdk;
50
- exports.Target = CheckSettings;
53
+ exports.Target = { ...api.Target, spec: sdk };
51
54
  class BatchClose extends api.BatchClose {
52
55
  }
53
56
  exports.BatchClose = BatchClose;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-selenium",
3
- "version": "4.60.2",
3
+ "version": "4.62.0",
4
4
  "description": "Applitools Eyes SDK for Selenium WebDriver",
5
5
  "keywords": [
6
6
  "eyes-selenium",
@@ -65,17 +65,17 @@
65
65
  }
66
66
  },
67
67
  "dependencies": {
68
- "@applitools/core": "1.1.6",
69
- "@applitools/eyes-api": "1.8.6",
70
- "@applitools/spec-driver-selenium": "1.5.2"
68
+ "@applitools/core": "1.3.3",
69
+ "@applitools/eyes-api": "1.11.2",
70
+ "@applitools/spec-driver-selenium": "1.5.14"
71
71
  },
72
72
  "devDependencies": {
73
73
  "@applitools/api-extractor": "1.2.11",
74
74
  "@applitools/bongo": "^2.2.0",
75
75
  "@applitools/scripts": "1.2.0",
76
- "@applitools/sdk-coverage-tests": "2.3.20",
76
+ "@applitools/sdk-coverage-tests": "2.7.10",
77
77
  "@applitools/sdk-shared": "0.9.15",
78
- "@applitools/test-utils": "1.5.2",
78
+ "@applitools/test-utils": "1.5.4",
79
79
  "@types/node": "12",
80
80
  "@types/selenium-webdriver": "^4.1.1",
81
81
  "@typescript-eslint/eslint-plugin": "^5.27.0",
package/types/index.d.ts CHANGED
@@ -19,10 +19,40 @@ export class Eyes {
19
19
  getIsOpen(): boolean;
20
20
  open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
21
21
  open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
22
- check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
23
- check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
22
+ open(config?: ConfigurationPlain): Promise<void>;
23
+ open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
24
+ check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
25
+ check(target: {
26
+ image: string | Buffer | URL;
27
+ name?: string;
28
+ dom?: string;
29
+ locationInViewport?: LocationPlain;
30
+ locationInView?: LocationPlain;
31
+ fullViewSize?: RectangleSizePlain;
32
+ }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
33
+ check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
24
34
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
35
+ extractTextRegions<TPattern extends string>(target: {
36
+ image: string | Buffer | URL;
37
+ size?: { width: number; height: number; };
38
+ name?: string;
39
+ source?: string;
40
+ dom?: string;
41
+ locationInViewport?: { x: number; y: number; };
42
+ locationInView?: { x: number; y: number; };
43
+ fullViewSize?: { width: number; height: number; };
44
+ }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
25
45
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
46
+ extractText(target: {
47
+ image: string | Buffer | URL;
48
+ size?: { width: number; height: number; };
49
+ name?: string;
50
+ source?: string;
51
+ dom?: string;
52
+ locationInViewport?: { x: number; y: number; };
53
+ locationInView?: { x: number; y: number; };
54
+ fullViewSize?: { width: number; height: number; };
55
+ }, settings: Array<OCRRegion>): Promise<Array<string>>;
26
56
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
27
57
  close(throwErr?: boolean): Promise<TestResults>;
28
58
  abort(): Promise<TestResults>;
@@ -372,75 +402,58 @@ export class Configuration implements Required<ConfigurationPlain> {
372
402
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
373
403
  }
374
404
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
375
- export type CheckSettingsPlain = {
376
- name?: string;
377
- region?: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
405
+ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
378
406
  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>; })))>;
407
+ webview?: string | boolean;
379
408
  scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
380
409
  fully?: boolean;
381
- matchLevel?: MatchLevelPlain;
382
- useDom?: boolean;
383
- sendDom?: boolean;
384
- enablePatterns?: boolean;
385
- ignoreDisplacements?: boolean;
386
- ignoreCaret?: boolean;
387
- ignoreRegions?: Array<(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; }>;
388
- layoutRegions?: Array<(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; }>;
389
- strictRegions?: Array<(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; }>;
390
- contentRegions?: Array<(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; }>;
391
- floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
392
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
393
- padding?: number | { top: number; bottom: number; let: number; right: number; };
394
- regionId?: string;
395
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
396
- } | {
397
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
398
- padding?: number | { top: number; bottom: number; let: number; right: number; };
399
- regionId?: string;
400
- maxUpOffset?: number;
401
- maxDownOffset?: number;
402
- maxLeftOffset?: number;
403
- maxRightOffset?: number;
404
- }>;
405
- accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
406
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
407
- padding?: number | { top: number; bottom: number; let: number; right: number; };
408
- regionId?: string;
409
- type?: AccessibilityRegionTypePlain;
410
- }>;
411
410
  disableBrowserFetching?: boolean;
412
411
  layoutBreakpoints?: boolean | Array<number>;
413
412
  visualGridOptions?: { [key: string]: any; };
413
+ nmgOptions?: { [key: string]: any; };
414
414
  hooks?: { beforeCaptureScreenshot: string; };
415
415
  renderId?: string;
416
- pageId?: string;
417
- variationGroupId?: string;
418
416
  timeout?: number;
419
417
  waitBeforeCapture?: number;
420
418
  lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
421
- webview?: string | boolean;
422
419
  };
423
- export class CheckSettings {
424
- constructor(settings?: CheckSettings | CheckSettingsPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
425
- withName(name: string): CheckSettings;
426
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
427
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
428
- frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
429
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
430
- 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; }): CheckSettings;
431
- 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; }>): CheckSettings;
432
- 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; }): CheckSettings;
433
- 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; }>): CheckSettings;
434
- 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; }): CheckSettings;
435
- 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; }>): CheckSettings;
436
- 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; }): CheckSettings;
437
- 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; }>): CheckSettings;
420
+ export class CheckSettingsAutomation {
421
+ constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
422
+ region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
423
+ shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
424
+ 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;
425
+ 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;
426
+ webview(webview?: string | boolean): CheckSettingsAutomation;
427
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
428
+ fully(fully?: boolean): CheckSettingsAutomation;
429
+ disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
430
+ layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
431
+ hook(name: string, script: string): CheckSettingsAutomation;
432
+ beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
433
+ ufgOption(key: string, value: any): CheckSettingsAutomation;
434
+ ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
435
+ nmgOption(key: string, value: any): CheckSettingsAutomation;
436
+ nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
437
+ renderId(renderId: string): CheckSettingsAutomation;
438
+ timeout(timeout: number): CheckSettingsAutomation;
439
+ waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
440
+ lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
441
+ name(name: string): CheckSettingsAutomation;
442
+ withName(name: string): CheckSettingsAutomation;
443
+ 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;
444
+ 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;
445
+ 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;
446
+ 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;
447
+ 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;
448
+ 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;
449
+ 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;
450
+ 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;
438
451
  floatingRegion(region: {
439
452
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
440
453
  padding?: number | { top: number; bottom: number; let: number; right: number; };
441
454
  regionId?: string;
442
455
  offset?: { top?: number; bottom?: number; left?: number; right?: number; };
443
- }): CheckSettings;
456
+ }): CheckSettingsAutomation;
444
457
  floatingRegion(region: {
445
458
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
446
459
  padding?: number | { top: number; bottom: number; let: number; right: number; };
@@ -449,63 +462,45 @@ export class CheckSettings {
449
462
  maxDownOffset?: number;
450
463
  maxLeftOffset?: number;
451
464
  maxRightOffset?: number;
452
- }): CheckSettings;
453
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettings;
465
+ }): CheckSettingsAutomation;
466
+ 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;
454
467
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
455
468
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
456
469
  padding?: number | { top: number; bottom: number; let: number; right: number; };
457
470
  regionId?: string;
458
471
  offset?: { top?: number; bottom?: number; left?: number; right?: number; };
459
- }>): CheckSettings;
460
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
472
+ }>): CheckSettingsAutomation;
473
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
461
474
  accessibilityRegion(region: {
462
475
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
463
476
  padding?: number | { top: number; bottom: number; let: number; right: number; };
464
477
  regionId?: string;
465
478
  type?: AccessibilityRegionTypePlain;
466
- }): CheckSettings;
467
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
479
+ }): CheckSettingsAutomation;
480
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
468
481
  accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
469
482
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
470
483
  padding?: number | { top: number; bottom: number; let: number; right: number; };
471
484
  regionId?: string;
472
485
  type?: AccessibilityRegionTypePlain;
473
- }>): CheckSettings;
474
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
475
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
476
- fully(fully?: boolean): CheckSettings;
477
- matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
478
- layout(): CheckSettings;
479
- exact(): CheckSettings;
480
- strict(): CheckSettings;
481
- content(): CheckSettings;
482
- useDom(useDom?: boolean): CheckSettings;
483
- sendDom(sendDom?: boolean): CheckSettings;
484
- enablePatterns(enablePatterns?: boolean): CheckSettings;
485
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettings;
486
- ignoreCaret(ignoreCaret?: boolean): CheckSettings;
487
- disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
488
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
489
- hook(name: string, script: string): CheckSettings;
490
- beforeRenderScreenshotHook(script: string): CheckSettings;
491
- ufgOption(key: string, value: any): CheckSettings;
492
- ufgOptions(options: { [key: string]: any; }): CheckSettings;
493
- renderId(renderId: string): CheckSettings;
494
- pageId(pageId: string): CheckSettings;
495
- variationGroupId(variationGroupId: string): CheckSettings;
496
- timeout(timeout: number): CheckSettings;
497
- waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
498
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
499
- webview(option?: string | boolean): CheckSettings;
486
+ }>): CheckSettingsAutomation;
487
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
488
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
489
+ layout(): CheckSettingsAutomation;
490
+ exact(): CheckSettingsAutomation;
491
+ strict(): CheckSettingsAutomation;
492
+ ignoreColors(): CheckSettingsAutomation;
493
+ enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
494
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
495
+ ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
496
+ useDom(useDom?: boolean): CheckSettingsAutomation;
497
+ sendDom(sendDom?: boolean): CheckSettingsAutomation;
498
+ pageId(pageId: string): CheckSettingsAutomation;
499
+ variationGroupId(variationGroupId: string): CheckSettingsAutomation;
500
500
  }
501
- export const Target: {
502
- window(): CheckSettings;
503
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
504
- frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
505
- frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
506
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
507
- webview(option?: string | boolean): CheckSettings;
508
- };
501
+ export class CheckSettings extends CheckSettingsAutomation {
502
+ }
503
+ export const Target: TargetImage & TargetAutomation<Element, Selector>;
509
504
  export class BatchClose {
510
505
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
511
506
  constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
@@ -638,7 +633,7 @@ export enum FailureReport {
638
633
  IMMEDIATE = 'IMMEDIATE',
639
634
  ON_CLOSE = 'ON_CLOSE'
640
635
  }
641
- export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
636
+ export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
642
637
  export enum IosDeviceName {
643
638
  iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
644
639
  iPhone_14 = 'iPhone 14',
@@ -660,6 +655,7 @@ export enum IosDeviceName {
660
655
  iPhone_7 = 'iPhone 7',
661
656
  iPhone_SE = 'iPhone SE (1st generation)',
662
657
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
658
+ iPad_Pro_4 = 'iPad Pro (11-inch) (4th generation)',
663
659
  iPad_7 = 'iPad (7th generation)',
664
660
  iPad_9 = 'iPad (9th generation)',
665
661
  iPad_Air_2 = 'iPad Air (2nd generation)',
@@ -671,19 +667,13 @@ export enum IosVersion {
671
667
  ONE_VERSION_BACK = 'latest-1',
672
668
  LATEST_ONE_VERSION_BACK = 'latest-1'
673
669
  }
674
- export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro";
670
+ export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro";
675
671
  export enum AndroidDeviceName {
676
672
  Pixel_3_XL = 'Pixel 3 XL',
677
673
  Pixel_4 = 'Pixel 4',
678
674
  Pixel_4_XL = 'Pixel 4 XL',
679
675
  Pixel_5 = 'Pixel 5',
680
676
  Pixel_6 = 'Pixel 6',
681
- Galaxy_Note_8 = 'Galaxy Note 8',
682
- Galaxy_Note_9 = 'Galaxy Note 9',
683
- Galaxy_S8 = 'Galaxy S8',
684
- Galaxy_S8_Plus = 'Galaxy S8 Plus',
685
- Galaxy_S9 = 'Galaxy S9',
686
- Galaxy_S9_Plus = 'Galaxy S9 Plus',
687
677
  Galaxy_S10 = 'Galaxy S10',
688
678
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
689
679
  Galaxy_Note_10 = 'Galaxy Note 10',
@@ -816,6 +806,135 @@ export class BatchInfo implements Required<BatchInfoPlain> {
816
806
  addProperty(name: string, value: string): BatchInfo;
817
807
  addProperty(prop: PropertyDataPlain): BatchInfo;
818
808
  }
809
+ export type CheckSettingsImagePlain = {
810
+ name?: string;
811
+ region?: RegionPlain;
812
+ matchLevel?: MatchLevelPlain;
813
+ useDom?: boolean;
814
+ sendDom?: boolean;
815
+ enablePatterns?: boolean;
816
+ ignoreDisplacements?: boolean;
817
+ ignoreMismatch?: boolean;
818
+ ignoreCaret?: boolean;
819
+ ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
820
+ layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
821
+ strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
822
+ contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
823
+ floatingRegions?: Array<RegionPlain | {
824
+ region: RegionPlain;
825
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
826
+ regionId?: string;
827
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
828
+ } | {
829
+ region: RegionPlain;
830
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
831
+ regionId?: string;
832
+ maxUpOffset?: number;
833
+ maxDownOffset?: number;
834
+ maxLeftOffset?: number;
835
+ maxRightOffset?: number;
836
+ }>;
837
+ accessibilityRegions?: Array<RegionPlain | {
838
+ region: RegionPlain;
839
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
840
+ regionId?: string;
841
+ type?: AccessibilityRegionTypePlain;
842
+ }>;
843
+ pageId?: string;
844
+ variationGroupId?: string;
845
+ };
846
+ export class CheckSettingsImage {
847
+ constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
848
+ image: string | Buffer | URL;
849
+ name?: string;
850
+ dom?: string;
851
+ locationInViewport?: LocationPlain;
852
+ locationInView?: LocationPlain;
853
+ fullViewSize?: RectangleSizePlain;
854
+ });
855
+ image(image: string | Buffer | URL): CheckSettingsImage;
856
+ buffer(imageBuffer: Buffer): CheckSettingsImage;
857
+ base64(imageBase64: Buffer): CheckSettingsImage;
858
+ path(imagePath: string): CheckSettingsImage;
859
+ url(imageUrl: string | URL): CheckSettingsImage;
860
+ name(name: string): CheckSettingsImage;
861
+ withDom(dom: string): CheckSettingsImage;
862
+ withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
863
+ region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
864
+ withName(name: string): CheckSettingsImage;
865
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
866
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
867
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
868
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
869
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
870
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
871
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
872
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
873
+ floatingRegion(region: {
874
+ region: RegionPlain;
875
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
876
+ regionId?: string;
877
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
878
+ }): CheckSettingsImage;
879
+ floatingRegion(region: {
880
+ region: RegionPlain;
881
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
882
+ regionId?: string;
883
+ maxUpOffset?: number;
884
+ maxDownOffset?: number;
885
+ maxLeftOffset?: number;
886
+ maxRightOffset?: number;
887
+ }): CheckSettingsImage;
888
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
889
+ floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
890
+ region: RegionPlain;
891
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
892
+ regionId?: string;
893
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
894
+ }>): CheckSettingsImage;
895
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
896
+ accessibilityRegion(region: {
897
+ region: RegionPlain;
898
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
899
+ regionId?: string;
900
+ type?: AccessibilityRegionTypePlain;
901
+ }): CheckSettingsImage;
902
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
903
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
904
+ region: RegionPlain;
905
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
906
+ regionId?: string;
907
+ type?: AccessibilityRegionTypePlain;
908
+ }>): CheckSettingsImage;
909
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
910
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
911
+ layout(): CheckSettingsImage;
912
+ exact(): CheckSettingsImage;
913
+ strict(): CheckSettingsImage;
914
+ ignoreColors(): CheckSettingsImage;
915
+ enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
916
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
917
+ ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
918
+ useDom(useDom?: boolean): CheckSettingsImage;
919
+ sendDom(sendDom?: boolean): CheckSettingsImage;
920
+ pageId(pageId: string): CheckSettingsImage;
921
+ variationGroupId(variationGroupId: string): CheckSettingsImage;
922
+ }
923
+ export type TargetImage = {
924
+ image(image: string | Buffer | URL): CheckSettingsImage;
925
+ buffer(imageBuffer: Buffer): CheckSettingsImage;
926
+ base64(imageBase64: string): CheckSettingsImage;
927
+ path(imagePath: string): CheckSettingsImage;
928
+ url(imageUrl: string | URL): CheckSettingsImage;
929
+ };
930
+ export type TargetAutomation<TElement, TSelector> = {
931
+ window(): CheckSettingsAutomation;
932
+ region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
933
+ 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;
934
+ 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;
935
+ shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
936
+ webview(webview?: string | boolean): CheckSettingsAutomation;
937
+ };
819
938
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
820
939
  export class CutProvider implements Required<{
821
940
  x: number;