@applitools/eyes-selenium 4.59.2 → 4.59.3
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 +15 -0
- package/README.md +28 -1
- package/package.json +17 -13
- package/types/index.d.ts +61 -169
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,21 @@
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
11
|
+
## 4.59.3 - 2022/7/5
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
- Add the ability for the SDK to lazy load the page prior to performing a check window
|
|
15
|
+
- Support padding for regions in the following region types - ignoreRegions, layoutRegions, strictRegions, contentRegions
|
|
16
|
+
- Support `addMobileDevice` in user API for NMG
|
|
17
|
+
- Add support for dynamic coded regions
|
|
18
|
+
### Bug fixes
|
|
19
|
+
- Fix issue that prevented self-signed certificates from working when connecting through a proxy server
|
|
20
|
+
- Fixed native screenshots of the elements under large collapsing areas
|
|
21
|
+
- Fixed scrolling on some android devices
|
|
22
|
+
- Improved handling of touch padding related issues in native apps
|
|
23
|
+
- Prevented navbar from appearing on Android 12 screenshots
|
|
24
|
+
- Improve the logic that detects the side of native Android navigation bar
|
|
25
|
+
|
|
11
26
|
## 4.59.2 - 2022/6/9
|
|
12
27
|
|
|
13
28
|
### Features
|
package/README.md
CHANGED
|
@@ -378,6 +378,33 @@ eyes.check(Target.window().variationGroupId('Login button on the right'))
|
|
|
378
378
|
|
|
379
379
|
_For more information, visit our documentation page: https://applitools.com/docs/features/baseline-variations-groups.html_
|
|
380
380
|
|
|
381
|
+
##### Lazy loading (`lazyLoad`)
|
|
382
|
+
|
|
383
|
+
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.
|
|
384
|
+
|
|
385
|
+
```js
|
|
386
|
+
// lazy loads with sensible defaults
|
|
387
|
+
eyes.check(Target.window().lazyLoad())
|
|
388
|
+
|
|
389
|
+
// lazy loads with options specified
|
|
390
|
+
eyes.check(Target.window().lazyLoad({
|
|
391
|
+
maxAmountToScroll: 1000, // total pixels of the page to be scrolled
|
|
392
|
+
scrollLength: 250, // amount of pixels to use for each scroll attempt
|
|
393
|
+
waitingTime: 500, // milliseconds to wait in-between each scroll attempt
|
|
394
|
+
}))
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
Possible input types are:
|
|
398
|
+
|
|
399
|
+
- nothing (enables sensible defaults)
|
|
400
|
+
- options object (`{maxAmountToScroll, waitingTime, scrollLength}`)
|
|
401
|
+
|
|
402
|
+
Other details:
|
|
403
|
+
|
|
404
|
+
- If an option is omitted, the sensible default for that value will be used
|
|
405
|
+
- 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)
|
|
406
|
+
- 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
|
|
407
|
+
|
|
381
408
|
###### Other checkSettings configuration
|
|
382
409
|
|
|
383
410
|
<!-- TODO add explanation -->
|
|
@@ -954,4 +981,4 @@ Possible values for `iosVersion` are:
|
|
|
954
981
|
|
|
955
982
|
- `IosVersion.LATEST` - the latest iOS version that's supported by the UFG
|
|
956
983
|
- `IosVersion.LATEST_ONE_VERSION_BACK'` - one version prior to the latest version
|
|
957
|
-
- `undefined` - the UFG's default
|
|
984
|
+
- `undefined` - the UFG's default
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-selenium",
|
|
3
|
-
"version": "4.59.
|
|
3
|
+
"version": "4.59.3",
|
|
4
4
|
"description": "Applitools Eyes SDK for Selenium WebDriver",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-selenium",
|
|
@@ -24,13 +24,16 @@
|
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
26
26
|
"url": "git://github.com/applitools/eyes.sdk.javascript1.git",
|
|
27
|
-
"directory": "packages/eyes-selenium"
|
|
27
|
+
"directory": "js/packages/eyes-selenium"
|
|
28
28
|
},
|
|
29
29
|
"license": "SEE LICENSE IN LICENSE",
|
|
30
30
|
"author": {
|
|
31
31
|
"name": "Applitools Team",
|
|
32
32
|
"email": "team@applitools.com"
|
|
33
33
|
},
|
|
34
|
+
"aliases": [
|
|
35
|
+
"selenium"
|
|
36
|
+
],
|
|
34
37
|
"main": "./dist/index.js",
|
|
35
38
|
"types": "./types/index.d.ts",
|
|
36
39
|
"files": [
|
|
@@ -42,6 +45,7 @@
|
|
|
42
45
|
"build": "ttsc",
|
|
43
46
|
"generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-selenium'",
|
|
44
47
|
"test": "yarn test:coverage",
|
|
48
|
+
"test:sanity": "echo 'create sanity suite'",
|
|
45
49
|
"test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
|
|
46
50
|
"report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-selenium'",
|
|
47
51
|
"setup": "yarn docker:setup",
|
|
@@ -49,7 +53,7 @@
|
|
|
49
53
|
"docker:teardown": "docker-compose down",
|
|
50
54
|
"upgrade:framework": "if [ ! -z $APPLITOOLS_SELENIUM_MAJOR_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile selenium-webdriver@$APPLITOOLS_SELENIUM_MAJOR_VERSION; echo \"$packagejson\" > package.json; fi",
|
|
51
55
|
"deps": "bongo deps",
|
|
52
|
-
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-selenium utils driver snippets screenshoter'
|
|
56
|
+
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-selenium utils driver snippets screenshoter'",
|
|
53
57
|
"gh:publish": "gh workflow run publish-selenium.yml --ref $(git rev-parse --abbrev-ref HEAD)",
|
|
54
58
|
"preversion": "bongo preversion --verifyPendingChanges && yarn build",
|
|
55
59
|
"version": "bongo version --withPendingChanges",
|
|
@@ -61,23 +65,23 @@
|
|
|
61
65
|
}
|
|
62
66
|
},
|
|
63
67
|
"dependencies": {
|
|
64
|
-
"@applitools/eyes-api": "1.
|
|
65
|
-
"@applitools/eyes-sdk-core": "13.
|
|
66
|
-
"@applitools/spec-driver-selenium": "1.3.
|
|
67
|
-
"@applitools/visual-grid-client": "15.
|
|
68
|
+
"@applitools/eyes-api": "1.7.3",
|
|
69
|
+
"@applitools/eyes-sdk-core": "13.8.10",
|
|
70
|
+
"@applitools/spec-driver-selenium": "1.3.15",
|
|
71
|
+
"@applitools/visual-grid-client": "15.13.4"
|
|
68
72
|
},
|
|
69
73
|
"devDependencies": {
|
|
70
|
-
"@applitools/api-extractor": "1.2.
|
|
71
|
-
"@applitools/bongo": "^2.1.
|
|
74
|
+
"@applitools/api-extractor": "1.2.9",
|
|
75
|
+
"@applitools/bongo": "^2.1.6",
|
|
72
76
|
"@applitools/scripts": "1.1.0",
|
|
73
|
-
"@applitools/sdk-coverage-tests": "2.3.
|
|
74
|
-
"@applitools/sdk-shared": "0.9.
|
|
75
|
-
"@applitools/test-utils": "1.
|
|
77
|
+
"@applitools/sdk-coverage-tests": "2.3.19",
|
|
78
|
+
"@applitools/sdk-shared": "0.9.13",
|
|
79
|
+
"@applitools/test-utils": "1.4.2",
|
|
76
80
|
"@types/node": "12",
|
|
77
81
|
"@types/selenium-webdriver": "^4.1.1",
|
|
78
82
|
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
|
79
83
|
"@typescript-eslint/parser": "^5.27.0",
|
|
80
|
-
"chromedriver": "
|
|
84
|
+
"chromedriver": "102",
|
|
81
85
|
"eslint": "^8.16.0",
|
|
82
86
|
"eslint-config-prettier": "^8.5.0",
|
|
83
87
|
"eslint-plugin-mocha-no-only": "^1.1.1",
|
package/types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export type Driver = import('selenium-webdriver').WebDriver & { __applitoolsBrand?: never; };
|
|
2
2
|
export type Element = import('selenium-webdriver').WebElement & { __applitoolsBrand?: never; };
|
|
3
|
-
export type Selector = (import('selenium-webdriver').
|
|
3
|
+
export type Selector = (import('selenium-webdriver').By | import('selenium-webdriver').RelativeBy | import('selenium-webdriver').ByHash | { using: string; value: string; } | ((webdriver: import('selenium-webdriver').WebDriver) => Promise<any>)) & { __applitoolsBrand?: never; };
|
|
4
4
|
export class Eyes {
|
|
5
5
|
static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
|
|
6
6
|
constructor(runner?: EyesRunner, config?: ConfigurationPlain);
|
|
@@ -17,37 +17,15 @@ export class Eyes {
|
|
|
17
17
|
setConfiguration(config: ConfigurationPlain): void;
|
|
18
18
|
get isOpen(): boolean;
|
|
19
19
|
getIsOpen(): boolean;
|
|
20
|
-
on(handler: (event: string, data?: Record<string, any>) => any): () => void;
|
|
21
|
-
on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
|
|
22
|
-
on(event: "setSizeEnded", handler: () => any): () => void;
|
|
23
|
-
on(event: "initStarted", handler: () => any): () => void;
|
|
24
|
-
on(event: "initEnded", handler: () => any): () => void;
|
|
25
|
-
on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
|
|
26
|
-
on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
|
|
27
|
-
on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
|
|
28
|
-
on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
|
|
29
|
-
off(event: string): void;
|
|
30
|
-
off(handler: (...args: Array<any>) => any): void;
|
|
31
20
|
open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
|
|
32
21
|
open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
|
|
33
|
-
checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
|
|
34
|
-
checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
|
|
35
|
-
checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
|
|
36
|
-
checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
|
|
37
|
-
checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
|
|
38
|
-
checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
|
|
39
|
-
checkRegionBy(selector: EyesSelector<Selector>, name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
|
|
40
|
-
checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResult>;
|
|
41
22
|
check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
|
|
42
23
|
check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
|
|
43
24
|
locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
|
|
44
25
|
extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
45
26
|
extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
|
|
46
27
|
close(throwErr?: boolean): Promise<TestResults>;
|
|
47
|
-
closeAsync(): Promise<void>;
|
|
48
28
|
abort(): Promise<TestResults>;
|
|
49
|
-
abortAsync(): Promise<void>;
|
|
50
|
-
abortIfNotClosed(): Promise<TestResultsPlain>;
|
|
51
29
|
getViewportSize(): Promise<RectangleSize>;
|
|
52
30
|
setViewportSize(size: RectangleSizePlain): Promise<void>;
|
|
53
31
|
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
@@ -80,8 +58,6 @@ export class Eyes {
|
|
|
80
58
|
setAppName(appName: string): void;
|
|
81
59
|
getBaselineBranchName(): string;
|
|
82
60
|
setBaselineBranchName(baselineBranchName: string): void;
|
|
83
|
-
getBaselineName(): string;
|
|
84
|
-
setBaselineName(baselineName: string): void;
|
|
85
61
|
getBaselineEnvName(): string;
|
|
86
62
|
setBaselineEnvName(baselineEnvName: string): void;
|
|
87
63
|
getBranchName(): string;
|
|
@@ -130,23 +106,14 @@ export class Eyes {
|
|
|
130
106
|
setStitchMode(stitchMode: StitchModePlain): void;
|
|
131
107
|
getStitchOverlap(): number;
|
|
132
108
|
setStitchOverlap(stitchOverlap: number): void;
|
|
133
|
-
getSessionEventHandlers(): SessionEventHandlers;
|
|
134
|
-
addSessionEventHandler(handler: SessionEventHandler): void;
|
|
135
|
-
removeSessionEventHandler(handler: SessionEventHandler): void;
|
|
136
|
-
clearSessionEventHandlers(): void;
|
|
137
109
|
}
|
|
138
110
|
export type ConfigurationPlain = {
|
|
139
|
-
logs?: LogHandlerPlain;
|
|
140
|
-
debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
|
|
141
111
|
agentId?: string;
|
|
142
112
|
apiKey?: string;
|
|
143
113
|
serverUrl?: string;
|
|
144
114
|
proxy?: ProxySettingsPlain;
|
|
145
115
|
autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
|
|
146
116
|
isDisabled?: boolean;
|
|
147
|
-
connectionTimeout?: number;
|
|
148
|
-
removeSession?: boolean;
|
|
149
|
-
remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; };
|
|
150
117
|
appName?: string;
|
|
151
118
|
testName?: string;
|
|
152
119
|
displayName?: string;
|
|
@@ -171,7 +138,6 @@ export type ConfigurationPlain = {
|
|
|
171
138
|
saveFailedTests?: boolean;
|
|
172
139
|
saveNewTests?: boolean;
|
|
173
140
|
saveDiffs?: boolean;
|
|
174
|
-
dontCloseBatches?: boolean;
|
|
175
141
|
sendDom?: boolean;
|
|
176
142
|
matchTimeout?: number;
|
|
177
143
|
forceFullPageScreenshot?: boolean;
|
|
@@ -185,28 +151,13 @@ export type ConfigurationPlain = {
|
|
|
185
151
|
rotation?: ImageRotationPlain;
|
|
186
152
|
scaleRatio?: number;
|
|
187
153
|
waitBeforeCapture?: number;
|
|
188
|
-
|
|
189
|
-
browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
|
|
154
|
+
browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
190
155
|
visualGridOptions?: Record<string, any>;
|
|
191
156
|
layoutBreakpoints?: boolean | Array<number>;
|
|
192
157
|
disableBrowserFetching?: boolean;
|
|
193
158
|
};
|
|
194
159
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
195
160
|
constructor(config?: ConfigurationPlain);
|
|
196
|
-
get logs(): LogHandlerPlain;
|
|
197
|
-
set logs(logs: LogHandlerPlain);
|
|
198
|
-
getShowLogs(): boolean;
|
|
199
|
-
setShowLogs(show: boolean): Configuration;
|
|
200
|
-
getLogHandler(): LogHandlerPlain;
|
|
201
|
-
setLogHandler(handler: LogHandlerPlain): Configuration;
|
|
202
|
-
get debugScreenshots(): { save: boolean; path?: string; prefix?: string; };
|
|
203
|
-
set debugScreenshots(debugScreenshots: { save: boolean; path?: string; prefix?: string; });
|
|
204
|
-
getSaveDebugScreenshots(): boolean;
|
|
205
|
-
setSaveDebugScreenshots(save: boolean): Configuration;
|
|
206
|
-
getDebugScreenshotsPath(): string;
|
|
207
|
-
setDebugScreenshotsPath(path: string): Configuration;
|
|
208
|
-
getDebugScreenshotsPrefix(): string;
|
|
209
|
-
setDebugScreenshotsPrefix(prefix: string): Configuration;
|
|
210
161
|
get appName(): string;
|
|
211
162
|
set appName(appName: string);
|
|
212
163
|
getAppName(): string;
|
|
@@ -257,18 +208,6 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
257
208
|
set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
|
|
258
209
|
getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
|
|
259
210
|
setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
|
|
260
|
-
get connectionTimeout(): number;
|
|
261
|
-
set connectionTimeout(connectionTimeout: number);
|
|
262
|
-
getConnectionTimeout(): number;
|
|
263
|
-
setConnectionTimeout(connectionTimeout: number): Configuration;
|
|
264
|
-
get removeSession(): boolean;
|
|
265
|
-
set removeSession(removeSession: boolean);
|
|
266
|
-
getRemoveSession(): boolean;
|
|
267
|
-
setRemoveSession(removeSession: boolean): Configuration;
|
|
268
|
-
get remoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
|
|
269
|
-
set remoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; });
|
|
270
|
-
getRemoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
|
|
271
|
-
setRemoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }): Configuration;
|
|
272
211
|
get batch(): BatchInfoPlain;
|
|
273
212
|
set batch(batch: BatchInfoPlain);
|
|
274
213
|
getBatch(): BatchInfo;
|
|
@@ -408,18 +347,16 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
408
347
|
set scaleRatio(scaleRatio: number);
|
|
409
348
|
getScaleRatio(): number;
|
|
410
349
|
setScaleRatio(scaleRatio: number): Configuration;
|
|
411
|
-
get
|
|
412
|
-
set
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>;
|
|
418
|
-
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
|
|
419
|
-
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
|
|
420
|
-
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo): Configuration;
|
|
350
|
+
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
351
|
+
set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
|
|
352
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
353
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
354
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
355
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
|
|
421
356
|
addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
|
|
422
357
|
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
|
|
358
|
+
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
|
|
359
|
+
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
|
|
423
360
|
get visualGridOptions(): { [key: string]: any; };
|
|
424
361
|
set visualGridOptions(visualGridOptions: { [key: string]: any; });
|
|
425
362
|
getVisualGridOptions(): { [key: string]: any; };
|
|
@@ -433,10 +370,6 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
433
370
|
set disableBrowserFetching(disableBrowserFetching: boolean);
|
|
434
371
|
getDisableBrowserFetching(): boolean;
|
|
435
372
|
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
436
|
-
get dontCloseBatches(): boolean;
|
|
437
|
-
set dontCloseBatches(dontCloseBatches: boolean);
|
|
438
|
-
getDontCloseBatches(): boolean;
|
|
439
|
-
setDontCloseBatches(dontCloseBatches: boolean): Configuration;
|
|
440
373
|
}
|
|
441
374
|
export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
|
|
442
375
|
export type CheckSettingsPlain = {
|
|
@@ -451,18 +384,19 @@ export type CheckSettingsPlain = {
|
|
|
451
384
|
enablePatterns?: boolean;
|
|
452
385
|
ignoreDisplacements?: boolean;
|
|
453
386
|
ignoreCaret?: boolean;
|
|
454
|
-
ignoreRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
|
|
455
|
-
layoutRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
|
|
456
|
-
strictRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
|
|
457
|
-
contentRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
|
|
387
|
+
ignoreRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
388
|
+
layoutRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
389
|
+
strictRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
390
|
+
contentRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
458
391
|
floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
459
392
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
460
393
|
maxUpOffset?: number;
|
|
461
394
|
maxDownOffset?: number;
|
|
462
395
|
maxLeftOffset?: number;
|
|
463
396
|
maxRightOffset?: number;
|
|
397
|
+
regionId?: string;
|
|
464
398
|
}>;
|
|
465
|
-
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; }>;
|
|
399
|
+
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; }>;
|
|
466
400
|
disableBrowserFetching?: boolean;
|
|
467
401
|
layoutBreakpoints?: boolean | Array<number>;
|
|
468
402
|
visualGridOptions?: { [key: string]: any; };
|
|
@@ -472,31 +406,30 @@ export type CheckSettingsPlain = {
|
|
|
472
406
|
variationGroupId?: string;
|
|
473
407
|
timeout?: number;
|
|
474
408
|
waitBeforeCapture?: number;
|
|
409
|
+
lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
|
|
475
410
|
};
|
|
476
411
|
export class CheckSettings {
|
|
477
412
|
constructor(settings?: CheckSettingsPlain);
|
|
478
|
-
name(name: string): CheckSettings;
|
|
479
413
|
withName(name: string): CheckSettings;
|
|
480
414
|
region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
481
415
|
shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
|
|
482
416
|
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;
|
|
483
417
|
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;
|
|
484
|
-
ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
485
|
-
ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
493
|
-
contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
418
|
+
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;
|
|
419
|
+
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;
|
|
420
|
+
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;
|
|
421
|
+
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;
|
|
422
|
+
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;
|
|
423
|
+
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;
|
|
424
|
+
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;
|
|
425
|
+
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;
|
|
494
426
|
floatingRegion(region: {
|
|
495
427
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
496
428
|
maxUpOffset?: number;
|
|
497
429
|
maxDownOffset?: number;
|
|
498
430
|
maxLeftOffset?: number;
|
|
499
431
|
maxRightOffset?: number;
|
|
432
|
+
regionId?: string;
|
|
500
433
|
}): CheckSettings;
|
|
501
434
|
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;
|
|
502
435
|
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
@@ -505,31 +438,15 @@ export class CheckSettings {
|
|
|
505
438
|
maxDownOffset?: number;
|
|
506
439
|
maxLeftOffset?: number;
|
|
507
440
|
maxRightOffset?: number;
|
|
441
|
+
regionId?: string;
|
|
508
442
|
}>): CheckSettings;
|
|
509
443
|
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
510
|
-
|
|
511
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
512
|
-
maxUpOffset?: number;
|
|
513
|
-
maxDownOffset?: number;
|
|
514
|
-
maxLeftOffset?: number;
|
|
515
|
-
maxRightOffset?: number;
|
|
516
|
-
}): CheckSettings;
|
|
517
|
-
floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
518
|
-
floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
519
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
520
|
-
maxUpOffset?: number;
|
|
521
|
-
maxDownOffset?: number;
|
|
522
|
-
maxLeftOffset?: number;
|
|
523
|
-
maxRightOffset?: number;
|
|
524
|
-
}>): CheckSettings;
|
|
525
|
-
floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
526
|
-
accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
|
|
444
|
+
accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }): CheckSettings;
|
|
527
445
|
accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
|
|
528
|
-
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;
|
|
446
|
+
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;
|
|
529
447
|
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
530
448
|
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
|
|
531
449
|
fully(fully?: boolean): CheckSettings;
|
|
532
|
-
stitchContent(stitchContent?: boolean): CheckSettings;
|
|
533
450
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
|
|
534
451
|
layout(): CheckSettings;
|
|
535
452
|
exact(): CheckSettings;
|
|
@@ -544,7 +461,6 @@ export class CheckSettings {
|
|
|
544
461
|
layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
|
|
545
462
|
hook(name: string, script: string): CheckSettings;
|
|
546
463
|
beforeRenderScreenshotHook(script: string): CheckSettings;
|
|
547
|
-
webHook(script: string): CheckSettings;
|
|
548
464
|
visualGridOption(key: string, value: any): CheckSettings;
|
|
549
465
|
visualGridOptions(options: { [key: string]: any; }): CheckSettings;
|
|
550
466
|
renderId(renderId: string): CheckSettings;
|
|
@@ -552,6 +468,7 @@ export class CheckSettings {
|
|
|
552
468
|
variationGroupId(variationGroupId: string): CheckSettings;
|
|
553
469
|
timeout(timeout: number): CheckSettings;
|
|
554
470
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
|
|
471
|
+
lazyLoad(options: { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
|
|
555
472
|
}
|
|
556
473
|
export const Target: {
|
|
557
474
|
window(): CheckSettings;
|
|
@@ -721,6 +638,33 @@ export enum IosVersion {
|
|
|
721
638
|
ONE_VERSION_BACK = 'latest-1',
|
|
722
639
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
723
640
|
}
|
|
641
|
+
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";
|
|
642
|
+
export enum AndroidDeviceName {
|
|
643
|
+
Pixel_3_XL = 'Pixel 3 XL',
|
|
644
|
+
Pixel_4 = 'Pixel 4',
|
|
645
|
+
Pixel_4_XL = 'Pixel 4 XL',
|
|
646
|
+
Galaxy_Note_8 = 'Galaxy Note 8',
|
|
647
|
+
Galaxy_Note_9 = 'Galaxy Note 9',
|
|
648
|
+
Galaxy_S8 = 'Galaxy S8',
|
|
649
|
+
Galaxy_S8_Plus = 'Galaxy S8 Plus',
|
|
650
|
+
Galaxy_S9 = 'Galaxy S9',
|
|
651
|
+
Galaxy_S9_Plus = 'Galaxy S9 Plus',
|
|
652
|
+
Galaxy_S10 = 'Galaxy S10',
|
|
653
|
+
Galaxy_S10_Plus = 'Galaxy S10 Plus',
|
|
654
|
+
Galaxy_Note_10 = 'Galaxy Note 10',
|
|
655
|
+
Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
|
|
656
|
+
Galaxy_S20 = 'Galaxy S20',
|
|
657
|
+
Galaxy_S20_Plus = 'Galaxy S20 Plus',
|
|
658
|
+
Galaxy_S21 = 'Galaxy S21',
|
|
659
|
+
Galaxy_S21_Plus = 'Galaxy S21 Plus',
|
|
660
|
+
Galaxy_S21_Ultra = 'Galaxy S21 Ultra'
|
|
661
|
+
}
|
|
662
|
+
export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
|
|
663
|
+
export enum AndroidVersion {
|
|
664
|
+
LATEST = 'latest',
|
|
665
|
+
ONE_VERSION_BACK = 'latest-1',
|
|
666
|
+
TWO_VERSIONS_BACK = 'latest-2'
|
|
667
|
+
}
|
|
724
668
|
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
|
|
725
669
|
export enum MatchLevel {
|
|
726
670
|
None = 'None',
|
|
@@ -1136,6 +1080,7 @@ export class Region implements Required<RegionPlain> {
|
|
|
1136
1080
|
export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
|
|
1137
1081
|
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1138
1082
|
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1083
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1139
1084
|
export type RunnerOptionsPlain = { testConcurrency?: number; };
|
|
1140
1085
|
export class RunnerOptionsFluent {
|
|
1141
1086
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1152,46 +1097,35 @@ export type ApiUrlsPlain = {
|
|
|
1152
1097
|
export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
1153
1098
|
get baselineImage(): string;
|
|
1154
1099
|
getBaselineImage(): string;
|
|
1155
|
-
setBaselineImage(setBaselineImage: string): void;
|
|
1156
1100
|
get currentImage(): string;
|
|
1157
1101
|
getCurrentImage(): string;
|
|
1158
|
-
setCurrentImage(currentImage: string): void;
|
|
1159
1102
|
get checkpointImage(): string;
|
|
1160
1103
|
getCheckpointImage(): string;
|
|
1161
|
-
setCheckpointImage(checkpointImage: string): void;
|
|
1162
1104
|
get checkpointImageThumbnail(): string;
|
|
1163
1105
|
getCheckpointImageThumbnail(): string;
|
|
1164
|
-
setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
|
|
1165
1106
|
get diffImage(): string;
|
|
1166
1107
|
getDiffImage(): string;
|
|
1167
|
-
setDiffImage(diffImage: string): void;
|
|
1168
1108
|
}
|
|
1169
1109
|
export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
|
|
1170
1110
|
export class AppUrls implements Required<AppUrlsPlain> {
|
|
1171
1111
|
get step(): string;
|
|
1172
1112
|
getStep(): string;
|
|
1173
|
-
setStep(step: string): void;
|
|
1174
1113
|
get stepEditor(): string;
|
|
1175
1114
|
getStepEditor(): string;
|
|
1176
|
-
setStepEditor(stepEditor: string): void;
|
|
1177
1115
|
}
|
|
1178
1116
|
export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
|
|
1179
1117
|
export class MatchResult implements Required<MatchResultPlain> {
|
|
1180
1118
|
get asExpected(): boolean;
|
|
1181
1119
|
getAsExpected(): boolean;
|
|
1182
|
-
setAsExpected(asExpected: boolean): void;
|
|
1183
1120
|
get windowId(): number;
|
|
1184
1121
|
getWindowId(): number;
|
|
1185
|
-
setWindowId(windowId: number): void;
|
|
1186
1122
|
}
|
|
1187
1123
|
export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
|
|
1188
1124
|
export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
1189
1125
|
get batch(): string;
|
|
1190
1126
|
getBatch(): string;
|
|
1191
|
-
setBatch(batch: string): void;
|
|
1192
1127
|
get session(): string;
|
|
1193
1128
|
getSession(): string;
|
|
1194
|
-
setSession(session: string): void;
|
|
1195
1129
|
}
|
|
1196
1130
|
export type StepInfoPlain = {
|
|
1197
1131
|
readonly name?: string;
|
|
@@ -1205,25 +1139,18 @@ export type StepInfoPlain = {
|
|
|
1205
1139
|
export class StepInfo implements Required<StepInfoPlain> {
|
|
1206
1140
|
get name(): string;
|
|
1207
1141
|
getName(): string;
|
|
1208
|
-
setName(value: string): void;
|
|
1209
1142
|
get isDifferent(): boolean;
|
|
1210
1143
|
getIsDifferent(): boolean;
|
|
1211
|
-
setIsDifferent(value: boolean): void;
|
|
1212
1144
|
get hasBaselineImage(): boolean;
|
|
1213
1145
|
getHasBaselineImage(): boolean;
|
|
1214
|
-
setHasBaselineImage(value: boolean): void;
|
|
1215
1146
|
get hasCurrentImage(): boolean;
|
|
1216
1147
|
getHasCurrentImage(): boolean;
|
|
1217
|
-
setHasCurrentImage(hasCurrentImage: boolean): void;
|
|
1218
1148
|
get appUrls(): AppUrlsPlain;
|
|
1219
1149
|
getAppUrls(): AppUrls;
|
|
1220
|
-
setAppUrls(appUrls: AppUrlsPlain): void;
|
|
1221
1150
|
get apiUrls(): ApiUrlsPlain;
|
|
1222
1151
|
getApiUrls(): ApiUrls;
|
|
1223
|
-
setApiUrls(apiUrls: ApiUrlsPlain): void;
|
|
1224
1152
|
get renderId(): Array<string>;
|
|
1225
1153
|
getRenderId(): Array<string>;
|
|
1226
|
-
setRenderId(renderId: Array<string>): void;
|
|
1227
1154
|
}
|
|
1228
1155
|
export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
|
|
1229
1156
|
export type TestResultsPlain = {
|
|
@@ -1261,97 +1188,66 @@ export type TestResultsPlain = {
|
|
|
1261
1188
|
export class TestResults implements Required<TestResultsPlain> {
|
|
1262
1189
|
get id(): string;
|
|
1263
1190
|
getId(): string;
|
|
1264
|
-
setId(id: string): void;
|
|
1265
1191
|
get name(): string;
|
|
1266
1192
|
getName(): string;
|
|
1267
|
-
setName(name: string): void;
|
|
1268
1193
|
get secretToken(): string;
|
|
1269
1194
|
getSecretToken(): string;
|
|
1270
|
-
setSecretToken(secretToken: string): void;
|
|
1271
1195
|
get status(): TestResultsStatusPlain;
|
|
1272
1196
|
getStatus(): TestResultsStatus;
|
|
1273
|
-
setStatus(status: TestResultsStatus): void;
|
|
1274
1197
|
get appName(): string;
|
|
1275
1198
|
getAppName(): string;
|
|
1276
|
-
setAppName(appName: string): void;
|
|
1277
1199
|
get batchName(): string;
|
|
1278
1200
|
getBatchName(): string;
|
|
1279
|
-
setBatchName(batchName: string): void;
|
|
1280
1201
|
get batchId(): string;
|
|
1281
1202
|
getBatchId(): string;
|
|
1282
|
-
setBatchId(batchId: string): void;
|
|
1283
1203
|
get branchName(): string;
|
|
1284
1204
|
getBranchName(): string;
|
|
1285
|
-
setBranchName(branchName: string): void;
|
|
1286
1205
|
get hostOS(): string;
|
|
1287
1206
|
getHostOS(): string;
|
|
1288
|
-
setHostOS(hostOS: string): void;
|
|
1289
1207
|
get hostApp(): string;
|
|
1290
1208
|
getHostApp(): string;
|
|
1291
|
-
setHostApp(hostApp: string): void;
|
|
1292
1209
|
get hostDisplaySize(): RectangleSizePlain;
|
|
1293
1210
|
getHostDisplaySize(): RectangleSize;
|
|
1294
|
-
setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
|
|
1295
1211
|
get accessibilityStatus(): TestAccessibilityStatus;
|
|
1296
1212
|
getAccessibilityStatus(): TestAccessibilityStatus;
|
|
1297
|
-
setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
|
|
1298
1213
|
get startedAt(): string | Date;
|
|
1299
1214
|
getStartedAt(): Date;
|
|
1300
|
-
setStartedAt(startedAt: string | Date): void;
|
|
1301
1215
|
get duration(): number;
|
|
1302
1216
|
getDuration(): number;
|
|
1303
|
-
setDuration(duration: number): void;
|
|
1304
1217
|
get isNew(): boolean;
|
|
1305
1218
|
getIsNew(): boolean;
|
|
1306
|
-
setIsNew(isNew: boolean): void;
|
|
1307
1219
|
get isDifferent(): boolean;
|
|
1308
1220
|
getIsDifferent(): boolean;
|
|
1309
|
-
setIsDifferent(isDifferent: boolean): void;
|
|
1310
1221
|
get isAborted(): boolean;
|
|
1311
1222
|
getIsAborted(): boolean;
|
|
1312
|
-
setIsAborted(isAborted: boolean): void;
|
|
1313
1223
|
get appUrls(): SessionUrlsPlain;
|
|
1314
1224
|
getAppUrls(): SessionUrls;
|
|
1315
|
-
setAppUrls(appUrls: SessionUrlsPlain): void;
|
|
1316
1225
|
get apiUrls(): SessionUrlsPlain;
|
|
1317
1226
|
getApiUrls(): SessionUrls;
|
|
1318
|
-
setApiUrls(apiUrls: SessionUrlsPlain): void;
|
|
1319
1227
|
get stepsInfo(): Array<StepInfoPlain>;
|
|
1320
1228
|
getStepsInfo(): Array<StepInfo>;
|
|
1321
|
-
setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
|
|
1322
1229
|
get steps(): number;
|
|
1323
1230
|
getSteps(): number;
|
|
1324
|
-
setSteps(steps: number): void;
|
|
1325
1231
|
get matches(): number;
|
|
1326
1232
|
getMatches(): number;
|
|
1327
|
-
setMatches(matches: number): void;
|
|
1328
1233
|
get mismatches(): number;
|
|
1329
1234
|
getMismatches(): number;
|
|
1330
|
-
setMismatches(mismatches: number): void;
|
|
1331
1235
|
get missing(): number;
|
|
1332
1236
|
getMissing(): number;
|
|
1333
|
-
setMissing(missing: number): void;
|
|
1334
1237
|
get exactMatches(): number;
|
|
1335
1238
|
getExactMatches(): number;
|
|
1336
|
-
setExactMatches(exactMatches: number): void;
|
|
1337
1239
|
get strictMatches(): number;
|
|
1338
1240
|
getStrictMatches(): number;
|
|
1339
|
-
setStrictMatches(strictMatches: number): void;
|
|
1340
1241
|
get contentMatches(): number;
|
|
1341
1242
|
getContentMatches(): number;
|
|
1342
|
-
setContentMatches(contentMatches: number): void;
|
|
1343
1243
|
get layoutMatches(): number;
|
|
1344
1244
|
getLayoutMatches(): number;
|
|
1345
|
-
setLayoutMatches(layoutMatches: number): void;
|
|
1346
1245
|
get noneMatches(): number;
|
|
1347
1246
|
getNoneMatches(): number;
|
|
1348
|
-
setNoneMatches(noneMatches: number): void;
|
|
1349
1247
|
get url(): string;
|
|
1350
1248
|
getUrl(): string;
|
|
1351
|
-
setUrl(url: string): void;
|
|
1352
1249
|
isPassed(): boolean;
|
|
1353
1250
|
delete(): Promise<void>;
|
|
1354
|
-
deleteSession(): Promise<void>;
|
|
1355
1251
|
}
|
|
1356
1252
|
export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
|
|
1357
1253
|
readonly id?: string;
|
|
@@ -1398,14 +1294,14 @@ export type TestResultContainerPlain = { readonly exception?: Error; readonly te
|
|
|
1398
1294
|
readonly layoutMatches?: number;
|
|
1399
1295
|
readonly noneMatches?: number;
|
|
1400
1296
|
readonly url?: string;
|
|
1401
|
-
}; 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"; }; }; };
|
|
1297
|
+
}; 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"; }; }; };
|
|
1402
1298
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1403
1299
|
get testResults(): TestResultsPlain;
|
|
1404
1300
|
getTestResults(): TestResults;
|
|
1405
1301
|
get exception(): Error;
|
|
1406
1302
|
getException(): Error;
|
|
1407
|
-
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"; }; };
|
|
1408
|
-
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"; }; };
|
|
1303
|
+
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"; }; };
|
|
1304
|
+
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"; }; };
|
|
1409
1305
|
}
|
|
1410
1306
|
export type TestResultsSummaryPlain = {
|
|
1411
1307
|
results: Array<TestResultContainerPlain>;
|
|
@@ -1464,11 +1360,7 @@ export class ClassicRunner extends EyesRunner {
|
|
|
1464
1360
|
}
|
|
1465
1361
|
export class VisualGridRunner extends EyesRunner {
|
|
1466
1362
|
constructor(options?: RunnerOptionsPlain);
|
|
1467
|
-
constructor(options?: RunnerOptionsFluent);
|
|
1468
|
-
constructor(legacyConcurrency?: number);
|
|
1469
1363
|
get testConcurrency(): number;
|
|
1470
|
-
get legacyConcurrency(): number;
|
|
1471
|
-
getConcurrentSessions(): number;
|
|
1472
1364
|
}
|
|
1473
1365
|
export abstract class SessionEventHandler {
|
|
1474
1366
|
abstract initStarted(): any;
|