@applitools/eyes-webdriverio 5.41.1 → 5.42.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 +12 -0
- package/README.md +17 -0
- package/package.json +13 -13
- package/types/index.d.ts +67 -62
package/CHANGELOG.md
CHANGED
|
@@ -10,6 +10,18 @@
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
|
+
## 5.42.1 - 2023/3/7
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
- Added support for scroll root elements in ufg (only for native apps)
|
|
17
|
+
### Bug fixes
|
|
18
|
+
|
|
19
|
+
## 5.42.0 - 2023/2/17
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
- Crop screenshot image base on account info
|
|
23
|
+
### Bug fixes
|
|
24
|
+
|
|
13
25
|
## 5.41.1 - 2023/2/6
|
|
14
26
|
|
|
15
27
|
### Features
|
package/README.md
CHANGED
|
@@ -397,6 +397,23 @@ eyes.check(Target.webview('webview-id'))
|
|
|
397
397
|
|
|
398
398
|
After the check command, the SDK will switch the driver back to the app context that it was prior to performing the check.
|
|
399
399
|
|
|
400
|
+
##### Density metrics (`densityMetrics`)
|
|
401
|
+
|
|
402
|
+
In order to set the density metrics for the screenshot, use the `densityMetrics` method. This method accepts a object value with the following properties:
|
|
403
|
+
|
|
404
|
+
- `xdpi` - The exact physical pixels per inch of the screen in the X dimension.
|
|
405
|
+
- `ydpi` - The exact physical pixels per inch of the screen in the Y dimension.
|
|
406
|
+
- `scaleRatio` - The scale ratio.
|
|
407
|
+
|
|
408
|
+
```js
|
|
409
|
+
// set density metrics
|
|
410
|
+
eyes.check(Target.window().densityMetrics({
|
|
411
|
+
xdpi: 100,
|
|
412
|
+
ydpi: 100,
|
|
413
|
+
scaleRatio: 1
|
|
414
|
+
}))
|
|
415
|
+
```
|
|
416
|
+
|
|
400
417
|
###### Other checkSettings configuration
|
|
401
418
|
|
|
402
419
|
<!-- TODO add explanation -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-webdriverio",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.42.1",
|
|
4
4
|
"description": "Applitools Eyes SDK for WebdriverIO",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-webdriverio",
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
"setup": "yarn docker:setup",
|
|
102
102
|
"docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
|
|
103
103
|
"docker:teardown": "docker-compose down",
|
|
104
|
-
"upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION
|
|
104
|
+
"upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
|
|
105
105
|
"deps": "bongo deps",
|
|
106
106
|
"gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
|
|
107
107
|
"gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
|
|
@@ -111,28 +111,28 @@
|
|
|
111
111
|
"postversion": "bongo postversion"
|
|
112
112
|
},
|
|
113
113
|
"dependencies": {
|
|
114
|
-
"@applitools/core": "
|
|
115
|
-
"@applitools/eyes-api": "1.13.
|
|
116
|
-
"@applitools/spec-driver-webdriverio": "1.4.
|
|
114
|
+
"@applitools/core": "2.3.13",
|
|
115
|
+
"@applitools/eyes-api": "1.13.11",
|
|
116
|
+
"@applitools/spec-driver-webdriverio": "1.4.30"
|
|
117
117
|
},
|
|
118
118
|
"devDependencies": {
|
|
119
119
|
"@applitools/api-extractor": "1.2.11",
|
|
120
|
-
"@applitools/bongo": "^2.2.
|
|
121
|
-
"@applitools/sdk-coverage-tests": "^2.7.
|
|
120
|
+
"@applitools/bongo": "^2.2.5",
|
|
121
|
+
"@applitools/sdk-coverage-tests": "^2.7.12",
|
|
122
122
|
"@applitools/test-utils": "1.5.12",
|
|
123
123
|
"@types/mocha": "^9.1.1",
|
|
124
124
|
"@types/node": "16",
|
|
125
|
-
"@wdio/cli": "^8.
|
|
126
|
-
"@wdio/dot-reporter": "^8.0
|
|
127
|
-
"@wdio/globals": "^8.
|
|
128
|
-
"@wdio/local-runner": "^8.
|
|
129
|
-
"@wdio/mocha-framework": "^8.
|
|
125
|
+
"@wdio/cli": "^8.3.9",
|
|
126
|
+
"@wdio/dot-reporter": "^8.3.0",
|
|
127
|
+
"@wdio/globals": "^8.3.9",
|
|
128
|
+
"@wdio/local-runner": "^8.3.9",
|
|
129
|
+
"@wdio/mocha-framework": "^8.3.0",
|
|
130
130
|
"chromedriver": "^109.0.0",
|
|
131
131
|
"expect-webdriverio": "^4.0.1",
|
|
132
132
|
"geckodriver": "^1.20.0",
|
|
133
133
|
"mocha": "^9.2.2",
|
|
134
134
|
"mocha-multi": "^1.1.7",
|
|
135
|
-
"webdriverio": "^8.
|
|
135
|
+
"webdriverio": "^8.3.9"
|
|
136
136
|
},
|
|
137
137
|
"peerDependencies": {
|
|
138
138
|
"webdriverio": ">=5.0.0"
|
package/types/index.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export class By {
|
|
|
16
16
|
export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: undefined; };
|
|
17
17
|
export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: undefined; };
|
|
18
18
|
export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: undefined; };
|
|
19
|
+
export type SpecType = { driver: Driver; context: Driver; element: Element; selector: Selector; };
|
|
19
20
|
export class Eyes {
|
|
20
21
|
static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
|
|
21
22
|
static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
|
|
@@ -38,9 +39,9 @@ export class Eyes {
|
|
|
38
39
|
open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
|
|
39
40
|
open(config?: undefined | ConfigurationPlain): Promise<void>;
|
|
40
41
|
open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
|
|
41
|
-
check(name: string, checkSettings:
|
|
42
|
+
check(name: string, checkSettings: CheckSettingsAutomation | CheckSettingsImage): Promise<MatchResult>;
|
|
42
43
|
check(target: {
|
|
43
|
-
image: string |
|
|
44
|
+
image: string | Buffer | URL;
|
|
44
45
|
name?: undefined | string;
|
|
45
46
|
dom?: undefined | string;
|
|
46
47
|
locationInViewport?: undefined | LocationPlain;
|
|
@@ -50,7 +51,7 @@ export class Eyes {
|
|
|
50
51
|
check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
|
|
51
52
|
locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
|
|
52
53
|
extractTextRegions<TPattern extends string>(target: {
|
|
53
|
-
image: string |
|
|
54
|
+
image: string | Buffer | URL;
|
|
54
55
|
size?: undefined | { width: number; height: number; };
|
|
55
56
|
name?: undefined | string;
|
|
56
57
|
source?: undefined | string;
|
|
@@ -61,7 +62,7 @@ export class Eyes {
|
|
|
61
62
|
}, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
62
63
|
extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
63
64
|
extractText(target: {
|
|
64
|
-
image: string |
|
|
65
|
+
image: string | Buffer | URL;
|
|
65
66
|
size?: undefined | { width: number; height: number; };
|
|
66
67
|
name?: undefined | string;
|
|
67
68
|
source?: undefined | string;
|
|
@@ -72,12 +73,14 @@ export class Eyes {
|
|
|
72
73
|
}, settings: Array<OCRRegion>): Promise<Array<string>>;
|
|
73
74
|
extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
|
|
74
75
|
close(throwErr?: undefined | boolean): Promise<TestResults>;
|
|
76
|
+
closeAsync(): Promise<void>;
|
|
75
77
|
abort(): Promise<TestResults>;
|
|
78
|
+
abortAsync(): Promise<void>;
|
|
76
79
|
getViewportSize(): Promise<RectangleSize>;
|
|
77
80
|
setViewportSize(size: RectangleSizePlain): Promise<void>;
|
|
78
81
|
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
79
82
|
setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
|
|
80
|
-
setLogHandler(handler:
|
|
83
|
+
setLogHandler(handler: LogHandler | LogHandlerPlain): void;
|
|
81
84
|
getLogHandler(): LogHandler;
|
|
82
85
|
setCutProvider(cutProvider: CutProvider): void;
|
|
83
86
|
setImageCut(cutProvider: CutProvider): void;
|
|
@@ -396,12 +399,12 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
396
399
|
setScaleRatio(scaleRatio: number): Configuration;
|
|
397
400
|
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
398
401
|
set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
|
|
399
|
-
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
400
|
-
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
401
|
-
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
402
|
-
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
402
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>;
|
|
403
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
404
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
405
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }): Configuration;
|
|
403
406
|
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 | "
|
|
407
|
+
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait" | "landscape"): Configuration;
|
|
405
408
|
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
406
409
|
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
407
410
|
get visualGridOptions(): { [key: string]: any; };
|
|
@@ -455,16 +458,17 @@ export class CheckSettingsAutomation {
|
|
|
455
458
|
timeout(timeout: number): CheckSettingsAutomation;
|
|
456
459
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|
|
457
460
|
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
461
|
+
densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
|
|
458
462
|
name(name: string): CheckSettingsAutomation;
|
|
459
463
|
withName(name: string): CheckSettingsAutomation;
|
|
460
|
-
ignoreRegion(region:
|
|
461
|
-
ignoreRegions(...regions: Array<
|
|
462
|
-
layoutRegion(region:
|
|
463
|
-
layoutRegions(...regions: Array<
|
|
464
|
-
strictRegion(region:
|
|
465
|
-
strictRegions(...regions: Array<
|
|
466
|
-
contentRegion(region:
|
|
467
|
-
contentRegions(...regions: Array<
|
|
464
|
+
ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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
|
+
ignoreRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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
|
+
layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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
|
+
layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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
|
+
strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
469
|
+
strictRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
470
|
+
contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
471
|
+
contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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
472
|
floatingRegion(region: {
|
|
469
473
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
470
474
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -480,28 +484,28 @@ export class CheckSettingsAutomation {
|
|
|
480
484
|
maxLeftOffset?: undefined | number;
|
|
481
485
|
maxRightOffset?: undefined | number;
|
|
482
486
|
}): CheckSettingsAutomation;
|
|
483
|
-
floatingRegion(region:
|
|
484
|
-
floatingRegions(...regions: Array<
|
|
487
|
+
floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
488
|
+
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
485
489
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
486
490
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
487
491
|
regionId?: undefined | string;
|
|
488
492
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
489
493
|
}>): CheckSettingsAutomation;
|
|
490
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
494
|
+
floatingRegions(maxOffset: number, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
|
|
491
495
|
accessibilityRegion(region: {
|
|
492
496
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
493
497
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
494
498
|
regionId?: undefined | string;
|
|
495
499
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
496
500
|
}): CheckSettingsAutomation;
|
|
497
|
-
accessibilityRegion(region:
|
|
498
|
-
accessibilityRegions(...regions: Array<
|
|
501
|
+
accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
|
|
502
|
+
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
499
503
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
500
504
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
501
505
|
regionId?: undefined | string;
|
|
502
506
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
503
507
|
}>): CheckSettingsAutomation;
|
|
504
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
508
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
|
|
505
509
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
506
510
|
layout(): CheckSettingsAutomation;
|
|
507
511
|
exact(): CheckSettingsAutomation;
|
|
@@ -517,7 +521,7 @@ export class CheckSettingsAutomation {
|
|
|
517
521
|
}
|
|
518
522
|
export class CheckSettings extends CheckSettingsAutomation {
|
|
519
523
|
}
|
|
520
|
-
export const Target: TargetImage & TargetAutomation<
|
|
524
|
+
export const Target: TargetImage & TargetAutomation<SpecType>;
|
|
521
525
|
export class BatchClose {
|
|
522
526
|
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
523
527
|
constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
|
|
@@ -719,7 +723,7 @@ export enum AndroidVersion {
|
|
|
719
723
|
LATEST = 'latest',
|
|
720
724
|
ONE_VERSION_BACK = 'latest-1'
|
|
721
725
|
}
|
|
722
|
-
export type MatchLevelPlain = "
|
|
726
|
+
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
723
727
|
export enum MatchLevel {
|
|
724
728
|
None = 'None',
|
|
725
729
|
LegacyLayout = 'Layout1',
|
|
@@ -730,7 +734,7 @@ export enum MatchLevel {
|
|
|
730
734
|
Strict = 'Strict',
|
|
731
735
|
Exact = 'Exact'
|
|
732
736
|
}
|
|
733
|
-
export type ScreenOrientationPlain = "
|
|
737
|
+
export type ScreenOrientationPlain = "portrait" | "landscape";
|
|
734
738
|
export enum ScreenOrientation {
|
|
735
739
|
PORTRAIT = 'portrait',
|
|
736
740
|
LANDSCAPE = 'landscape'
|
|
@@ -745,7 +749,7 @@ export enum StitchMode {
|
|
|
745
749
|
SCROLL = 'Scroll',
|
|
746
750
|
CSS = 'CSS'
|
|
747
751
|
}
|
|
748
|
-
export type TestResultsStatusPlain = "Passed" | "
|
|
752
|
+
export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
|
|
749
753
|
export enum TestResultsStatus {
|
|
750
754
|
Passed = 'Passed',
|
|
751
755
|
Unresolved = 'Unresolved',
|
|
@@ -832,7 +836,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
832
836
|
export type CheckSettingsImagePlain = {
|
|
833
837
|
name?: undefined | string;
|
|
834
838
|
region?: undefined | RegionPlain;
|
|
835
|
-
matchLevel?: undefined | "
|
|
839
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
836
840
|
useDom?: undefined | boolean;
|
|
837
841
|
sendDom?: undefined | boolean;
|
|
838
842
|
enablePatterns?: undefined | boolean;
|
|
@@ -865,17 +869,18 @@ export type CheckSettingsImagePlain = {
|
|
|
865
869
|
}>;
|
|
866
870
|
pageId?: undefined | string;
|
|
867
871
|
variationGroupId?: undefined | string;
|
|
872
|
+
densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
|
|
868
873
|
};
|
|
869
874
|
export class CheckSettingsImage {
|
|
870
|
-
constructor(settings?: undefined |
|
|
871
|
-
image: string |
|
|
875
|
+
constructor(settings?: undefined | CheckSettingsImage | CheckSettingsImagePlain, target?: undefined | {
|
|
876
|
+
image: string | Buffer | URL;
|
|
872
877
|
name?: undefined | string;
|
|
873
878
|
dom?: undefined | string;
|
|
874
879
|
locationInViewport?: undefined | LocationPlain;
|
|
875
880
|
locationInView?: undefined | LocationPlain;
|
|
876
881
|
fullViewSize?: undefined | RectangleSizePlain;
|
|
877
882
|
});
|
|
878
|
-
image(image: string |
|
|
883
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
879
884
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
880
885
|
base64(imageBase64: Buffer): CheckSettingsImage;
|
|
881
886
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -883,16 +888,16 @@ export class CheckSettingsImage {
|
|
|
883
888
|
name(name: string): CheckSettingsImage;
|
|
884
889
|
withDom(dom: string): CheckSettingsImage;
|
|
885
890
|
withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
|
|
886
|
-
region(region:
|
|
891
|
+
region(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
|
|
887
892
|
withName(name: string): CheckSettingsImage;
|
|
888
|
-
ignoreRegion(region:
|
|
889
|
-
ignoreRegions(...regions: Array<
|
|
890
|
-
layoutRegion(region:
|
|
891
|
-
layoutRegions(...regions: Array<
|
|
892
|
-
strictRegion(region:
|
|
893
|
-
strictRegions(...regions: Array<
|
|
894
|
-
contentRegion(region:
|
|
895
|
-
contentRegions(...regions: Array<
|
|
893
|
+
ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
894
|
+
ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
895
|
+
layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
896
|
+
layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
897
|
+
strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
898
|
+
strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
899
|
+
contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
900
|
+
contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
896
901
|
floatingRegion(region: {
|
|
897
902
|
region: RegionPlain;
|
|
898
903
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -908,28 +913,28 @@ export class CheckSettingsImage {
|
|
|
908
913
|
maxLeftOffset?: undefined | number;
|
|
909
914
|
maxRightOffset?: undefined | number;
|
|
910
915
|
}): CheckSettingsImage;
|
|
911
|
-
floatingRegion(region:
|
|
912
|
-
floatingRegions(...regions: Array<
|
|
916
|
+
floatingRegion(region: RegionPlain | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
917
|
+
floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
913
918
|
region: RegionPlain;
|
|
914
919
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
915
920
|
regionId?: undefined | string;
|
|
916
921
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
917
922
|
}>): CheckSettingsImage;
|
|
918
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
923
|
+
floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
919
924
|
accessibilityRegion(region: {
|
|
920
925
|
region: RegionPlain;
|
|
921
926
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
922
927
|
regionId?: undefined | string;
|
|
923
928
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
924
929
|
}): CheckSettingsImage;
|
|
925
|
-
accessibilityRegion(region:
|
|
926
|
-
accessibilityRegions(...regions: Array<
|
|
930
|
+
accessibilityRegion(region: RegionPlain | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
|
|
931
|
+
accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
927
932
|
region: RegionPlain;
|
|
928
933
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
929
934
|
regionId?: undefined | string;
|
|
930
935
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
931
936
|
}>): CheckSettingsImage;
|
|
932
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
937
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
933
938
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
|
|
934
939
|
layout(): CheckSettingsImage;
|
|
935
940
|
exact(): CheckSettingsImage;
|
|
@@ -944,18 +949,18 @@ export class CheckSettingsImage {
|
|
|
944
949
|
variationGroupId(variationGroupId: string): CheckSettingsImage;
|
|
945
950
|
}
|
|
946
951
|
export type TargetImage = {
|
|
947
|
-
image(image: string |
|
|
952
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
948
953
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
949
954
|
base64(imageBase64: string): CheckSettingsImage;
|
|
950
955
|
path(imagePath: string): CheckSettingsImage;
|
|
951
956
|
url(imageUrl: string | URL): CheckSettingsImage;
|
|
952
957
|
};
|
|
953
|
-
export type TargetAutomation<
|
|
958
|
+
export type TargetAutomation<TSpec extends SpecType = SpecType> = {
|
|
954
959
|
window(): CheckSettingsAutomation;
|
|
955
|
-
region(region: LegacyRegionPlain | (RegionPlain | (
|
|
956
|
-
frame(context: { frame: number | (
|
|
957
|
-
frame(frame: number | (
|
|
958
|
-
shadow(selector: string |
|
|
960
|
+
region(region: LegacyRegionPlain | (RegionPlain | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })))): CheckSettingsAutomation;
|
|
961
|
+
frame(context: { frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); }): CheckSettingsAutomation;
|
|
962
|
+
frame(frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })), scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))): CheckSettingsAutomation;
|
|
963
|
+
shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
|
|
959
964
|
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
960
965
|
};
|
|
961
966
|
export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
@@ -1048,7 +1053,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1048
1053
|
}
|
|
1049
1054
|
export type ImageMatchSettingsPlain = {
|
|
1050
1055
|
exact?: undefined | ExactMatchSettingsPlain;
|
|
1051
|
-
matchLevel?: undefined | "
|
|
1056
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
1052
1057
|
ignoreCaret?: undefined | boolean;
|
|
1053
1058
|
useDom?: undefined | boolean;
|
|
1054
1059
|
enablePatterns?: undefined | boolean;
|
|
@@ -1147,7 +1152,7 @@ export class Location implements Required<LocationPlain> {
|
|
|
1147
1152
|
getY(): number;
|
|
1148
1153
|
setY(y: number): void;
|
|
1149
1154
|
}
|
|
1150
|
-
export type LogHandlerPlain = CustomLogHandlerPlain |
|
|
1155
|
+
export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
|
|
1151
1156
|
export type CustomLogHandlerPlain = { log(message: any): void; };
|
|
1152
1157
|
export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
|
|
1153
1158
|
export type ConsoleLogHandlerPlain = { type: "console"; };
|
|
@@ -1255,9 +1260,9 @@ export class Region implements Required<RegionPlain> {
|
|
|
1255
1260
|
setHeight(height: number): void;
|
|
1256
1261
|
}
|
|
1257
1262
|
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; };
|
|
1258
|
-
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1259
|
-
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "
|
|
1260
|
-
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "
|
|
1263
|
+
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1264
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1265
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1261
1266
|
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1262
1267
|
export class RunnerOptionsFluent {
|
|
1263
1268
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1334,7 +1339,7 @@ export type TestResultsPlain = {
|
|
|
1334
1339
|
readonly id?: undefined | string;
|
|
1335
1340
|
readonly name?: undefined | string;
|
|
1336
1341
|
readonly secretToken?: undefined | string;
|
|
1337
|
-
readonly status?: undefined | "Passed" | "
|
|
1342
|
+
readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
|
|
1338
1343
|
readonly appName?: undefined | string;
|
|
1339
1344
|
readonly batchId?: undefined | string;
|
|
1340
1345
|
readonly batchName?: undefined | string;
|
|
@@ -1426,14 +1431,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1426
1431
|
isPassed(): boolean;
|
|
1427
1432
|
delete(): Promise<void>;
|
|
1428
1433
|
}
|
|
1429
|
-
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1434
|
+
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }); };
|
|
1430
1435
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1431
1436
|
get testResults(): TestResultsPlain;
|
|
1432
1437
|
getTestResults(): TestResults;
|
|
1433
1438
|
get exception(): Error;
|
|
1434
1439
|
getException(): Error;
|
|
1435
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1436
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1440
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1441
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1437
1442
|
}
|
|
1438
1443
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1439
1444
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|