@applitools/eyes-playwright 1.12.1 → 1.12.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 +31 -0
- package/README.md +29 -2
- package/dist/api.js +3 -5
- package/package.json +15 -12
- package/types/index.d.ts +148 -238
package/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,37 @@
|
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## 1.12.3 - 2022/9/23
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
- Don't fail `eyes.open` when there is a failure to set viewport size in `UFG`.
|
|
18
|
+
- Using `lazyLoad.waitingTime` as a delay between stitches by default
|
|
19
|
+
- Added `Sony Xperia 10 II` emulation device
|
|
20
|
+
- Added `iPhone 14` and `iPhone 14 Pro Max` ios devices
|
|
21
|
+
### Bug fixes
|
|
22
|
+
- Fixed incorrect calculation of the target element position.
|
|
23
|
+
|
|
24
|
+
## 1.12.2 - 2022/7/28
|
|
25
|
+
|
|
26
|
+
### Features
|
|
27
|
+
- Added support for taking full screenshots of elements that are scroll by pages only
|
|
28
|
+
- Allowed `` values in custom properties
|
|
29
|
+
- Add special attribute for pseudo elements
|
|
30
|
+
- Add the ability for the SDK to lazy load the page prior to performing a check window
|
|
31
|
+
- Support padding for regions in the following region types - ignoreRegions, layoutRegions, strictRegions, contentRegions
|
|
32
|
+
- Support `addMobileDevice` in user API for NMG
|
|
33
|
+
- Add support for dynamic coded regions
|
|
34
|
+
### Bug fixes
|
|
35
|
+
- Fixed broken links to enums implementation in the README.md
|
|
36
|
+
- Fixed `forceFullPageScreenshot` option behavior
|
|
37
|
+
- Fix calling `waitBeforeCapture` when failed to set required viewport size
|
|
38
|
+
- Fix rendering issues with Salesforce Lightning design system
|
|
39
|
+
- Fix issue that prevented self-signed certificates from working when connecting through a proxy server
|
|
40
|
+
- Fixed bug where a failure in a single UFG environment fails all other environments in the same configuration
|
|
41
|
+
- Better support in DOM slot element
|
|
42
|
+
|
|
12
43
|
## 1.12.1 - 2022/6/2
|
|
13
44
|
|
|
14
45
|
### Features
|
package/README.md
CHANGED
|
@@ -356,6 +356,33 @@ Defines a name for the checkpoint in the Eyes Test Manager. The name may be any
|
|
|
356
356
|
eyes.check(Target.window().withName('Main page'))
|
|
357
357
|
```
|
|
358
358
|
|
|
359
|
+
##### Lazy loading (`lazyLoad`)
|
|
360
|
+
|
|
361
|
+
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.
|
|
362
|
+
|
|
363
|
+
```js
|
|
364
|
+
// lazy loads with sensible defaults
|
|
365
|
+
eyes.check(Target.window().lazyLoad())
|
|
366
|
+
|
|
367
|
+
// lazy loads with options specified
|
|
368
|
+
eyes.check(Target.window().lazyLoad({
|
|
369
|
+
maxAmountToScroll: 1000, // total pixels of the page to be scrolled
|
|
370
|
+
scrollLength: 250, // amount of pixels to use for each scroll attempt
|
|
371
|
+
waitingTime: 500, // milliseconds to wait in-between each scroll attempt
|
|
372
|
+
}))
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
Possible input types are:
|
|
376
|
+
|
|
377
|
+
- nothing (enables sensible defaults)
|
|
378
|
+
- options object (`{maxAmountToScroll, waitingTime, scrollLength}`)
|
|
379
|
+
|
|
380
|
+
Other details:
|
|
381
|
+
|
|
382
|
+
- If an option is omitted, the sensible default for that value will be used
|
|
383
|
+
- 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)
|
|
384
|
+
- 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
|
|
385
|
+
|
|
359
386
|
###### Other checkSettings configuration
|
|
360
387
|
|
|
361
388
|
<!-- TODO add explanation -->
|
|
@@ -867,10 +894,10 @@ configuration.addBrowser({
|
|
|
867
894
|
eyes.setConfiguration(configuration)
|
|
868
895
|
```
|
|
869
896
|
|
|
870
|
-
The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-
|
|
897
|
+
The list of devices is available at https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-api/src/enums/IosDeviceName.ts
|
|
871
898
|
|
|
872
899
|
Possible values for `iosVersion` are:
|
|
873
900
|
|
|
874
901
|
- `IosVersion.LATEST` - the latest iOS version that's supported by the UFG
|
|
875
902
|
- `IosVersion.LATEST_ONE_VERSION_BACK'` - one version prior to the latest version
|
|
876
|
-
- `undefined` - the UFG's default
|
|
903
|
+
- `undefined` - the UFG's default
|
package/dist/api.js
CHANGED
|
@@ -27,14 +27,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
};
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
29
|
exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = void 0;
|
|
30
|
-
const
|
|
30
|
+
const core_1 = require("@applitools/core");
|
|
31
31
|
const api = __importStar(require("@applitools/eyes-api"));
|
|
32
32
|
const spec = __importStar(require("@applitools/spec-driver-playwright"));
|
|
33
|
-
const sdk = (0,
|
|
34
|
-
|
|
35
|
-
version: require('../package.json').version,
|
|
33
|
+
const sdk = (0, core_1.makeCore)({
|
|
34
|
+
agentId: `eyes.playwright/${require('../package.json').version}`,
|
|
36
35
|
spec,
|
|
37
|
-
VisualGridClient: require('@applitools/visual-grid-client'),
|
|
38
36
|
});
|
|
39
37
|
__exportStar(require("@applitools/eyes-api"), exports);
|
|
40
38
|
class Eyes extends api.Eyes {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-playwright",
|
|
3
|
-
"version": "1.12.
|
|
3
|
+
"version": "1.12.3",
|
|
4
4
|
"description": "Applitools Eyes SDK for Playwright",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-playwright",
|
|
@@ -20,13 +20,16 @@
|
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|
|
22
22
|
"url": "git@github.com:applitools/eyes.sdk.javascript1.git",
|
|
23
|
-
"directory": "packages/eyes-playwright"
|
|
23
|
+
"directory": "js/packages/eyes-playwright"
|
|
24
24
|
},
|
|
25
25
|
"license": "SEE LICENSE IN LICENSE",
|
|
26
26
|
"author": {
|
|
27
27
|
"name": "Applitools Team",
|
|
28
28
|
"email": "team@applitools.com"
|
|
29
29
|
},
|
|
30
|
+
"aliases": [
|
|
31
|
+
"playwright"
|
|
32
|
+
],
|
|
30
33
|
"main": "./dist/index.js",
|
|
31
34
|
"types": "./types/index.d.ts",
|
|
32
35
|
"files": [
|
|
@@ -38,11 +41,12 @@
|
|
|
38
41
|
"build": "ttsc",
|
|
39
42
|
"generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-playwright'",
|
|
40
43
|
"test": "yarn test:coverage",
|
|
44
|
+
"test:sanity": "echo 'create sanity suite'",
|
|
41
45
|
"test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
|
|
42
46
|
"report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-playwright'",
|
|
43
47
|
"upgrade:framework": "if [ ! -z $APPLITOOLS_PLAYWRIGHT_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile playwright@$APPLITOOLS_PLAYWRIGHT_VERSION; echo \"$packagejson\" > package.json; fi",
|
|
44
48
|
"deps": "bongo deps",
|
|
45
|
-
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='playwright' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-playwright utils driver snippets screenshoter'
|
|
49
|
+
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='playwright' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-playwright utils driver snippets screenshoter'",
|
|
46
50
|
"gh:publish": "gh workflow run publish-playwright.yml --ref $(git rev-parse --abbrev-ref HEAD)",
|
|
47
51
|
"preversion": "bongo preversion --verifyPendingChanges && yarn build",
|
|
48
52
|
"version": "bongo version --withPendingChanges",
|
|
@@ -54,18 +58,17 @@
|
|
|
54
58
|
}
|
|
55
59
|
},
|
|
56
60
|
"dependencies": {
|
|
57
|
-
"@applitools/
|
|
58
|
-
"@applitools/eyes-
|
|
59
|
-
"@applitools/spec-driver-playwright": "1.3.
|
|
60
|
-
"@applitools/visual-grid-client": "15.12.37"
|
|
61
|
+
"@applitools/core": "1.0.4",
|
|
62
|
+
"@applitools/eyes-api": "1.7.8",
|
|
63
|
+
"@applitools/spec-driver-playwright": "1.3.3"
|
|
61
64
|
},
|
|
62
65
|
"devDependencies": {
|
|
63
|
-
"@applitools/api-extractor": "1.2.
|
|
64
|
-
"@applitools/bongo": "^2.
|
|
66
|
+
"@applitools/api-extractor": "1.2.11",
|
|
67
|
+
"@applitools/bongo": "^2.2.0",
|
|
65
68
|
"@applitools/scripts": "1.1.0",
|
|
66
|
-
"@applitools/sdk-coverage-tests": "2.3.
|
|
67
|
-
"@applitools/sdk-shared": "0.9.
|
|
68
|
-
"@applitools/test-utils": "1.
|
|
69
|
+
"@applitools/sdk-coverage-tests": "2.3.20",
|
|
70
|
+
"@applitools/sdk-shared": "0.9.14",
|
|
71
|
+
"@applitools/test-utils": "1.5.1",
|
|
69
72
|
"@types/mocha": "^9.1.1",
|
|
70
73
|
"@types/node": "12",
|
|
71
74
|
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
package/types/index.d.ts
CHANGED
|
@@ -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
|
-
extractText(
|
|
26
|
+
extractText(settings: 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,21 @@ 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
|
-
autProxy?: {
|
|
115
|
+
autProxy?: {
|
|
116
|
+
url: string;
|
|
117
|
+
username?: string;
|
|
118
|
+
password?: string;
|
|
119
|
+
isHttpOnly?: boolean;
|
|
120
|
+
mode?: "Allow" | "Block";
|
|
121
|
+
domains?: Array<string>;
|
|
122
|
+
};
|
|
146
123
|
isDisabled?: boolean;
|
|
147
|
-
connectionTimeout?: number;
|
|
148
|
-
removeSession?: boolean;
|
|
149
|
-
remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; };
|
|
150
124
|
appName?: string;
|
|
151
125
|
testName?: string;
|
|
152
126
|
displayName?: string;
|
|
@@ -171,7 +145,6 @@ export type ConfigurationPlain = {
|
|
|
171
145
|
saveFailedTests?: boolean;
|
|
172
146
|
saveNewTests?: boolean;
|
|
173
147
|
saveDiffs?: boolean;
|
|
174
|
-
dontCloseBatches?: boolean;
|
|
175
148
|
sendDom?: boolean;
|
|
176
149
|
matchTimeout?: number;
|
|
177
150
|
forceFullPageScreenshot?: boolean;
|
|
@@ -185,28 +158,13 @@ export type ConfigurationPlain = {
|
|
|
185
158
|
rotation?: ImageRotationPlain;
|
|
186
159
|
scaleRatio?: number;
|
|
187
160
|
waitBeforeCapture?: number;
|
|
188
|
-
|
|
189
|
-
browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
|
|
161
|
+
browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
190
162
|
visualGridOptions?: Record<string, any>;
|
|
191
163
|
layoutBreakpoints?: boolean | Array<number>;
|
|
192
164
|
disableBrowserFetching?: boolean;
|
|
193
165
|
};
|
|
194
166
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
195
|
-
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;
|
|
167
|
+
constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
|
|
210
168
|
get appName(): string;
|
|
211
169
|
set appName(appName: string);
|
|
212
170
|
getAppName(): string;
|
|
@@ -253,22 +211,38 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
253
211
|
setProxy(proxy: ProxySettingsPlain): Configuration;
|
|
254
212
|
setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
|
|
255
213
|
setProxy(isEnabled: false): Configuration;
|
|
256
|
-
get autProxy(): {
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
214
|
+
get autProxy(): {
|
|
215
|
+
url: string;
|
|
216
|
+
username?: string;
|
|
217
|
+
password?: string;
|
|
218
|
+
isHttpOnly?: boolean;
|
|
219
|
+
mode?: "Allow" | "Block";
|
|
220
|
+
domains?: Array<string>;
|
|
221
|
+
};
|
|
222
|
+
set autProxy(autProxy: {
|
|
223
|
+
url: string;
|
|
224
|
+
username?: string;
|
|
225
|
+
password?: string;
|
|
226
|
+
isHttpOnly?: boolean;
|
|
227
|
+
mode?: "Allow" | "Block";
|
|
228
|
+
domains?: Array<string>;
|
|
229
|
+
});
|
|
230
|
+
getAutProxy(): {
|
|
231
|
+
url: string;
|
|
232
|
+
username?: string;
|
|
233
|
+
password?: string;
|
|
234
|
+
isHttpOnly?: boolean;
|
|
235
|
+
mode?: "Allow" | "Block";
|
|
236
|
+
domains?: Array<string>;
|
|
237
|
+
};
|
|
238
|
+
setAutProxy(autProxy: {
|
|
239
|
+
url: string;
|
|
240
|
+
username?: string;
|
|
241
|
+
password?: string;
|
|
242
|
+
isHttpOnly?: boolean;
|
|
243
|
+
mode?: "Allow" | "Block";
|
|
244
|
+
domains?: Array<string>;
|
|
245
|
+
}): Configuration;
|
|
272
246
|
get batch(): BatchInfoPlain;
|
|
273
247
|
set batch(batch: BatchInfoPlain);
|
|
274
248
|
getBatch(): BatchInfo;
|
|
@@ -408,18 +382,16 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
408
382
|
set scaleRatio(scaleRatio: number);
|
|
409
383
|
getScaleRatio(): number;
|
|
410
384
|
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;
|
|
385
|
+
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
386
|
+
set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
|
|
387
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
388
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
389
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
390
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
|
|
421
391
|
addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
|
|
422
392
|
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
|
|
393
|
+
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
|
|
394
|
+
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
|
|
423
395
|
get visualGridOptions(): { [key: string]: any; };
|
|
424
396
|
set visualGridOptions(visualGridOptions: { [key: string]: any; });
|
|
425
397
|
getVisualGridOptions(): { [key: string]: any; };
|
|
@@ -433,10 +405,6 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
433
405
|
set disableBrowserFetching(disableBrowserFetching: boolean);
|
|
434
406
|
getDisableBrowserFetching(): boolean;
|
|
435
407
|
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
436
|
-
get dontCloseBatches(): boolean;
|
|
437
|
-
set dontCloseBatches(dontCloseBatches: boolean);
|
|
438
|
-
getDontCloseBatches(): boolean;
|
|
439
|
-
setDontCloseBatches(dontCloseBatches: boolean): Configuration;
|
|
440
408
|
}
|
|
441
409
|
export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
|
|
442
410
|
export type CheckSettingsPlain = {
|
|
@@ -451,18 +419,30 @@ export type CheckSettingsPlain = {
|
|
|
451
419
|
enablePatterns?: boolean;
|
|
452
420
|
ignoreDisplacements?: boolean;
|
|
453
421
|
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>; }))>;
|
|
422
|
+
ignoreRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
423
|
+
layoutRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
424
|
+
strictRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
425
|
+
contentRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
|
|
458
426
|
floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
459
427
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
428
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
429
|
+
regionId?: string;
|
|
430
|
+
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
431
|
+
} | {
|
|
432
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
433
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
434
|
+
regionId?: string;
|
|
460
435
|
maxUpOffset?: number;
|
|
461
436
|
maxDownOffset?: number;
|
|
462
437
|
maxLeftOffset?: number;
|
|
463
438
|
maxRightOffset?: number;
|
|
464
439
|
}>;
|
|
465
|
-
accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
440
|
+
accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
441
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
442
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
443
|
+
regionId?: string;
|
|
444
|
+
type?: AccessibilityRegionTypePlain;
|
|
445
|
+
}>;
|
|
466
446
|
disableBrowserFetching?: boolean;
|
|
467
447
|
layoutBreakpoints?: boolean | Array<number>;
|
|
468
448
|
visualGridOptions?: { [key: string]: any; };
|
|
@@ -472,27 +452,33 @@ export type CheckSettingsPlain = {
|
|
|
472
452
|
variationGroupId?: string;
|
|
473
453
|
timeout?: number;
|
|
474
454
|
waitBeforeCapture?: number;
|
|
455
|
+
lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
|
|
475
456
|
};
|
|
476
457
|
export class CheckSettings {
|
|
477
|
-
constructor(settings?: CheckSettingsPlain);
|
|
478
|
-
name(name: string): CheckSettings;
|
|
458
|
+
constructor(settings?: CheckSettings | CheckSettingsPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
|
|
479
459
|
withName(name: string): CheckSettings;
|
|
480
460
|
region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
481
461
|
shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
|
|
482
462
|
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
463
|
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
|
-
|
|
493
|
-
|
|
464
|
+
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;
|
|
465
|
+
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;
|
|
466
|
+
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;
|
|
467
|
+
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;
|
|
468
|
+
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;
|
|
469
|
+
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;
|
|
470
|
+
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;
|
|
471
|
+
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;
|
|
472
|
+
floatingRegion(region: {
|
|
473
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
474
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
475
|
+
regionId?: string;
|
|
476
|
+
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
477
|
+
}): CheckSettings;
|
|
494
478
|
floatingRegion(region: {
|
|
495
479
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
480
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
481
|
+
regionId?: string;
|
|
496
482
|
maxUpOffset?: number;
|
|
497
483
|
maxDownOffset?: number;
|
|
498
484
|
maxLeftOffset?: number;
|
|
@@ -501,35 +487,27 @@ export class CheckSettings {
|
|
|
501
487
|
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
488
|
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
503
489
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
maxRightOffset?: number;
|
|
490
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
491
|
+
regionId?: string;
|
|
492
|
+
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
508
493
|
}>): CheckSettings;
|
|
509
494
|
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
510
|
-
|
|
495
|
+
accessibilityRegion(region: {
|
|
511
496
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
maxRightOffset?: number;
|
|
497
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
498
|
+
regionId?: string;
|
|
499
|
+
type?: AccessibilityRegionTypePlain;
|
|
516
500
|
}): CheckSettings;
|
|
517
|
-
|
|
518
|
-
|
|
501
|
+
accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
|
|
502
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
519
503
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
maxRightOffset?: number;
|
|
504
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
505
|
+
regionId?: string;
|
|
506
|
+
type?: AccessibilityRegionTypePlain;
|
|
524
507
|
}>): 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;
|
|
527
|
-
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;
|
|
529
508
|
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
530
509
|
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
|
|
531
510
|
fully(fully?: boolean): CheckSettings;
|
|
532
|
-
stitchContent(stitchContent?: boolean): CheckSettings;
|
|
533
511
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
|
|
534
512
|
layout(): CheckSettings;
|
|
535
513
|
exact(): CheckSettings;
|
|
@@ -544,14 +522,14 @@ export class CheckSettings {
|
|
|
544
522
|
layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
|
|
545
523
|
hook(name: string, script: string): CheckSettings;
|
|
546
524
|
beforeRenderScreenshotHook(script: string): CheckSettings;
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
visualGridOptions(options: { [key: string]: any; }): CheckSettings;
|
|
525
|
+
ufgOption(key: string, value: any): CheckSettings;
|
|
526
|
+
ufgOptions(options: { [key: string]: any; }): CheckSettings;
|
|
550
527
|
renderId(renderId: string): CheckSettings;
|
|
551
528
|
pageId(pageId: string): CheckSettings;
|
|
552
529
|
variationGroupId(variationGroupId: string): CheckSettings;
|
|
553
530
|
timeout(timeout: number): CheckSettings;
|
|
554
531
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
|
|
532
|
+
lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
|
|
555
533
|
}
|
|
556
534
|
export const Target: {
|
|
557
535
|
window(): CheckSettings;
|
|
@@ -618,7 +596,7 @@ export enum CorsIframeHandle {
|
|
|
618
596
|
KEEP = 'KEEP',
|
|
619
597
|
SNAPSHOT = 'SNAPSHOT'
|
|
620
598
|
}
|
|
621
|
-
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";
|
|
599
|
+
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" | "Sony Xperia 10 II";
|
|
622
600
|
export enum DeviceName {
|
|
623
601
|
Blackberry_PlayBook = 'Blackberry PlayBook',
|
|
624
602
|
BlackBerry_Z30 = 'BlackBerry Z30',
|
|
@@ -683,15 +661,18 @@ export enum DeviceName {
|
|
|
683
661
|
Pixel_3_XL = 'Pixel 3 XL',
|
|
684
662
|
Pixel_4 = 'Pixel 4',
|
|
685
663
|
Pixel_4_XL = 'Pixel 4 XL',
|
|
686
|
-
Pixel_5 = 'Pixel 5'
|
|
664
|
+
Pixel_5 = 'Pixel 5',
|
|
665
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II'
|
|
687
666
|
}
|
|
688
667
|
export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
|
|
689
668
|
export enum FailureReport {
|
|
690
669
|
IMMEDIATE = 'IMMEDIATE',
|
|
691
670
|
ON_CLOSE = 'ON_CLOSE'
|
|
692
671
|
}
|
|
693
|
-
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)";
|
|
672
|
+
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)" | "iPhone 14 Pro Max" | "iPhone 14";
|
|
694
673
|
export enum IosDeviceName {
|
|
674
|
+
iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
|
|
675
|
+
iPhone_14 = 'iPhone 14',
|
|
695
676
|
iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
|
|
696
677
|
iPhone_13_Pro = 'iPhone 13 Pro',
|
|
697
678
|
iPhone_13 = 'iPhone 13',
|
|
@@ -721,6 +702,41 @@ export enum IosVersion {
|
|
|
721
702
|
ONE_VERSION_BACK = 'latest-1',
|
|
722
703
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
723
704
|
}
|
|
705
|
+
export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro";
|
|
706
|
+
export enum AndroidDeviceName {
|
|
707
|
+
Pixel_3_XL = 'Pixel 3 XL',
|
|
708
|
+
Pixel_4 = 'Pixel 4',
|
|
709
|
+
Pixel_4_XL = 'Pixel 4 XL',
|
|
710
|
+
Pixel_5 = 'Pixel 5',
|
|
711
|
+
Pixel_6 = 'Pixel 6',
|
|
712
|
+
Galaxy_Note_8 = 'Galaxy Note 8',
|
|
713
|
+
Galaxy_Note_9 = 'Galaxy Note 9',
|
|
714
|
+
Galaxy_S8 = 'Galaxy S8',
|
|
715
|
+
Galaxy_S8_Plus = 'Galaxy S8 Plus',
|
|
716
|
+
Galaxy_S9 = 'Galaxy S9',
|
|
717
|
+
Galaxy_S9_Plus = 'Galaxy S9 Plus',
|
|
718
|
+
Galaxy_S10 = 'Galaxy S10',
|
|
719
|
+
Galaxy_S10_Plus = 'Galaxy S10 Plus',
|
|
720
|
+
Galaxy_Note_10 = 'Galaxy Note 10',
|
|
721
|
+
Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
|
|
722
|
+
Galaxy_S20 = 'Galaxy S20',
|
|
723
|
+
Galaxy_S20_Plus = 'Galaxy S20 Plus',
|
|
724
|
+
Galaxy_S21 = 'Galaxy S21',
|
|
725
|
+
Galaxy_S21_Plus = 'Galaxy S21 Plus',
|
|
726
|
+
Galaxy_S21_Ultra = 'Galaxy S21 Ultra',
|
|
727
|
+
Galaxy_S22 = 'Galaxy S22',
|
|
728
|
+
Galaxy_S22_Plus = 'Galaxy S22 Plus',
|
|
729
|
+
Galaxy_Tab_S7 = 'Galaxy Tab S7',
|
|
730
|
+
Galaxy_Tab_S8 = 'Galaxy Tab S8',
|
|
731
|
+
Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
|
|
732
|
+
Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro'
|
|
733
|
+
}
|
|
734
|
+
export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
|
|
735
|
+
export enum AndroidVersion {
|
|
736
|
+
LATEST = 'latest',
|
|
737
|
+
ONE_VERSION_BACK = 'latest-1',
|
|
738
|
+
TWO_VERSIONS_BACK = 'latest-2'
|
|
739
|
+
}
|
|
724
740
|
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
|
|
725
741
|
export enum MatchLevel {
|
|
726
742
|
None = 'None',
|
|
@@ -1136,6 +1152,7 @@ export class Region implements Required<RegionPlain> {
|
|
|
1136
1152
|
export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
|
|
1137
1153
|
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1138
1154
|
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1155
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
|
|
1139
1156
|
export type RunnerOptionsPlain = { testConcurrency?: number; };
|
|
1140
1157
|
export class RunnerOptionsFluent {
|
|
1141
1158
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1152,46 +1169,35 @@ export type ApiUrlsPlain = {
|
|
|
1152
1169
|
export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
1153
1170
|
get baselineImage(): string;
|
|
1154
1171
|
getBaselineImage(): string;
|
|
1155
|
-
setBaselineImage(setBaselineImage: string): void;
|
|
1156
1172
|
get currentImage(): string;
|
|
1157
1173
|
getCurrentImage(): string;
|
|
1158
|
-
setCurrentImage(currentImage: string): void;
|
|
1159
1174
|
get checkpointImage(): string;
|
|
1160
1175
|
getCheckpointImage(): string;
|
|
1161
|
-
setCheckpointImage(checkpointImage: string): void;
|
|
1162
1176
|
get checkpointImageThumbnail(): string;
|
|
1163
1177
|
getCheckpointImageThumbnail(): string;
|
|
1164
|
-
setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
|
|
1165
1178
|
get diffImage(): string;
|
|
1166
1179
|
getDiffImage(): string;
|
|
1167
|
-
setDiffImage(diffImage: string): void;
|
|
1168
1180
|
}
|
|
1169
1181
|
export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
|
|
1170
1182
|
export class AppUrls implements Required<AppUrlsPlain> {
|
|
1171
1183
|
get step(): string;
|
|
1172
1184
|
getStep(): string;
|
|
1173
|
-
setStep(step: string): void;
|
|
1174
1185
|
get stepEditor(): string;
|
|
1175
1186
|
getStepEditor(): string;
|
|
1176
|
-
setStepEditor(stepEditor: string): void;
|
|
1177
1187
|
}
|
|
1178
1188
|
export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
|
|
1179
1189
|
export class MatchResult implements Required<MatchResultPlain> {
|
|
1180
1190
|
get asExpected(): boolean;
|
|
1181
1191
|
getAsExpected(): boolean;
|
|
1182
|
-
setAsExpected(asExpected: boolean): void;
|
|
1183
1192
|
get windowId(): number;
|
|
1184
1193
|
getWindowId(): number;
|
|
1185
|
-
setWindowId(windowId: number): void;
|
|
1186
1194
|
}
|
|
1187
1195
|
export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
|
|
1188
1196
|
export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
1189
1197
|
get batch(): string;
|
|
1190
1198
|
getBatch(): string;
|
|
1191
|
-
setBatch(batch: string): void;
|
|
1192
1199
|
get session(): string;
|
|
1193
1200
|
getSession(): string;
|
|
1194
|
-
setSession(session: string): void;
|
|
1195
1201
|
}
|
|
1196
1202
|
export type StepInfoPlain = {
|
|
1197
1203
|
readonly name?: string;
|
|
@@ -1205,25 +1211,18 @@ export type StepInfoPlain = {
|
|
|
1205
1211
|
export class StepInfo implements Required<StepInfoPlain> {
|
|
1206
1212
|
get name(): string;
|
|
1207
1213
|
getName(): string;
|
|
1208
|
-
setName(value: string): void;
|
|
1209
1214
|
get isDifferent(): boolean;
|
|
1210
1215
|
getIsDifferent(): boolean;
|
|
1211
|
-
setIsDifferent(value: boolean): void;
|
|
1212
1216
|
get hasBaselineImage(): boolean;
|
|
1213
1217
|
getHasBaselineImage(): boolean;
|
|
1214
|
-
setHasBaselineImage(value: boolean): void;
|
|
1215
1218
|
get hasCurrentImage(): boolean;
|
|
1216
1219
|
getHasCurrentImage(): boolean;
|
|
1217
|
-
setHasCurrentImage(hasCurrentImage: boolean): void;
|
|
1218
1220
|
get appUrls(): AppUrlsPlain;
|
|
1219
1221
|
getAppUrls(): AppUrls;
|
|
1220
|
-
setAppUrls(appUrls: AppUrlsPlain): void;
|
|
1221
1222
|
get apiUrls(): ApiUrlsPlain;
|
|
1222
1223
|
getApiUrls(): ApiUrls;
|
|
1223
|
-
setApiUrls(apiUrls: ApiUrlsPlain): void;
|
|
1224
1224
|
get renderId(): Array<string>;
|
|
1225
1225
|
getRenderId(): Array<string>;
|
|
1226
|
-
setRenderId(renderId: Array<string>): void;
|
|
1227
1226
|
}
|
|
1228
1227
|
export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
|
|
1229
1228
|
export type TestResultsPlain = {
|
|
@@ -1261,163 +1260,78 @@ export type TestResultsPlain = {
|
|
|
1261
1260
|
export class TestResults implements Required<TestResultsPlain> {
|
|
1262
1261
|
get id(): string;
|
|
1263
1262
|
getId(): string;
|
|
1264
|
-
setId(id: string): void;
|
|
1265
1263
|
get name(): string;
|
|
1266
1264
|
getName(): string;
|
|
1267
|
-
setName(name: string): void;
|
|
1268
1265
|
get secretToken(): string;
|
|
1269
1266
|
getSecretToken(): string;
|
|
1270
|
-
setSecretToken(secretToken: string): void;
|
|
1271
1267
|
get status(): TestResultsStatusPlain;
|
|
1272
1268
|
getStatus(): TestResultsStatus;
|
|
1273
|
-
setStatus(status: TestResultsStatus): void;
|
|
1274
1269
|
get appName(): string;
|
|
1275
1270
|
getAppName(): string;
|
|
1276
|
-
setAppName(appName: string): void;
|
|
1277
1271
|
get batchName(): string;
|
|
1278
1272
|
getBatchName(): string;
|
|
1279
|
-
setBatchName(batchName: string): void;
|
|
1280
1273
|
get batchId(): string;
|
|
1281
1274
|
getBatchId(): string;
|
|
1282
|
-
setBatchId(batchId: string): void;
|
|
1283
1275
|
get branchName(): string;
|
|
1284
1276
|
getBranchName(): string;
|
|
1285
|
-
setBranchName(branchName: string): void;
|
|
1286
1277
|
get hostOS(): string;
|
|
1287
1278
|
getHostOS(): string;
|
|
1288
|
-
setHostOS(hostOS: string): void;
|
|
1289
1279
|
get hostApp(): string;
|
|
1290
1280
|
getHostApp(): string;
|
|
1291
|
-
setHostApp(hostApp: string): void;
|
|
1292
1281
|
get hostDisplaySize(): RectangleSizePlain;
|
|
1293
1282
|
getHostDisplaySize(): RectangleSize;
|
|
1294
|
-
setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
|
|
1295
1283
|
get accessibilityStatus(): TestAccessibilityStatus;
|
|
1296
1284
|
getAccessibilityStatus(): TestAccessibilityStatus;
|
|
1297
|
-
setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
|
|
1298
1285
|
get startedAt(): string | Date;
|
|
1299
1286
|
getStartedAt(): Date;
|
|
1300
|
-
setStartedAt(startedAt: string | Date): void;
|
|
1301
1287
|
get duration(): number;
|
|
1302
1288
|
getDuration(): number;
|
|
1303
|
-
setDuration(duration: number): void;
|
|
1304
1289
|
get isNew(): boolean;
|
|
1305
1290
|
getIsNew(): boolean;
|
|
1306
|
-
setIsNew(isNew: boolean): void;
|
|
1307
1291
|
get isDifferent(): boolean;
|
|
1308
1292
|
getIsDifferent(): boolean;
|
|
1309
|
-
setIsDifferent(isDifferent: boolean): void;
|
|
1310
1293
|
get isAborted(): boolean;
|
|
1311
1294
|
getIsAborted(): boolean;
|
|
1312
|
-
setIsAborted(isAborted: boolean): void;
|
|
1313
1295
|
get appUrls(): SessionUrlsPlain;
|
|
1314
1296
|
getAppUrls(): SessionUrls;
|
|
1315
|
-
setAppUrls(appUrls: SessionUrlsPlain): void;
|
|
1316
1297
|
get apiUrls(): SessionUrlsPlain;
|
|
1317
1298
|
getApiUrls(): SessionUrls;
|
|
1318
|
-
setApiUrls(apiUrls: SessionUrlsPlain): void;
|
|
1319
1299
|
get stepsInfo(): Array<StepInfoPlain>;
|
|
1320
1300
|
getStepsInfo(): Array<StepInfo>;
|
|
1321
|
-
setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
|
|
1322
1301
|
get steps(): number;
|
|
1323
1302
|
getSteps(): number;
|
|
1324
|
-
setSteps(steps: number): void;
|
|
1325
1303
|
get matches(): number;
|
|
1326
1304
|
getMatches(): number;
|
|
1327
|
-
setMatches(matches: number): void;
|
|
1328
1305
|
get mismatches(): number;
|
|
1329
1306
|
getMismatches(): number;
|
|
1330
|
-
setMismatches(mismatches: number): void;
|
|
1331
1307
|
get missing(): number;
|
|
1332
1308
|
getMissing(): number;
|
|
1333
|
-
setMissing(missing: number): void;
|
|
1334
1309
|
get exactMatches(): number;
|
|
1335
1310
|
getExactMatches(): number;
|
|
1336
|
-
setExactMatches(exactMatches: number): void;
|
|
1337
1311
|
get strictMatches(): number;
|
|
1338
1312
|
getStrictMatches(): number;
|
|
1339
|
-
setStrictMatches(strictMatches: number): void;
|
|
1340
1313
|
get contentMatches(): number;
|
|
1341
1314
|
getContentMatches(): number;
|
|
1342
|
-
setContentMatches(contentMatches: number): void;
|
|
1343
1315
|
get layoutMatches(): number;
|
|
1344
1316
|
getLayoutMatches(): number;
|
|
1345
|
-
setLayoutMatches(layoutMatches: number): void;
|
|
1346
1317
|
get noneMatches(): number;
|
|
1347
1318
|
getNoneMatches(): number;
|
|
1348
|
-
setNoneMatches(noneMatches: number): void;
|
|
1349
1319
|
get url(): string;
|
|
1350
1320
|
getUrl(): string;
|
|
1351
|
-
setUrl(url: string): void;
|
|
1352
1321
|
isPassed(): boolean;
|
|
1353
1322
|
delete(): Promise<void>;
|
|
1354
|
-
deleteSession(): Promise<void>;
|
|
1355
1323
|
}
|
|
1356
|
-
export type TestResultContainerPlain = { readonly exception
|
|
1357
|
-
readonly id?: string;
|
|
1358
|
-
readonly name?: string;
|
|
1359
|
-
readonly secretToken?: string;
|
|
1360
|
-
readonly status?: "Passed" | "Failed" | "Unresolved";
|
|
1361
|
-
readonly appName?: string;
|
|
1362
|
-
readonly batchId?: string;
|
|
1363
|
-
readonly batchName?: string;
|
|
1364
|
-
readonly branchName?: string;
|
|
1365
|
-
readonly hostOS?: string;
|
|
1366
|
-
readonly hostApp?: string;
|
|
1367
|
-
readonly hostDisplaySize?: { width: number; height: number; };
|
|
1368
|
-
readonly accessibilityStatus?: { readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; readonly status: "Passed" | "Failed"; };
|
|
1369
|
-
readonly startedAt?: string | Date;
|
|
1370
|
-
readonly duration?: number;
|
|
1371
|
-
readonly isNew?: boolean;
|
|
1372
|
-
readonly isDifferent?: boolean;
|
|
1373
|
-
readonly isAborted?: boolean;
|
|
1374
|
-
readonly appUrls?: { readonly batch?: string; readonly session?: string; };
|
|
1375
|
-
readonly apiUrls?: { readonly batch?: string; readonly session?: string; };
|
|
1376
|
-
readonly stepsInfo?: Array<{
|
|
1377
|
-
readonly name?: string;
|
|
1378
|
-
readonly isDifferent?: boolean;
|
|
1379
|
-
readonly hasBaselineImage?: boolean;
|
|
1380
|
-
readonly hasCurrentImage?: boolean;
|
|
1381
|
-
readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
|
|
1382
|
-
readonly apiUrls?: {
|
|
1383
|
-
readonly baselineImage?: string;
|
|
1384
|
-
readonly currentImage?: string;
|
|
1385
|
-
readonly checkpointImage?: string;
|
|
1386
|
-
readonly checkpointImageThumbnail?: string;
|
|
1387
|
-
readonly diffImage?: string;
|
|
1388
|
-
};
|
|
1389
|
-
readonly renderId?: Array<string>;
|
|
1390
|
-
}>;
|
|
1391
|
-
readonly steps?: number;
|
|
1392
|
-
readonly matches?: number;
|
|
1393
|
-
readonly mismatches?: number;
|
|
1394
|
-
readonly missing?: number;
|
|
1395
|
-
readonly exactMatches?: number;
|
|
1396
|
-
readonly strictMatches?: number;
|
|
1397
|
-
readonly contentMatches?: number;
|
|
1398
|
-
readonly layoutMatches?: number;
|
|
1399
|
-
readonly noneMatches?: number;
|
|
1400
|
-
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?: "landscape" | "portrait"; }; } | { 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?: "landscape" | "portrait"; }; }; };
|
|
1324
|
+
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
|
|
1402
1325
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1403
1326
|
get testResults(): TestResultsPlain;
|
|
1404
1327
|
getTestResults(): TestResults;
|
|
1405
1328
|
get exception(): Error;
|
|
1406
1329
|
getException(): Error;
|
|
1407
|
-
get browserInfo():
|
|
1408
|
-
getBrowserInfo():
|
|
1330
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1331
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1409
1332
|
}
|
|
1410
|
-
export type TestResultsSummaryPlain =
|
|
1411
|
-
|
|
1412
|
-
passed: number;
|
|
1413
|
-
unresolved: number;
|
|
1414
|
-
failed: number;
|
|
1415
|
-
exceptions: number;
|
|
1416
|
-
mismatches: number;
|
|
1417
|
-
missing: number;
|
|
1418
|
-
matches: number;
|
|
1419
|
-
};
|
|
1420
|
-
export class TestResultsSummary implements Iterable<TestResultContainerPlain> {
|
|
1333
|
+
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1334
|
+
export class TestResultsSummary implements Iterable<TestResultContainer> {
|
|
1421
1335
|
getAllResults(): Array<TestResultContainer>;
|
|
1422
1336
|
[Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
|
|
1423
1337
|
}
|
|
@@ -1464,11 +1378,7 @@ export class ClassicRunner extends EyesRunner {
|
|
|
1464
1378
|
}
|
|
1465
1379
|
export class VisualGridRunner extends EyesRunner {
|
|
1466
1380
|
constructor(options?: RunnerOptionsPlain);
|
|
1467
|
-
constructor(options?: RunnerOptionsFluent);
|
|
1468
|
-
constructor(legacyConcurrency?: number);
|
|
1469
1381
|
get testConcurrency(): number;
|
|
1470
|
-
get legacyConcurrency(): number;
|
|
1471
|
-
getConcurrentSessions(): number;
|
|
1472
1382
|
}
|
|
1473
1383
|
export abstract class SessionEventHandler {
|
|
1474
1384
|
abstract initStarted(): any;
|