@applitools/eyes-puppeteer 1.11.3 → 1.12.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 (4) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/dist/api.js +8 -4
  3. package/package.json +7 -7
  4. package/types/index.d.ts +259 -177
package/CHANGELOG.md CHANGED
@@ -11,6 +11,32 @@
11
11
 
12
12
 
13
13
 
14
+ ## 1.12.0 - 2022/12/1
15
+
16
+ ### Features
17
+ - Added new selector extensions `child` and `fallback`
18
+ - Changed default value of `sendDom` from `true` to dynamically calculated
19
+ - Mark target element with `data-applitools-scroll` attribute before capture dom
20
+ - Added new iOS device - 'iPad Pro (11-inch) (4th generation)'
21
+ - Use user agent metadata to improve browser environment detection logic
22
+ - Use APPLITOOLS_CONCURRENCY env variable to specify concurrency
23
+ - Added `ignoreColors` method to `CheckSettings` to set a match level
24
+ ### Bug fixes
25
+ - Fixed issue with ufg renders failing intermittently
26
+ - Fixed error that was happening when test results were deleted
27
+ - Fixed bug that caused `extractText` to throw, due to fractional size of the target region
28
+ - Fix dontCloseBatches mapping
29
+
30
+ ## 1.11.4 - 2022/10/8
31
+
32
+ ### Features
33
+ - Applied client's user-agent by default to resource requests in ufg mode
34
+ ### Bug fixes
35
+ - Fixed wrong signature of `closeBatch` function
36
+ - Blank missed frames src in ufg
37
+ - Fix an issue when ufg related requests were not sent through the proxy
38
+ - Fixed issue with logs not being saved/written
39
+
14
40
  ## 1.11.3 - 2022/10/4
15
41
 
16
42
  ### Features
package/dist/api.js CHANGED
@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
26
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.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,12 +43,16 @@ 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;
54
57
  BatchClose._spec = sdk;
58
+ exports.closeBatch = api.closeBatch(sdk);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-puppeteer",
3
- "version": "1.11.3",
3
+ "version": "1.12.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.3",
66
- "@applitools/eyes-api": "1.8.2",
67
- "@applitools/spec-driver-puppeteer": "1.1.14"
65
+ "@applitools/core": "1.2.15",
66
+ "@applitools/eyes-api": "1.10.7",
67
+ "@applitools/spec-driver-puppeteer": "1.1.23"
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",
74
- "@applitools/sdk-shared": "0.9.14",
75
- "@applitools/test-utils": "1.5.1",
73
+ "@applitools/sdk-coverage-tests": "2.7.8",
74
+ "@applitools/sdk-shared": "0.9.15",
75
+ "@applitools/test-utils": "1.5.2",
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,18 +19,48 @@ 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;
33
- setLogHandler(handler: LogHandler): void;
61
+ getScrollRootElement(): Element<globalThis.Element> | EyesSelector<Selector>;
62
+ setScrollRootElement(scrollRootElement: Element<globalThis.Element> | EyesSelector<Selector>): void;
63
+ setLogHandler(handler: LogHandlerPlain | LogHandler): void;
34
64
  getLogHandler(): LogHandler;
35
65
  setCutProvider(cutProvider: CutProvider): void;
36
66
  setImageCut(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,103 @@ 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; };
449
413
  hooks?: { beforeCaptureScreenshot: string; };
450
414
  renderId?: string;
451
- pageId?: string;
452
- variationGroupId?: string;
453
415
  timeout?: number;
454
416
  waitBeforeCapture?: number;
455
417
  lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
456
- webview?: string | boolean;
457
418
  };
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;
419
+ export class CheckSettingsAutomation {
420
+ constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element<globalThis.Element>; isSelector(value: any): value is Selector; });
421
+ region(region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
422
+ shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
423
+ 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;
424
+ 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;
425
+ webview(webview?: string | boolean): CheckSettingsAutomation;
426
+ scrollRootElement(scrollRootElement: Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
427
+ fully(fully?: boolean): CheckSettingsAutomation;
428
+ disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
429
+ layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
430
+ hook(name: string, script: string): CheckSettingsAutomation;
431
+ beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
432
+ ufgOption(key: string, value: any): CheckSettingsAutomation;
433
+ ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
434
+ renderId(renderId: string): CheckSettingsAutomation;
435
+ timeout(timeout: number): CheckSettingsAutomation;
436
+ waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
437
+ lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
438
+ name(name: string): CheckSettingsAutomation;
439
+ withName(name: string): CheckSettingsAutomation;
440
+ 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;
441
+ 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;
442
+ 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;
443
+ 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;
444
+ 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;
445
+ 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;
446
+ 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;
447
+ 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
448
  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; };
449
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
450
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
476
451
  regionId?: string;
477
452
  offset?: { top?: number; bottom?: number; left?: number; right?: number; };
478
- }): CheckSettings;
453
+ }): CheckSettingsAutomation;
479
454
  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; };
