@applitools/eyes-puppeteer 1.11.4 → 1.13.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 +23 -0
  2. package/README.md +56 -38
  3. package/dist/api.js +7 -4
  4. package/package.json +6 -6
  5. package/types/index.d.ts +259 -174
package/CHANGELOG.md CHANGED
@@ -11,6 +11,29 @@
11
11
 
12
12
 
13
13
 
14
+ ## 1.13.0 - 2022/12/20
15
+
16
+ ### Features
17
+ ### Bug fixes
18
+ - Handle fake shadowRoot with UFG
19
+ - Handed error during polling in long requests to eyes server
20
+
21
+ ## 1.12.0 - 2022/12/1
22
+
23
+ ### Features
24
+ - Added new selector extensions `child` and `fallback`
25
+ - Changed default value of `sendDom` from `true` to dynamically calculated
26
+ - Mark target element with `data-applitools-scroll` attribute before capture dom
27
+ - Added new iOS device - 'iPad Pro (11-inch) (4th generation)'
28
+ - Use user agent metadata to improve browser environment detection logic
29
+ - Use APPLITOOLS_CONCURRENCY env variable to specify concurrency
30
+ - Added `ignoreColors` method to `CheckSettings` to set a match level
31
+ ### Bug fixes
32
+ - Fixed issue with ufg renders failing intermittently
33
+ - Fixed error that was happening when test results were deleted
34
+ - Fixed bug that caused `extractText` to throw, due to fractional size of the target region
35
+ - Fix dontCloseBatches mapping
36
+
14
37
  ## 1.11.4 - 2022/10/8
15
38
 
16
39
  ### Features
