@applitools/eyes-playwright 1.42.5 → 1.44.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,82 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.44.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.43.0...js/eyes-playwright@1.44.0) (2026-01-19)
4
+
5
+
6
+ ### Features
7
+
8
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * @applitools/driver bumped to 1.25.0
14
+ #### Features
15
+
16
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
17
+ * @applitools/spec-driver-playwright bumped to 1.8.0
18
+ #### Features
19
+
20
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
21
+
22
+
23
+
24
+ * @applitools/spec-driver-puppeteer bumped to 1.7.0
25
+ #### Features
26
+
27
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
28
+
29
+
30
+
31
+ * @applitools/core bumped to 4.55.0
32
+ #### Features
33
+
34
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
35
+
36
+
37
+
38
+ * @applitools/dom-snapshot bumped to 4.15.6
39
+
40
+ * @applitools/spec-driver-webdriver bumped to 1.5.5
41
+
42
+ * @applitools/spec-driver-selenium bumped to 1.7.11
43
+
44
+ * @applitools/screenshoter bumped to 3.12.12
45
+
46
+ * @applitools/nml-client bumped to 1.11.15
47
+
48
+ * @applitools/ec-client bumped to 1.12.17
49
+
50
+ * @applitools/eyes bumped to 1.38.0
51
+ #### Features
52
+
53
+ * multi-page support - FLD-3827 ([#3410](https://github.com/Applitools-Dev/sdk/issues/3410)) ([a55b982](https://github.com/Applitools-Dev/sdk/commit/a55b9827c2218c11da5ed61b38bf12a70ce4c8db))
54
+
55
+
56
+
57
+
58
+ ## [1.43.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.42.5...js/eyes-playwright@1.43.0) (2026-01-14)
59
+
60
+
61
+ ### Features
62
+
63
+ * expose buildId in BatchInfo type | FLD-4020 ([#3466](https://github.com/Applitools-Dev/sdk/issues/3466)) ([7868ba0](https://github.com/Applitools-Dev/sdk/commit/7868ba08de9a9d348c42d8eac5a953dce44844d0))
64
+
65
+
66
+ ### Dependencies
67
+
68
+ * @applitools/core bumped to 4.54.3
69
+ #### Bug Fixes
70
+
71
+ * `close`/`getResults` race condition ([#3450](https://github.com/Applitools-Dev/sdk/issues/3450)) ([2e5437d](https://github.com/Applitools-Dev/sdk/commit/2e5437dcfde6fda58d76227659ee249bfa3885a7))
72
+ * @applitools/eyes bumped to 1.37.0
73
+ #### Features
74
+
75
+ * expose buildId in BatchInfo type | FLD-4020 ([#3466](https://github.com/Applitools-Dev/sdk/issues/3466)) ([7868ba0](https://github.com/Applitools-Dev/sdk/commit/7868ba08de9a9d348c42d8eac5a953dce44844d0))
76
+
77
+
78
+
79
+
3
80
  ## [1.42.5](https://github.com/Applitools-Dev/sdk/compare/js/eyes-playwright@1.42.4...js/eyes-playwright@1.42.5) (2026-01-11)
4
81
 
5
82
 
@@ -46,6 +46,13 @@ exports.test = test_1.test.extend({
46
46
  ;
47
47
  page.__eyesRunner = eyesRunner;
48
48
  page.__eyesConfig = eyesConfig; // TODO merge playwrightConfig, projectConfig, eyesConfig
49
+ // Track main page for multi-page support: all new pages in the same context should reference this main page
50
+ // Runner and config can be accessed via page.__eyesMainPage.__eyesRunner and page.__eyesMainPage.__eyesConfig
51
+ const context = page.context();
52
+ context.on('page', newPage => {
53
+ ;
54
+ newPage.__eyesMainPage = page;
55
+ });
49
56
  await use(page);
50
57
  },
51
58
  eyes: [
@@ -6,7 +6,7 @@ const index_1 = require("./index");
6
6
  const getEyes_1 = require("./getEyes");
7
7
  exports.expect = test_1.expect.extend({
8
8
  async toHaveScreenshot(pageOrLocator, nameOrOptions = {}, optOptions = {}) {
9
- var _a, _b, _c, _d, _e, _f;
9
+ var _a, _b, _c, _d, _e, _f, _g;
10
10
  const testInfo = index_1.test.info();
11
11
  if (!testInfo) {
12
12
  throw new Error(`toHaveScreenshot() must be called during the test`);
@@ -24,9 +24,12 @@ exports.expect = test_1.expect.extend({
24
24
  // }
25
25
  }
26
26
  expectTypes(pageOrLocator, ['Page', 'Locator'], 'toHaveScreenshot');
27
- const [page, locator] = pageOrLocator.constructor.name === 'Page'
27
+ const [targetPage, locator] = pageOrLocator.constructor.name === 'Page'
28
28
  ? [pageOrLocator, undefined]
29
29
  : [pageOrLocator.page(), pageOrLocator];
30
+ // For multi-page support: Always use the main page that has Eyes opened
31
+ // If targetPage has no Eyes instance, fall back to the targetPage itself (backward compatibility)
32
+ const mainPage = targetPage.__eyes ? targetPage : (_b = targetPage.__eyesMainPage) !== null && _b !== void 0 ? _b : targetPage;
30
33
  const options = {
31
34
  ...optOptions,
32
35
  ...(typeof nameOrOptions === 'object' ? nameOrOptions : {}),
@@ -95,9 +98,9 @@ exports.expect = test_1.expect.extend({
95
98
  console.warn(`${message}, because Applitools utilizes smarter comparison algorithms that mimic the humn eyesight, and therefore do not require using that option. Feel free to remove that hard-coded configuration as it's not used and no longer needed.`);
96
99
  }
97
100
  }
98
- const configuration = (_b = page.__eyesConfig) !== null && _b !== void 0 ? _b : {};
101
+ const configuration = (_c = mainPage.__eyesConfig) !== null && _c !== void 0 ? _c : {};
99
102
  configuration.properties = [
100
- ...((_c = configuration.properties) !== null && _c !== void 0 ? _c : []),
103
+ ...((_d = configuration.properties) !== null && _d !== void 0 ? _d : []),
101
104
  {
102
105
  name: 'playwright expect toHaveScreenshot options',
103
106
  value: JSON.stringify(options),
@@ -115,9 +118,9 @@ exports.expect = test_1.expect.extend({
115
118
  }
116
119
  await (await (0, getEyes_1.getEyes)({
117
120
  testInfo,
118
- eyesConfig: (_d = page.__eyesConfig) !== null && _d !== void 0 ? _d : {},
119
- eyesRunner: (_e = page.__eyesRunner) !== null && _e !== void 0 ? _e : {},
120
- page,
121
+ eyesConfig: (_e = mainPage.__eyesConfig) !== null && _e !== void 0 ? _e : {},
122
+ eyesRunner: (_f = mainPage.__eyesRunner) !== null && _f !== void 0 ? _f : {},
123
+ page: mainPage,
121
124
  })).check({
122
125
  name: typeof nameOrOptions === 'string'
123
126
  ? nameOrOptions
@@ -126,8 +129,9 @@ exports.expect = test_1.expect.extend({
126
129
  : typeof (nameOrOptions === null || nameOrOptions === void 0 ? void 0 : nameOrOptions.name) === 'string'
127
130
  ? nameOrOptions.name
128
131
  : undefined,
132
+ page: targetPage !== mainPage ? targetPage : undefined,
129
133
  region: locator !== null && locator !== void 0 ? locator : options.clip,
130
- fully: (_f = options.fullPage) !== null && _f !== void 0 ? _f : configuration.fully,
134
+ fully: (_g = options.fullPage) !== null && _g !== void 0 ? _g : configuration.fully,
131
135
  ignoreRegions: options.mask,
132
136
  });
133
137
  return {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-playwright",
3
- "version": "1.42.5",
3
+ "version": "1.44.0",
4
4
  "description": "Applitools Eyes SDK for Playwright",
5
5
  "keywords": [
6
6
  "eyes-playwright",
@@ -52,16 +52,16 @@
52
52
  "build:cli": "cp -R src/fixture/example dist/fixture",
53
53
  "generate:tests": "NODE_OPTIONS='--experimental-import-meta-resolve --experimental-loader=@applitools/generic/dist/code-loader.js' generic ./test/generic/config.mjs",
54
54
  "test": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) run --top-level mocha './test/*.spec.{js,ts}' --exit",
55
- "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-8} --exit",
55
+ "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-3} --exit",
56
56
  "test:fixture": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(npx uuid).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright-fixture' APPLITOOLS_BATCH_ID=$(npx uuid) run playwright test",
57
57
  "setup": "run playwright:setup && run --top-level xvfb:setup",
58
58
  "playwright:setup": "yarn playwright install --with-deps chromium firefox webkit",
59
59
  "up:framework": "echo \"$(jq '.devDependencies.playwright = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
60
60
  },
61
61
  "dependencies": {
62
- "@applitools/eyes": "1.36.20",
62
+ "@applitools/eyes": "1.38.0",
63
63
  "@applitools/req": "1.8.7",
64
- "@applitools/spec-driver-playwright": "1.7.10",
64
+ "@applitools/spec-driver-playwright": "1.8.0",
65
65
  "@applitools/utils": "1.14.1",
66
66
  "@inquirer/prompts": "7.0.1",
67
67
  "chalk": "4.1.2",
package/types/index.d.ts CHANGED
@@ -10,6 +10,126 @@ export type SpecType = {
10
10
  secondary: never;
11
11
  userFunction: unknown;
12
12
  };
13
+ export type CheckSettingsAutomationWithOptIn<TSpec extends SpecType> = {
14
+ name?: undefined | string;
15
+ region?: undefined | RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain;
16
+ matchLevel?: undefined | MatchLevelPlain;
17
+ useDom?: undefined | boolean;
18
+ sendDom?: undefined | boolean;
19
+ enablePatterns?: undefined | boolean;
20
+ ignoreDisplacements?: undefined | boolean;
21
+ ignoreMismatch?: undefined | boolean;
22
+ ignoreCaret?: undefined | boolean;
23
+ ignoreRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
24
+ layoutRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
25
+ strictRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
26
+ contentRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
27
+ floatingRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | {
28
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain;
29
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
30
+ regionId?: undefined | string;
31
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
32
+ } | {
33
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain;
34
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
35
+ regionId?: undefined | string;
36
+ maxUpOffset?: undefined | number;
37
+ maxDownOffset?: undefined | number;
38
+ maxLeftOffset?: undefined | number;
39
+ maxRightOffset?: undefined | number;
40
+ }>;
41
+ accessibilityRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain | {
42
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain;
43
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
44
+ regionId?: undefined | string;
45
+ type?: undefined | AccessibilityRegionTypePlain;
46
+ }>;
47
+ dynamicRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | {
48
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | TSpec["driver"]; }) | { selector: string | TSpec["selector"]; page?: undefined | TSpec["driver"]; } | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))) | LegacyRegionPlain;
49
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
50
+ regionId?: undefined | string;
51
+ type?: undefined | string | Array<string>;
52
+ }>;
53
+ pageId?: undefined | string;
54
+ variationGroupId?: undefined | string;
55
+ densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
56
+ stitchMode?: undefined | StitchModePlain;
57
+ } & {
58
+ frames?: undefined | Array<{ frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); } | (number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })))>;
59
+ webview?: undefined | string | boolean;
60
+ scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }));
61
+ fully?: undefined | boolean;
62
+ disableBrowserFetching?: undefined | boolean;
63
+ layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
64
+ visualGridOptions?: undefined | { [key: string]: any; };
65
+ ufgOptions?: undefined | { [key: string]: any; };
66
+ nmgOptions?: undefined | { [key: string]: any; };
67
+ useSystemScreenshot?: undefined | boolean;
68
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
69
+ timeout?: undefined | number;
70
+ waitBeforeCapture?: undefined | number | (() => Promise<void>);
71
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
72
+ } & import('../eyes/types/input/CheckSettings.d.ts').CheckSettingsOptIn<TSpec, ["page"]>;
73
+ export type CheckSettingsAutomationWithOptInPlan = {
74
+ name?: undefined | string;
75
+ region?: undefined | RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain;
76
+ matchLevel?: undefined | MatchLevelPlain;
77
+ useDom?: undefined | boolean;
78
+ sendDom?: undefined | boolean;
79
+ enablePatterns?: undefined | boolean;
80
+ ignoreDisplacements?: undefined | boolean;
81
+ ignoreMismatch?: undefined | boolean;
82
+ ignoreCaret?: undefined | boolean;
83
+ ignoreRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
84
+ layoutRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
85
+ strictRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
86
+ contentRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
87
+ floatingRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
88
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain;
89
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
90
+ regionId?: undefined | string;
91
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
92
+ } | {
93
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain;
94
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
95
+ regionId?: undefined | string;
96
+ maxUpOffset?: undefined | number;
97
+ maxDownOffset?: undefined | number;
98
+ maxLeftOffset?: undefined | number;
99
+ maxRightOffset?: undefined | number;
100
+ }>;
101
+ accessibilityRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
102
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain;
103
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
104
+ regionId?: undefined | string;
105
+ type?: undefined | AccessibilityRegionTypePlain;
106
+ }>;
107
+ dynamicRegions?: undefined | Array<RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
108
+ region: RegionPlain | ((LocationPlain & RectangleSizePlain & { page?: undefined | Driver; }) | { selector: string | Selector; page?: undefined | Driver; } | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain;
109
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
110
+ regionId?: undefined | string;
111
+ type?: undefined | string | Array<string>;
112
+ }>;
113
+ pageId?: undefined | string;
114
+ variationGroupId?: undefined | string;
115
+ densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
116
+ stitchMode?: undefined | StitchModePlain;
117
+ } & {
118
+ frames?: undefined | Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
119
+ webview?: undefined | string | boolean;
120
+ scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
121
+ fully?: undefined | boolean;
122
+ disableBrowserFetching?: undefined | boolean;
123
+ layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
124
+ visualGridOptions?: undefined | { [key: string]: any; };
125
+ ufgOptions?: undefined | { [key: string]: any; };
126
+ nmgOptions?: undefined | { [key: string]: any; };
127
+ useSystemScreenshot?: undefined | boolean;
128
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
129
+ timeout?: undefined | number;
130
+ waitBeforeCapture?: undefined | number | (() => Promise<void>);
131
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
132
+ } & import('../eyes/types/input/CheckSettings.d.ts').CheckSettingsOptIn<SpecType, ["page"]>;
13
133
  export class Eyes {
14
134
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
15
135
  static getExecutionCloudUrl(config?: undefined | (ConfigurationPlain & { maskLog?: undefined | boolean; })): Promise<string>;
@@ -48,7 +168,7 @@ export class Eyes {
48
168
  check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
49
169
  check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
50
170
  check(target: Image, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
51
- check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
171
+ check(checkSettings?: undefined | CheckSettingsAutomationWithOptInPlan): Promise<MatchResult>;
52
172
  checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
53
173
  checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
54
174
  checkFrame(element: Element, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
@@ -220,7 +340,7 @@ export type CheckSettingsImagePlain = {
220
340
  };
221
341
  export type CheckSettingsAutomationPlain = {
222
342
  name?: undefined | string;
223
- region?: undefined | (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
343
+ region?: undefined | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain);
224
344
  matchLevel?: undefined | MatchLevelPlain;
225
345
  useDom?: undefined | boolean;
226
346
  sendDom?: undefined | boolean;
@@ -228,17 +348,17 @@ export type CheckSettingsAutomationPlain = {
228
348
  ignoreDisplacements?: undefined | boolean;
229
349
  ignoreMismatch?: undefined | boolean;
230
350
  ignoreCaret?: undefined | boolean;
231
- ignoreRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
232
- layoutRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
233
- strictRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
234
- contentRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
235
- floatingRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
236
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
351
+ ignoreRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
352
+ layoutRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
353
+ strictRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
354
+ contentRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
355
+ floatingRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
356
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
237
357
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
238
358
  regionId?: undefined | string;
239
359
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
240
360
  } | {
241
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
361
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
242
362
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
243
363
  regionId?: undefined | string;
244
364
  maxUpOffset?: undefined | number;
@@ -246,14 +366,14 @@ export type CheckSettingsAutomationPlain = {
246
366
  maxLeftOffset?: undefined | number;
247
367
  maxRightOffset?: undefined | number;
248
368
  }>;
249
- accessibilityRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
250
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
369
+ accessibilityRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
370
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
251
371
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
252
372
  regionId?: undefined | string;
253
373
  type?: undefined | AccessibilityRegionTypePlain;
254
374
  }>;
255
- dynamicRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
256
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
375
+ dynamicRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
376
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
257
377
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
258
378
  regionId?: undefined | string;
259
379
  type?: undefined | string | Array<string>;
@@ -262,6 +382,7 @@ export type CheckSettingsAutomationPlain = {
262
382
  variationGroupId?: undefined | string;
263
383
  densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
264
384
  stitchMode?: undefined | StitchModePlain;
385
+ } & {
265
386
  frames?: undefined | Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
266
387
  webview?: undefined | string | boolean;
267
388
  scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
@@ -276,13 +397,13 @@ export type CheckSettingsAutomationPlain = {
276
397
  timeout?: undefined | number;
277
398
  waitBeforeCapture?: undefined | number | (() => Promise<void>);
278
399
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
279
- };
400
+ } & import('../eyes/types/input/CheckSettings.d.ts').CheckSettingsOptIn<SpecType, ["page"]>;
280
401
  export class CheckSettingsAutomation {
281
402
  constructor(settings?: undefined | CheckSettingsAutomation);
282
- constructor(settings?: undefined | CheckSettingsAutomationPlain);
403
+ constructor(settings?: undefined | CheckSettingsAutomationWithOptIn<SpecType>);
283
404
  region(region: RegionPlain): CheckSettingsAutomation;
284
- region(region: LegacyRegionPlain): CheckSettingsAutomation;
285
405
  region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
406
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
286
407
  shadow(selector: string): CheckSettingsAutomation;
287
408
  shadow(selector: Selector): CheckSettingsAutomation;
288
409
  shadow(selector: { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
@@ -318,30 +439,30 @@ export class CheckSettingsAutomation {
318
439
  stitchMode(stitchMode: StitchModePlain): CheckSettingsAutomation;
319
440
  name(name: string): CheckSettingsAutomation;
320
441
  withName(name: string): CheckSettingsAutomation;
321
- ignoreRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
322
- ignoreRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
323
- ignoreRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
442
+ ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain)): CheckSettingsAutomation;
443
+ ignoreRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
444
+ ignoreRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
324
445
  ignore(region: RegionPlain): CheckSettingsAutomation;
325
- ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
326
446
  ignore(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
327
- ignores(...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
328
- layoutRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
329
- layoutRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
330
- layoutRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
331
- strictRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
332
- strictRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
333
- strictRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
334
- contentRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
335
- contentRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
336
- contentRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
447
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
448
+ ignores(...regions: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain>): CheckSettingsAutomation;
449
+ layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain)): CheckSettingsAutomation;
450
+ layoutRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
451
+ layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
452
+ strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain)): CheckSettingsAutomation;
453
+ strictRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
454
+ strictRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
455
+ contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain)): CheckSettingsAutomation;
456
+ contentRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
457
+ contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
337
458
  floatingRegion(region: {
338
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
459
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
339
460
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
340
461
  regionId?: undefined | string;
341
462
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
342
463
  }): CheckSettingsAutomation;
343
464
  floatingRegion(region: {
344
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
465
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
345
466
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
346
467
  regionId?: undefined | string;
347
468
  maxUpOffset?: undefined | number;
@@ -350,64 +471,64 @@ export class CheckSettingsAutomation {
350
471
  maxRightOffset?: undefined | number;
351
472
  }): CheckSettingsAutomation;
352
473
  floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
353
- floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
354
474
  floatingRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
355
- floatingRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
356
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
475
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
476
+ floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
477
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
357
478
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
358
479
  regionId?: undefined | string;
359
480
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
360
481
  }>): CheckSettingsAutomation;
361
- floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
482
+ floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain>): CheckSettingsAutomation;
362
483
  floating(region: {
363
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
484
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
364
485
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
365
486
  regionId?: undefined | string;
366
487
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
367
488
  }): CheckSettingsAutomation;
368
489
  floating(region: RegionPlain): CheckSettingsAutomation;
369
- floating(region: LegacyRegionPlain): CheckSettingsAutomation;
370
490
  floating(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
371
- floatings(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
372
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
491
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
492
+ floatings(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
493
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
373
494
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
374
495
  regionId?: undefined | string;
375
496
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
376
497
  }>): CheckSettingsAutomation;
377
- floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
498
+ floatings(maxOffset: number, ...regions: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain>): CheckSettingsAutomation;
378
499
  accessibilityRegion(region: {
379
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
500
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
380
501
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
381
502
  regionId?: undefined | string;
382
503
  type?: undefined | AccessibilityRegionTypePlain;
383
504
  }): CheckSettingsAutomation;
384
505
  accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
385
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
386
506
  accessibilityRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
387
- accessibilityRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
388
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
507
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
508
+ accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
509
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
389
510
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
390
511
  regionId?: undefined | string;
391
512
  type?: undefined | AccessibilityRegionTypePlain;
392
513
  }>): CheckSettingsAutomation;
393
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
514
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain>): CheckSettingsAutomation;
394
515
  dynamicRegion(region: {
395
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
516
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
396
517
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
397
518
  regionId?: undefined | string;
398
519
  type?: undefined | string | Array<string>;
399
520
  }): CheckSettingsAutomation;
400
521
  dynamicRegion(region: RegionPlain): CheckSettingsAutomation;
401
- dynamicRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
402
522
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
523
+ dynamicRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
403
524
  dynamicRegion(region: RegionPlain, type?: undefined | string): CheckSettingsAutomation;
404
- dynamicRegion(region: LegacyRegionPlain, type?: undefined | string): CheckSettingsAutomation;
405
525
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | string): CheckSettingsAutomation;
526
+ dynamicRegion(region: LegacyRegionPlain, type?: undefined | string): CheckSettingsAutomation;
406
527
  dynamicRegion(region: RegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
407
- dynamicRegion(region: LegacyRegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
408
528
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | Array<string>): CheckSettingsAutomation;
409
- dynamicRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
410
- region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
529
+ dynamicRegion(region: LegacyRegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
530
+ dynamicRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain) | {
531
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })) | LegacyRegionPlain;
411
532
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
412
533
  regionId?: undefined | string;
413
534
  type?: undefined | string | Array<string>;
@@ -432,8 +553,8 @@ export class CheckSettings extends CheckSettingsAutomation {
432
553
  export type TargetAutomation = {
433
554
  window(): CheckSettingsAutomation;
434
555
  region(region: RegionPlain): CheckSettingsAutomation;
435
- region(region: LegacyRegionPlain): CheckSettingsAutomation;
436
556
  region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
557
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
437
558
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
438
559
  frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
439
560
  frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
@@ -446,8 +567,8 @@ export type TargetAutomation = {
446
567
  export const TargetAutomation: {
447
568
  window(): CheckSettingsAutomation;
448
569
  region(region: RegionPlain): CheckSettingsAutomation;
449
- region(region: LegacyRegionPlain): CheckSettingsAutomation;
450
570
  region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
571
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
451
572
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
452
573
  frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
453
574
  frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
@@ -459,7 +580,7 @@ export const TargetAutomation: {
459
580
  };
460
581
  export type Target = TargetImage & TargetAutomation;
461
582
  export const Target: TargetImage & TargetAutomation;
462
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
583
+ export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
463
584
  export type ConfigurationPlain = {
464
585
  accessibilityValidation?: undefined | AccessibilitySettings;
465
586
  agentId?: undefined | string;
@@ -1187,6 +1308,7 @@ export type BatchInfoPlain = {
1187
1308
  startedAt?: undefined | string | Date;
1188
1309
  notifyOnCompletion?: undefined | boolean;
1189
1310
  properties?: undefined | Array<PropertyDataPlain>;
1311
+ buildId?: undefined | string;
1190
1312
  };
1191
1313
  export class BatchInfo implements Required<BatchInfoPlain> {
1192
1314
  constructor();
@@ -1220,6 +1342,10 @@ export class BatchInfo implements Required<BatchInfoPlain> {
1220
1342
  setProperties(properties: Array<PropertyDataPlain>): BatchInfo;
1221
1343
  addProperty(name: string, value: string): BatchInfo;
1222
1344
  addProperty(prop: PropertyDataPlain): BatchInfo;
1345
+ get buildId(): string;
1346
+ set buildId(buildId: string);
1347
+ getBuildId(): string;
1348
+ setBuildId(buildId: string): BatchInfo;
1223
1349
  }
1224
1350
  export type Image = {
1225
1351
  image: string | Buffer | URL;