@applitools/eyes-nightwatch 1.10.3 → 1.11.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,67 @@
3
3
  ## Unreleased
4
4
 
5
5
 
6
+
7
+
8
+
9
+
10
+
11
+
12
+
13
+
14
+ ## 1.11.2 - 2022/7/5
15
+
16
+ ### Features
17
+ - Added support for taking full screenshots of elements that are scroll by pages only
18
+ - Allowed `` values in custom properties
19
+ - Add special attribute for pseudo elements
20
+ - Add the ability for the SDK to lazy load the page prior to performing a check window
21
+ - Support padding for regions in the following region types - ignoreRegions, layoutRegions, strictRegions, contentRegions
22
+ - Support `addMobileDevice` in user API for NMG
23
+ - Add support for dynamic coded regions
24
+ ### Bug fixes
25
+ - Fixed the "Maximum Call Stack Size Exceeded" error when taking screenshots on iOS Safari
26
+ - Fixed an issue with wrong cropped screenshots of elements out of viewport bounds on native devices
27
+ - Fixed broken links to enums implementation in the README.md
28
+ - Fixed `forceFullPageScreenshot` option behavior
29
+ - Fix calling `waitBeforeCapture` when failed to set required viewport size
30
+ - Fix rendering issues with Salesforce Lightning design system
31
+ - Fix issue that prevented self-signed certificates from working when connecting through a proxy server
32
+ - Fixed native screenshots of the elements under large collapsing areas
33
+ - Fixed scrolling on some android devices
34
+ - Improved handling of touch padding related issues in native apps
35
+ - Prevented navbar from appearing on Android 12 screenshots
36
+
37
+ ## 1.11.1 - 2022/6/2
38
+
39
+ ### Features
40
+ ### Bug fixes
41
+ - Fix rounding error of image size when scaling introduces fractions
42
+
43
+ ## 1.11.0 - 2022/6/1
44
+
45
+ ### Features
46
+ - Support UFG for native mobile
47
+ - `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
48
+ - Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
49
+ - Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
50
+ - Added support for drivers that return screenshots in jpeg format
51
+ - Dorp support for Node.js versions <=12
52
+ ### Bug fixes
53
+ - `runner.getAllTestResults` now aborts unclosed tests
54
+ - `runner.getAllTestResults` now returns all results, including aborted tests
55
+ - `extractText` now supports regions that don't use hints while using `x`/`y` coordinates
56
+ - accept ios and android lowercase as driver platformName capability when using custom grid
57
+ - Fixed check region fully in classic execution when using CSS stitching
58
+ - Support data urls in iframes
59
+ - Allow running with self-signed certificates
60
+ - Fixed bug in native apps when screenshot of the element was taken only for the small visible part of the element
61
+ - Fixed bug when navigation bar was presented in screenshot on Android 12
62
+ - Fixed `CheckSetting`'s `fully` being overridden by `Configuration`'s `forceFullPageScreenshot`
63
+ - Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
64
+ - Improve error message when failed to set viewport size
65
+ - Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
66
+
6
67
  ## 1.10.3 - 2022/3/14
7
68
 
8
69
  - fixing: Nightwatch 1.10.2 throwing Module assert/Strict not found
package/README.md CHANGED
@@ -447,6 +447,33 @@ Defines a name for the checkpoint in the Eyes Test Manager. The name may be any
447
447
  eyes.check(Target.window().withName('Main page'))
448
448
  ```
449
449
 
450
+ ##### Lazy loading (`lazyLoad`)
451
+
452
+ It's possible to have the SDK scroll the entire page (or a specific length of the page) to make sure all lazyily loaded assets are on the page before performing a check.
453
+
454
+ ```js
455
+ // lazy loads with sensible defaults
456
+ eyes.check(Target.window().lazyLoad())
457
+
458
+ // lazy loads with options specified
459
+ eyes.check(Target.window().lazyLoad({
460
+ maxAmountToScroll: 1000, // total pixels of the page to be scrolled
461
+ scrollLength: 250, // amount of pixels to use for each scroll attempt
462
+ waitingTime: 500, // milliseconds to wait in-between each scroll attempt
463
+ }))
464
+ ```
465
+
466
+ Possible input types are:
467
+
468
+ - nothing (enables sensible defaults)
469
+ - options object (`{maxAmountToScroll, waitingTime, scrollLength}`)
470
+
471
+ Other details:
472
+
473
+ - If an option is omitted, the sensible default for that value will be used
474
+ - The SDK will repeatedly scroll the page using the `scrollLength` until either the page cannot be scrolled further or the `maxAmountToScroll` has been reached (whichever happens first)
475
+ - If more time is needed for additional content to load, then increase the waitingTime to a value higher than 500 milliseconds. If better performance is desired and additional content lazily loads faster than the default waitingTime, then reduce it to a value below 500 milliseconds
476
+
450
477
  ###### Other checkSettings configuration
451
478
 
452
479
  <!-- TODO add explanation -->
