@applitools/eyes-webdriverio 5.40.0 → 5.40.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 +6 -0
- package/package.json +8 -8
- package/types/index.d.ts +73 -73
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-webdriverio",
|
|
3
|
-
"version": "5.40.
|
|
3
|
+
"version": "5.40.1",
|
|
4
4
|
"description": "Applitools Eyes SDK for WebdriverIO",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-webdriverio",
|
|
@@ -116,8 +116,8 @@
|
|
|
116
116
|
}
|
|
117
117
|
},
|
|
118
118
|
"dependencies": {
|
|
119
|
-
"@applitools/core": "1.4.
|
|
120
|
-
"@applitools/eyes-api": "1.12.
|
|
119
|
+
"@applitools/core": "1.4.2",
|
|
120
|
+
"@applitools/eyes-api": "1.12.2",
|
|
121
121
|
"@applitools/spec-driver-webdriverio": "1.4.20"
|
|
122
122
|
},
|
|
123
123
|
"devDependencies": {
|
|
@@ -131,11 +131,11 @@
|
|
|
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.
|
|
134
|
+
"@wdio/cli": "^8.2.1",
|
|
135
135
|
"@wdio/dot-reporter": "^8.0.14",
|
|
136
|
-
"@wdio/globals": "^8.
|
|
137
|
-
"@wdio/local-runner": "^8.
|
|
138
|
-
"@wdio/mocha-framework": "^8.
|
|
136
|
+
"@wdio/globals": "^8.2.1",
|
|
137
|
+
"@wdio/local-runner": "^8.2.1",
|
|
138
|
+
"@wdio/mocha-framework": "^8.2.1",
|
|
139
139
|
"chromedriver": "^105.0.1",
|
|
140
140
|
"eslint": "^8.16.0",
|
|
141
141
|
"eslint-config-prettier": "^8.5.0",
|
|
@@ -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.
|
|
154
|
+
"webdriverio": "^8.2.1"
|
|
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: CheckSettingsAutomation | CheckSettingsImage): Promise<MatchResult>;
|
|
42
42
|
check(target: {
|
|
43
|
-
image: string |
|
|
43
|
+
image: string | Buffer | URL;
|
|
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 | Buffer | URL;
|
|
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 | Buffer | URL;
|
|
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: LogHandler | LogHandlerPlain): 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 | { 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 | "
|
|
399
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>;
|
|
400
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
401
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
402
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }): 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 | "portrait" | "landscape"): 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,51 +457,51 @@ 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:
|
|
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<
|
|
460
|
+
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;
|
|
461
|
+
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;
|
|
462
|
+
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;
|
|
463
|
+
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;
|
|
464
|
+
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;
|
|
465
|
+
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;
|
|
466
|
+
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;
|
|
467
|
+
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
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
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
470
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
471
471
|
regionId?: undefined | string;
|
|
472
472
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
473
473
|
}): CheckSettingsAutomation;
|
|
474
474
|
floatingRegion(region: {
|
|
475
475
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
476
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
476
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
477
477
|
regionId?: undefined | string;
|
|
478
478
|
maxUpOffset?: undefined | number;
|
|
479
479
|
maxDownOffset?: undefined | number;
|
|
480
480
|
maxLeftOffset?: undefined | number;
|
|
481
481
|
maxRightOffset?: undefined | number;
|
|
482
482
|
}): CheckSettingsAutomation;
|
|
483
|
-
floatingRegion(region:
|
|
484
|
-
floatingRegions(...regions: Array<
|
|
483
|
+
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;
|
|
484
|
+
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
485
485
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
486
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
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<
|
|
490
|
+
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
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
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
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:
|
|
498
|
-
accessibilityRegions(...regions: Array<
|
|
497
|
+
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;
|
|
498
|
+
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
499
499
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
500
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
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<
|
|
504
|
+
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
505
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
506
506
|
layout(): CheckSettingsAutomation;
|
|
507
507
|
exact(): CheckSettingsAutomation;
|
|
@@ -715,7 +715,7 @@ export enum AndroidVersion {
|
|
|
715
715
|
LATEST = 'latest',
|
|
716
716
|
ONE_VERSION_BACK = 'latest-1'
|
|
717
717
|
}
|
|
718
|
-
export type MatchLevelPlain = "
|
|
718
|
+
export type MatchLevelPlain = "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
719
719
|
export enum MatchLevel {
|
|
720
720
|
None = 'None',
|
|
721
721
|
LegacyLayout = 'Layout1',
|
|
@@ -726,7 +726,7 @@ export enum MatchLevel {
|
|
|
726
726
|
Strict = 'Strict',
|
|
727
727
|
Exact = 'Exact'
|
|
728
728
|
}
|
|
729
|
-
export type ScreenOrientationPlain = "
|
|
729
|
+
export type ScreenOrientationPlain = "portrait" | "landscape";
|
|
730
730
|
export enum ScreenOrientation {
|
|
731
731
|
PORTRAIT = 'portrait',
|
|
732
732
|
LANDSCAPE = 'landscape'
|
|
@@ -741,7 +741,7 @@ export enum StitchMode {
|
|
|
741
741
|
SCROLL = 'Scroll',
|
|
742
742
|
CSS = 'CSS'
|
|
743
743
|
}
|
|
744
|
-
export type TestResultsStatusPlain = "Passed" | "
|
|
744
|
+
export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
|
|
745
745
|
export enum TestResultsStatus {
|
|
746
746
|
Passed = 'Passed',
|
|
747
747
|
Unresolved = 'Unresolved',
|
|
@@ -828,25 +828,25 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
828
828
|
export type CheckSettingsImagePlain = {
|
|
829
829
|
name?: undefined | string;
|
|
830
830
|
region?: undefined | RegionPlain;
|
|
831
|
-
matchLevel?: undefined | "
|
|
831
|
+
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
832
832
|
useDom?: undefined | boolean;
|
|
833
833
|
sendDom?: undefined | boolean;
|
|
834
834
|
enablePatterns?: undefined | boolean;
|
|
835
835
|
ignoreDisplacements?: undefined | boolean;
|
|
836
836
|
ignoreMismatch?: undefined | boolean;
|
|
837
837
|
ignoreCaret?: undefined | boolean;
|
|
838
|
-
ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number;
|
|
839
|
-
layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number;
|
|
840
|
-
strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number;
|
|
841
|
-
contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number;
|
|
838
|
+
ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
839
|
+
layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
840
|
+
strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
841
|
+
contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
842
842
|
floatingRegions?: undefined | Array<RegionPlain | {
|
|
843
843
|
region: RegionPlain;
|
|
844
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
844
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
845
845
|
regionId?: undefined | string;
|
|
846
846
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
847
847
|
} | {
|
|
848
848
|
region: RegionPlain;
|
|
849
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
849
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
850
850
|
regionId?: undefined | string;
|
|
851
851
|
maxUpOffset?: undefined | number;
|
|
852
852
|
maxDownOffset?: undefined | number;
|
|
@@ -855,7 +855,7 @@ export type CheckSettingsImagePlain = {
|
|
|
855
855
|
}>;
|
|
856
856
|
accessibilityRegions?: undefined | Array<RegionPlain | {
|
|
857
857
|
region: RegionPlain;
|
|
858
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
858
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
859
859
|
regionId?: undefined | string;
|
|
860
860
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
861
861
|
}>;
|
|
@@ -863,15 +863,15 @@ export type CheckSettingsImagePlain = {
|
|
|
863
863
|
variationGroupId?: undefined | string;
|
|
864
864
|
};
|
|
865
865
|
export class CheckSettingsImage {
|
|
866
|
-
constructor(settings?: undefined |
|
|
867
|
-
image: string |
|
|
866
|
+
constructor(settings?: undefined | CheckSettingsImage | CheckSettingsImagePlain, target?: undefined | {
|
|
867
|
+
image: string | Buffer | URL;
|
|
868
868
|
name?: undefined | string;
|
|
869
869
|
dom?: undefined | string;
|
|
870
870
|
locationInViewport?: undefined | LocationPlain;
|
|
871
871
|
locationInView?: undefined | LocationPlain;
|
|
872
872
|
fullViewSize?: undefined | RectangleSizePlain;
|
|
873
873
|
});
|
|
874
|
-
image(image: string |
|
|
874
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
875
875
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
876
876
|
base64(imageBase64: Buffer): CheckSettingsImage;
|
|
877
877
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -879,53 +879,53 @@ export class CheckSettingsImage {
|
|
|
879
879
|
name(name: string): CheckSettingsImage;
|
|
880
880
|
withDom(dom: string): CheckSettingsImage;
|
|
881
881
|
withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
|
|
882
|
-
region(region:
|
|
882
|
+
region(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
|
|
883
883
|
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<
|
|
884
|
+
ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
885
|
+
ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
886
|
+
layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
887
|
+
layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
888
|
+
strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
889
|
+
strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
890
|
+
contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
891
|
+
contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
892
892
|
floatingRegion(region: {
|
|
893
893
|
region: RegionPlain;
|
|
894
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
894
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
895
895
|
regionId?: undefined | string;
|
|
896
896
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
897
897
|
}): CheckSettingsImage;
|
|
898
898
|
floatingRegion(region: {
|
|
899
899
|
region: RegionPlain;
|
|
900
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
900
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
901
901
|
regionId?: undefined | string;
|
|
902
902
|
maxUpOffset?: undefined | number;
|
|
903
903
|
maxDownOffset?: undefined | number;
|
|
904
904
|
maxLeftOffset?: undefined | number;
|
|
905
905
|
maxRightOffset?: undefined | number;
|
|
906
906
|
}): CheckSettingsImage;
|
|
907
|
-
floatingRegion(region:
|
|
908
|
-
floatingRegions(...regions: Array<
|
|
907
|
+
floatingRegion(region: RegionPlain | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
908
|
+
floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
909
909
|
region: RegionPlain;
|
|
910
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
910
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
911
911
|
regionId?: undefined | string;
|
|
912
912
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
913
913
|
}>): CheckSettingsImage;
|
|
914
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
914
|
+
floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
915
915
|
accessibilityRegion(region: {
|
|
916
916
|
region: RegionPlain;
|
|
917
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
917
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
918
918
|
regionId?: undefined | string;
|
|
919
919
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
920
920
|
}): CheckSettingsImage;
|
|
921
|
-
accessibilityRegion(region:
|
|
922
|
-
accessibilityRegions(...regions: Array<
|
|
921
|
+
accessibilityRegion(region: RegionPlain | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
|
|
922
|
+
accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
923
923
|
region: RegionPlain;
|
|
924
|
-
padding?: undefined | number | { top: number; bottom: number;
|
|
924
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
925
925
|
regionId?: undefined | string;
|
|
926
926
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
927
927
|
}>): CheckSettingsImage;
|
|
928
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
928
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
929
929
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
|
|
930
930
|
layout(): CheckSettingsImage;
|
|
931
931
|
exact(): CheckSettingsImage;
|
|
@@ -940,7 +940,7 @@ export class CheckSettingsImage {
|
|
|
940
940
|
variationGroupId(variationGroupId: string): CheckSettingsImage;
|
|
941
941
|
}
|
|
942
942
|
export type TargetImage = {
|
|
943
|
-
image(image: string |
|
|
943
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
944
944
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
945
945
|
base64(imageBase64: string): CheckSettingsImage;
|
|
946
946
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -1044,7 +1044,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1044
1044
|
}
|
|
1045
1045
|
export type ImageMatchSettingsPlain = {
|
|
1046
1046
|
exact?: undefined | ExactMatchSettingsPlain;
|
|
1047
|
-
matchLevel?: undefined | "
|
|
1047
|
+
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
1048
1048
|
ignoreCaret?: undefined | boolean;
|
|
1049
1049
|
useDom?: undefined | boolean;
|
|
1050
1050
|
enablePatterns?: undefined | boolean;
|
|
@@ -1143,7 +1143,7 @@ export class Location implements Required<LocationPlain> {
|
|
|
1143
1143
|
getY(): number;
|
|
1144
1144
|
setY(y: number): void;
|
|
1145
1145
|
}
|
|
1146
|
-
export type LogHandlerPlain = CustomLogHandlerPlain |
|
|
1146
|
+
export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
|
|
1147
1147
|
export type CustomLogHandlerPlain = { log(message: any): void; };
|
|
1148
1148
|
export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
|
|
1149
1149
|
export type ConsoleLogHandlerPlain = { type: "console"; };
|
|
@@ -1251,9 +1251,9 @@ export class Region implements Required<RegionPlain> {
|
|
|
1251
1251
|
setHeight(height: number): void;
|
|
1252
1252
|
}
|
|
1253
1253
|
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 | "
|
|
1254
|
+
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1255
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1256
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1257
1257
|
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1258
1258
|
export class RunnerOptionsFluent {
|
|
1259
1259
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1330,7 +1330,7 @@ export type TestResultsPlain = {
|
|
|
1330
1330
|
readonly id?: undefined | string;
|
|
1331
1331
|
readonly name?: undefined | string;
|
|
1332
1332
|
readonly secretToken?: undefined | string;
|
|
1333
|
-
readonly status?: undefined | "Passed" | "
|
|
1333
|
+
readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
|
|
1334
1334
|
readonly appName?: undefined | string;
|
|
1335
1335
|
readonly batchId?: undefined | string;
|
|
1336
1336
|
readonly batchName?: undefined | string;
|
|
@@ -1422,14 +1422,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1422
1422
|
isPassed(): boolean;
|
|
1423
1423
|
delete(): Promise<void>;
|
|
1424
1424
|
}
|
|
1425
|
-
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1425
|
+
export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1426
1426
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1427
1427
|
get testResults(): TestResultsPlain;
|
|
1428
1428
|
getTestResults(): TestResults;
|
|
1429
1429
|
get exception(): Error;
|
|
1430
1430
|
getException(): Error;
|
|
1431
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1432
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1431
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1432
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1433
1433
|
}
|
|
1434
1434
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1435
1435
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|