455
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
456
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
482
457
  regionId?: string;
483
458
  maxUpOffset?: number;
484
459
  maxDownOffset?: number;
485
460
  maxLeftOffset?: number;
486
461
  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; };
462
+ }): CheckSettingsAutomation;
463
+ 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;
464
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
465
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
466
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
492
467
  regionId?: string;
493
468
  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;
469
+ }>): CheckSettingsAutomation;
470
+ 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
471
  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; };
472
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
473
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
499
474
  regionId?: string;
500
475
  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; };
476
+ }): CheckSettingsAutomation;
477
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
478
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
479
+ region: RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
480
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
506
481
  regionId?: string;
507
482
  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;
483
+ }>): CheckSettingsAutomation;
484
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element<globalThis.Element> | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
485
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
486
+ layout(): CheckSettingsAutomation;
487
+ exact(): CheckSettingsAutomation;
488
+ strict(): CheckSettingsAutomation;
489
+ ignoreColors(): CheckSettingsAutomation;
490
+ enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
491
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
492
+ ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
493
+ useDom(useDom?: boolean): CheckSettingsAutomation;
494
+ sendDom(sendDom?: boolean): CheckSettingsAutomation;
495
+ pageId(pageId: string): CheckSettingsAutomation;
496
+ variationGroupId(variationGroupId: string): CheckSettingsAutomation;
535
497
  }
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
- };
498
+ export class CheckSettings extends CheckSettingsAutomation {
499
+ }
500
+ export const Target: TargetImage & TargetAutomation<Element<globalThis.Element>, Selector>;
544
501
  export class BatchClose {
545
502
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
546
503
  constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
@@ -550,6 +507,7 @@ export class BatchClose {
550
507
  setApiKey(apiKey: string): BatchClose;
551
508
  setProxy(proxy: ProxySettingsPlain): BatchClose;
552
509
  }
510
+ export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
553
511
  export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
554
512
  export enum AccessibilityGuidelinesVersion {
555
513
  WCAG_2_0 = 'WCAG_2_0',
@@ -568,12 +526,12 @@ export enum AccessibilityRegionType {
568
526
  BoldText = 'BoldText',
569
527
  GraphicalObject = 'GraphicalObject'
570
528
  }
571
- export type AccessibilityStatusPlain = "Passed" | "Failed";
529
+ export type AccessibilityStatusPlain = "Failed" | "Passed";
572
530
  export enum AccessibilityStatus {
573
531
  Passed = 'Passed',
574
532
  Failed = 'Failed'
575
533
  }
576
- 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";
534
+ 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";
577
535
  export enum BrowserType {
578
536
  CHROME = 'chrome',
579
537
  CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
@@ -672,7 +630,7 @@ export enum FailureReport {
672
630
  IMMEDIATE = 'IMMEDIATE',
673
631
  ON_CLOSE = 'ON_CLOSE'
674
632
  }
675
- 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)";
633
+ 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)";
676
634
  export enum IosDeviceName {
677
635
  iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
678
636
  iPhone_14 = 'iPhone 14',
@@ -694,6 +652,7 @@ export enum IosDeviceName {
694
652
  iPhone_7 = 'iPhone 7',
695
653
  iPhone_SE = 'iPhone SE (1st generation)',
696
654
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
655
+ iPad_Pro_4 = 'iPad Pro (11-inch) (4th generation)',
697
656
  iPad_7 = 'iPad (7th generation)',
698
657
  iPad_9 = 'iPad (9th generation)',
699
658
  iPad_Air_2 = 'iPad Air (2nd generation)',
@@ -705,19 +664,13 @@ export enum IosVersion {
705
664
  ONE_VERSION_BACK = 'latest-1',
706
665
  LATEST_ONE_VERSION_BACK = 'latest-1'
707
666
  }
708
- 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";
667
+ 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";
709
668
  export enum AndroidDeviceName {
710
669
  Pixel_3_XL = 'Pixel 3 XL',
711
670
  Pixel_4 = 'Pixel 4',
712
671
  Pixel_4_XL = 'Pixel 4 XL',
713
672
  Pixel_5 = 'Pixel 5',
714
673
  Pixel_6 = 'Pixel 6',
715
- Galaxy_Note_8 = 'Galaxy Note 8',
716
- Galaxy_Note_9 = 'Galaxy Note 9',
717
- Galaxy_S8 = 'Galaxy S8',
718
- Galaxy_S8_Plus = 'Galaxy S8 Plus',
719
- Galaxy_S9 = 'Galaxy S9',
720
- Galaxy_S9_Plus = 'Galaxy S9 Plus',
721
674
  Galaxy_S10 = 'Galaxy S10',
722
675
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
723
676
  Galaxy_Note_10 = 'Galaxy Note 10',
@@ -732,21 +685,22 @@ export enum AndroidDeviceName {
732
685
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
733
686
  Galaxy_Tab_S8 = 'Galaxy Tab S8',
734
687
  Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
735
- Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro'
688
+ Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
689
+ Sony_Xperia_10_II = 'Sony Xperia 10 II'
736
690
  }
737
691
  export type AndroidVersionPlain = "latest" | "latest-1";
738
692
  export enum AndroidVersion {
739
693
  LATEST = 'latest',
740
694
  ONE_VERSION_BACK = 'latest-1'
741
695
  }
742
- export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColor" | "Strict" | "Exact";
696
+ export type MatchLevelPlain = "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
743
697
  export enum MatchLevel {
744
698
  None = 'None',
745
699
  LegacyLayout = 'Layout1',
746
700
  Layout = 'Layout',
747
701
  Layout2 = 'Layout2',
748
702
  Content = 'Content',
749
- IgnoreColor = 'IgnoreColor',
703
+ IgnoreColors = 'IgnoreColors',
750
704
  Strict = 'Strict',
751
705
  Exact = 'Exact'
752
706
  }
@@ -760,12 +714,12 @@ export enum SessionType {
760
714
  SEQUENTIAL = 'SEQUENTIAL',
761
715
  PROGRESSION = 'PROGRESSION'
762
716
  }
763
- export type StitchModePlain = "CSS" | "Scroll";
717
+ export type StitchModePlain = "Scroll" | "CSS";
764
718
  export enum StitchMode {
765
719
  SCROLL = 'Scroll',
766
720
  CSS = 'CSS'
767
721
  }
768
- export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
722
+ export type TestResultsStatusPlain = "Failed" | "Passed" | "Unresolved";
769
723
  export enum TestResultsStatus {
770
724
  Passed = 'Passed',
771
725
  Unresolved = 'Unresolved',
@@ -849,6 +803,135 @@ export class BatchInfo implements Required<BatchInfoPlain> {
849
803
  addProperty(name: string, value: string): BatchInfo;
850
804
  addProperty(prop: PropertyDataPlain): BatchInfo;
851
805
  }
806
+ export type CheckSettingsImagePlain = {
807
+ name?: string;
808
+ region?: RegionPlain;
809
+ matchLevel?: MatchLevelPlain;
810
+ useDom?: boolean;
811
+ sendDom?: boolean;
812
+ enablePatterns?: boolean;
813
+ ignoreDisplacements?: boolean;
814
+ ignoreMismatch?: boolean;
815
+ ignoreCaret?: boolean;
816
+ ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
817
+ layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
818
+ strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
819
+ contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
820
+ floatingRegions?: Array<RegionPlain | {
821
+ region: RegionPlain;
822
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
823
+ regionId?: string;
824
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
825
+ } | {
826
+ region: RegionPlain;
827
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
828
+ regionId?: string;
829
+ maxUpOffset?: number;
830
+ maxDownOffset?: number;
831
+ maxLeftOffset?: number;
832
+ maxRightOffset?: number;
833
+ }>;
834
+ accessibilityRegions?: Array<RegionPlain | {
835
+ region: RegionPlain;
836
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
837
+ regionId?: string;
838
+ type?: AccessibilityRegionTypePlain;
839
+ }>;
840
+ pageId?: string;
841
+ variationGroupId?: string;
842
+ };
843
+ export class CheckSettingsImage {
844
+ constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
845
+ image: string | URL | Buffer;
846
+ name?: string;
847
+ dom?: string;
848
+ locationInViewport?: LocationPlain;
849
+ locationInView?: LocationPlain;
850
+ fullViewSize?: RectangleSizePlain;
851
+ });
852
+ image(image: string | URL | Buffer): CheckSettingsImage;
853
+ buffer(imageBuffer: Buffer): CheckSettingsImage;
854
+ base64(imageBase64: Buffer): CheckSettingsImage;
855
+ path(imagePath: string): CheckSettingsImage;
856
+ url(imageUrl: string | URL): CheckSettingsImage;
857
+ name(name: string): CheckSettingsImage;
858
+ withDom(dom: string): CheckSettingsImage;
859
+ withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
860
+ region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
861
+ withName(name: string): CheckSettingsImage;
862
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
863
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
864
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
865
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
866
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
867
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
868
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
869
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
870
+ floatingRegion(region: {
871
+ region: RegionPlain;
872
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
873
+ regionId?: string;
874
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
875
+ }): CheckSettingsImage;
876
+ floatingRegion(region: {
877
+ region: RegionPlain;
878
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
879
+ regionId?: string;
880
+ maxUpOffset?: number;
881
+ maxDownOffset?: number;
882
+ maxLeftOffset?: number;
883
+ maxRightOffset?: number;
884
+ }): CheckSettingsImage;
885
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
886
+ floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
887
+ region: RegionPlain;
888
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
889
+ regionId?: string;
890
+ offset?: { top?: number; bottom?: number; left?: number; right?: number; };
891
+ }>): CheckSettingsImage;
892
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
893
+ accessibilityRegion(region: {
894
+ region: RegionPlain;
895
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
896
+ regionId?: string;
897
+ type?: AccessibilityRegionTypePlain;
898
+ }): CheckSettingsImage;
899
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
900
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
901
+ region: RegionPlain;
902
+ padding?: number | { top: number; bottom: number; let: number; right: number; };
903
+ regionId?: string;
904
+ type?: AccessibilityRegionTypePlain;
905
+ }>): CheckSettingsImage;
906
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
907
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
908
+ layout(): CheckSettingsImage;
909
+ exact(): CheckSettingsImage;
910
+ strict(): CheckSettingsImage;
911
+ ignoreColors(): CheckSettingsImage;
912
+ enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
913
+ ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
914
+ ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
915
+ useDom(useDom?: boolean): CheckSettingsImage;
916
+ sendDom(sendDom?: boolean): CheckSettingsImage;
917
+ pageId(pageId: string): CheckSettingsImage;
918
+ variationGroupId(variationGroupId: string): CheckSettingsImage;
919
+ }
920
+ export type TargetImage = {
921
+ image(image: string | URL | Buffer): CheckSettingsImage;
922
+ buffer(imageBuffer: Buffer): CheckSettingsImage;
923
+ base64(imageBase64: string): CheckSettingsImage;
924
+ path(imagePath: string): CheckSettingsImage;
925
+ url(imageUrl: string | URL): CheckSettingsImage;
926
+ };
927
+ export type TargetAutomation<TElement, TSelector> = {
928
+ window(): CheckSettingsAutomation;
929
+ region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
930
+ 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;
931
+ 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;
932
+ shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
933
+ webview(webview?: string | boolean): CheckSettingsAutomation;
934
+ };
852
935
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
853
936
  export class CutProvider implements Required<{
854
937
  x: number;
@@ -1361,7 +1444,7 @@ export type EyesSelector<TSelector = never> = string | TSelector | { selector: s
1361
1444
  export class Logger {
1362
1445
  constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1363
1446
  constructor(show?: boolean);
1364
- getLogHandler(): LogHandler;
1447
+ getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
1365
1448
  setLogHandler(handler: LogHandlerPlain): void;
1366
1449
  verbose(...messages: Array<any>): void;
1367
1450
  log(...messages: Array<any>): void;
@@ -1373,7 +1456,6 @@ export class Logger {
1373
1456
  tag(name: string, value: any): void;
1374
1457
  extend(label?: string): Logger;
1375
1458
  }
1376
- export function closeBatch(spec: BatchCloseSpec): (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
1377
1459
  export abstract class EyesRunner {
1378
1460
  getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1379
1461
  }