@@ -963,10 +990,10 @@ configuration.addBrowser({
963
990
  eyes.setConfiguration(configuration)
964
991
  ```
965
992
 
966
- The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config/IosDeviceName.js
993
+ The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
967
994
 
968
995
  Possible values for `iosVersion` are:
969
996
 
970
997
  - `IosVersion.LATEST` - the latest iOS version that's supported by the UFG
971
998
  - `IosVersion.LATEST_ONE_VERSION_BACK'` - one version prior to the latest version
972
- - `undefined` - the UFG's default
999
+ - `undefined` - the UFG's default
package/dist/api.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/dist/index.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -19,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
19
23
  return result;
20
24
  };
21
25
  Object.defineProperty(exports, "__esModule", { value: true });
22
- exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.type = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCapabilities = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.transformSelector = exports.transformElement = exports.transformDriver = exports.isSelector = exports.isElement = exports.isDriver = void 0;
26
+ exports.build = exports.waitUntilDisplayed = exports.scrollIntoView = exports.type = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCapabilities = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.untransformSelector = exports.transformSelector = exports.transformElement = exports.transformDriver = exports.isSelector = exports.isElement = exports.isDriver = void 0;
23
27
  const utils = __importStar(require("@applitools/utils"));
24
28
  const LEGACY_ELEMENT_ID = 'ELEMENT';
25
29
  const SHADOW_ROOT_ID = 'shadow-6066-11e4-a52e-4f735466cecf';
@@ -81,7 +85,9 @@ function transformSelector(selector) {
81
85
  if (utils.types.isString(selector)) {
82
86
  return { locateStrategy: 'css selector', selector };
83
87
  }
84
- else if (utils.types.has(selector, 'selector') && !utils.types.has(selector, 'locateStrategy')) {
88
+ else if (utils.types.has(selector, 'selector')) {
89
+ if (utils.types.has(selector, 'locateStrategy'))
90
+ return selector;
85
91
  if (!utils.types.isString(selector.selector))
86
92
  return selector.selector;
87
93
  if (!utils.types.has(selector, 'type'))
@@ -94,6 +100,16 @@ function transformSelector(selector) {
94
100
  return selector;
95
101
  }
96
102
  exports.transformSelector = transformSelector;
103
+ function untransformSelector(selector) {
104
+ if (utils.types.has(selector, ['locateStrategy', 'selector'])) {
105
+ return {
106
+ type: selector.locateStrategy === 'css selector' ? 'css' : selector.locateStrategy,
107
+ selector: selector.selector,
108
+ };
109
+ }
110
+ return selector;
111
+ }
112
+ exports.untransformSelector = untransformSelector;
97
113
  function isStaleElementError(err) {
98
114
  if (!err)
99
115
  return false;
@@ -135,7 +151,7 @@ async function findElement(driver, selector, parent) {
135
151
  ? await call(driver, 'elementIdElement', extractElementId(parent), selector.locateStrategy, selector.selector)
136
152
  : await call(driver, 'element', selector.locateStrategy, selector.selector);
137
153
  }
138
- catch (_a) {
154
+ catch {
139
155
  return null;
140
156
  }
141
157
  }
@@ -151,7 +167,7 @@ async function getWindowSize(driver) {
151
167
  const rect = (await call(driver, 'getWindowRect'));
152
168
  return { width: rect.width, height: rect.height };
153
169
  }
154
- catch (_a) {
170
+ catch {
155
171
  return call(driver, 'getWindowSize');
156
172
  }
157
173
  }
@@ -160,7 +176,7 @@ async function setWindowSize(driver, size) {
160
176
  try {
161
177
  await call(driver, 'setWindowRect', size);
162
178
  }
163
- catch (_a) {
179
+ catch {
164
180
  await call(driver, 'setWindowPosition', 0, 0);
165
181
  await call(driver, 'setWindowSize', size.width, size.height);
166
182
  }
@@ -176,7 +192,7 @@ async function getCapabilities(driver) {
176
192
  try {
177
193
  return await call(driver, 'session');
178
194
  }
179
- catch (_a) {
195
+ catch {
180
196
  return driver.options.desiredCapabilities;
181
197
  }
182
198
  }
@@ -235,8 +251,8 @@ const browserOptionsNames = {
235
251
  };
236
252
  async function build(env) {
237
253
  const parseEnv = require('@applitools/test-utils/src/parse-env');
238
- const { browser = '', capabilities, url, configurable = true, args = [], headless } = parseEnv(Object.assign(Object.assign({}, env), { legacy: true }));
239
- const desiredCapabilities = Object.assign({ browserName: browser }, capabilities);
254
+ const { browser = '', capabilities, url, configurable = true, args = [], headless } = parseEnv({ ...env, legacy: true });
255
+ const desiredCapabilities = { browserName: browser, ...capabilities };
240
256
  if (configurable) {
241
257
  const browserOptionsName = browserOptionsNames[browser || desiredCapabilities.browserName];
242
258
  if (browserOptionsName) {
@@ -264,7 +280,7 @@ async function build(env) {
264
280
  output: false,
265
281
  webdriver: {
266
282
  host: !url.host.includes('localhost') ? url.host : undefined,
267
- port: url.port || 4444,
283
+ port: url.port || (url.protocol === 'https:' ? 443 : undefined),
268
284
  default_path_prefix: url.pathname,
269
285
  },
270
286
  desiredCapabilities,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-nightwatch",
3
- "version": "1.10.3",
3
+ "version": "1.11.2",
4
4
  "description": "Applitools Eyes SDK for Nightwatch.js",
5
5
  "keywords": [
6
6
  "eyes-nightwatch",
@@ -23,20 +23,18 @@
23
23
  "repository": {
24
24
  "type": "git",
25
25
  "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
26
- "directory": "packages/eyes-nightwatch"
26
+ "directory": "js/packages/eyes-nightwatch"
27
27
  },
28
28
  "license": "SEE LICENSE IN LICENSE",
29
29
  "author": {
30
30
  "name": "Applitools Team",
31
31
  "email": "team@applitools.com"
32
32
  },
33
+ "aliases": [
34
+ "nightwatch"
35
+ ],
33
36
  "main": "./dist/index.js",
34
37
  "types": "./types/index.d.ts",
35
- "directories": {
36
- "lib": "./lib",
37
- "example": "./example",
38
- "test": "./test"
39
- },
40
38
  "files": [
41
39
  "dist",
42
40
  "commands",
@@ -47,6 +45,7 @@
47
45
  "build": "ttsc",
48
46
  "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-nightwatch'",
49
47
  "test": "yarn test:it && yarn test:e2e && yarn test:coverage",
48
+ "test:sanity": "yarn test:it",
50
49
  "test:it": "mocha ./test/it/spec-driver.spec.js --exit --no-timeouts -r @applitools/test-utils/mocha-hooks/docker",
51
50
  "test:e2e": "yarn test:e2e:nightwatch && yarn test:e2e:cucumber",
52
51
  "test:e2e:cucumber": "cucumber-js test/e2e/cucumber/features/*.feature --require test/e2e/cucumber/cucumber.config.js --require test/e2e/cucumber/step_definitions",
@@ -57,10 +56,10 @@
57
56
  "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
58
57
  "docker:teardown": "docker-compose down",
59
58
  "deps": "bongo deps",
60
- "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='nightwatch' -f links='eyes-sdk-core eyes-api types test-utils utils driver snippets screenshoter sdk-shared visual-grid-client' -f linking-depth=3",
59
+ "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='nightwatch' -f links='eyes-sdk-core eyes-api types test-utils utils driver snippets screenshoter sdk-shared visual-grid-client'",
61
60
  "gh:publish": "gh workflow run publish-nightwatch.yml --ref $(git rev-parse --abbrev-ref HEAD)",
62
- "preversion": "bongo preversion && yarn build",
63
- "version": "bongo version",
61
+ "preversion": "bongo preversion --verifyPendingChanges && yarn build",
62
+ "version": "bongo version --withPendingChanges",
64
63
  "postversion": "bongo postversion"
65
64
  },
66
65
  "husky": {
@@ -69,44 +68,45 @@
69
68
  }
70
69
  },
71
70
  "dependencies": {
72
- "@applitools/eyes-api": "1.2.0",
73
- "@applitools/eyes-sdk-core": "13.1.1",
74
- "@applitools/types": "1.2.2",
75
- "@applitools/utils": "1.2.13",
76
- "@applitools/visual-grid-client": "15.10.1"
71
+ "@applitools/eyes-api": "1.7.3",
72
+ "@applitools/eyes-sdk-core": "13.8.10",
73
+ "@applitools/types": "1.5.6",
74
+ "@applitools/utils": "1.3.10",
75
+ "@applitools/visual-grid-client": "15.13.4"
77
76
  },
78
77
  "devDependencies": {
79
- "@applitools/api-extractor": "1.2.7",
78
+ "@applitools/api-extractor": "1.2.9",
79
+ "@applitools/bongo": "^2.1.6",
80
80
  "@applitools/scripts": "1.1.0",
81
- "@applitools/sdk-coverage-tests": "2.3.18",
82
- "@applitools/sdk-release-kit": "0.13.11",
83
- "@applitools/sdk-shared": "0.9.11",
84
- "@applitools/test-utils": "1.1.5",
81
+ "@applitools/sdk-coverage-tests": "2.3.19",
82
+ "@applitools/sdk-shared": "0.9.13",
83
+ "@applitools/test-utils": "1.4.2",
85
84
  "@types/nightwatch": "^1.3.3",
86
- "@typescript-eslint/eslint-plugin": "^4.15.1",
87
- "@typescript-eslint/parser": "^4.15.1",
88
- "chromedriver": "^86.0.0",
89
- "cucumber": "6.0.5",
90
- "eslint": "^7.9.0",
91
- "eslint-config-prettier": "^7.2.0",
85
+ "@types/node": "12",
86
+ "@typescript-eslint/eslint-plugin": "^5.27.0",
87
+ "@typescript-eslint/parser": "^5.27.0",
88
+ "chromedriver": "^101.0.0",
89
+ "cucumber": "6.0.7",
90
+ "eslint": "^8.16.0",
91
+ "eslint-config-prettier": "^8.5.0",
92
92
  "eslint-plugin-mocha-no-only": "^1.1.1",
93
93
  "eslint-plugin-node": "^11.1.0",
94
- "eslint-plugin-prettier": "^3.3.1",
95
- "geckodriver": "^1.20.0",
94
+ "eslint-plugin-prettier": "^4.0.0",
95
+ "geckodriver": "^3.0.1",
96
96
  "husky": "^4.3.8",
97
- "mocha": "^9.1.3",
97
+ "mocha": "^10.0.0",
98
98
  "nightwatch": "1.7.13",
99
99
  "nightwatch-api": "^3.0.2",
100
- "prettier": "^2.1.2",
100
+ "prettier": "^2.6.2",
101
101
  "spec-xunit-file": "0.0.1-3",
102
- "ts-node": "^10.4.0",
103
- "ttypescript": "^1.5.12",
104
- "typescript": "^4.5.1-rc"
102
+ "ts-node": "^10.8.0",
103
+ "ttypescript": "^1.5.13",
104
+ "typescript": "^4.7.2"
105
105
  },
106
106
  "peerDependencies": {
107
107
  "nightwatch": ">=1.3.4"
108
108
  },
109
109
  "engines": {
110
- "node": ">=8.9.0"
110
+ "node": ">=12.13.0"
111
111
  }
112
112
  }
package/types/index.d.ts CHANGED
@@ -21,37 +21,15 @@ export class Eyes {
21
21
  setConfiguration(config: ConfigurationPlain): void;
22
22
  get isOpen(): boolean;
23
23
  getIsOpen(): boolean;
24
- on(handler: (event: string, data?: Record<string, any>) => any): () => void;
25
- on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
26
- on(event: "setSizeEnded", handler: () => any): () => void;
27
- on(event: "initStarted", handler: () => any): () => void;
28
- on(event: "initEnded", handler: () => any): () => void;
29
- on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
30
- on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
31
- on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
32
- on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
33
- off(event: string): void;
34
- off(handler: (...args: Array<any>) => any): void;
35
24
  open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
36
25
  open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
37
- checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
38
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
39
- checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
40
- checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
41
- checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
42
- checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
43
- checkRegionBy(selector: EyesSelector<Selector>, name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
44
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResult>;
45
26
  check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
46
27
  check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
47
28
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
48
29
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
49
30
  extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
50
31
  close(throwErr?: boolean): Promise<TestResults>;
51
- closeAsync(): Promise<void>;
52
32
  abort(): Promise<TestResults>;
53
- abortAsync(): Promise<void>;
54
- abortIfNotClosed(): Promise<TestResultsPlain>;
55
33
  getViewportSize(): Promise<RectangleSize>;
56
34
  setViewportSize(size: RectangleSizePlain): Promise<void>;
57
35
  getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -84,8 +62,6 @@ export class Eyes {
84
62
  setAppName(appName: string): void;
85
63
  getBaselineBranchName(): string;
86
64
  setBaselineBranchName(baselineBranchName: string): void;
87
- getBaselineName(): string;
88
- setBaselineName(baselineName: string): void;
89
65
  getBaselineEnvName(): string;
90
66
  setBaselineEnvName(baselineEnvName: string): void;
91
67
  getBranchName(): string;
@@ -134,23 +110,14 @@ export class Eyes {
134
110
  setStitchMode(stitchMode: StitchModePlain): void;
135
111
  getStitchOverlap(): number;
136
112
  setStitchOverlap(stitchOverlap: number): void;
137
- getSessionEventHandlers(): SessionEventHandlers;
138
- addSessionEventHandler(handler: SessionEventHandler): void;
139
- removeSessionEventHandler(handler: SessionEventHandler): void;
140
- clearSessionEventHandlers(): void;
141
113
  }
142
114
  export type ConfigurationPlain = {
143
- logs?: LogHandlerPlain;
144
- debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
145
115
  agentId?: string;
146
116
  apiKey?: string;
147
117
  serverUrl?: string;
148
118
  proxy?: ProxySettingsPlain;
149
119
  autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
150
120
  isDisabled?: boolean;
151
- connectionTimeout?: number;
152
- removeSession?: boolean;
153
- remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; };
154
121
  appName?: string;
155
122
  testName?: string;
156
123
  displayName?: string;
@@ -175,7 +142,6 @@ export type ConfigurationPlain = {
175
142
  saveFailedTests?: boolean;
176
143
  saveNewTests?: boolean;
177
144
  saveDiffs?: boolean;
178
- dontCloseBatches?: boolean;
179
145
  sendDom?: boolean;
180
146
  matchTimeout?: number;
181
147
  forceFullPageScreenshot?: boolean;
@@ -189,28 +155,13 @@ export type ConfigurationPlain = {
189
155
  rotation?: ImageRotationPlain;
190
156
  scaleRatio?: number;
191
157
  waitBeforeCapture?: number;
192
- concurrentSessions?: number;
193
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
158
+ browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
194
159
  visualGridOptions?: Record<string, any>;
195
160
  layoutBreakpoints?: boolean | Array<number>;
196
161
  disableBrowserFetching?: boolean;
197
162
  };
198
163
  export class Configuration implements Required<ConfigurationPlain> {
199
164
  constructor(config?: ConfigurationPlain);
200
- get logs(): LogHandlerPlain;
201
- set logs(logs: LogHandlerPlain);
202
- getShowLogs(): boolean;
203
- setShowLogs(show: boolean): Configuration;
204
- getLogHandler(): LogHandlerPlain;
205
- setLogHandler(handler: LogHandlerPlain): Configuration;
206
- get debugScreenshots(): { save: boolean; path?: string; prefix?: string; };
207
- set debugScreenshots(debugScreenshots: { save: boolean; path?: string; prefix?: string; });
208
- getSaveDebugScreenshots(): boolean;
209
- setSaveDebugScreenshots(save: boolean): Configuration;
210
- getDebugScreenshotsPath(): string;
211
- setDebugScreenshotsPath(path: string): Configuration;
212
- getDebugScreenshotsPrefix(): string;
213
- setDebugScreenshotsPrefix(prefix: string): Configuration;
214
165
  get appName(): string;
215
166
  set appName(appName: string);
216
167
  getAppName(): string;
@@ -261,18 +212,6 @@ export class Configuration implements Required<ConfigurationPlain> {
261
212
  set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
262
213
  getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
263
214
  setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
264
- get connectionTimeout(): number;
265
- set connectionTimeout(connectionTimeout: number);
266
- getConnectionTimeout(): number;
267
- setConnectionTimeout(connectionTimeout: number): Configuration;
268
- get removeSession(): boolean;
269
- set removeSession(removeSession: boolean);
270
- getRemoveSession(): boolean;
271
- setRemoveSession(removeSession: boolean): Configuration;
272
- get remoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
273
- set remoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; });
274
- getRemoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
275
- setRemoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }): Configuration;
276
215
  get batch(): BatchInfoPlain;
277
216
  set batch(batch: BatchInfoPlain);
278
217
  getBatch(): BatchInfo;
@@ -412,18 +351,16 @@ export class Configuration implements Required<ConfigurationPlain> {
412
351
  set scaleRatio(scaleRatio: number);
413
352
  getScaleRatio(): number;
414
353
  setScaleRatio(scaleRatio: number): Configuration;
415
- get concurrentSessions(): number;
416
- set concurrentSessions(concurrentSessions: number);
417
- getConcurrentSessions(): number;
418
- setConcurrentSessions(concurrentSessions: number): Configuration;
419
- get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
420
- set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
421
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
422
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
423
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
424
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
354
+ get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
355
+ set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
356
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
357
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
358
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
359
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
425
360
  addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
426
361
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
362
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
363
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
427
364
  get visualGridOptions(): { [key: string]: any; };
428
365
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
429
366
  getVisualGridOptions(): { [key: string]: any; };
@@ -437,12 +374,8 @@ export class Configuration implements Required<ConfigurationPlain> {
437
374
  set disableBrowserFetching(disableBrowserFetching: boolean);
438
375
  getDisableBrowserFetching(): boolean;
439
376
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
440
- get dontCloseBatches(): boolean;
441
- set dontCloseBatches(dontCloseBatches: boolean);
442
- getDontCloseBatches(): boolean;
443
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
444
377
  }
445
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
378
+ export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
446
379
  export type CheckSettingsPlain = {
447
380
  name?: string;
448
381
  region?: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
@@ -455,18 +388,19 @@ export type CheckSettingsPlain = {
455
388
  enablePatterns?: boolean;
456
389
  ignoreDisplacements?: boolean;
457
390
  ignoreCaret?: boolean;
458
- ignoreRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
459
- layoutRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
460
- strictRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
461
- contentRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
391
+ 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; }>;
392
+ 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; }>;
393
+ 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; }>;
394
+ 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; }>;
462
395
  floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
463
396
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
464
397
  maxUpOffset?: number;
465
398
  maxDownOffset?: number;
466
399
  maxLeftOffset?: number;
467
400
  maxRightOffset?: number;
401
+ regionId?: string;
468
402
  }>;
469
- accessibilityRegions?: 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>; })); type?: AccessibilityRegionTypePlain; }>;
403
+ accessibilityRegions?: 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>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }>;
470
404
  disableBrowserFetching?: boolean;
471
405
  layoutBreakpoints?: boolean | Array<number>;
472
406
  visualGridOptions?: { [key: string]: any; };
@@ -476,31 +410,30 @@ export type CheckSettingsPlain = {
476
410
  variationGroupId?: string;
477
411
  timeout?: number;
478
412
  waitBeforeCapture?: number;
413
+ lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
479
414
  };
480
415
  export class CheckSettings {
481
416
  constructor(settings?: CheckSettingsPlain);
482
- name(name: string): CheckSettings;
483
417
  withName(name: string): CheckSettings;
484
418
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
485
419
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
486
420
  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;
487
421
  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;
488
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
489
- ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
490
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
491
- ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
492
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
493
- layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
494
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
495
- strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
496
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
497
- contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
422
+ 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;
423
+ 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;
424
+ 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;
425
+ 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;
426
+ 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;
427
+ 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;
428
+ 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;
429
+ 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;
498
430
  floatingRegion(region: {
499
431
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
500
432
  maxUpOffset?: number;
501
433
  maxDownOffset?: number;
502
434
  maxLeftOffset?: number;
503
435
  maxRightOffset?: number;
436
+ regionId?: string;
504
437
  }): CheckSettings;
505
438
  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;
506
439
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
@@ -509,31 +442,15 @@ export class CheckSettings {
509
442
  maxDownOffset?: number;
510
443
  maxLeftOffset?: number;
511
444
  maxRightOffset?: number;
445
+ regionId?: string;
512
446
  }>): CheckSettings;
513
447
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
514
- floating(region: {
515
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
516
- maxUpOffset?: number;
517
- maxDownOffset?: number;
518
- maxLeftOffset?: number;
519
- maxRightOffset?: number;
520
- }): CheckSettings;
521
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
522
- floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
523
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
524
- maxUpOffset?: number;
525
- maxDownOffset?: number;
526
- maxLeftOffset?: number;
527
- maxRightOffset?: number;
528
- }>): CheckSettings;
529
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
530
- accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
448
+ accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }): CheckSettings;
531
449
  accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
532
- accessibilityRegions(...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>; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings;
450
+ accessibilityRegions(...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>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }>): CheckSettings;
533
451
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
534
452
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
535
453
  fully(fully?: boolean): CheckSettings;
536
- stitchContent(stitchContent?: boolean): CheckSettings;
537
454
  matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
538
455
  layout(): CheckSettings;
539
456
  exact(): CheckSettings;
@@ -548,7 +465,6 @@ export class CheckSettings {
548
465
  layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
549
466
  hook(name: string, script: string): CheckSettings;
550
467
  beforeRenderScreenshotHook(script: string): CheckSettings;
551
- webHook(script: string): CheckSettings;
552
468
  visualGridOption(key: string, value: any): CheckSettings;
553
469
  visualGridOptions(options: { [key: string]: any; }): CheckSettings;
554
470
  renderId(renderId: string): CheckSettings;
@@ -556,6 +472,7 @@ export class CheckSettings {
556
472
  variationGroupId(variationGroupId: string): CheckSettings;
557
473
  timeout(timeout: number): CheckSettings;
558
474
  waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
475
+ lazyLoad(options: { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
559
476
  }
560
477
  export const Target: {
561
478
  window(): CheckSettings;
@@ -623,7 +540,7 @@ export enum CorsIframeHandle {
623
540
  KEEP = 'KEEP',
624
541
  SNAPSHOT = 'SNAPSHOT'
625
542
  }
626
- export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5";
543
+ export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5";
627
544
  export enum DeviceName {
628
545
  Blackberry_PlayBook = 'Blackberry PlayBook',
629
546
  BlackBerry_Z30 = 'BlackBerry Z30',
@@ -644,6 +561,7 @@ export enum DeviceName {
644
561
  Galaxy_S10 = 'Galaxy S10',
645
562
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
646
563
  Galaxy_S20 = 'Galaxy S20',
564
+ Galaxy_S22 = 'Galaxy S22',
647
565
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
648
566
  iPad = 'iPad',
649
567
  iPad_6th_Gen = 'iPad 6th Gen',
@@ -694,7 +612,7 @@ export enum FailureReport {
694
612
  IMMEDIATE = 'IMMEDIATE',
695
613
  ON_CLOSE = 'ON_CLOSE'
696
614
  }
697
- export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
615
+ export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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)";
698
616
  export enum IosDeviceName {
699
617
  iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
700
618
  iPhone_13_Pro = 'iPhone 13 Pro',
@@ -710,7 +628,9 @@ export enum IosDeviceName {
710
628
  iPhone_XS = 'iPhone Xs',
711
629
  iPhone_X = 'iPhone X',
712
630
  iPhone_8 = 'iPhone 8',
631
+ iPhone_8_Plus = 'iPhone 8 Plus',
713
632
  iPhone_7 = 'iPhone 7',
633
+ iPhone_SE = 'iPhone SE (1st generation)',
714
634
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
715
635
  iPad_7 = 'iPad (7th generation)',
716
636
  iPad_9 = 'iPad (9th generation)',
@@ -723,6 +643,33 @@ export enum IosVersion {
723
643
  ONE_VERSION_BACK = 'latest-1',
724
644
  LATEST_ONE_VERSION_BACK = 'latest-1'
725
645
  }
646
+ 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" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra";
647
+ export enum AndroidDeviceName {
648
+ Pixel_3_XL = 'Pixel 3 XL',
649
+ Pixel_4 = 'Pixel 4',
650
+ Pixel_4_XL = 'Pixel 4 XL',
651
+ Galaxy_Note_8 = 'Galaxy Note 8',
652
+ Galaxy_Note_9 = 'Galaxy Note 9',
653
+ Galaxy_S8 = 'Galaxy S8',
654
+ Galaxy_S8_Plus = 'Galaxy S8 Plus',
655
+ Galaxy_S9 = 'Galaxy S9',
656
+ Galaxy_S9_Plus = 'Galaxy S9 Plus',
657
+ Galaxy_S10 = 'Galaxy S10',
658
+ Galaxy_S10_Plus = 'Galaxy S10 Plus',
659
+ Galaxy_Note_10 = 'Galaxy Note 10',
660
+ Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
661
+ Galaxy_S20 = 'Galaxy S20',
662
+ Galaxy_S20_Plus = 'Galaxy S20 Plus',
663
+ Galaxy_S21 = 'Galaxy S21',
664
+ Galaxy_S21_Plus = 'Galaxy S21 Plus',
665
+ Galaxy_S21_Ultra = 'Galaxy S21 Ultra'
666
+ }
667
+ export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
668
+ export enum AndroidVersion {
669
+ LATEST = 'latest',
670
+ ONE_VERSION_BACK = 'latest-1',
671
+ TWO_VERSIONS_BACK = 'latest-2'
672
+ }
726
673
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
727
674
  export enum MatchLevel {
728
675
  None = 'None',
@@ -743,7 +690,7 @@ export enum SessionType {
743
690
  SEQUENTIAL = 'SEQUENTIAL',
744
691
  PROGRESSION = 'PROGRESSION'
745
692
  }
746
- export type StitchModePlain = "Scroll" | "CSS";
693
+ export type StitchModePlain = "CSS" | "Scroll";
747
694
  export enum StitchMode {
748
695
  SCROLL = 'Scroll',
749
696
  CSS = 'CSS'
@@ -931,8 +878,8 @@ export type ImageMatchSettingsPlain = {
931
878
  layoutRegions?: Array<RegionPlain>;
932
879
  strictRegions?: Array<RegionPlain>;
933
880
  contentRegions?: Array<RegionPlain>;
934
- floatingRegions?: Array<FloatingMatchSettingsPlain | RegionPlain>;
935
- accessibilityRegions?: Array<AccessibilityMatchSettingsPlain | RegionPlain>;
881
+ floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
882
+ accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
936
883
  accessibilitySettings?: AccessibilitySettings;
937
884
  };
938
885
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
@@ -983,16 +930,16 @@ export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
983
930
  set content(content: Array<RegionPlain>);
984
931
  getContentRegions(): Array<Region>;
985
932
  setContentRegions(contentRegions: Array<RegionPlain>): void;
986
- get floatingRegions(): Array<FloatingMatchSettingsPlain | RegionPlain>;
987
- set floatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain | RegionPlain>);
988
- get floating(): Array<FloatingMatchSettingsPlain | RegionPlain>;
989
- set floating(floating: Array<FloatingMatchSettingsPlain | RegionPlain>);
933
+ get floatingRegions(): Array<RegionPlain | FloatingMatchSettingsPlain>;
934
+ set floatingRegions(floatingRegions: Array<RegionPlain | FloatingMatchSettingsPlain>);
935
+ get floating(): Array<RegionPlain | FloatingMatchSettingsPlain>;
936
+ set floating(floating: Array<RegionPlain | FloatingMatchSettingsPlain>);
990
937
  getFloatingRegions(): Array<FloatingMatchSettings>;
991
938
  setFloatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain>): void;
992
- get accessibilityRegions(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
993
- set accessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
994
- get accessibility(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
995
- set accessibility(accessibility: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
939
+ get accessibilityRegions(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
940
+ set accessibilityRegions(accessibilityRegions: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
941
+ get accessibility(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
942
+ set accessibility(accessibility: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
996
943
  getAccessibilityRegions(): Array<AccessibilityMatchSettings>;
997
944
  setAccessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain>): void;
998
945
  get accessibilitySettings(): AccessibilitySettings;
@@ -1021,7 +968,7 @@ export class Location implements Required<LocationPlain> {
1021
968
  getY(): number;
1022
969
  setY(y: number): void;
1023
970
  }
1024
- export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
971
+ export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1025
972
  export type CustomLogHandlerPlain = {
1026
973
  log(message: any): void;
1027
974
  warn?(message: any): void;
@@ -1138,6 +1085,7 @@ export class Region implements Required<RegionPlain> {
1138
1085
  export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1139
1086
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1140
1087
  export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1088
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1141
1089
  export type RunnerOptionsPlain = { testConcurrency?: number; };
1142
1090
  export class RunnerOptionsFluent {
1143
1091
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1154,46 +1102,35 @@ export type ApiUrlsPlain = {
1154
1102
  export class ApiUrls implements Required<ApiUrlsPlain> {
1155
1103
  get baselineImage(): string;
1156
1104
  getBaselineImage(): string;
1157
- setBaselineImage(setBaselineImage: string): void;
1158
1105
  get currentImage(): string;
1159
1106
  getCurrentImage(): string;
1160
- setCurrentImage(currentImage: string): void;
1161
1107
  get checkpointImage(): string;
1162
1108
  getCheckpointImage(): string;
1163
- setCheckpointImage(checkpointImage: string): void;
1164
1109
  get checkpointImageThumbnail(): string;
1165
1110
  getCheckpointImageThumbnail(): string;
1166
- setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1167
1111
  get diffImage(): string;
1168
1112
  getDiffImage(): string;
1169
- setDiffImage(diffImage: string): void;
1170
1113
  }
1171
1114
  export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1172
1115
  export class AppUrls implements Required<AppUrlsPlain> {
1173
1116
  get step(): string;
1174
1117
  getStep(): string;
1175
- setStep(step: string): void;
1176
1118
  get stepEditor(): string;
1177
1119
  getStepEditor(): string;
1178
- setStepEditor(stepEditor: string): void;
1179
1120
  }
1180
1121
  export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1181
1122
  export class MatchResult implements Required<MatchResultPlain> {
1182
1123
  get asExpected(): boolean;
1183
1124
  getAsExpected(): boolean;
1184
- setAsExpected(asExpected: boolean): void;
1185
1125
  get windowId(): number;
1186
1126
  getWindowId(): number;
1187
- setWindowId(windowId: number): void;
1188
1127
  }
1189
1128
  export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1190
1129
  export class SessionUrls implements Required<SessionUrlsPlain> {
1191
1130
  get batch(): string;
1192
1131
  getBatch(): string;
1193
- setBatch(batch: string): void;
1194
1132
  get session(): string;
1195
1133
  getSession(): string;
1196
- setSession(session: string): void;
1197
1134
  }
1198
1135
  export type StepInfoPlain = {
1199
1136
  readonly name?: string;
@@ -1207,25 +1144,18 @@ export type StepInfoPlain = {
1207
1144
  export class StepInfo implements Required<StepInfoPlain> {
1208
1145
  get name(): string;
1209
1146
  getName(): string;
1210
- setName(value: string): void;
1211
1147
  get isDifferent(): boolean;
1212
1148
  getIsDifferent(): boolean;
1213
- setIsDifferent(value: boolean): void;
1214
1149
  get hasBaselineImage(): boolean;
1215
1150
  getHasBaselineImage(): boolean;
1216
- setHasBaselineImage(value: boolean): void;
1217
1151
  get hasCurrentImage(): boolean;
1218
1152
  getHasCurrentImage(): boolean;
1219
- setHasCurrentImage(hasCurrentImage: boolean): void;
1220
1153
  get appUrls(): AppUrlsPlain;
1221
1154
  getAppUrls(): AppUrls;
1222
- setAppUrls(appUrls: AppUrlsPlain): void;
1223
1155
  get apiUrls(): ApiUrlsPlain;
1224
1156
  getApiUrls(): ApiUrls;
1225
- setApiUrls(apiUrls: ApiUrlsPlain): void;
1226
1157
  get renderId(): Array<string>;
1227
1158
  getRenderId(): Array<string>;
1228
- setRenderId(renderId: Array<string>): void;
1229
1159
  }
1230
1160
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1231
1161
  export type TestResultsPlain = {
@@ -1263,97 +1193,66 @@ export type TestResultsPlain = {
1263
1193
  export class TestResults implements Required<TestResultsPlain> {
1264
1194
  get id(): string;
1265
1195
  getId(): string;
1266
- setId(id: string): void;
1267
1196
  get name(): string;
1268
1197
  getName(): string;
1269
- setName(name: string): void;
1270
1198
  get secretToken(): string;
1271
1199
  getSecretToken(): string;
1272
- setSecretToken(secretToken: string): void;
1273
1200
  get status(): TestResultsStatusPlain;
1274
1201
  getStatus(): TestResultsStatus;
1275
- setStatus(status: TestResultsStatus): void;
1276
1202
  get appName(): string;
1277
1203
  getAppName(): string;
1278
- setAppName(appName: string): void;
1279
1204
  get batchName(): string;
1280
1205
  getBatchName(): string;
1281
- setBatchName(batchName: string): void;
1282
1206
  get batchId(): string;
1283
1207
  getBatchId(): string;
1284
- setBatchId(batchId: string): void;
1285
1208
  get branchName(): string;
1286
1209
  getBranchName(): string;
1287
- setBranchName(branchName: string): void;
1288
1210
  get hostOS(): string;
1289
1211
  getHostOS(): string;
1290
- setHostOS(hostOS: string): void;
1291
1212
  get hostApp(): string;
1292
1213
  getHostApp(): string;
1293
- setHostApp(hostApp: string): void;
1294
1214
  get hostDisplaySize(): RectangleSizePlain;
1295
1215
  getHostDisplaySize(): RectangleSize;
1296
- setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
1297
1216
  get accessibilityStatus(): TestAccessibilityStatus;
1298
1217
  getAccessibilityStatus(): TestAccessibilityStatus;
1299
- setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
1300
1218
  get startedAt(): string | Date;
1301
1219
  getStartedAt(): Date;
1302
- setStartedAt(startedAt: string | Date): void;
1303
1220
  get duration(): number;
1304
1221
  getDuration(): number;
1305
- setDuration(duration: number): void;
1306
1222
  get isNew(): boolean;
1307
1223
  getIsNew(): boolean;
1308
- setIsNew(isNew: boolean): void;
1309
1224
  get isDifferent(): boolean;
1310
1225
  getIsDifferent(): boolean;
1311
- setIsDifferent(isDifferent: boolean): void;
1312
1226
  get isAborted(): boolean;
1313
1227
  getIsAborted(): boolean;
1314
- setIsAborted(isAborted: boolean): void;
1315
1228
  get appUrls(): SessionUrlsPlain;
1316
1229
  getAppUrls(): SessionUrls;
1317
- setAppUrls(appUrls: SessionUrlsPlain): void;
1318
1230
  get apiUrls(): SessionUrlsPlain;
1319
1231
  getApiUrls(): SessionUrls;
1320
- setApiUrls(apiUrls: SessionUrlsPlain): void;
1321
1232
  get stepsInfo(): Array<StepInfoPlain>;
1322
1233
  getStepsInfo(): Array<StepInfo>;
1323
- setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
1324
1234
  get steps(): number;
1325
1235
  getSteps(): number;
1326
- setSteps(steps: number): void;
1327
1236
  get matches(): number;
1328
1237
  getMatches(): number;
1329
- setMatches(matches: number): void;
1330
1238
  get mismatches(): number;
1331
1239
  getMismatches(): number;
1332
- setMismatches(mismatches: number): void;
1333
1240
  get missing(): number;
1334
1241
  getMissing(): number;
1335
- setMissing(missing: number): void;
1336
1242
  get exactMatches(): number;
1337
1243
  getExactMatches(): number;
1338
- setExactMatches(exactMatches: number): void;
1339
1244
  get strictMatches(): number;
1340
1245
  getStrictMatches(): number;
1341
- setStrictMatches(strictMatches: number): void;
1342
1246
  get contentMatches(): number;
1343
1247
  getContentMatches(): number;
1344
- setContentMatches(contentMatches: number): void;
1345
1248
  get layoutMatches(): number;
1346
1249
  getLayoutMatches(): number;
1347
- setLayoutMatches(layoutMatches: number): void;
1348
1250
  get noneMatches(): number;
1349
1251
  getNoneMatches(): number;
1350
- setNoneMatches(noneMatches: number): void;
1351
1252
  get url(): string;
1352
1253
  getUrl(): string;
1353
- setUrl(url: string): void;
1354
1254
  isPassed(): boolean;
1355
1255
  delete(): Promise<void>;
1356
- deleteSession(): Promise<void>;
1357
1256
  }
1358
1257
  export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
1359
1258
  readonly id?: string;
@@ -1400,14 +1299,14 @@ export type TestResultContainerPlain = { readonly exception?: Error; readonly te
1400
1299
  readonly layoutMatches?: number;
1401
1300
  readonly noneMatches?: number;
1402
1301
  readonly url?: string;
1403
- }; readonly browserInfo?: { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; }; };
1302
+ }; readonly browserInfo?: { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; } | { androidDeviceInfo: { deviceName: "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" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "portrait" | "landscape"; }; }; };
1404
1303
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1405
1304
  get testResults(): TestResultsPlain;
1406
1305
  getTestResults(): TestResults;
1407
1306
  get exception(): Error;
1408
1307
  getException(): Error;
1409
- get browserInfo(): { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; };
1410
- getBrowserInfo(): { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; };
1308
+ get browserInfo(): { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; } | { androidDeviceInfo: { deviceName: "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" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "portrait" | "landscape"; }; };
1309
+ getBrowserInfo(): { name?: "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"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; } | { androidDeviceInfo: { deviceName: "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" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "portrait" | "landscape"; }; };
1411
1310
  }
1412
1311
  export type TestResultsSummaryPlain = {
1413
1312
  results: Array<TestResultContainerPlain>;
@@ -1455,41 +1354,7 @@ export class Logger {
1455
1354
  fatal(...messages: Array<any>): void;
1456
1355
  open(): void;
1457
1356
  close(): void;
1458
- extend(options?: Omit<{
1459
- handler?: CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain | {
1460
- type: "rolling file";
1461
- dirname?: string;
1462
- name?: string;
1463
- maxFileLength?: number;
1464
- maxFileNumber?: number;
1465
- };
1466
- format?: (message: any, options: {
1467
- formatting?: boolean;
1468
- label?: string;
1469
- timestamp?: Date;
1470
- level?: "silent" | "fatal" | "error" | "warn" | "info";
1471
- tags?: Record<string, unknown>;
1472
- color?: string | Array<string>;
1473
- colors?: { timestamp?: string | Array<string>; level?: {
1474
- silent?: string | Array<string>;
1475
- fatal?: string | Array<string>;
1476
- error?: string | Array<string>;
1477
- warn?: string | Array<string>;
1478
- info?: string | Array<string>;
1479
- }; tags?: string | Array<string>; message?: string | Array<string>; };
1480
- }) => string;
1481
- label?: string;
1482
- timestamp?: false;
1483
- level?: number | ("silent" | "fatal" | "error" | "warn" | "info");
1484
- colors?: boolean | { timestamp?: string | Array<string>; level?: {
1485
- silent?: string | Array<string>;
1486
- fatal?: string | Array<string>;
1487
- error?: string | Array<string>;
1488
- warn?: string | Array<string>;
1489
- info?: string | Array<string>;
1490
- }; tags?: string | Array<string>; message?: string | Array<string>; };
1491
- console?: boolean | CustomLogHandlerPlain;
1492
- }, "handler">): Logger;
1357
+ tag(name: string, value: any): void;
1493
1358
  extend(label?: string): Logger;
1494
1359
  }
1495
1360
  export abstract class EyesRunner {
@@ -1499,11 +1364,7 @@ export class ClassicRunner extends EyesRunner {
1499
1364
  }
1500
1365
  export class VisualGridRunner extends EyesRunner {
1501
1366
  constructor(options?: RunnerOptionsPlain);
1502
- constructor(options?: RunnerOptionsFluent);
1503
- constructor(legacyConcurrency?: number);
1504
1367
  get testConcurrency(): number;
1505
- get legacyConcurrency(): number;
1506
- getConcurrentSessions(): number;
1507
1368
  }
1508
1369
  export abstract class SessionEventHandler {
1509
1370
  abstract initStarted(): any;