@applitools/eyes-webdriverio 5.40.1 → 5.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/package.json +10 -10
- package/types/index.d.ts +62 -58
package/CHANGELOG.md
CHANGED
|
@@ -10,6 +10,19 @@
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
|
+
## 5.41.0 - 2023/2/1
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
- Add NML support for Android
|
|
17
|
+
### Bug fixes
|
|
18
|
+
|
|
19
|
+
## 5.40.2 - 2023/1/27
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
- Added new android devices Sony Xperia 1 II, Sony Xperia Ace II, Huawei P30 Lite, Xiaomi Redmi Note 10 JE
|
|
23
|
+
### Bug fixes
|
|
24
|
+
- Fixed issue with sessionId on ufg
|
|
25
|
+
|
|
13
26
|
## 5.40.1 - 2023/1/23
|
|
14
27
|
|
|
15
28
|
### Features
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-webdriverio",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.41.0",
|
|
4
4
|
"description": "Applitools Eyes SDK for WebdriverIO",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-webdriverio",
|
|
@@ -116,9 +116,9 @@
|
|
|
116
116
|
}
|
|
117
117
|
},
|
|
118
118
|
"dependencies": {
|
|
119
|
-
"@applitools/core": "1.4.
|
|
120
|
-
"@applitools/eyes-api": "1.
|
|
121
|
-
"@applitools/spec-driver-webdriverio": "1.4.
|
|
119
|
+
"@applitools/core": "1.4.6",
|
|
120
|
+
"@applitools/eyes-api": "1.13.1",
|
|
121
|
+
"@applitools/spec-driver-webdriverio": "1.4.22"
|
|
122
122
|
},
|
|
123
123
|
"devDependencies": {
|
|
124
124
|
"@applitools/api-extractor": "1.2.11",
|
|
@@ -126,17 +126,17 @@
|
|
|
126
126
|
"@applitools/scripts": "1.2.0",
|
|
127
127
|
"@applitools/sdk-coverage-tests": "^2.7.10",
|
|
128
128
|
"@applitools/sdk-shared": "0.9.15",
|
|
129
|
-
"@applitools/test-utils": "1.5.
|
|
129
|
+
"@applitools/test-utils": "1.5.10",
|
|
130
130
|
"@types/mocha": "^9.1.1",
|
|
131
131
|
"@types/node": "16",
|
|
132
132
|
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
|
133
133
|
"@typescript-eslint/parser": "^5.27.0",
|
|
134
|
-
"@wdio/cli": "^8.2.
|
|
134
|
+
"@wdio/cli": "^8.2.2",
|
|
135
135
|
"@wdio/dot-reporter": "^8.0.14",
|
|
136
|
-
"@wdio/globals": "^8.2.
|
|
137
|
-
"@wdio/local-runner": "^8.2.
|
|
136
|
+
"@wdio/globals": "^8.2.2",
|
|
137
|
+
"@wdio/local-runner": "^8.2.2",
|
|
138
138
|
"@wdio/mocha-framework": "^8.2.1",
|
|
139
|
-
"chromedriver": "^
|
|
139
|
+
"chromedriver": "^109.0.0",
|
|
140
140
|
"eslint": "^8.16.0",
|
|
141
141
|
"eslint-config-prettier": "^8.5.0",
|
|
142
142
|
"eslint-plugin-mocha-no-only": "^1.1.1",
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
"ts-node": "^10.8.0",
|
|
152
152
|
"ttypescript": "^1.5.13",
|
|
153
153
|
"typescript": "^4.9.4",
|
|
154
|
-
"webdriverio": "^8.2.
|
|
154
|
+
"webdriverio": "^8.2.2"
|
|
155
155
|
},
|
|
156
156
|
"peerDependencies": {
|
|
157
157
|
"webdriverio": "5.0.0 - 8.x.x"
|
package/types/index.d.ts
CHANGED
|
@@ -38,9 +38,9 @@ export class Eyes {
|
|
|
38
38
|
open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
|
|
39
39
|
open(config?: undefined | ConfigurationPlain): Promise<void>;
|
|
40
40
|
open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
|
|
41
|
-
check(name: string, checkSettings:
|
|
41
|
+
check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
|
|
42
42
|
check(target: {
|
|
43
|
-
image: string |
|
|
43
|
+
image: string | URL | Buffer;
|
|
44
44
|
name?: undefined | string;
|
|
45
45
|
dom?: undefined | string;
|
|
46
46
|
locationInViewport?: undefined | LocationPlain;
|
|
@@ -50,7 +50,7 @@ export class Eyes {
|
|
|
50
50
|
check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
|
|
51
51
|
locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
|
|
52
52
|
extractTextRegions<TPattern extends string>(target: {
|
|
53
|
-
image: string |
|
|
53
|
+
image: string | URL | Buffer;
|
|
54
54
|
size?: undefined | { width: number; height: number; };
|
|
55
55
|
name?: undefined | string;
|
|
56
56
|
source?: undefined | string;
|
|
@@ -61,7 +61,7 @@ export class Eyes {
|
|
|
61
61
|
}, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
62
62
|
extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
63
63
|
extractText(target: {
|
|
64
|
-
image: string |
|
|
64
|
+
image: string | URL | Buffer;
|
|
65
65
|
size?: undefined | { width: number; height: number; };
|
|
66
66
|
name?: undefined | string;
|
|
67
67
|
source?: undefined | string;
|
|
@@ -77,7 +77,7 @@ export class Eyes {
|
|
|
77
77
|
setViewportSize(size: RectangleSizePlain): Promise<void>;
|
|
78
78
|
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
79
79
|
setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
|
|
80
|
-
setLogHandler(handler:
|
|
80
|
+
setLogHandler(handler: LogHandlerPlain | LogHandler): void;
|
|
81
81
|
getLogHandler(): LogHandler;
|
|
82
82
|
setCutProvider(cutProvider: CutProvider): void;
|
|
83
83
|
setImageCut(cutProvider: CutProvider): void;
|
|
@@ -396,12 +396,12 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
396
396
|
setScaleRatio(scaleRatio: number): Configuration;
|
|
397
397
|
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
398
398
|
set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
|
|
399
|
-
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo |
|
|
400
|
-
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo |
|
|
401
|
-
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo |
|
|
402
|
-
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo |
|
|
399
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
400
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
401
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
402
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
|
|
403
403
|
addBrowser(width: number, height: number, name?: undefined | "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"): Configuration;
|
|
404
|
-
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "
|
|
404
|
+
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
|
|
405
405
|
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
406
406
|
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
407
407
|
get visualGridOptions(): { [key: string]: any; };
|
|
@@ -457,14 +457,14 @@ export class CheckSettingsAutomation {
|
|
|
457
457
|
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
458
458
|
name(name: string): CheckSettingsAutomation;
|
|
459
459
|
withName(name: string): CheckSettingsAutomation;
|
|
460
|
-
ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
461
|
-
ignoreRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
462
|
-
layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
463
|
-
layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
464
|
-
strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
465
|
-
strictRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
466
|
-
contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
467
|
-
contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
460
|
+
ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
461
|
+
ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
462
|
+
layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
463
|
+
layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
464
|
+
strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
465
|
+
strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
466
|
+
contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
467
|
+
contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
468
468
|
floatingRegion(region: {
|
|
469
469
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
470
470
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -480,28 +480,28 @@ export class CheckSettingsAutomation {
|
|
|
480
480
|
maxLeftOffset?: undefined | number;
|
|
481
481
|
maxRightOffset?: undefined | number;
|
|
482
482
|
}): CheckSettingsAutomation;
|
|
483
|
-
floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))
|
|
484
|
-
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
483
|
+
floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
484
|
+
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
485
485
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
486
486
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
487
487
|
regionId?: undefined | string;
|
|
488
488
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
489
489
|
}>): CheckSettingsAutomation;
|
|
490
|
-
floatingRegions(maxOffset: number, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))
|
|
490
|
+
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
491
491
|
accessibilityRegion(region: {
|
|
492
492
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
493
493
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
494
494
|
regionId?: undefined | string;
|
|
495
495
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
496
496
|
}): CheckSettingsAutomation;
|
|
497
|
-
accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))
|
|
498
|
-
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
497
|
+
accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
|
|
498
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
499
499
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
500
500
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
501
501
|
regionId?: undefined | string;
|
|
502
502
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
503
503
|
}>): CheckSettingsAutomation;
|
|
504
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))
|
|
504
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
505
505
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
506
506
|
layout(): CheckSettingsAutomation;
|
|
507
507
|
exact(): CheckSettingsAutomation;
|
|
@@ -686,7 +686,7 @@ export enum IosVersion {
|
|
|
686
686
|
ONE_VERSION_BACK = 'latest-1',
|
|
687
687
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
688
688
|
}
|
|
689
|
-
export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "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";
|
|
689
|
+
export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
|
|
690
690
|
export enum AndroidDeviceName {
|
|
691
691
|
Pixel_3_XL = 'Pixel 3 XL',
|
|
692
692
|
Pixel_4 = 'Pixel 4',
|
|
@@ -706,16 +706,20 @@ export enum AndroidDeviceName {
|
|
|
706
706
|
Galaxy_S22_Plus = 'Galaxy S22 Plus',
|
|
707
707
|
Galaxy_Tab_S7 = 'Galaxy Tab S7',
|
|
708
708
|
Galaxy_Tab_S8 = 'Galaxy Tab S8',
|
|
709
|
+
Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
|
|
709
710
|
Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
|
|
710
711
|
Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
|
|
711
|
-
|
|
712
|
+
Sony_Xperia_1_II = 'Sony Xperia 1 II',
|
|
713
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II',
|
|
714
|
+
Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
|
|
715
|
+
Huawei_P30_Lite = 'Huawei P30 Lite'
|
|
712
716
|
}
|
|
713
717
|
export type AndroidVersionPlain = "latest" | "latest-1";
|
|
714
718
|
export enum AndroidVersion {
|
|
715
719
|
LATEST = 'latest',
|
|
716
720
|
ONE_VERSION_BACK = 'latest-1'
|
|
717
721
|
}
|
|
718
|
-
export type MatchLevelPlain = "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "
|
|
722
|
+
export type MatchLevelPlain = "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
|
|
719
723
|
export enum MatchLevel {
|
|
720
724
|
None = 'None',
|
|
721
725
|
LegacyLayout = 'Layout1',
|
|
@@ -726,7 +730,7 @@ export enum MatchLevel {
|
|
|
726
730
|
Strict = 'Strict',
|
|
727
731
|
Exact = 'Exact'
|
|
728
732
|
}
|
|
729
|
-
export type ScreenOrientationPlain = "
|
|
733
|
+
export type ScreenOrientationPlain = "landscape" | "portrait";
|
|
730
734
|
export enum ScreenOrientation {
|
|
731
735
|
PORTRAIT = 'portrait',
|
|
732
736
|
LANDSCAPE = 'landscape'
|
|
@@ -741,7 +745,7 @@ export enum StitchMode {
|
|
|
741
745
|
SCROLL = 'Scroll',
|
|
742
746
|
CSS = 'CSS'
|
|
743
747
|
}
|
|
744
|
-
export type TestResultsStatusPlain = "Passed" | "
|
|
748
|
+
export type TestResultsStatusPlain = "Passed" | "Unresolved" | "Failed";
|
|
745
749
|
export enum TestResultsStatus {
|
|
746
750
|
Passed = 'Passed',
|
|
747
751
|
Unresolved = 'Unresolved',
|
|
@@ -828,7 +832,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
828
832
|
export type CheckSettingsImagePlain = {
|
|
829
833
|
name?: undefined | string;
|
|
830
834
|
region?: undefined | RegionPlain;
|
|
831
|
-
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "
|
|
835
|
+
matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
|
|
832
836
|
useDom?: undefined | boolean;
|
|
833
837
|
sendDom?: undefined | boolean;
|
|
834
838
|
enablePatterns?: undefined | boolean;
|
|
@@ -863,15 +867,15 @@ export type CheckSettingsImagePlain = {
|
|
|
863
867
|
variationGroupId?: undefined | string;
|
|
864
868
|
};
|
|
865
869
|
export class CheckSettingsImage {
|
|
866
|
-
constructor(settings?: undefined |
|
|
867
|
-
image: string |
|
|
870
|
+
constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
|
|
871
|
+
image: string | URL | Buffer;
|
|
868
872
|
name?: undefined | string;
|
|
869
873
|
dom?: undefined | string;
|
|
870
874
|
locationInViewport?: undefined | LocationPlain;
|
|
871
875
|
locationInView?: undefined | LocationPlain;
|
|
872
876
|
fullViewSize?: undefined | RectangleSizePlain;
|
|
873
877
|
});
|
|
874
|
-
image(image: string |
|
|
878
|
+
image(image: string | URL | Buffer): CheckSettingsImage;
|
|
875
879
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
876
880
|
base64(imageBase64: Buffer): CheckSettingsImage;
|
|
877
881
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -879,16 +883,16 @@ export class CheckSettingsImage {
|
|
|
879
883
|
name(name: string): CheckSettingsImage;
|
|
880
884
|
withDom(dom: string): CheckSettingsImage;
|
|
881
885
|
withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
|
|
882
|
-
region(region:
|
|
886
|
+
region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
|
|
883
887
|
withName(name: string): CheckSettingsImage;
|
|
884
|
-
ignoreRegion(region:
|
|
885
|
-
ignoreRegions(...regions: Array<
|
|
886
|
-
layoutRegion(region:
|
|
887
|
-
layoutRegions(...regions: Array<
|
|
888
|
-
strictRegion(region:
|
|
889
|
-
strictRegions(...regions: Array<
|
|
890
|
-
contentRegion(region:
|
|
891
|
-
contentRegions(...regions: Array<
|
|
888
|
+
ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
889
|
+
ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
890
|
+
layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
891
|
+
layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
892
|
+
strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
893
|
+
strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
894
|
+
contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
895
|
+
contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
892
896
|
floatingRegion(region: {
|
|
893
897
|
region: RegionPlain;
|
|
894
898
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -904,28 +908,28 @@ export class CheckSettingsImage {
|
|
|
904
908
|
maxLeftOffset?: undefined | number;
|
|
905
909
|
maxRightOffset?: undefined | number;
|
|
906
910
|
}): CheckSettingsImage;
|
|
907
|
-
floatingRegion(region:
|
|
908
|
-
floatingRegions(...regions: Array<
|
|
911
|
+
floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
912
|
+
floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
|
|
909
913
|
region: RegionPlain;
|
|
910
914
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
911
915
|
regionId?: undefined | string;
|
|
912
916
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
913
917
|
}>): CheckSettingsImage;
|
|
914
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
918
|
+
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
|
|
915
919
|
accessibilityRegion(region: {
|
|
916
920
|
region: RegionPlain;
|
|
917
921
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
918
922
|
regionId?: undefined | string;
|
|
919
923
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
920
924
|
}): CheckSettingsImage;
|
|
921
|
-
accessibilityRegion(region:
|
|
922
|
-
accessibilityRegions(...regions: Array<
|
|
925
|
+
accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
|
|
926
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
|
|
923
927
|
region: RegionPlain;
|
|
924
928
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
925
929
|
regionId?: undefined | string;
|
|
926
930
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
927
931
|
}>): CheckSettingsImage;
|
|
928
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
932
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
|
|
929
933
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
|
|
930
934
|
layout(): CheckSettingsImage;
|
|
931
935
|
exact(): CheckSettingsImage;
|
|
@@ -940,7 +944,7 @@ export class CheckSettingsImage {
|
|
|
940
944
|
variationGroupId(variationGroupId: string): CheckSettingsImage;
|
|
941
945
|
}
|
|
942
946
|
export type TargetImage = {
|
|
943
|
-
image(image: string |
|
|
947
|
+
image(image: string | URL | Buffer): CheckSettingsImage;
|
|
944
948
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
945
949
|
base64(imageBase64: string): CheckSettingsImage;
|
|
946
950
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -1044,7 +1048,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1044
1048
|
}
|
|
1045
1049
|
export type ImageMatchSettingsPlain = {
|
|
1046
1050
|
exact?: undefined | ExactMatchSettingsPlain;
|
|
1047
|
-
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "
|
|
1051
|
+
matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
|
|
1048
1052
|
ignoreCaret?: undefined | boolean;
|
|
1049
1053
|
useDom?: undefined | boolean;
|
|
1050
1054
|
enablePatterns?: undefined | boolean;
|
|
@@ -1143,7 +1147,7 @@ export class Location implements Required<LocationPlain> {
|
|
|
1143
1147
|
getY(): number;
|
|
1144
1148
|
setY(y: number): void;
|
|
1145
1149
|
}
|
|
1146
|
-
export type LogHandlerPlain = CustomLogHandlerPlain |
|
|
1150
|
+
export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
|
|
1147
1151
|
export type CustomLogHandlerPlain = { log(message: any): void; };
|
|
1148
1152
|
export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
|
|
1149
1153
|
export type ConsoleLogHandlerPlain = { type: "console"; };
|
|
@@ -1251,9 +1255,9 @@ export class Region implements Required<RegionPlain> {
|
|
|
1251
1255
|
setHeight(height: number): void;
|
|
1252
1256
|
}
|
|
1253
1257
|
export type DesktopBrowserInfo = { name?: undefined | "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; };
|
|
1254
|
-
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1255
|
-
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "
|
|
1256
|
-
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "
|
|
1258
|
+
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1259
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1260
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1257
1261
|
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1258
1262
|
export class RunnerOptionsFluent {
|
|
1259
1263
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1330,7 +1334,7 @@ export type TestResultsPlain = {
|
|
|
1330
1334
|
readonly id?: undefined | string;
|
|
1331
1335
|
readonly name?: undefined | string;
|
|
1332
1336
|
readonly secretToken?: undefined | string;
|
|
1333
|
-
readonly status?: undefined | "Passed" | "
|
|
1337
|
+
readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
|
|
1334
1338
|
readonly appName?: undefined | string;
|
|
1335
1339
|
readonly batchId?: undefined | string;
|
|
1336
1340
|
readonly batchName?: undefined | string;
|
|
@@ -1422,14 +1426,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1422
1426
|
isPassed(): boolean;
|
|
1423
1427
|
delete(): Promise<void>;
|
|
1424
1428
|
}
|
|
1425
|
-
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo |
|
|
1429
|
+
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo; };
|
|
1426
1430
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1427
1431
|
get testResults(): TestResultsPlain;
|
|
1428
1432
|
getTestResults(): TestResults;
|
|
1429
1433
|
get exception(): Error;
|
|
1430
1434
|
getException(): Error;
|
|
1431
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo |
|
|
1432
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo |
|
|
1435
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1436
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1433
1437
|
}
|
|
1434
1438
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1435
1439
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|