@applitools/eyes-webdriverio 5.41.1 → 5.42.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 +6 -0
- package/package.json +11 -11
- package/types/index.d.ts +63 -62
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-webdriverio",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.42.0",
|
|
4
4
|
"description": "Applitools Eyes SDK for WebdriverIO",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-webdriverio",
|
|
@@ -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.6",
|
|
115
|
+
"@applitools/eyes-api": "1.13.6",
|
|
116
|
+
"@applitools/spec-driver-webdriverio": "1.4.27"
|
|
117
117
|
},
|
|
118
118
|
"devDependencies": {
|
|
119
119
|
"@applitools/api-extractor": "1.2.11",
|
|
120
|
-
"@applitools/bongo": "^2.2.
|
|
120
|
+
"@applitools/bongo": "^2.2.5",
|
|
121
121
|
"@applitools/sdk-coverage-tests": "^2.7.10",
|
|
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;
|
|
@@ -77,7 +78,7 @@ export class Eyes {
|
|
|
77
78
|
setViewportSize(size: RectangleSizePlain): Promise<void>;
|
|
78
79
|
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
79
80
|
setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
|
|
80
|
-
setLogHandler(handler:
|
|
81
|
+
setLogHandler(handler: LogHandler | LogHandlerPlain): void;
|
|
81
82
|
getLogHandler(): LogHandler;
|
|
82
83
|
setCutProvider(cutProvider: CutProvider): void;
|
|
83
84
|
setImageCut(cutProvider: CutProvider): void;
|
|
@@ -396,12 +397,12 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
396
397
|
setScaleRatio(scaleRatio: number): Configuration;
|
|
397
398
|
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
398
399
|
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 | "
|
|
400
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>;
|
|
401
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
402
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
|
|
403
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }): Configuration;
|
|
403
404
|
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 | "
|
|
405
|
+
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait" | "landscape"): Configuration;
|
|
405
406
|
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
406
407
|
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
407
408
|
get visualGridOptions(): { [key: string]: any; };
|
|
@@ -457,14 +458,14 @@ export class CheckSettingsAutomation {
|
|
|
457
458
|
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
458
459
|
name(name: string): CheckSettingsAutomation;
|
|
459
460
|
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<
|
|
461
|
+
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;
|
|
462
|
+
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;
|
|
463
|
+
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;
|
|
464
|
+
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;
|
|
465
|
+
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;
|
|
466
|
+
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;
|
|
467
|
+
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;
|
|
468
|
+
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
469
|
floatingRegion(region: {
|
|
469
470
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
470
471
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -480,28 +481,28 @@ export class CheckSettingsAutomation {
|
|
|
480
481
|
maxLeftOffset?: undefined | number;
|
|
481
482
|
maxRightOffset?: undefined | number;
|
|
482
483
|
}): CheckSettingsAutomation;
|
|
483
|
-
floatingRegion(region:
|
|
484
|
-
floatingRegions(...regions: Array<
|
|
484
|
+
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;
|
|
485
|
+
floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
485
486
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
486
487
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
487
488
|
regionId?: undefined | string;
|
|
488
489
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
489
490
|
}>): CheckSettingsAutomation;
|
|
490
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
491
|
+
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
492
|
accessibilityRegion(region: {
|
|
492
493
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
493
494
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
494
495
|
regionId?: undefined | string;
|
|
495
496
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
496
497
|
}): CheckSettingsAutomation;
|
|
497
|
-
accessibilityRegion(region:
|
|
498
|
-
accessibilityRegions(...regions: Array<
|
|
498
|
+
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;
|
|
499
|
+
accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
|
|
499
500
|
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
500
501
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
501
502
|
regionId?: undefined | string;
|
|
502
503
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
503
504
|
}>): CheckSettingsAutomation;
|
|
504
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
505
|
+
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
506
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
506
507
|
layout(): CheckSettingsAutomation;
|
|
507
508
|
exact(): CheckSettingsAutomation;
|
|
@@ -517,7 +518,7 @@ export class CheckSettingsAutomation {
|
|
|
517
518
|
}
|
|
518
519
|
export class CheckSettings extends CheckSettingsAutomation {
|
|
519
520
|
}
|
|
520
|
-
export const Target: TargetImage & TargetAutomation<
|
|
521
|
+
export const Target: TargetImage & TargetAutomation<SpecType>;
|
|
521
522
|
export class BatchClose {
|
|
522
523
|
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
523
524
|
constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
|
|
@@ -719,7 +720,7 @@ export enum AndroidVersion {
|
|
|
719
720
|
LATEST = 'latest',
|
|
720
721
|
ONE_VERSION_BACK = 'latest-1'
|
|
721
722
|
}
|
|
722
|
-
export type MatchLevelPlain = "
|
|
723
|
+
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
723
724
|
export enum MatchLevel {
|
|
724
725
|
None = 'None',
|
|
725
726
|
LegacyLayout = 'Layout1',
|
|
@@ -730,7 +731,7 @@ export enum MatchLevel {
|
|
|
730
731
|
Strict = 'Strict',
|
|
731
732
|
Exact = 'Exact'
|
|
732
733
|
}
|
|
733
|
-
export type ScreenOrientationPlain = "
|
|
734
|
+
export type ScreenOrientationPlain = "portrait" | "landscape";
|
|
734
735
|
export enum ScreenOrientation {
|
|
735
736
|
PORTRAIT = 'portrait',
|
|
736
737
|
LANDSCAPE = 'landscape'
|
|
@@ -745,7 +746,7 @@ export enum StitchMode {
|
|
|
745
746
|
SCROLL = 'Scroll',
|
|
746
747
|
CSS = 'CSS'
|
|
747
748
|
}
|
|
748
|
-
export type TestResultsStatusPlain = "Passed" | "
|
|
749
|
+
export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
|
|
749
750
|
export enum TestResultsStatus {
|
|
750
751
|
Passed = 'Passed',
|
|
751
752
|
Unresolved = 'Unresolved',
|
|
@@ -832,7 +833,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
832
833
|
export type CheckSettingsImagePlain = {
|
|
833
834
|
name?: undefined | string;
|
|
834
835
|
region?: undefined | RegionPlain;
|
|
835
|
-
matchLevel?: undefined | "
|
|
836
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
836
837
|
useDom?: undefined | boolean;
|
|
837
838
|
sendDom?: undefined | boolean;
|
|
838
839
|
enablePatterns?: undefined | boolean;
|
|
@@ -867,15 +868,15 @@ export type CheckSettingsImagePlain = {
|
|
|
867
868
|
variationGroupId?: undefined | string;
|
|
868
869
|
};
|
|
869
870
|
export class CheckSettingsImage {
|
|
870
|
-
constructor(settings?: undefined |
|
|
871
|
-
image: string |
|
|
871
|
+
constructor(settings?: undefined | CheckSettingsImage | CheckSettingsImagePlain, target?: undefined | {
|
|
872
|
+
image: string | Buffer | URL;
|
|
872
873
|
name?: undefined | string;
|
|
873
874
|
dom?: undefined | string;
|
|
874
875
|
locationInViewport?: undefined | LocationPlain;
|
|
875
876
|
locationInView?: undefined | LocationPlain;
|
|
876
877
|
fullViewSize?: undefined | RectangleSizePlain;
|
|
877
878
|
});
|
|
878
|
-
image(image: string |
|
|
879
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
879
880
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
880
881
|
base64(imageBase64: Buffer): CheckSettingsImage;
|
|
881
882
|
path(imagePath: string): CheckSettingsImage;
|
|
@@ -883,16 +884,16 @@ export class CheckSettingsImage {
|
|
|
883
884
|
name(name: string): CheckSettingsImage;
|
|
884
885
|
withDom(dom: string): CheckSettingsImage;
|
|
885
886
|
withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
|
|
886
|
-
region(region:
|
|
887
|
+
region(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
|
|
887
888
|
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<
|
|
889
|
+
ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
890
|
+
ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
891
|
+
layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
892
|
+
layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
893
|
+
strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
894
|
+
strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
895
|
+
contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
896
|
+
contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
896
897
|
floatingRegion(region: {
|
|
897
898
|
region: RegionPlain;
|
|
898
899
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
@@ -908,28 +909,28 @@ export class CheckSettingsImage {
|
|
|
908
909
|
maxLeftOffset?: undefined | number;
|
|
909
910
|
maxRightOffset?: undefined | number;
|
|
910
911
|
}): CheckSettingsImage;
|
|
911
|
-
floatingRegion(region:
|
|
912
|
-
floatingRegions(...regions: Array<
|
|
912
|
+
floatingRegion(region: RegionPlain | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
913
|
+
floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
913
914
|
region: RegionPlain;
|
|
914
915
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
915
916
|
regionId?: undefined | string;
|
|
916
917
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
917
918
|
}>): CheckSettingsImage;
|
|
918
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
919
|
+
floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
919
920
|
accessibilityRegion(region: {
|
|
920
921
|
region: RegionPlain;
|
|
921
922
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
922
923
|
regionId?: undefined | string;
|
|
923
924
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
924
925
|
}): CheckSettingsImage;
|
|
925
|
-
accessibilityRegion(region:
|
|
926
|
-
accessibilityRegions(...regions: Array<
|
|
926
|
+
accessibilityRegion(region: RegionPlain | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
|
|
927
|
+
accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
927
928
|
region: RegionPlain;
|
|
928
929
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
929
930
|
regionId?: undefined | string;
|
|
930
931
|
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
931
932
|
}>): CheckSettingsImage;
|
|
932
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
933
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
933
934
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
|
|
934
935
|
layout(): CheckSettingsImage;
|
|
935
936
|
exact(): CheckSettingsImage;
|
|
@@ -944,18 +945,18 @@ export class CheckSettingsImage {
|
|
|
944
945
|
variationGroupId(variationGroupId: string): CheckSettingsImage;
|
|
945
946
|
}
|
|
946
947
|
export type TargetImage = {
|
|
947
|
-
image(image: string |
|
|
948
|
+
image(image: string | Buffer | URL): CheckSettingsImage;
|
|
948
949
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
949
950
|
base64(imageBase64: string): CheckSettingsImage;
|
|
950
951
|
path(imagePath: string): CheckSettingsImage;
|
|
951
952
|
url(imageUrl: string | URL): CheckSettingsImage;
|
|
952
953
|
};
|
|
953
|
-
export type TargetAutomation<
|
|
954
|
+
export type TargetAutomation<TSpec extends SpecType = SpecType> = {
|
|
954
955
|
window(): CheckSettingsAutomation;
|
|
955
|
-
region(region: LegacyRegionPlain | (RegionPlain | (
|
|
956
|
-
frame(context: { frame: number | (
|
|
957
|
-
frame(frame: number | (
|
|
958
|
-
shadow(selector: string |
|
|
956
|
+
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;
|
|
957
|
+
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;
|
|
958
|
+
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;
|
|
959
|
+
shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
|
|
959
960
|
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
960
961
|
};
|
|
961
962
|
export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
@@ -1048,7 +1049,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1048
1049
|
}
|
|
1049
1050
|
export type ImageMatchSettingsPlain = {
|
|
1050
1051
|
exact?: undefined | ExactMatchSettingsPlain;
|
|
1051
|
-
matchLevel?: undefined | "
|
|
1052
|
+
matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
1052
1053
|
ignoreCaret?: undefined | boolean;
|
|
1053
1054
|
useDom?: undefined | boolean;
|
|
1054
1055
|
enablePatterns?: undefined | boolean;
|
|
@@ -1147,7 +1148,7 @@ export class Location implements Required<LocationPlain> {
|
|
|
1147
1148
|
getY(): number;
|
|
1148
1149
|
setY(y: number): void;
|
|
1149
1150
|
}
|
|
1150
|
-
export type LogHandlerPlain = CustomLogHandlerPlain |
|
|
1151
|
+
export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
|
|
1151
1152
|
export type CustomLogHandlerPlain = { log(message: any): void; };
|
|
1152
1153
|
export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
|
|
1153
1154
|
export type ConsoleLogHandlerPlain = { type: "console"; };
|
|
@@ -1255,9 +1256,9 @@ export class Region implements Required<RegionPlain> {
|
|
|
1255
1256
|
setHeight(height: number): void;
|
|
1256
1257
|
}
|
|
1257
1258
|
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 | "
|
|
1259
|
+
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1260
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1261
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
|
|
1261
1262
|
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1262
1263
|
export class RunnerOptionsFluent {
|
|
1263
1264
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1334,7 +1335,7 @@ export type TestResultsPlain = {
|
|
|
1334
1335
|
readonly id?: undefined | string;
|
|
1335
1336
|
readonly name?: undefined | string;
|
|
1336
1337
|
readonly secretToken?: undefined | string;
|
|
1337
|
-
readonly status?: undefined | "Passed" | "
|
|
1338
|
+
readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
|
|
1338
1339
|
readonly appName?: undefined | string;
|
|
1339
1340
|
readonly batchId?: undefined | string;
|
|
1340
1341
|
readonly batchName?: undefined | string;
|
|
@@ -1426,14 +1427,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1426
1427
|
isPassed(): boolean;
|
|
1427
1428
|
delete(): Promise<void>;
|
|
1428
1429
|
}
|
|
1429
|
-
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1430
|
+
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
1431
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1431
1432
|
get testResults(): TestResultsPlain;
|
|
1432
1433
|
getTestResults(): TestResults;
|
|
1433
1434
|
get exception(): Error;
|
|
1434
1435
|
getException(): Error;
|
|
1435
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1436
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "
|
|
1436
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1437
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
|
|
1437
1438
|
}
|
|
1438
1439
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1439
1440
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|