@applitools/eyes-puppeteer 1.10.3 → 1.11.1
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 +16 -0
- package/dist/api.js +3 -5
- package/package.json +10 -11
- package/types/index.d.ts +104 -86
package/CHANGELOG.md
CHANGED
|
@@ -11,6 +11,22 @@
|
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
|
14
|
+
## 1.11.1 - 2022/9/26
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
### Bug fixes
|
|
18
|
+
- Fixed minor issues
|
|
19
|
+
|
|
20
|
+
## 1.11.0 - 2022/9/23
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
- Don't fail `eyes.open` when there is a failure to set viewport size in `UFG`.
|
|
24
|
+
- Using `lazyLoad.waitingTime` as a delay between stitches by default
|
|
25
|
+
- Added `Sony Xperia 10 II` emulation device
|
|
26
|
+
- Added `iPhone 14` and `iPhone 14 Pro Max` ios devices
|
|
27
|
+
### Bug fixes
|
|
28
|
+
- Fixed incorrect calculation of the target element position.
|
|
29
|
+
|
|
14
30
|
## 1.10.3 - 2022/7/25
|
|
15
31
|
|
|
16
32
|
### Features
|
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-puppeteer"));
|
|
33
|
-
const sdk = (0,
|
|
34
|
-
|
|
35
|
-
version: require('../package.json').version,
|
|
33
|
+
const sdk = (0, core_1.makeCore)({
|
|
34
|
+
agentId: `eyes.puppeteer/${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-puppeteer",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.11.1",
|
|
4
4
|
"description": "Applitools Eyes SDK for Puppeteer",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-puppeteer",
|
|
@@ -62,18 +62,17 @@
|
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@applitools/
|
|
66
|
-
"@applitools/eyes-
|
|
67
|
-
"@applitools/spec-driver-puppeteer": "1.1.
|
|
68
|
-
"@applitools/visual-grid-client": "15.13.11"
|
|
65
|
+
"@applitools/core": "1.0.9",
|
|
66
|
+
"@applitools/eyes-api": "1.7.10",
|
|
67
|
+
"@applitools/spec-driver-puppeteer": "1.1.12"
|
|
69
68
|
},
|
|
70
69
|
"devDependencies": {
|
|
71
|
-
"@applitools/api-extractor": "1.2.
|
|
72
|
-
"@applitools/bongo": "^2.
|
|
70
|
+
"@applitools/api-extractor": "1.2.11",
|
|
71
|
+
"@applitools/bongo": "^2.2.0",
|
|
73
72
|
"@applitools/scripts": "1.1.0",
|
|
74
|
-
"@applitools/sdk-coverage-tests": "2.3.
|
|
75
|
-
"@applitools/sdk-shared": "0.9.
|
|
76
|
-
"@applitools/test-utils": "1.
|
|
73
|
+
"@applitools/sdk-coverage-tests": "2.3.20",
|
|
74
|
+
"@applitools/sdk-shared": "0.9.14",
|
|
75
|
+
"@applitools/test-utils": "1.5.1",
|
|
77
76
|
"@types/mocha": "^9.1.1",
|
|
78
77
|
"@types/node": "12",
|
|
79
78
|
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
|
@@ -86,7 +85,7 @@
|
|
|
86
85
|
"husky": "^4.3.8",
|
|
87
86
|
"mocha": "^9.2.2",
|
|
88
87
|
"prettier": "^2.6.2",
|
|
89
|
-
"puppeteer": "^
|
|
88
|
+
"puppeteer": "^18.0.5",
|
|
90
89
|
"spec-xunit-file": "0.0.1-3",
|
|
91
90
|
"ts-node": "^10.8.0",
|
|
92
91
|
"ttypescript": "^1.5.13",
|
package/types/index.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export class Eyes {
|
|
|
23
23
|
check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
|
|
24
24
|
locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
|
|
25
25
|
extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
26
|
-
extractText(
|
|
26
|
+
extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
|
|
27
27
|
close(throwErr?: boolean): Promise<TestResults>;
|
|
28
28
|
abort(): Promise<TestResults>;
|
|
29
29
|
getViewportSize(): Promise<RectangleSize>;
|
|
@@ -112,7 +112,14 @@ export type ConfigurationPlain = {
|
|
|
112
112
|
apiKey?: string;
|
|
113
113
|
serverUrl?: string;
|
|
114
114
|
proxy?: ProxySettingsPlain;
|
|
115
|
-
autProxy?: {
|
|
115
|
+
autProxy?: {
|
|
116
|
+
url: string;
|
|
117
|
+
username?: string;
|
|
118
|
+
password?: string;
|
|
119
|
+
isHttpOnly?: boolean;
|
|
120
|
+
mode?: "Allow" | "Block";
|
|
121
|
+
domains?: Array<string>;
|
|
122
|
+
};
|
|
116
123
|
isDisabled?: boolean;
|
|
117
124
|
appName?: string;
|
|
118
125
|
testName?: string;
|
|
@@ -157,7 +164,7 @@ export type ConfigurationPlain = {
|
|
|
157
164
|
disableBrowserFetching?: boolean;
|
|
158
165
|
};
|
|
159
166
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
160
|
-
constructor(config?: ConfigurationPlain);
|
|
167
|
+
constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
|
|
161
168
|
get appName(): string;
|
|
162
169
|
set appName(appName: string);
|
|
163
170
|
getAppName(): string;
|
|
@@ -204,10 +211,38 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
204
211
|
setProxy(proxy: ProxySettingsPlain): Configuration;
|
|
205
212
|
setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
|
|
206
213
|
setProxy(isEnabled: false): Configuration;
|
|
207
|
-
get autProxy(): {
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
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;
|
|
211
246
|
get batch(): BatchInfoPlain;
|
|
212
247
|
set batch(batch: BatchInfoPlain);
|
|
213
248
|
getBatch(): BatchInfo;
|
|
@@ -390,13 +425,24 @@ export type CheckSettingsPlain = {
|
|
|
390
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; }>;
|
|
391
426
|
floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
392
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;
|
|
393
435
|
maxUpOffset?: number;
|
|
394
436
|
maxDownOffset?: number;
|
|
395
437
|
maxLeftOffset?: number;
|
|
396
438
|
maxRightOffset?: number;
|
|
439
|
+
}>;
|
|
440
|
+
accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
441
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
442
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
397
443
|
regionId?: string;
|
|
444
|
+
type?: AccessibilityRegionTypePlain;
|
|
398
445
|
}>;
|
|
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; }>;
|
|
400
446
|
disableBrowserFetching?: boolean;
|
|
401
447
|
layoutBreakpoints?: boolean | Array<number>;
|
|
402
448
|
visualGridOptions?: { [key: string]: any; };
|
|
@@ -409,7 +455,7 @@ export type CheckSettingsPlain = {
|
|
|
409
455
|
lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
|
|
410
456
|
};
|
|
411
457
|
export class CheckSettings {
|
|
412
|
-
constructor(settings?: CheckSettingsPlain);
|
|
458
|
+
constructor(settings?: CheckSettings | CheckSettingsPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
|
|
413
459
|
withName(name: string): CheckSettings;
|
|
414
460
|
region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
|
|
415
461
|
shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
|
|
@@ -425,25 +471,40 @@ export class CheckSettings {
|
|
|
425
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;
|
|
426
472
|
floatingRegion(region: {
|
|
427
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;
|
|
478
|
+
floatingRegion(region: {
|
|
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;
|
|
428
482
|
maxUpOffset?: number;
|
|
429
483
|
maxDownOffset?: number;
|
|
430
484
|
maxLeftOffset?: number;
|
|
431
485
|
maxRightOffset?: number;
|
|
432
|
-
regionId?: string;
|
|
433
486
|
}): CheckSettings;
|
|
434
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;
|
|
435
488
|
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
436
489
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
437
|
-
|
|
438
|
-
maxDownOffset?: number;
|
|
439
|
-
maxLeftOffset?: number;
|
|
440
|
-
maxRightOffset?: number;
|
|
490
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
441
491
|
regionId?: string;
|
|
492
|
+
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
442
493
|
}>): CheckSettings;
|
|
443
494
|
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
444
|
-
accessibilityRegion(region: {
|
|
495
|
+
accessibilityRegion(region: {
|
|
496
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
497
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
498
|
+
regionId?: string;
|
|
499
|
+
type?: AccessibilityRegionTypePlain;
|
|
500
|
+
}): CheckSettings;
|
|
445
501
|
accessibilityRegion(region: LegacyRegionPlain | (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>; }))) | {
|
|
502
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
503
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
504
|
+
padding?: number | { top?: number; right?: number; bottom?: number; left?: number; };
|
|
505
|
+
regionId?: string;
|
|
506
|
+
type?: AccessibilityRegionTypePlain;
|
|
507
|
+
}>): CheckSettings;
|
|
447
508
|
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
|
|
448
509
|
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
|
|
449
510
|
fully(fully?: boolean): CheckSettings;
|
|
@@ -461,14 +522,14 @@ export class CheckSettings {
|
|
|
461
522
|
layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
|
|
462
523
|
hook(name: string, script: string): CheckSettings;
|
|
463
524
|
beforeRenderScreenshotHook(script: string): CheckSettings;
|
|
464
|
-
|
|
465
|
-
|
|
525
|
+
ufgOption(key: string, value: any): CheckSettings;
|
|
526
|
+
ufgOptions(options: { [key: string]: any; }): CheckSettings;
|
|
466
527
|
renderId(renderId: string): CheckSettings;
|
|
467
528
|
pageId(pageId: string): CheckSettings;
|
|
468
529
|
variationGroupId(variationGroupId: string): CheckSettings;
|
|
469
530
|
timeout(timeout: number): CheckSettings;
|
|
470
531
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
|
|
471
|
-
lazyLoad(options
|
|
532
|
+
lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettings;
|
|
472
533
|
}
|
|
473
534
|
export const Target: {
|
|
474
535
|
window(): CheckSettings;
|
|
@@ -478,8 +539,8 @@ export const Target: {
|
|
|
478
539
|
shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
|
|
479
540
|
};
|
|
480
541
|
export class BatchClose {
|
|
481
|
-
static close(settings: { batchIds: Array<string>; serverUrl
|
|
482
|
-
constructor(options?: { batchIds: Array<string>; serverUrl
|
|
542
|
+
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
|
|
543
|
+
constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
|
|
483
544
|
close(): Promise<void>;
|
|
484
545
|
setBatchIds(batchIds: Array<string>): BatchClose;
|
|
485
546
|
setUrl(serverUrl: string): BatchClose;
|
|
@@ -535,7 +596,7 @@ export enum CorsIframeHandle {
|
|
|
535
596
|
KEEP = 'KEEP',
|
|
536
597
|
SNAPSHOT = 'SNAPSHOT'
|
|
537
598
|
}
|
|
538
|
-
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";
|
|
539
600
|
export enum DeviceName {
|
|
540
601
|
Blackberry_PlayBook = 'Blackberry PlayBook',
|
|
541
602
|
BlackBerry_Z30 = 'BlackBerry Z30',
|
|
@@ -600,15 +661,18 @@ export enum DeviceName {
|
|
|
600
661
|
Pixel_3_XL = 'Pixel 3 XL',
|
|
601
662
|
Pixel_4 = 'Pixel 4',
|
|
602
663
|
Pixel_4_XL = 'Pixel 4 XL',
|
|
603
|
-
Pixel_5 = 'Pixel 5'
|
|
664
|
+
Pixel_5 = 'Pixel 5',
|
|
665
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II'
|
|
604
666
|
}
|
|
605
667
|
export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
|
|
606
668
|
export enum FailureReport {
|
|
607
669
|
IMMEDIATE = 'IMMEDIATE',
|
|
608
670
|
ON_CLOSE = 'ON_CLOSE'
|
|
609
671
|
}
|
|
610
|
-
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 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
|
|
611
673
|
export enum IosDeviceName {
|
|
674
|
+
iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
|
|
675
|
+
iPhone_14 = 'iPhone 14',
|
|
612
676
|
iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
|
|
613
677
|
iPhone_13_Pro = 'iPhone 13 Pro',
|
|
614
678
|
iPhone_13 = 'iPhone 13',
|
|
@@ -638,11 +702,13 @@ export enum IosVersion {
|
|
|
638
702
|
ONE_VERSION_BACK = 'latest-1',
|
|
639
703
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
640
704
|
}
|
|
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";
|
|
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";
|
|
642
706
|
export enum AndroidDeviceName {
|
|
643
707
|
Pixel_3_XL = 'Pixel 3 XL',
|
|
644
708
|
Pixel_4 = 'Pixel 4',
|
|
645
709
|
Pixel_4_XL = 'Pixel 4 XL',
|
|
710
|
+
Pixel_5 = 'Pixel 5',
|
|
711
|
+
Pixel_6 = 'Pixel 6',
|
|
646
712
|
Galaxy_Note_8 = 'Galaxy Note 8',
|
|
647
713
|
Galaxy_Note_9 = 'Galaxy Note 9',
|
|
648
714
|
Galaxy_S8 = 'Galaxy S8',
|
|
@@ -657,7 +723,13 @@ export enum AndroidDeviceName {
|
|
|
657
723
|
Galaxy_S20_Plus = 'Galaxy S20 Plus',
|
|
658
724
|
Galaxy_S21 = 'Galaxy S21',
|
|
659
725
|
Galaxy_S21_Plus = 'Galaxy S21 Plus',
|
|
660
|
-
Galaxy_S21_Ultra = 'Galaxy S21 Ultra'
|
|
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'
|
|
661
733
|
}
|
|
662
734
|
export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
|
|
663
735
|
export enum AndroidVersion {
|
|
@@ -1249,71 +1321,17 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1249
1321
|
isPassed(): boolean;
|
|
1250
1322
|
delete(): Promise<void>;
|
|
1251
1323
|
}
|
|
1252
|
-
export type TestResultContainerPlain = { readonly exception
|
|
1253
|
-
readonly id?: string;
|
|
1254
|
-
readonly name?: string;
|
|
1255
|
-
readonly secretToken?: string;
|
|
1256
|
-
readonly status?: "Passed" | "Failed" | "Unresolved";
|
|
1257
|
-
readonly appName?: string;
|
|
1258
|
-
readonly batchId?: string;
|
|
1259
|
-
readonly batchName?: string;
|
|
1260
|
-
readonly branchName?: string;
|
|
1261
|
-
readonly hostOS?: string;
|
|
1262
|
-
readonly hostApp?: string;
|
|
1263
|
-
readonly hostDisplaySize?: { width: number; height: number; };
|
|
1264
|
-
readonly accessibilityStatus?: { readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; readonly status: "Passed" | "Failed"; };
|
|
1265
|
-
readonly startedAt?: string | Date;
|
|
1266
|
-
readonly duration?: number;
|
|
1267
|
-
readonly isNew?: boolean;
|
|
1268
|
-
readonly isDifferent?: boolean;
|
|
1269
|
-
readonly isAborted?: boolean;
|
|
1270
|
-
readonly appUrls?: { readonly batch?: string; readonly session?: string; };
|
|
1271
|
-
readonly apiUrls?: { readonly batch?: string; readonly session?: string; };
|
|
1272
|
-
readonly stepsInfo?: Array<{
|
|
1273
|
-
readonly name?: string;
|
|
1274
|
-
readonly isDifferent?: boolean;
|
|
1275
|
-
readonly hasBaselineImage?: boolean;
|
|
1276
|
-
readonly hasCurrentImage?: boolean;
|
|
1277
|
-
readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
|
|
1278
|
-
readonly apiUrls?: {
|
|
1279
|
-
readonly baselineImage?: string;
|
|
1280
|
-
readonly currentImage?: string;
|
|
1281
|
-
readonly checkpointImage?: string;
|
|
1282
|
-
readonly checkpointImageThumbnail?: string;
|
|
1283
|
-
readonly diffImage?: string;
|
|
1284
|
-
};
|
|
1285
|
-
readonly renderId?: Array<string>;
|
|
1286
|
-
}>;
|
|
1287
|
-
readonly steps?: number;
|
|
1288
|
-
readonly matches?: number;
|
|
1289
|
-
readonly mismatches?: number;
|
|
1290
|
-
readonly missing?: number;
|
|
1291
|
-
readonly exactMatches?: number;
|
|
1292
|
-
readonly strictMatches?: number;
|
|
1293
|
-
readonly contentMatches?: number;
|
|
1294
|
-
readonly layoutMatches?: number;
|
|
1295
|
-
readonly noneMatches?: number;
|
|
1296
|
-
readonly url?: string;
|
|
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?: "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"; }; } | { 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?: "landscape" | "portrait"; }; }; };
|
|
1324
|
+
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
|
|
1298
1325
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1299
1326
|
get testResults(): TestResultsPlain;
|
|
1300
1327
|
getTestResults(): TestResults;
|
|
1301
1328
|
get exception(): Error;
|
|
1302
1329
|
getException(): Error;
|
|
1303
|
-
get browserInfo():
|
|
1304
|
-
getBrowserInfo():
|
|
1330
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1331
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1305
1332
|
}
|
|
1306
|
-
export type TestResultsSummaryPlain =
|
|
1307
|
-
|
|
1308
|
-
passed: number;
|
|
1309
|
-
unresolved: number;
|
|
1310
|
-
failed: number;
|
|
1311
|
-
exceptions: number;
|
|
1312
|
-
mismatches: number;
|
|
1313
|
-
missing: number;
|
|
1314
|
-
matches: number;
|
|
1315
|
-
};
|
|
1316
|
-
export class TestResultsSummary implements Iterable<TestResultContainerPlain> {
|
|
1333
|
+
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1334
|
+
export class TestResultsSummary implements Iterable<TestResultContainer> {
|
|
1317
1335
|
getAllResults(): Array<TestResultContainer>;
|
|
1318
1336
|
[Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
|
|
1319
1337
|
}
|
|
@@ -1352,7 +1370,7 @@ export class Logger {
|
|
|
1352
1370
|
tag(name: string, value: any): void;
|
|
1353
1371
|
extend(label?: string): Logger;
|
|
1354
1372
|
}
|
|
1355
|
-
export function closeBatch(spec:
|
|
1373
|
+
export function closeBatch(spec: BatchCloseSpec): (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
|
|
1356
1374
|
export abstract class EyesRunner {
|
|
1357
1375
|
getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
|
|
1358
1376
|
}
|