package/README.md CHANGED
@@ -7,52 +7,55 @@
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
- * [Other checkSettings configuration](#other-checksettings-configuration)
33
- * [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
+ - [Working with frames](#working-with-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
+ - [Lazy loading (`lazyLoad`)](#lazy-loading-lazyload)
32
+ - [Other checkSettings configuration](#other-checksettings-configuration)
33
+ - [close](#close)
34
34
  - [Runners](#runners)
35
- * [Purpose of runners](#purpose-of-runners)
36
- + [1. Use the Ultrafast grid](#1-use-the-ultra-fast-grid)
37
- + [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
35
+ - [Purpose of runners](#purpose-of-runners)
36
+ - [1. Use the Ultrafast grid](#1-use-the-ultrafast-grid)
37
+ - [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
38
38
  - [Recipes for common tasks](#recipes-for-common-tasks)
39
- * [Configure Server URL](#configure-server-url)
40
- * [Configure Proxy](#configure-proxy)
41
- * [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
42
- * [Organize tests in batches](#organize-tests-in-batches)
43
- + [Method 1: environment variable](#method-1--environment-variable)
44
- + [Method 2: `eyes.setBatch`](#method-2--eyessetbatch)
45
- * [Stitch mode](#stitch-mode)
46
- + [Background information](#background-information)
39
+ - [Configure Server URL](#configure-server-url)
40
+ - [Configure Proxy](#configure-proxy)
41
+ - [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
42
+ - [Organize tests in batches](#organize-tests-in-batches)
43
+ - [Method 1: environment variable](#method-1-environment-variable)
44
+ - [Method 2: `eyes.setBatch`](#method-2-eyessetbatch)
45
+ - [Stitch mode](#stitch-mode)
46
+ - [Background information](#background-information)
47
47
  - [1. Stitch mode: Scroll](#1-stitch-mode-scroll)
48
48
  - [2. Stitch mode: CSS](#2-stitch-mode-css)
49
- * [Stitch overlap](#stitch-overlap)
50
- * [Match level](#match-level)
51
- * [Ignore displacements](#ignore-displacements)
52
- * [Test properties](#test-properties)
53
- * [Test results](#test-results)
54
- * [Logging](#logging)
55
- * [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultra-fast-grid)
49
+ - [Stitch overlap](#stitch-overlap)
50
+ - [Match level](#match-level)
51
+ - [Ignore displacements](#ignore-displacements)
52
+ - [Test properties](#test-properties)
53
+ - [Test results](#test-results)
54
+ - [Logging](#logging)
55
+ - [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultrafast-grid)
56
+ - [Desktop browsers](#desktop-browsers)
57
+ - [Chrome device emulation](#chrome-device-emulation)
58
+ - [iOS device](#ios-device)
56
59
 
57
60
 
58
61
  ## Installation
@@ -716,7 +719,7 @@ It's possible to provide additional information about each test in custom fields
716
719
  This is done by calling `setProperties` on the configuration, and providing it with an array of properties with the structure `{name, value}`. For example:
717
720
 
718
721
  ```js
719
- const {Eyes, Target} = require('@applitools/eyes-puppeteer')
722
+ const {Eyes} = require('@applitools/eyes-puppeteer')
720
723
 
721
724
  const eyes = new Eyes()
722
725
 
@@ -725,6 +728,21 @@ configuration.setProperties([{name: 'my custom property', value: 'some value'}])
725
728
  eyes.setConfiguration(configuration)
726
729
  ```
727
730
 
731
+ 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:
732
+
733
+ ```js
734
+ const {Eyes, BatchInfo} = require('@applitools/eyes-puppeteer')
735
+
736
+ const eyes = new Eyes()
737
+
738
+ const batch = new BatchInfo()
739
+ batch.setProperties([{name: 'my custom batch property', value: 'some value'}])
740
+
741
+ const configuration = eyes.getConfiguration()
742
+ configuration.setBatch(batch)
743
+ eyes.setConfiguration(configuration)
744
+ ```
745
+
728
746
  ### Test results
729
747
 
730
748
  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-puppeteer"));
@@ -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-puppeteer",
3
- "version": "1.11.4",
3
+ "version": "1.13.0",
4
4
  "description": "Applitools Eyes SDK for Puppeteer",
5
5
  "keywords": [
6
6
  "eyes-puppeteer",
@@ -62,17 +62,17 @@
62
62
  }
63
63
  },
64
64
  "dependencies": {
65
- "@applitools/core": "1.1.5",
66
- "@applitools/eyes-api": "1.8.5",
67
- "@applitools/spec-driver-puppeteer": "1.1.16"
65
+ "@applitools/core": "1.3.3",
66
+ "@applitools/eyes-api": "1.11.2",
67
+ "@applitools/spec-driver-puppeteer": "1.1.28"
68
68
  },
69
69
  "devDependencies": {
70
70
  "@applitools/api-extractor": "1.2.11",
71
71
  "@applitools/bongo": "^2.2.0",
72
72
  "@applitools/scripts": "1.2.0",
73
- "@applitools/sdk-coverage-tests": "2.3.20",
73
+ "@applitools/sdk-coverage-tests": "2.7.10",
74
74
  "@applitools/sdk-shared": "0.9.15",
75
- "@applitools/test-utils": "1.5.2",
75
+ "@applitools/test-utils": "1.5.4",
76
76
  "@types/mocha": "^9.1.1",
77
77
  "@types/node": "12",
78
78
  "@typescript-eslint/eslint-plugin": "^5.27.0",
package/types/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export type Driver = import('puppeteer').Page & { __applitoolsBrand?: never; };
2
- export type Element = import('puppeteer').ElementHandle & { __applitoolsBrand?: never; };
2
+ export type Element<T extends globalThis.Element = globalThis.Element> = import('puppeteer').ElementHandle<T> & { __applitoolsBrand?: never; };
3
3
  export type Selector = string & { __applitoolsBrand?: never; };
4
4
  export class Eyes {
5
5
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
@@ -19,17 +19,47 @@ 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 | URL | Buffer;
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 | URL | Buffer;
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 | URL | Buffer;
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>;
29
59
  getViewportSize(): Promise<RectangleSize>;
30
60
  setViewportSize(size: RectangleSizePlain): Promise<void>;
31
- getScrollRootElement(): Element | EyesSelector<Selector>;
32
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
61
+ getScrollRootElement(): Element<globalThis.Element> | EyesSelector<Selector>;
62
+ setScrollRootElement(scrollRootElement: Element<globalThis.Element> | EyesSelector<Selector>): void;
33
63
  setLogHandler(handler: LogHandlerPlain | LogHandler): void;
34
64
  getLogHandler(): LogHandler;
35
65
  setCutProvider(cutProvider: CutProvider): void;
@@ -112,14 +142,7 @@ export type ConfigurationPlain = {
112
142
  apiKey?: string;
113
143
  serverUrl?: string;
114
144
  proxy?: ProxySettingsPlain;
115
- autProxy?: {
116
- url: string;
117
- username?: string;
118
- password?: string;
119
- isHttpOnly?: boolean;
120
- mode?: "Allow" | "Block";
121
- domains?: Array<string>;
122
- };
145
+ autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
123
146
  isDisabled?: boolean;
124
147
  appName?: string;
125
148
  testName?: string;
@@ -153,7 +176,7 @@ export type ConfigurationPlain = {
153
176
  hideScrollbars?: boolean;
154
177
  hideCaret?: boolean;
155
178
  stitchOverlap?: number;
156
- scrollRootElement?: Element | EyesSelector<Selector>;
179
+ scrollRootElement?: Element<globalThis.Element> | EyesSelector<Selector>;
157
180
  cut?: CutProviderPlain;
158
181
  rotation?: ImageRotationPlain;
159
182
  scaleRatio?: number;
@@ -164,7 +187,7 @@ export type ConfigurationPlain = {
164
187
  disableBrowserFetching?: boolean;
165
188
  };
166
189
  export class Configuration implements Required<ConfigurationPlain> {
167
- constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
190
+ constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element<globalThis.Element>; isSelector(selector: any): selector is Selector; });
168
191
  get appName(): string;
169
192
  set appName(appName: string);
170
193
  getAppName(): string;
@@ -211,38 +234,10 @@ export class Configuration implements Required<ConfigurationPlain> {
211
234
  setProxy(proxy: ProxySettingsPlain): Configuration;
212
235
  setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
213
236
  setProxy(isEnabled: false): Configuration;
214
- get autProxy(): {
215
- url: string;
216
- username?: string;
217
- password?: string;
218
- isHttpOnly?: boolean;
219
- mode?: "Allow" | "Block";
220
- domains?: Array<string>;
221
- };
222
- set autProxy(autProxy: {
223
- url: string;
224
- username?: string;
225
- password?: string;
226
- isHttpOnly?: boolean;
227
- mode?: "Allow" | "Block";
228
- domains?: Array<string>;
229
- });
230
- getAutProxy(): {
231
- url: string;
232
- username?: string;
233
- password?: string;
234
- isHttpOnly?: boolean;
235
- mode?: "Allow" | "Block";
236
- domains?: Array<string>;
237
- };
238
- setAutProxy(autProxy: {
239
- url: string;
240
- username?: string;
241
- password?: string;
242
- isHttpOnly?: boolean;
243
- mode?: "Allow" | "Block";
244
- domains?: Array<string>;
245
- }): Configuration;
237
+ get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
238
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
239
+ getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
240
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
246
241
  get batch(): BatchInfoPlain;
247
242
  set batch(batch: BatchInfoPlain);
248
243
  getBatch(): BatchInfo;
@@ -366,10 +361,10 @@ export class Configuration implements Required<ConfigurationPlain> {
366
361
  set stitchOverlap(stitchOverlap: number);
367
362
  getStitchOverlap(): number;
368
363
  setStitchOverlap(stitchOverlap: number): Configuration;
369
- get scrollRootElement(): Element | EyesSelector<Selector>;
370
- set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
371
- getScrollRootElement(): Element | EyesSelector<Selector>;
372
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
364
+ get scrollRootElement(): Element<globalThis.Element> | EyesSelector<Selector>;
365
+ set scrollRootElement(scrollRootElement: Element<globalThis.Element> | EyesSelector<Selector>);
366
+ getScrollRootElement(): Element<globalThis.Element> | EyesSelector<Selector>;
367
+ setScrollRootElement(scrollRootElement: Element<globalThis.Element> | EyesSelector<Selector>): Configuration;
373
368
  get cut(): CutProviderPlain;
374
369
  set cut(cut: CutProviderPlain);
375
370
  getCut(): CutProviderPlain;
@@ -406,141 +401,106 @@ export class Configuration implements Required<ConfigurationPlain> {
406
401
  getDisableBrowserFetching(): boolean;
407
402
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
408
403
  }
409
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
410
- export type CheckSettingsPlain = {
411
- name?: string;
412
- region?: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
413
- 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>; })))>;
414
- scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
404
+ export type OCRRegion = { target: Element<globalThis.Element> | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
405
+ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
406
+ frames?: Array<{ frame: number | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); } | (number | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
407
+ webview?: string | boolean;
408
+ scrollRootElement?: Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
415
409
  fully?: boolean;
416
- matchLevel?: MatchLevelPlain;
417
- useDom?: boolean;
418
- sendDom?: boolean;
419
- enablePatterns?: boolean;
420
- ignoreDisplacements?: boolean;
421
- ignoreCaret?: boolean;
422
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
423
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
424
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
425
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
426
- floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
427
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
428
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
429
- regionId?: string;
430
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
431
- } | {
432
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
433
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
434
- regionId?: string;
435
- maxUpOffset?: number;
436
- maxDownOffset?: number;
437
- maxLeftOffset?: number;
438
- maxRightOffset?: number;
439
- }>;
440
- accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
441
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
442
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
443
- regionId?: string;
444
- type?: AccessibilityRegionTypePlain;
445
- }>;
446
410
  disableBrowserFetching?: boolean;
447
411
  layoutBreakpoints?: boolean | Array<number>;
448
412
  visualGridOptions?: { [key: string]: any; };
413
+ nmgOptions?: { [key: string]: any; };
449
414
  hooks?: { beforeCaptureScreenshot: string; };
450
415
  renderId?: string;
451
- pageId?: string;
452
- variationGroupId?: string;
453
416
  timeout?: number;
454
417
  waitBeforeCapture?: number;
455
418
  lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
456
- webview?: string | boolean;
457
419
  };
458
- export class CheckSettings {
459
- constructor(settings?: CheckSettings | CheckSettingsPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
460
- withName(name: string): CheckSettings;
461
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
462
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
463
- 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;
464
- 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;
465
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
466
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
467
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
468
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
469
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
470
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
471
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
472
- 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; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
420
+ export class CheckSettingsAutomation {
421
+ constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element<globalThis.Element>; isSelector(value: any): value is Selector; });
422
+ region(region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettingsAutomation;
425
+ frame(frame: number | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element<globalThis.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<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element<globalThis.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;
473
451
  floatingRegion(region: {
474
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
475
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
452
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
453
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
476
454
  regionId?: string;
477
455
  offset?: { top?: number; bottom?: number; left?: number; right?: number; };
478
- }): CheckSettings;
456
+ }): CheckSettingsAutomation;
479
457
  floatingRegion(region: {
480
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
481
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
458
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
459
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
482
460
  regionId?: string;
483
461
  maxUpOffset?: number;
484
462
  maxDownOffset?: number;
485
463
  maxLeftOffset?: number;
486
464
  maxRightOffset?: number;
487
- }): CheckSettings;
488
- 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;
489
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
490
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
491
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
465
+ }): CheckSettingsAutomation;
466
+ floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsAutomation;
467
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
468
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
469
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
492
470
  regionId?: string;
493
471
  offset?: { top?: number; bottom?: number; left?: number; right?: number; };
494
- }>): CheckSettings;
495
- 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<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
496
474
  accessibilityRegion(region: {
497
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
498
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
475
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
476
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
499
477
  regionId?: string;
500
478
  type?: AccessibilityRegionTypePlain;
501
- }): CheckSettings;
502
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
503
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
504
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
505
- padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
479
+ }): CheckSettingsAutomation;
480
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
481
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
482
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
483
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
506
484
  regionId?: string;
507
485
  type?: AccessibilityRegionTypePlain;
508
- }>): CheckSettings;
509
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
510
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
511
- fully(fully?: boolean): CheckSettings;
512
- matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
513
- layout(): CheckSettings;
514
- exact(): CheckSettings;
515
- strict(): CheckSettings;
516
- content(): CheckSettings;
517
- useDom(useDom?: boolean): CheckSettings;
518
- sendDom(sendDom?: boolean): CheckSettings;
519
- enablePatterns(enablePatterns?: boolean): CheckSettings;
520
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettings;
521
- ignoreCaret(ignoreCaret?: boolean): CheckSettings;
522
- disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
523
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
524
- hook(name: string, script: string): CheckSettings;
525
- beforeRenderScreenshotHook(script: string): CheckSettings;
526
- ufgOption(key: string, value: any): CheckSettings;
527
- ufgOptions(options: { [key: string]: any; }): CheckSettings;
528
- renderId(renderId: string): CheckSettings;
529
- pageId(pageId: string): CheckSettings;
530
- variationGroupId(variationGroupId: string): CheckSettings;
531
- timeout(timeout: number): CheckSettings;
532
- waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
533
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
534
- webview(option?: string | boolean): CheckSettings;
486
+ }>): CheckSettingsAutomation;
487
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.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;
535
500
  }
536
- export const Target: {
537
- window(): CheckSettings;
538
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
539
- 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;
540
- 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;
541
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
542
- webview(option?: string | boolean): CheckSettings;
543
- };
501
+ export class CheckSettings extends CheckSettingsAutomation {
502
+ }
503
+ export const Target: TargetImage & TargetAutomation<Element<globalThis.Element>, Selector>;
544
504
  export class BatchClose {
545
505
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
546
506
  constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
@@ -569,12 +529,12 @@ export enum AccessibilityRegionType {
569
529
  BoldText = 'BoldText',
570
530
  GraphicalObject = 'GraphicalObject'
571
531
  }
572
- export type AccessibilityStatusPlain = "Passed" | "Failed";
532
+ export type AccessibilityStatusPlain = "Failed" | "Passed";
573
533
  export enum AccessibilityStatus {
574
534
  Passed = 'Passed',
575
535
  Failed = 'Failed'
576
536
  }
577
- export type BrowserTypePlain = "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back";
537
+ export type BrowserTypePlain = "chrome" | "firefox" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back";
578
538
  export enum BrowserType {
579
539
  CHROME = 'chrome',
580
540
  CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
@@ -673,7 +633,7 @@ export enum FailureReport {
673
633
  IMMEDIATE = 'IMMEDIATE',
674
634
  ON_CLOSE = 'ON_CLOSE'
675
635
  }
676
- 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)";
677
637
  export enum IosDeviceName {
678
638
  iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
679
639
  iPhone_14 = 'iPhone 14',
@@ -695,6 +655,7 @@ export enum IosDeviceName {
695
655
  iPhone_7 = 'iPhone 7',
696
656
  iPhone_SE = 'iPhone SE (1st generation)',
697
657
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
658
+ iPad_Pro_4 = 'iPad Pro (11-inch) (4th generation)',
698
659
  iPad_7 = 'iPad (7th generation)',
699
660
  iPad_9 = 'iPad (9th generation)',
700
661
  iPad_Air_2 = 'iPad Air (2nd generation)',
@@ -706,19 +667,13 @@ export enum IosVersion {
706
667
  ONE_VERSION_BACK = 'latest-1',
707
668
  LATEST_ONE_VERSION_BACK = 'latest-1'
708
669
  }
709
- 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" | "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";
710
671
  export enum AndroidDeviceName {
711
672
  Pixel_3_XL = 'Pixel 3 XL',
712
673
  Pixel_4 = 'Pixel 4',
713
674
  Pixel_4_XL = 'Pixel 4 XL',
714
675
  Pixel_5 = 'Pixel 5',
715
676
  Pixel_6 = 'Pixel 6',
716
- Galaxy_Note_8 = 'Galaxy Note 8',
717
- Galaxy_Note_9 = 'Galaxy Note 9',
718
- Galaxy_S8 = 'Galaxy S8',
719
- Galaxy_S8_Plus = 'Galaxy S8 Plus',
720
- Galaxy_S9 = 'Galaxy S9',
721
- Galaxy_S9_Plus = 'Galaxy S9 Plus',
722
677
  Galaxy_S10 = 'Galaxy S10',
723
678
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
724
679
  Galaxy_Note_10 = 'Galaxy Note 10',
@@ -733,21 +688,22 @@ export enum AndroidDeviceName {
733
688
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
734
689
  Galaxy_Tab_S8 = 'Galaxy Tab S8',
735
690
  Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
736
- Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro'
691
+ Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
692
+ Sony_Xperia_10_II = 'Sony Xperia 10 II'
737
693
  }
738
694
  export type AndroidVersionPlain = "latest" | "latest-1";
739
695
  export enum AndroidVersion {
740
696
  LATEST = 'latest',
741
697
  ONE_VERSION_BACK = 'latest-1'
742
698
  }
743
- export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColor" | "Strict" | "Exact";
699
+ export type MatchLevelPlain = "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
744
700
  export enum MatchLevel {
745
701
  None = 'None',
746
702
  LegacyLayout = 'Layout1',
747
703
  Layout = 'Layout',
748
704
  Layout2 = 'Layout2',
749
705
  Content = 'Content',
750
- IgnoreColor = 'IgnoreColor',
706
+ IgnoreColors = 'IgnoreColors',
751
707
  Strict = 'Strict',
752
708
  Exact = 'Exact'
753
709
  }
@@ -761,12 +717,12 @@ export enum SessionType {
761
717
  SEQUENTIAL = 'SEQUENTIAL',
762
718
  PROGRESSION = 'PROGRESSION'
763
719
  }
764
- export type StitchModePlain = "CSS" | "Scroll";
720
+ export type StitchModePlain = "Scroll" | "CSS";
765
721
  export enum StitchMode {
766
722
  SCROLL = 'Scroll',
767
723
  CSS = 'CSS'
768
724
  }
769
- export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
725
+ export type TestResultsStatusPlain = "Failed" | "Passed" | "Unresolved";
770
726
  export enum TestResultsStatus {
771
727
  Passed = 'Passed',
772
728
  Unresolved = 'Unresolved',
@@ -850,6 +806,135 @@ export class BatchInfo implements Required<BatchInfoPlain> {
850
806
  addProperty(name: string, value: string): BatchInfo;
851
807
  addProperty(prop: PropertyDataPlain): BatchInfo;
852
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 | URL | Buffer;
849
+ name?: string;
850
+ dom?: string;
851
+ locationInViewport?: LocationPlain;
852
+ locationInView?: LocationPlain;
853
+ fullViewSize?: RectangleSizePlain;
854
+ });
855
+ image(image: string | URL | Buffer): 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 | URL | Buffer): 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
+ };
853
938
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
854
939
  export class CutProvider implements Required<{
855
940
  x: number;