@applitools/eyes-puppeteer 1.12.0 → 1.14.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 +14 -0
- package/README.md +56 -38
- package/package.json +14 -36
- package/types/index.d.ts +372 -366
package/types/index.d.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
export type Driver = import('puppeteer').Page & { __applitoolsBrand?:
|
|
2
|
-
export type
|
|
3
|
-
export type
|
|
1
|
+
export type Driver = import('puppeteer').Page & { __applitoolsBrand?: undefined; };
|
|
2
|
+
export type Context = import('puppeteer').Frame & { __applitoolsBrand?: undefined; };
|
|
3
|
+
export type Element = import('puppeteer').ElementHandle & { __applitoolsBrand?: undefined; };
|
|
4
|
+
export type Selector = string & { __applitoolsBrand?: undefined; };
|
|
5
|
+
export type SpecType = { driver: Driver; context: Context; element: Element; selector: Selector; };
|
|
4
6
|
export class Eyes {
|
|
5
7
|
static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
|
|
6
|
-
|
|
7
|
-
constructor(config?: ConfigurationPlain);
|
|
8
|
+
static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
|
|
9
|
+
constructor(runner?: undefined | EyesRunner, config?: undefined | ConfigurationPlain);
|
|
10
|
+
constructor(config?: undefined | ConfigurationPlain);
|
|
8
11
|
get logger(): Logger;
|
|
9
12
|
getLogger(): Logger;
|
|
10
13
|
get runner(): EyesRunner;
|
|
@@ -17,49 +20,50 @@ export class Eyes {
|
|
|
17
20
|
setConfiguration(config: ConfigurationPlain): void;
|
|
18
21
|
get isOpen(): boolean;
|
|
19
22
|
getIsOpen(): boolean;
|
|
20
|
-
|
|
21
|
-
open(driver: Driver,
|
|
22
|
-
open(
|
|
23
|
-
open(
|
|
23
|
+
getExecutionCloudUrl(): Promise<string>;
|
|
24
|
+
open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
|
|
25
|
+
open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
|
|
26
|
+
open(config?: undefined | ConfigurationPlain): Promise<void>;
|
|
27
|
+
open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
|
|
24
28
|
check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
|
|
25
29
|
check(target: {
|
|
26
30
|
image: string | URL | Buffer;
|
|
27
|
-
name?: string;
|
|
28
|
-
dom?: string;
|
|
29
|
-
locationInViewport?: LocationPlain;
|
|
30
|
-
locationInView?: LocationPlain;
|
|
31
|
-
fullViewSize?: RectangleSizePlain;
|
|
32
|
-
}, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
|
|
33
|
-
check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
|
|
31
|
+
name?: undefined | string;
|
|
32
|
+
dom?: undefined | string;
|
|
33
|
+
locationInViewport?: undefined | LocationPlain;
|
|
34
|
+
locationInView?: undefined | LocationPlain;
|
|
35
|
+
fullViewSize?: undefined | RectangleSizePlain;
|
|
36
|
+
}, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
|
|
37
|
+
check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
|
|
34
38
|
locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
|
|
35
39
|
extractTextRegions<TPattern extends string>(target: {
|
|
36
40
|
image: string | URL | Buffer;
|
|
37
|
-
size?: { width: number; height: number; };
|
|
38
|
-
name?: string;
|
|
39
|
-
source?: string;
|
|
40
|
-
dom?: string;
|
|
41
|
-
locationInViewport?: { x: number; y: number; };
|
|
42
|
-
locationInView?: { x: number; y: number; };
|
|
43
|
-
fullViewSize?: { width: number; height: number; };
|
|
41
|
+
size?: undefined | { width: number; height: number; };
|
|
42
|
+
name?: undefined | string;
|
|
43
|
+
source?: undefined | string;
|
|
44
|
+
dom?: undefined | string;
|
|
45
|
+
locationInViewport?: undefined | { x: number; y: number; };
|
|
46
|
+
locationInView?: undefined | { x: number; y: number; };
|
|
47
|
+
fullViewSize?: undefined | { width: number; height: number; };
|
|
44
48
|
}, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
45
49
|
extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
|
|
46
50
|
extractText(target: {
|
|
47
51
|
image: string | URL | Buffer;
|
|
48
|
-
size?: { width: number; height: number; };
|
|
49
|
-
name?: string;
|
|
50
|
-
source?: string;
|
|
51
|
-
dom?: string;
|
|
52
|
-
locationInViewport?: { x: number; y: number; };
|
|
53
|
-
locationInView?: { x: number; y: number; };
|
|
54
|
-
fullViewSize?: { width: number; height: number; };
|
|
52
|
+
size?: undefined | { width: number; height: number; };
|
|
53
|
+
name?: undefined | string;
|
|
54
|
+
source?: undefined | string;
|
|
55
|
+
dom?: undefined | string;
|
|
56
|
+
locationInViewport?: undefined | { x: number; y: number; };
|
|
57
|
+
locationInView?: undefined | { x: number; y: number; };
|
|
58
|
+
fullViewSize?: undefined | { width: number; height: number; };
|
|
55
59
|
}, settings: Array<OCRRegion>): Promise<Array<string>>;
|
|
56
60
|
extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
|
|
57
|
-
close(throwErr?: boolean): Promise<TestResults>;
|
|
61
|
+
close(throwErr?: undefined | boolean): Promise<TestResults>;
|
|
58
62
|
abort(): Promise<TestResults>;
|
|
59
63
|
getViewportSize(): Promise<RectangleSize>;
|
|
60
64
|
setViewportSize(size: RectangleSizePlain): Promise<void>;
|
|
61
|
-
getScrollRootElement(): Element
|
|
62
|
-
setScrollRootElement(scrollRootElement: Element
|
|
65
|
+
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
66
|
+
setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
|
|
63
67
|
setLogHandler(handler: LogHandlerPlain | LogHandler): void;
|
|
64
68
|
getLogHandler(): LogHandler;
|
|
65
69
|
setCutProvider(cutProvider: CutProvider): void;
|
|
@@ -79,7 +83,7 @@ export class Eyes {
|
|
|
79
83
|
clearProperties(): Configuration;
|
|
80
84
|
getBatch(): BatchInfo;
|
|
81
85
|
setBatch(batch: BatchInfoPlain): void;
|
|
82
|
-
setBatch(name: string, id?: string, startedAt?: string | Date): void;
|
|
86
|
+
setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
|
|
83
87
|
getApiKey(): string;
|
|
84
88
|
setApiKey(apiKey: string): void;
|
|
85
89
|
getTestName(): string;
|
|
@@ -113,7 +117,7 @@ export class Eyes {
|
|
|
113
117
|
getParentBranchName(): string;
|
|
114
118
|
setParentBranchName(parentBranchName: string): void;
|
|
115
119
|
setProxy(proxy: ProxySettingsPlain): void;
|
|
116
|
-
setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
|
|
120
|
+
setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): void;
|
|
117
121
|
setProxy(isEnabled: false): void;
|
|
118
122
|
getProxy(): ProxySettings;
|
|
119
123
|
getSaveDiffs(): boolean;
|
|
@@ -138,56 +142,56 @@ export class Eyes {
|
|
|
138
142
|
setStitchOverlap(stitchOverlap: number): void;
|
|
139
143
|
}
|
|
140
144
|
export type ConfigurationPlain = {
|
|
141
|
-
agentId?: string;
|
|
142
|
-
apiKey?: string;
|
|
143
|
-
serverUrl?: string;
|
|
144
|
-
proxy?: ProxySettingsPlain;
|
|
145
|
-
autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
|
|
146
|
-
isDisabled?: boolean;
|
|
147
|
-
appName?: string;
|
|
148
|
-
testName?: string;
|
|
149
|
-
displayName?: string;
|
|
150
|
-
viewportSize?: RectangleSizePlain;
|
|
151
|
-
sessionType?:
|
|
152
|
-
properties?: Array<PropertyDataPlain>;
|
|
153
|
-
batch?: BatchInfoPlain;
|
|
154
|
-
defaultMatchSettings?: ImageMatchSettingsPlain;
|
|
155
|
-
hostApp?: string;
|
|
156
|
-
hostOS?: string;
|
|
157
|
-
hostAppInfo?: string;
|
|
158
|
-
hostOSInfo?: string;
|
|
159
|
-
deviceInfo?: string;
|
|
160
|
-
baselineEnvName?: string;
|
|
161
|
-
environmentName?: string;
|
|
162
|
-
branchName?: string;
|
|
163
|
-
parentBranchName?: string;
|
|
164
|
-
baselineBranchName?: string;
|
|
165
|
-
compareWithParentBranch?: boolean;
|
|
166
|
-
ignoreBaseline?: boolean;
|
|
167
|
-
ignoreGitMergeBase?: boolean;
|
|
168
|
-
saveFailedTests?: boolean;
|
|
169
|
-
saveNewTests?: boolean;
|
|
170
|
-
saveDiffs?: boolean;
|
|
171
|
-
sendDom?: boolean;
|
|
172
|
-
matchTimeout?: number;
|
|
173
|
-
forceFullPageScreenshot?: boolean;
|
|
174
|
-
waitBeforeScreenshots?: number;
|
|
175
|
-
stitchMode?:
|
|
176
|
-
hideScrollbars?: boolean;
|
|
177
|
-
hideCaret?: boolean;
|
|
178
|
-
stitchOverlap?: number;
|
|
179
|
-
scrollRootElement?: Element
|
|
180
|
-
cut?: CutProviderPlain;
|
|
181
|
-
rotation?: ImageRotationPlain;
|
|
182
|
-
scaleRatio?: number;
|
|
183
|
-
waitBeforeCapture?: number;
|
|
184
|
-
browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
185
|
-
visualGridOptions?: Record<string, any>;
|
|
186
|
-
layoutBreakpoints?: boolean | Array<number>;
|
|
187
|
-
disableBrowserFetching?: boolean;
|
|
145
|
+
agentId?: undefined | string;
|
|
146
|
+
apiKey?: undefined | string;
|
|
147
|
+
serverUrl?: undefined | string;
|
|
148
|
+
proxy?: undefined | ProxySettingsPlain;
|
|
149
|
+
autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
150
|
+
isDisabled?: undefined | boolean;
|
|
151
|
+
appName?: undefined | string;
|
|
152
|
+
testName?: undefined | string;
|
|
153
|
+
displayName?: undefined | string;
|
|
154
|
+
viewportSize?: undefined | RectangleSizePlain;
|
|
155
|
+
sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
|
|
156
|
+
properties?: undefined | Array<PropertyDataPlain>;
|
|
157
|
+
batch?: undefined | BatchInfoPlain;
|
|
158
|
+
defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
|
|
159
|
+
hostApp?: undefined | string;
|
|
160
|
+
hostOS?: undefined | string;
|
|
161
|
+
hostAppInfo?: undefined | string;
|
|
162
|
+
hostOSInfo?: undefined | string;
|
|
163
|
+
deviceInfo?: undefined | string;
|
|
164
|
+
baselineEnvName?: undefined | string;
|
|
165
|
+
environmentName?: undefined | string;
|
|
166
|
+
branchName?: undefined | string;
|
|
167
|
+
parentBranchName?: undefined | string;
|
|
168
|
+
baselineBranchName?: undefined | string;
|
|
169
|
+
compareWithParentBranch?: undefined | boolean;
|
|
170
|
+
ignoreBaseline?: undefined | boolean;
|
|
171
|
+
ignoreGitMergeBase?: undefined | boolean;
|
|
172
|
+
saveFailedTests?: undefined | boolean;
|
|
173
|
+
saveNewTests?: undefined | boolean;
|
|
174
|
+
saveDiffs?: undefined | boolean;
|
|
175
|
+
sendDom?: undefined | boolean;
|
|
176
|
+
matchTimeout?: undefined | number;
|
|
177
|
+
forceFullPageScreenshot?: undefined | boolean;
|
|
178
|
+
waitBeforeScreenshots?: undefined | number;
|
|
179
|
+
stitchMode?: undefined | "Scroll" | "CSS";
|
|
180
|
+
hideScrollbars?: undefined | boolean;
|
|
181
|
+
hideCaret?: undefined | boolean;
|
|
182
|
+
stitchOverlap?: undefined | number;
|
|
183
|
+
scrollRootElement?: undefined | Element | EyesSelector<Selector>;
|
|
184
|
+
cut?: undefined | CutProviderPlain;
|
|
185
|
+
rotation?: undefined | ImageRotationPlain;
|
|
186
|
+
scaleRatio?: undefined | number;
|
|
187
|
+
waitBeforeCapture?: undefined | number;
|
|
188
|
+
browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
189
|
+
visualGridOptions?: undefined | Record<string, any>;
|
|
190
|
+
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
191
|
+
disableBrowserFetching?: undefined | boolean;
|
|
188
192
|
};
|
|
189
193
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
190
|
-
constructor(config?: ConfigurationPlain, spec?:
|
|
194
|
+
constructor(config?: undefined | ConfigurationPlain, spec?: undefined | {});
|
|
191
195
|
get appName(): string;
|
|
192
196
|
set appName(appName: string);
|
|
193
197
|
getAppName(): string;
|
|
@@ -232,12 +236,12 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
232
236
|
set proxy(proxy: ProxySettingsPlain);
|
|
233
237
|
getProxy(): ProxySettings;
|
|
234
238
|
setProxy(proxy: ProxySettingsPlain): Configuration;
|
|
235
|
-
setProxy(url: string, username?: string, password?: string,
|
|
239
|
+
setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
|
|
236
240
|
setProxy(isEnabled: false): Configuration;
|
|
237
|
-
get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
|
|
238
|
-
set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
|
|
239
|
-
getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
|
|
240
|
-
setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
|
|
241
|
+
get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
242
|
+
set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
243
|
+
getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
244
|
+
setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
|
|
241
245
|
get batch(): BatchInfoPlain;
|
|
242
246
|
set batch(batch: BatchInfoPlain);
|
|
243
247
|
getBatch(): BatchInfo;
|
|
@@ -361,10 +365,10 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
361
365
|
set stitchOverlap(stitchOverlap: number);
|
|
362
366
|
getStitchOverlap(): number;
|
|
363
367
|
setStitchOverlap(stitchOverlap: number): Configuration;
|
|
364
|
-
get scrollRootElement(): Element
|
|
365
|
-
set scrollRootElement(scrollRootElement: Element
|
|
366
|
-
getScrollRootElement(): Element
|
|
367
|
-
setScrollRootElement(scrollRootElement: Element
|
|
368
|
+
get scrollRootElement(): Element | EyesSelector<Selector>;
|
|
369
|
+
set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
|
|
370
|
+
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
371
|
+
setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
|
|
368
372
|
get cut(): CutProviderPlain;
|
|
369
373
|
set cut(cut: CutProviderPlain);
|
|
370
374
|
getCut(): CutProviderPlain;
|
|
@@ -379,14 +383,14 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
379
383
|
setScaleRatio(scaleRatio: number): Configuration;
|
|
380
384
|
get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
381
385
|
set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
|
|
382
|
-
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
383
|
-
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
384
|
-
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
385
|
-
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
386
|
-
addBrowser(width: number, height: number, name?:
|
|
387
|
-
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?:
|
|
388
|
-
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?:
|
|
389
|
-
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?:
|
|
386
|
+
getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
|
|
387
|
+
setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
388
|
+
addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
|
|
389
|
+
addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
|
|
390
|
+
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;
|
|
391
|
+
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
|
|
392
|
+
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
393
|
+
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
|
|
390
394
|
get visualGridOptions(): { [key: string]: any; };
|
|
391
395
|
set visualGridOptions(visualGridOptions: { [key: string]: any; });
|
|
392
396
|
getVisualGridOptions(): { [key: string]: any; };
|
|
@@ -401,113 +405,116 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
401
405
|
getDisableBrowserFetching(): boolean;
|
|
402
406
|
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
403
407
|
}
|
|
404
|
-
export type OCRRegion = { target:
|
|
408
|
+
export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
405
409
|
export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
|
|
406
|
-
frames?: Array<{ frame: number | (Element
|
|
407
|
-
webview?: string | boolean;
|
|
408
|
-
scrollRootElement?: Element
|
|
409
|
-
fully?: boolean;
|
|
410
|
-
disableBrowserFetching?: boolean;
|
|
411
|
-
layoutBreakpoints?: boolean | Array<number>;
|
|
412
|
-
visualGridOptions?: { [key: string]: any; };
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
410
|
+
frames?: undefined | Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
|
|
411
|
+
webview?: undefined | string | boolean;
|
|
412
|
+
scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
413
|
+
fully?: undefined | boolean;
|
|
414
|
+
disableBrowserFetching?: undefined | boolean;
|
|
415
|
+
layoutBreakpoints?: undefined | boolean | Array<number>;
|
|
416
|
+
visualGridOptions?: undefined | { [key: string]: any; };
|
|
417
|
+
nmgOptions?: undefined | { [key: string]: any; };
|
|
418
|
+
hooks?: undefined | { beforeCaptureScreenshot: string; };
|
|
419
|
+
renderId?: undefined | string;
|
|
420
|
+
timeout?: undefined | number;
|
|
421
|
+
waitBeforeCapture?: undefined | number;
|
|
422
|
+
lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
|
|
418
423
|
};
|
|
419
424
|
export class CheckSettingsAutomation {
|
|
420
|
-
constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?:
|
|
421
|
-
region(region: RegionPlain | (Element
|
|
422
|
-
shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
423
|
-
frame(context: { frame: number | (Element
|
|
424
|
-
frame(frame: number | (Element
|
|
425
|
-
webview(webview?: string | boolean): CheckSettingsAutomation;
|
|
426
|
-
scrollRootElement(scrollRootElement: Element
|
|
427
|
-
fully(fully?: boolean): CheckSettingsAutomation;
|
|
425
|
+
constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
|
|
426
|
+
region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
427
|
+
shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
|
|
428
|
+
frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
|
|
429
|
+
frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
430
|
+
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
431
|
+
scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
|
|
432
|
+
fully(fully?: undefined | boolean): CheckSettingsAutomation;
|
|
428
433
|
disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
|
|
429
|
-
layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
|
|
434
|
+
layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
|
|
430
435
|
hook(name: string, script: string): CheckSettingsAutomation;
|
|
431
436
|
beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
|
|
432
437
|
ufgOption(key: string, value: any): CheckSettingsAutomation;
|
|
433
438
|
ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
439
|
+
nmgOption(key: string, value: any): CheckSettingsAutomation;
|
|
440
|
+
nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
434
441
|
renderId(renderId: string): CheckSettingsAutomation;
|
|
435
442
|
timeout(timeout: number): CheckSettingsAutomation;
|
|
436
443
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|
|
437
|
-
lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
|
|
444
|
+
lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
|
|
438
445
|
name(name: string): CheckSettingsAutomation;
|
|
439
446
|
withName(name: string): CheckSettingsAutomation;
|
|
440
|
-
ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
441
|
-
ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
442
|
-
layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
443
|
-
layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
444
|
-
strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
445
|
-
strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
446
|
-
contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
447
|
-
contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
447
|
+
ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
448
|
+
ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
449
|
+
layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
450
|
+
layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
451
|
+
strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
452
|
+
strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
453
|
+
contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
|
|
454
|
+
contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
|
|
448
455
|
floatingRegion(region: {
|
|
449
|
-
region: RegionPlain | (Element
|
|
450
|
-
padding?: number | { top: number; bottom: number;
|
|
451
|
-
regionId?: string;
|
|
452
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
456
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
457
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
458
|
+
regionId?: undefined | string;
|
|
459
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
453
460
|
}): CheckSettingsAutomation;
|
|
454
461
|
floatingRegion(region: {
|
|
455
|
-
region: RegionPlain | (Element
|
|
456
|
-
padding?: number | { top: number; bottom: number;
|
|
457
|
-
regionId?: string;
|
|
458
|
-
maxUpOffset?: number;
|
|
459
|
-
maxDownOffset?: number;
|
|
460
|
-
maxLeftOffset?: number;
|
|
461
|
-
maxRightOffset?: number;
|
|
462
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
463
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
464
|
+
regionId?: undefined | string;
|
|
465
|
+
maxUpOffset?: undefined | number;
|
|
466
|
+
maxDownOffset?: undefined | number;
|
|
467
|
+
maxLeftOffset?: undefined | number;
|
|
468
|
+
maxRightOffset?: undefined | number;
|
|
462
469
|
}): CheckSettingsAutomation;
|
|
463
|
-
floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
464
|
-
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
465
|
-
region: RegionPlain | (Element
|
|
466
|
-
padding?: number | { top: number; bottom: number;
|
|
467
|
-
regionId?: string;
|
|
468
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
470
|
+
floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
471
|
+
floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
472
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
473
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
474
|
+
regionId?: undefined | string;
|
|
475
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
469
476
|
}>): CheckSettingsAutomation;
|
|
470
|
-
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
477
|
+
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
471
478
|
accessibilityRegion(region: {
|
|
472
|
-
region: RegionPlain | (Element
|
|
473
|
-
padding?: number | { top: number; bottom: number;
|
|
474
|
-
regionId?: string;
|
|
475
|
-
type?:
|
|
479
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
480
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
481
|
+
regionId?: undefined | string;
|
|
482
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
476
483
|
}): CheckSettingsAutomation;
|
|
477
|
-
accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element
|
|
478
|
-
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
479
|
-
region: RegionPlain | (Element
|
|
480
|
-
padding?: number | { top: number; bottom: number;
|
|
481
|
-
regionId?: string;
|
|
482
|
-
type?:
|
|
484
|
+
accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
|
|
485
|
+
accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
486
|
+
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
487
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
488
|
+
regionId?: undefined | string;
|
|
489
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
483
490
|
}>): CheckSettingsAutomation;
|
|
484
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element
|
|
491
|
+
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
|
|
485
492
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
|
|
486
493
|
layout(): CheckSettingsAutomation;
|
|
487
494
|
exact(): CheckSettingsAutomation;
|
|
488
495
|
strict(): CheckSettingsAutomation;
|
|
489
496
|
ignoreColors(): CheckSettingsAutomation;
|
|
490
|
-
enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
|
|
491
|
-
ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
|
|
492
|
-
ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
|
|
493
|
-
useDom(useDom?: boolean): CheckSettingsAutomation;
|
|
494
|
-
sendDom(sendDom?: boolean): CheckSettingsAutomation;
|
|
497
|
+
enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
|
|
498
|
+
ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
|
|
499
|
+
ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
|
|
500
|
+
useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
|
|
501
|
+
sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
|
|
495
502
|
pageId(pageId: string): CheckSettingsAutomation;
|
|
496
503
|
variationGroupId(variationGroupId: string): CheckSettingsAutomation;
|
|
497
504
|
}
|
|
498
505
|
export class CheckSettings extends CheckSettingsAutomation {
|
|
499
506
|
}
|
|
500
|
-
export const Target: TargetImage & TargetAutomation<
|
|
507
|
+
export const Target: TargetImage & TargetAutomation<SpecType>;
|
|
501
508
|
export class BatchClose {
|
|
502
|
-
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
|
|
503
|
-
constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
|
|
509
|
+
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
510
|
+
constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
|
|
504
511
|
close(): Promise<void>;
|
|
505
512
|
setBatchIds(batchIds: Array<string>): BatchClose;
|
|
506
513
|
setUrl(serverUrl: string): BatchClose;
|
|
507
514
|
setApiKey(apiKey: string): BatchClose;
|
|
508
515
|
setProxy(proxy: ProxySettingsPlain): BatchClose;
|
|
509
516
|
}
|
|
510
|
-
export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
|
|
517
|
+
export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
|
|
511
518
|
export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
|
|
512
519
|
export enum AccessibilityGuidelinesVersion {
|
|
513
520
|
WCAG_2_0 = 'WCAG_2_0',
|
|
@@ -526,12 +533,12 @@ export enum AccessibilityRegionType {
|
|
|
526
533
|
BoldText = 'BoldText',
|
|
527
534
|
GraphicalObject = 'GraphicalObject'
|
|
528
535
|
}
|
|
529
|
-
export type AccessibilityStatusPlain = "
|
|
536
|
+
export type AccessibilityStatusPlain = "Passed" | "Failed";
|
|
530
537
|
export enum AccessibilityStatus {
|
|
531
538
|
Passed = 'Passed',
|
|
532
539
|
Failed = 'Failed'
|
|
533
540
|
}
|
|
534
|
-
export type BrowserTypePlain = "chrome" | "
|
|
541
|
+
export type BrowserTypePlain = "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";
|
|
535
542
|
export enum BrowserType {
|
|
536
543
|
CHROME = 'chrome',
|
|
537
544
|
CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
|
|
@@ -557,7 +564,7 @@ export enum CorsIframeHandle {
|
|
|
557
564
|
KEEP = 'KEEP',
|
|
558
565
|
SNAPSHOT = 'SNAPSHOT'
|
|
559
566
|
}
|
|
560
|
-
export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II";
|
|
567
|
+
export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11";
|
|
561
568
|
export enum DeviceName {
|
|
562
569
|
Blackberry_PlayBook = 'Blackberry PlayBook',
|
|
563
570
|
BlackBerry_Z30 = 'BlackBerry Z30',
|
|
@@ -623,7 +630,9 @@ export enum DeviceName {
|
|
|
623
630
|
Pixel_4 = 'Pixel 4',
|
|
624
631
|
Pixel_4_XL = 'Pixel 4 XL',
|
|
625
632
|
Pixel_5 = 'Pixel 5',
|
|
626
|
-
Sony_Xperia_10_II = 'Sony Xperia 10 II'
|
|
633
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II',
|
|
634
|
+
Huawei_Mate_50_Pro = 'Huawei Mate 50 Pro',
|
|
635
|
+
Huawei_Matepad_11 = 'Huawei Matepad 11'
|
|
627
636
|
}
|
|
628
637
|
export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
|
|
629
638
|
export enum FailureReport {
|
|
@@ -664,7 +673,7 @@ export enum IosVersion {
|
|
|
664
673
|
ONE_VERSION_BACK = 'latest-1',
|
|
665
674
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
666
675
|
}
|
|
667
|
-
export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro";
|
|
676
|
+
export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
|
|
668
677
|
export enum AndroidDeviceName {
|
|
669
678
|
Pixel_3_XL = 'Pixel 3 XL',
|
|
670
679
|
Pixel_4 = 'Pixel 4',
|
|
@@ -684,16 +693,20 @@ export enum AndroidDeviceName {
|
|
|
684
693
|
Galaxy_S22_Plus = 'Galaxy S22 Plus',
|
|
685
694
|
Galaxy_Tab_S7 = 'Galaxy Tab S7',
|
|
686
695
|
Galaxy_Tab_S8 = 'Galaxy Tab S8',
|
|
696
|
+
Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
|
|
687
697
|
Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
|
|
688
698
|
Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
|
|
689
|
-
|
|
699
|
+
Sony_Xperia_1_II = 'Sony Xperia 1 II',
|
|
700
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II',
|
|
701
|
+
Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
|
|
702
|
+
Huawei_P30_Lite = 'Huawei P30 Lite'
|
|
690
703
|
}
|
|
691
704
|
export type AndroidVersionPlain = "latest" | "latest-1";
|
|
692
705
|
export enum AndroidVersion {
|
|
693
706
|
LATEST = 'latest',
|
|
694
707
|
ONE_VERSION_BACK = 'latest-1'
|
|
695
708
|
}
|
|
696
|
-
export type MatchLevelPlain = "
|
|
709
|
+
export type MatchLevelPlain = "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
697
710
|
export enum MatchLevel {
|
|
698
711
|
None = 'None',
|
|
699
712
|
LegacyLayout = 'Layout1',
|
|
@@ -719,7 +732,7 @@ export enum StitchMode {
|
|
|
719
732
|
SCROLL = 'Scroll',
|
|
720
733
|
CSS = 'CSS'
|
|
721
734
|
}
|
|
722
|
-
export type TestResultsStatusPlain = "
|
|
735
|
+
export type TestResultsStatusPlain = "Passed" | "Unresolved" | "Failed";
|
|
723
736
|
export enum TestResultsStatus {
|
|
724
737
|
Passed = 'Passed',
|
|
725
738
|
Unresolved = 'Unresolved',
|
|
@@ -728,24 +741,24 @@ export enum TestResultsStatus {
|
|
|
728
741
|
export class EyesError extends Error {
|
|
729
742
|
}
|
|
730
743
|
export class TestFailedError extends EyesError {
|
|
731
|
-
constructor(message: string, results
|
|
744
|
+
constructor(message: string, results: TestResultsPlain);
|
|
732
745
|
constructor(results: TestResultsPlain);
|
|
733
746
|
get testResults(): TestResultsPlain;
|
|
734
747
|
getTestResults(): TestResults;
|
|
735
748
|
}
|
|
736
749
|
export class DiffsFoundError extends TestFailedError {
|
|
737
|
-
constructor(message: string, results?: TestResultsPlain);
|
|
750
|
+
constructor(message: string, results?: undefined | TestResultsPlain);
|
|
738
751
|
constructor(results: TestResultsPlain);
|
|
739
752
|
}
|
|
740
753
|
export class NewTestError extends TestFailedError {
|
|
741
|
-
constructor(message: string, results?: TestResultsPlain);
|
|
754
|
+
constructor(message: string, results?: undefined | TestResultsPlain);
|
|
742
755
|
constructor(results: TestResultsPlain);
|
|
743
756
|
}
|
|
744
|
-
export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?:
|
|
757
|
+
export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
|
|
745
758
|
export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
|
|
746
759
|
constructor(settings: AccessibilityMatchSettingsPlain);
|
|
747
760
|
constructor(region: RegionPlain);
|
|
748
|
-
constructor(x: number, y: number, width: number, height: number, type?:
|
|
761
|
+
constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
|
|
749
762
|
get region(): RegionPlain;
|
|
750
763
|
set region(region: RegionPlain);
|
|
751
764
|
getRegion(): Region;
|
|
@@ -763,19 +776,19 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
|
|
|
763
776
|
getType(): AccessibilityRegionType;
|
|
764
777
|
setType(type: AccessibilityRegionTypePlain): void;
|
|
765
778
|
}
|
|
766
|
-
export type AccessibilitySettings = { level?:
|
|
779
|
+
export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
|
|
767
780
|
export type BatchInfoPlain = {
|
|
768
|
-
id?: string;
|
|
769
|
-
name?: string;
|
|
770
|
-
sequenceName?: string;
|
|
771
|
-
startedAt?: string | Date;
|
|
772
|
-
notifyOnCompletion?: boolean;
|
|
773
|
-
properties?: Array<PropertyDataPlain>;
|
|
781
|
+
id?: undefined | string;
|
|
782
|
+
name?: undefined | string;
|
|
783
|
+
sequenceName?: undefined | string;
|
|
784
|
+
startedAt?: undefined | string | Date;
|
|
785
|
+
notifyOnCompletion?: undefined | boolean;
|
|
786
|
+
properties?: undefined | Array<PropertyDataPlain>;
|
|
774
787
|
};
|
|
775
788
|
export class BatchInfo implements Required<BatchInfoPlain> {
|
|
776
789
|
constructor();
|
|
777
|
-
constructor(batch?: BatchInfoPlain);
|
|
778
|
-
constructor(name?: string, startedAt?: string | Date, id?: string);
|
|
790
|
+
constructor(batch?: undefined | BatchInfoPlain);
|
|
791
|
+
constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
|
|
779
792
|
get id(): string;
|
|
780
793
|
set id(id: string);
|
|
781
794
|
getId(): string;
|
|
@@ -804,50 +817,50 @@ export class BatchInfo implements Required<BatchInfoPlain> {
|
|
|
804
817
|
addProperty(prop: PropertyDataPlain): BatchInfo;
|
|
805
818
|
}
|
|
806
819
|
export type CheckSettingsImagePlain = {
|
|
807
|
-
name?: string;
|
|
808
|
-
region?: RegionPlain;
|
|
809
|
-
matchLevel?:
|
|
810
|
-
useDom?: boolean;
|
|
811
|
-
sendDom?: boolean;
|
|
812
|
-
enablePatterns?: boolean;
|
|
813
|
-
ignoreDisplacements?: boolean;
|
|
814
|
-
ignoreMismatch?: boolean;
|
|
815
|
-
ignoreCaret?: boolean;
|
|
816
|
-
ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
817
|
-
layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
818
|
-
strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
819
|
-
contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
820
|
-
floatingRegions?: Array<RegionPlain | {
|
|
820
|
+
name?: undefined | string;
|
|
821
|
+
region?: undefined | RegionPlain;
|
|
822
|
+
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
823
|
+
useDom?: undefined | boolean;
|
|
824
|
+
sendDom?: undefined | boolean;
|
|
825
|
+
enablePatterns?: undefined | boolean;
|
|
826
|
+
ignoreDisplacements?: undefined | boolean;
|
|
827
|
+
ignoreMismatch?: undefined | boolean;
|
|
828
|
+
ignoreCaret?: undefined | boolean;
|
|
829
|
+
ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
830
|
+
layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
831
|
+
strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
832
|
+
contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
833
|
+
floatingRegions?: undefined | Array<RegionPlain | {
|
|
821
834
|
region: RegionPlain;
|
|
822
|
-
padding?: number | { top: number; bottom: number;
|
|
823
|
-
regionId?: string;
|
|
824
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
835
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
836
|
+
regionId?: undefined | string;
|
|
837
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
825
838
|
} | {
|
|
826
839
|
region: RegionPlain;
|
|
827
|
-
padding?: number | { top: number; bottom: number;
|
|
828
|
-
regionId?: string;
|
|
829
|
-
maxUpOffset?: number;
|
|
830
|
-
maxDownOffset?: number;
|
|
831
|
-
maxLeftOffset?: number;
|
|
832
|
-
maxRightOffset?: number;
|
|
840
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
841
|
+
regionId?: undefined | string;
|
|
842
|
+
maxUpOffset?: undefined | number;
|
|
843
|
+
maxDownOffset?: undefined | number;
|
|
844
|
+
maxLeftOffset?: undefined | number;
|
|
845
|
+
maxRightOffset?: undefined | number;
|
|
833
846
|
}>;
|
|
834
|
-
accessibilityRegions?: Array<RegionPlain | {
|
|
847
|
+
accessibilityRegions?: undefined | Array<RegionPlain | {
|
|
835
848
|
region: RegionPlain;
|
|
836
|
-
padding?: number | { top: number; bottom: number;
|
|
837
|
-
regionId?: string;
|
|
838
|
-
type?:
|
|
849
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
850
|
+
regionId?: undefined | string;
|
|
851
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
839
852
|
}>;
|
|
840
|
-
pageId?: string;
|
|
841
|
-
variationGroupId?: string;
|
|
853
|
+
pageId?: undefined | string;
|
|
854
|
+
variationGroupId?: undefined | string;
|
|
842
855
|
};
|
|
843
856
|
export class CheckSettingsImage {
|
|
844
|
-
constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
|
|
857
|
+
constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
|
|
845
858
|
image: string | URL | Buffer;
|
|
846
|
-
name?: string;
|
|
847
|
-
dom?: string;
|
|
848
|
-
locationInViewport?: LocationPlain;
|
|
849
|
-
locationInView?: LocationPlain;
|
|
850
|
-
fullViewSize?: RectangleSizePlain;
|
|
859
|
+
name?: undefined | string;
|
|
860
|
+
dom?: undefined | string;
|
|
861
|
+
locationInViewport?: undefined | LocationPlain;
|
|
862
|
+
locationInView?: undefined | LocationPlain;
|
|
863
|
+
fullViewSize?: undefined | RectangleSizePlain;
|
|
851
864
|
});
|
|
852
865
|
image(image: string | URL | Buffer): CheckSettingsImage;
|
|
853
866
|
buffer(imageBuffer: Buffer): CheckSettingsImage;
|
|
@@ -859,49 +872,49 @@ export class CheckSettingsImage {
|
|
|
859
872
|
withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
|
|
860
873
|
region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
|
|
861
874
|
withName(name: string): CheckSettingsImage;
|
|
862
|
-
ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
863
|
-
ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
864
|
-
layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
865
|
-
layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
866
|
-
strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
867
|
-
strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
868
|
-
contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
869
|
-
contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number;
|
|
875
|
+
ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
876
|
+
ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
877
|
+
layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
878
|
+
layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
879
|
+
strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
880
|
+
strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
881
|
+
contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
882
|
+
contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
870
883
|
floatingRegion(region: {
|
|
871
884
|
region: RegionPlain;
|
|
872
|
-
padding?: number | { top: number; bottom: number;
|
|
873
|
-
regionId?: string;
|
|
874
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
885
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
886
|
+
regionId?: undefined | string;
|
|
887
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
875
888
|
}): CheckSettingsImage;
|
|
876
889
|
floatingRegion(region: {
|
|
877
890
|
region: RegionPlain;
|
|
878
|
-
padding?: number | { top: number; bottom: number;
|
|
879
|
-
regionId?: string;
|
|
880
|
-
maxUpOffset?: number;
|
|
881
|
-
maxDownOffset?: number;
|
|
882
|
-
maxLeftOffset?: number;
|
|
883
|
-
maxRightOffset?: number;
|
|
891
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
892
|
+
regionId?: undefined | string;
|
|
893
|
+
maxUpOffset?: undefined | number;
|
|
894
|
+
maxDownOffset?: undefined | number;
|
|
895
|
+
maxLeftOffset?: undefined | number;
|
|
896
|
+
maxRightOffset?: undefined | number;
|
|
884
897
|
}): CheckSettingsImage;
|
|
885
|
-
floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
|
|
898
|
+
floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
886
899
|
floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
|
|
887
900
|
region: RegionPlain;
|
|
888
|
-
padding?: number | { top: number; bottom: number;
|
|
889
|
-
regionId?: string;
|
|
890
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
901
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
902
|
+
regionId?: undefined | string;
|
|
903
|
+
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
891
904
|
}>): CheckSettingsImage;
|
|
892
905
|
floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
|
|
893
906
|
accessibilityRegion(region: {
|
|
894
907
|
region: RegionPlain;
|
|
895
|
-
padding?: number | { top: number; bottom: number;
|
|
896
|
-
regionId?: string;
|
|
897
|
-
type?:
|
|
908
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
909
|
+
regionId?: undefined | string;
|
|
910
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
898
911
|
}): CheckSettingsImage;
|
|
899
|
-
accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?:
|
|
912
|
+
accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
|
|
900
913
|
accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
|
|
901
914
|
region: RegionPlain;
|
|
902
|
-
padding?: number | { top: number; bottom: number;
|
|
903
|
-
regionId?: string;
|
|
904
|
-
type?:
|
|
915
|
+
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
916
|
+
regionId?: undefined | string;
|
|
917
|
+
type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
905
918
|
}>): CheckSettingsImage;
|
|
906
919
|
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
|
|
907
920
|
matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
|
|
@@ -909,11 +922,11 @@ export class CheckSettingsImage {
|
|
|
909
922
|
exact(): CheckSettingsImage;
|
|
910
923
|
strict(): CheckSettingsImage;
|
|
911
924
|
ignoreColors(): CheckSettingsImage;
|
|
912
|
-
enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
|
|
913
|
-
ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
|
|
914
|
-
ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
|
|
915
|
-
useDom(useDom?: boolean): CheckSettingsImage;
|
|
916
|
-
sendDom(sendDom?: boolean): CheckSettingsImage;
|
|
925
|
+
enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
|
|
926
|
+
ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
|
|
927
|
+
ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
|
|
928
|
+
useDom(useDom?: undefined | boolean): CheckSettingsImage;
|
|
929
|
+
sendDom(sendDom?: undefined | boolean): CheckSettingsImage;
|
|
917
930
|
pageId(pageId: string): CheckSettingsImage;
|
|
918
931
|
variationGroupId(variationGroupId: string): CheckSettingsImage;
|
|
919
932
|
}
|
|
@@ -924,13 +937,13 @@ export type TargetImage = {
|
|
|
924
937
|
path(imagePath: string): CheckSettingsImage;
|
|
925
938
|
url(imageUrl: string | URL): CheckSettingsImage;
|
|
926
939
|
};
|
|
927
|
-
export type TargetAutomation<
|
|
940
|
+
export type TargetAutomation<TSpec extends SpecType = SpecType> = {
|
|
928
941
|
window(): CheckSettingsAutomation;
|
|
929
|
-
region(region: LegacyRegionPlain | (RegionPlain | (
|
|
930
|
-
frame(context: { frame: number | (
|
|
931
|
-
frame(frame: number | (
|
|
932
|
-
shadow(selector: string |
|
|
933
|
-
webview(webview?: string | boolean): CheckSettingsAutomation;
|
|
942
|
+
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;
|
|
943
|
+
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;
|
|
944
|
+
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;
|
|
945
|
+
shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
|
|
946
|
+
webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
|
|
934
947
|
};
|
|
935
948
|
export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
936
949
|
export class CutProvider implements Required<{
|
|
@@ -982,15 +995,15 @@ export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
|
|
|
982
995
|
}
|
|
983
996
|
export type FloatingMatchSettingsPlain = {
|
|
984
997
|
region: RegionPlain;
|
|
985
|
-
maxUpOffset?: number;
|
|
986
|
-
maxDownOffset?: number;
|
|
987
|
-
maxLeftOffset?: number;
|
|
988
|
-
maxRightOffset?: number;
|
|
998
|
+
maxUpOffset?: undefined | number;
|
|
999
|
+
maxDownOffset?: undefined | number;
|
|
1000
|
+
maxLeftOffset?: undefined | number;
|
|
1001
|
+
maxRightOffset?: undefined | number;
|
|
989
1002
|
};
|
|
990
1003
|
export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
|
|
991
1004
|
constructor(settings: FloatingMatchSettingsPlain);
|
|
992
1005
|
constructor(region: RegionPlain);
|
|
993
|
-
constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
|
|
1006
|
+
constructor(x: number, y: number, width: number, height: number, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number);
|
|
994
1007
|
get region(): RegionPlain;
|
|
995
1008
|
set region(region: RegionPlain);
|
|
996
1009
|
getRegion(): Region;
|
|
@@ -1021,22 +1034,22 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
|
|
|
1021
1034
|
setMaxRightOffset(maxRightOffset: number): void;
|
|
1022
1035
|
}
|
|
1023
1036
|
export type ImageMatchSettingsPlain = {
|
|
1024
|
-
exact?: ExactMatchSettingsPlain;
|
|
1025
|
-
matchLevel?:
|
|
1026
|
-
ignoreCaret?: boolean;
|
|
1027
|
-
useDom?: boolean;
|
|
1028
|
-
enablePatterns?: boolean;
|
|
1029
|
-
ignoreDisplacements?: boolean;
|
|
1030
|
-
ignoreRegions?: Array<RegionPlain>;
|
|
1031
|
-
layoutRegions?: Array<RegionPlain>;
|
|
1032
|
-
strictRegions?: Array<RegionPlain>;
|
|
1033
|
-
contentRegions?: Array<RegionPlain>;
|
|
1034
|
-
floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
|
|
1035
|
-
accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
|
|
1036
|
-
accessibilitySettings?: AccessibilitySettings;
|
|
1037
|
+
exact?: undefined | ExactMatchSettingsPlain;
|
|
1038
|
+
matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
1039
|
+
ignoreCaret?: undefined | boolean;
|
|
1040
|
+
useDom?: undefined | boolean;
|
|
1041
|
+
enablePatterns?: undefined | boolean;
|
|
1042
|
+
ignoreDisplacements?: undefined | boolean;
|
|
1043
|
+
ignoreRegions?: undefined | Array<RegionPlain>;
|
|
1044
|
+
layoutRegions?: undefined | Array<RegionPlain>;
|
|
1045
|
+
strictRegions?: undefined | Array<RegionPlain>;
|
|
1046
|
+
contentRegions?: undefined | Array<RegionPlain>;
|
|
1047
|
+
floatingRegions?: undefined | Array<RegionPlain | FloatingMatchSettingsPlain>;
|
|
1048
|
+
accessibilityRegions?: undefined | Array<RegionPlain | AccessibilityMatchSettingsPlain>;
|
|
1049
|
+
accessibilitySettings?: undefined | AccessibilitySettings;
|
|
1037
1050
|
};
|
|
1038
1051
|
export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
|
|
1039
|
-
constructor(settings?: ImageMatchSettingsPlain);
|
|
1052
|
+
constructor(settings?: undefined | ImageMatchSettingsPlain);
|
|
1040
1053
|
get exact(): ExactMatchSettingsPlain;
|
|
1041
1054
|
set exact(exact: ExactMatchSettingsPlain);
|
|
1042
1055
|
getExact(): ExactMatchSettings;
|
|
@@ -1122,18 +1135,11 @@ export class Location implements Required<LocationPlain> {
|
|
|
1122
1135
|
setY(y: number): void;
|
|
1123
1136
|
}
|
|
1124
1137
|
export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
|
|
1125
|
-
export type CustomLogHandlerPlain = {
|
|
1126
|
-
|
|
1127
|
-
warn?(message: any): void;
|
|
1128
|
-
error?(message: any): void;
|
|
1129
|
-
fatal?(message: any): void;
|
|
1130
|
-
open?(): void;
|
|
1131
|
-
close?(): void;
|
|
1132
|
-
};
|
|
1133
|
-
export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
|
|
1138
|
+
export type CustomLogHandlerPlain = { log(message: any): void; };
|
|
1139
|
+
export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
|
|
1134
1140
|
export type ConsoleLogHandlerPlain = { type: "console"; };
|
|
1135
1141
|
export abstract class LogHandler implements CustomLogHandlerPlain {
|
|
1136
|
-
constructor(verbose?: boolean);
|
|
1142
|
+
constructor(verbose?: undefined | boolean);
|
|
1137
1143
|
get verbose(): boolean;
|
|
1138
1144
|
set verbose(verbose: boolean);
|
|
1139
1145
|
getIsVerbose(): boolean;
|
|
@@ -1144,7 +1150,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
|
|
|
1144
1150
|
abstract close(): void;
|
|
1145
1151
|
}
|
|
1146
1152
|
export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
|
|
1147
|
-
constructor(verbose?: boolean, filename?: string, append?: boolean);
|
|
1153
|
+
constructor(verbose?: undefined | boolean, filename?: undefined | string, append?: undefined | boolean);
|
|
1148
1154
|
readonly type: "file";
|
|
1149
1155
|
readonly filename: string;
|
|
1150
1156
|
readonly append: boolean;
|
|
@@ -1163,7 +1169,7 @@ export class NullLogHandler extends LogHandler {
|
|
|
1163
1169
|
open(): void;
|
|
1164
1170
|
close(): void;
|
|
1165
1171
|
}
|
|
1166
|
-
export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
|
|
1172
|
+
export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: undefined | boolean; firstOnly?: undefined | boolean; language?: undefined | string; };
|
|
1167
1173
|
export type PropertyDataPlain = { name: string; value: string; };
|
|
1168
1174
|
export class PropertyData implements Required<PropertyDataPlain> {
|
|
1169
1175
|
constructor(property: PropertyDataPlain);
|
|
@@ -1177,10 +1183,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
|
|
|
1177
1183
|
getValue(): string;
|
|
1178
1184
|
setValue(value: string): void;
|
|
1179
1185
|
}
|
|
1180
|
-
export type ProxySettingsPlain = { url: string; username?: string; password?:
|
|
1186
|
+
export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; };
|
|
1181
1187
|
export class ProxySettings implements Required<ProxySettingsPlain> {
|
|
1182
1188
|
constructor(proxy: ProxySettingsPlain);
|
|
1183
|
-
constructor(url: string, username?: string, password?: string,
|
|
1189
|
+
constructor(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean);
|
|
1184
1190
|
get url(): string;
|
|
1185
1191
|
getUri(): string;
|
|
1186
1192
|
getUrl(): string;
|
|
@@ -1235,22 +1241,22 @@ export class Region implements Required<RegionPlain> {
|
|
|
1235
1241
|
getHeight(): number;
|
|
1236
1242
|
setHeight(height: number): void;
|
|
1237
1243
|
}
|
|
1238
|
-
export type DesktopBrowserInfo = { name?:
|
|
1239
|
-
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?:
|
|
1240
|
-
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?:
|
|
1241
|
-
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?:
|
|
1242
|
-
export type RunnerOptionsPlain = { testConcurrency?: number; };
|
|
1244
|
+
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; };
|
|
1245
|
+
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1246
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1247
|
+
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
|
|
1248
|
+
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
|
|
1243
1249
|
export class RunnerOptionsFluent {
|
|
1244
1250
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
1245
1251
|
}
|
|
1246
1252
|
export function RunnerOptions(): RunnerOptionsFluent;
|
|
1247
1253
|
export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
|
|
1248
1254
|
export type ApiUrlsPlain = {
|
|
1249
|
-
readonly baselineImage?: string;
|
|
1250
|
-
readonly currentImage?: string;
|
|
1251
|
-
readonly checkpointImage?: string;
|
|
1252
|
-
readonly checkpointImageThumbnail?: string;
|
|
1253
|
-
readonly diffImage?: string;
|
|
1255
|
+
readonly baselineImage?: undefined | string;
|
|
1256
|
+
readonly currentImage?: undefined | string;
|
|
1257
|
+
readonly checkpointImage?: undefined | string;
|
|
1258
|
+
readonly checkpointImageThumbnail?: undefined | string;
|
|
1259
|
+
readonly diffImage?: undefined | string;
|
|
1254
1260
|
};
|
|
1255
1261
|
export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
1256
1262
|
get baselineImage(): string;
|
|
@@ -1264,21 +1270,21 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
|
|
|
1264
1270
|
get diffImage(): string;
|
|
1265
1271
|
getDiffImage(): string;
|
|
1266
1272
|
}
|
|
1267
|
-
export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
|
|
1273
|
+
export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
|
|
1268
1274
|
export class AppUrls implements Required<AppUrlsPlain> {
|
|
1269
1275
|
get step(): string;
|
|
1270
1276
|
getStep(): string;
|
|
1271
1277
|
get stepEditor(): string;
|
|
1272
1278
|
getStepEditor(): string;
|
|
1273
1279
|
}
|
|
1274
|
-
export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
|
|
1280
|
+
export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
|
|
1275
1281
|
export class MatchResult implements Required<MatchResultPlain> {
|
|
1276
1282
|
get asExpected(): boolean;
|
|
1277
1283
|
getAsExpected(): boolean;
|
|
1278
1284
|
get windowId(): number;
|
|
1279
1285
|
getWindowId(): number;
|
|
1280
1286
|
}
|
|
1281
|
-
export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
|
|
1287
|
+
export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
|
|
1282
1288
|
export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
1283
1289
|
get batch(): string;
|
|
1284
1290
|
getBatch(): string;
|
|
@@ -1286,13 +1292,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
|
|
|
1286
1292
|
getSession(): string;
|
|
1287
1293
|
}
|
|
1288
1294
|
export type StepInfoPlain = {
|
|
1289
|
-
readonly name?: string;
|
|
1290
|
-
readonly isDifferent?: boolean;
|
|
1291
|
-
readonly hasBaselineImage?: boolean;
|
|
1292
|
-
readonly hasCurrentImage?: boolean;
|
|
1293
|
-
readonly appUrls?: AppUrlsPlain;
|
|
1294
|
-
readonly apiUrls?: ApiUrlsPlain;
|
|
1295
|
-
readonly renderId?: Array<string>;
|
|
1295
|
+
readonly name?: undefined | string;
|
|
1296
|
+
readonly isDifferent?: undefined | boolean;
|
|
1297
|
+
readonly hasBaselineImage?: undefined | boolean;
|
|
1298
|
+
readonly hasCurrentImage?: undefined | boolean;
|
|
1299
|
+
readonly appUrls?: undefined | AppUrlsPlain;
|
|
1300
|
+
readonly apiUrls?: undefined | ApiUrlsPlain;
|
|
1301
|
+
readonly renderId?: undefined | Array<string>;
|
|
1296
1302
|
};
|
|
1297
1303
|
export class StepInfo implements Required<StepInfoPlain> {
|
|
1298
1304
|
get name(): string;
|
|
@@ -1312,36 +1318,36 @@ export class StepInfo implements Required<StepInfoPlain> {
|
|
|
1312
1318
|
}
|
|
1313
1319
|
export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
|
|
1314
1320
|
export type TestResultsPlain = {
|
|
1315
|
-
readonly id?: string;
|
|
1316
|
-
readonly name?: string;
|
|
1317
|
-
readonly secretToken?: string;
|
|
1318
|
-
readonly status?:
|
|
1319
|
-
readonly appName?: string;
|
|
1320
|
-
readonly batchId?: string;
|
|
1321
|
-
readonly batchName?: string;
|
|
1322
|
-
readonly branchName?: string;
|
|
1323
|
-
readonly hostOS?: string;
|
|
1324
|
-
readonly hostApp?: string;
|
|
1325
|
-
readonly hostDisplaySize?: RectangleSizePlain;
|
|
1326
|
-
readonly accessibilityStatus?: TestAccessibilityStatus;
|
|
1327
|
-
readonly startedAt?: string | Date;
|
|
1328
|
-
readonly duration?: number;
|
|
1329
|
-
readonly isNew?: boolean;
|
|
1330
|
-
readonly isDifferent?: boolean;
|
|
1331
|
-
readonly isAborted?: boolean;
|
|
1332
|
-
readonly appUrls?: SessionUrlsPlain;
|
|
1333
|
-
readonly apiUrls?: SessionUrlsPlain;
|
|
1334
|
-
readonly stepsInfo?: Array<StepInfoPlain>;
|
|
1335
|
-
readonly steps?: number;
|
|
1336
|
-
readonly matches?: number;
|
|
1337
|
-
readonly mismatches?: number;
|
|
1338
|
-
readonly missing?: number;
|
|
1339
|
-
readonly exactMatches?: number;
|
|
1340
|
-
readonly strictMatches?: number;
|
|
1341
|
-
readonly contentMatches?: number;
|
|
1342
|
-
readonly layoutMatches?: number;
|
|
1343
|
-
readonly noneMatches?: number;
|
|
1344
|
-
readonly url?: string;
|
|
1321
|
+
readonly id?: undefined | string;
|
|
1322
|
+
readonly name?: undefined | string;
|
|
1323
|
+
readonly secretToken?: undefined | string;
|
|
1324
|
+
readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
|
|
1325
|
+
readonly appName?: undefined | string;
|
|
1326
|
+
readonly batchId?: undefined | string;
|
|
1327
|
+
readonly batchName?: undefined | string;
|
|
1328
|
+
readonly branchName?: undefined | string;
|
|
1329
|
+
readonly hostOS?: undefined | string;
|
|
1330
|
+
readonly hostApp?: undefined | string;
|
|
1331
|
+
readonly hostDisplaySize?: undefined | RectangleSizePlain;
|
|
1332
|
+
readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
|
|
1333
|
+
readonly startedAt?: undefined | string | Date;
|
|
1334
|
+
readonly duration?: undefined | number;
|
|
1335
|
+
readonly isNew?: undefined | boolean;
|
|
1336
|
+
readonly isDifferent?: undefined | boolean;
|
|
1337
|
+
readonly isAborted?: undefined | boolean;
|
|
1338
|
+
readonly appUrls?: undefined | SessionUrlsPlain;
|
|
1339
|
+
readonly apiUrls?: undefined | SessionUrlsPlain;
|
|
1340
|
+
readonly stepsInfo?: undefined | Array<StepInfoPlain>;
|
|
1341
|
+
readonly steps?: undefined | number;
|
|
1342
|
+
readonly matches?: undefined | number;
|
|
1343
|
+
readonly mismatches?: undefined | number;
|
|
1344
|
+
readonly missing?: undefined | number;
|
|
1345
|
+
readonly exactMatches?: undefined | number;
|
|
1346
|
+
readonly strictMatches?: undefined | number;
|
|
1347
|
+
readonly contentMatches?: undefined | number;
|
|
1348
|
+
readonly layoutMatches?: undefined | number;
|
|
1349
|
+
readonly noneMatches?: undefined | number;
|
|
1350
|
+
readonly url?: undefined | string;
|
|
1345
1351
|
};
|
|
1346
1352
|
export class TestResults implements Required<TestResultsPlain> {
|
|
1347
1353
|
get id(): string;
|
|
@@ -1407,14 +1413,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1407
1413
|
isPassed(): boolean;
|
|
1408
1414
|
delete(): Promise<void>;
|
|
1409
1415
|
}
|
|
1410
|
-
export type TestResultContainerPlain = { readonly exception
|
|
1416
|
+
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
|
|
1411
1417
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1412
1418
|
get testResults(): TestResultsPlain;
|
|
1413
1419
|
getTestResults(): TestResults;
|
|
1414
1420
|
get exception(): Error;
|
|
1415
1421
|
getException(): Error;
|
|
1416
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
1417
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?:
|
|
1422
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1423
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
|
|
1418
1424
|
}
|
|
1419
1425
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1420
1426
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|
|
@@ -1440,10 +1446,10 @@ export class ValidationResult implements Required<ValidationResultPlain> {
|
|
|
1440
1446
|
get asExpected(): boolean;
|
|
1441
1447
|
getAsExpected(): boolean;
|
|
1442
1448
|
}
|
|
1443
|
-
export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
|
|
1449
|
+
export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; };
|
|
1444
1450
|
export class Logger {
|
|
1445
|
-
constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
|
|
1446
|
-
constructor(show?: boolean);
|
|
1451
|
+
constructor(options?: undefined | { show?: undefined | boolean; label?: undefined | string; handler?: undefined | LogHandlerPlain; });
|
|
1452
|
+
constructor(show?: undefined | boolean);
|
|
1447
1453
|
getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
|
|
1448
1454
|
setLogHandler(handler: LogHandlerPlain): void;
|
|
1449
1455
|
verbose(...messages: Array<any>): void;
|
|
@@ -1454,16 +1460,16 @@ export class Logger {
|
|
|
1454
1460
|
open(): void;
|
|
1455
1461
|
close(): void;
|
|
1456
1462
|
tag(name: string, value: any): void;
|
|
1457
|
-
extend(label?: string): Logger;
|
|
1463
|
+
extend(label?: undefined | string): Logger;
|
|
1458
1464
|
}
|
|
1459
1465
|
export abstract class EyesRunner {
|
|
1460
|
-
getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
|
|
1466
|
+
getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
|
|
1461
1467
|
}
|
|
1462
1468
|
export class ClassicRunner extends EyesRunner {
|
|
1463
1469
|
}
|
|
1464
1470
|
export class VisualGridRunner extends EyesRunner {
|
|
1465
|
-
constructor(options?: RunnerOptionsPlain);
|
|
1466
|
-
get testConcurrency(): number;
|
|
1471
|
+
constructor(options?: undefined | RunnerOptionsPlain);
|
|
1472
|
+
get testConcurrency(): undefined | number;
|
|
1467
1473
|
}
|
|
1468
1474
|
export abstract class SessionEventHandler {
|
|
1469
1475
|
abstract initStarted(): any;
|
|
@@ -1489,20 +1495,20 @@ export class SessionEventHandlers extends SessionEventHandler {
|
|
|
1489
1495
|
validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
|
|
1490
1496
|
}
|
|
1491
1497
|
export class RemoteSessionEventHandler extends SessionEventHandler {
|
|
1492
|
-
constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
|
|
1493
|
-
constructor(serverUrl: string, accessKey?: string, timeout?: number);
|
|
1498
|
+
constructor(options: { serverUrl: string; accessKey?: undefined | string; timeout?: undefined | number; });
|
|
1499
|
+
constructor(serverUrl: string, accessKey?: undefined | string, timeout?: undefined | number);
|
|
1494
1500
|
get serverUrl(): string;
|
|
1495
1501
|
set serverUrl(serverUrl: string);
|
|
1496
1502
|
getServerUrl(): string;
|
|
1497
1503
|
setServerUrl(serverUrl: string): void;
|
|
1498
|
-
get accessKey(): string;
|
|
1499
|
-
set accessKey(accessKey: string);
|
|
1500
|
-
getAccessKey(): string;
|
|
1504
|
+
get accessKey(): undefined | string;
|
|
1505
|
+
set accessKey(accessKey: undefined | string);
|
|
1506
|
+
getAccessKey(): undefined | string;
|
|
1501
1507
|
setAccessKey(accessKey: string): void;
|
|
1502
|
-
get timeout(): number;
|
|
1503
|
-
set timeout(timeout: number);
|
|
1508
|
+
get timeout(): undefined | number;
|
|
1509
|
+
set timeout(timeout: undefined | number);
|
|
1504
1510
|
setTimeout(timeout: number): void;
|
|
1505
|
-
getTimeout(): number;
|
|
1511
|
+
getTimeout(): undefined | number;
|
|
1506
1512
|
initStarted(): void;
|
|
1507
1513
|
initEnded(): void;
|
|
1508
1514
|
setSizeWillStart(): void;
|