export class By { static css(css: string): By; static cssSelector(css: string): By; static id(id: string): By; static className(className: string): By; static attributeValue(attr: string, value: string): By; static name(name: string): By; static tagName(tagName: string): By; static xpath(xpath: string): By; static xPath(xpath: string): By; constructor(value: string, using: string); readonly value: string; readonly using: string; toString(): string; } export type Driver = WebdriverIO.Client & { __applitoolsBrand?: never; }; export type Element = (WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; } | WebdriverIO.RawResult) & { __applitoolsBrand?: never; }; export type Selector = (string | By) & { __applitoolsBrand?: never; }; export class Eyes { static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise; constructor(runner: EyesRunner, config: ConfigurationPlain); constructor(config: ConfigurationPlain); get logger(): Logger; getLogger(): Logger; get runner(): EyesRunner; getRunner(): EyesRunner; get driver(): Driver; getDriver(): Driver; get configuration(): ConfigurationPlain; set configuration(configuration: ConfigurationPlain); getConfiguration(): Configuration; setConfiguration(config: ConfigurationPlain): void; get isOpen(): boolean; getIsOpen(): boolean; on(handler: (event: string, data: Record) => any): () => void; on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void; on(event: "setSizeEnded", handler: () => any): () => void; on(event: "initStarted", handler: () => any): () => void; on(event: "initEnded", handler: () => any): () => void; on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void; on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void; on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void; on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void; off(event: string): void; off(handler: (args: Array) => any): void; open(driver: Driver, config: ConfigurationPlain): Promise; open(driver: Driver, appName: string, testName: string, viewportSize: RectangleSizePlain, sessionType: SessionTypePlain): Promise; checkWindow(name: string, timeout: number, fully: boolean): Promise; checkFrame(element: number | Element | EyesSelector, timeout: number, name: string): Promise; checkElement(element: Element, timeout: number, name: string): Promise; checkElementBy(selector: EyesSelector, timeout: number, name: string): Promise; checkRegion(region: RegionPlain, name: string, timeout: number): Promise; checkRegionByElement(element: Element, name: string, timeout: number): Promise; checkRegionBy(selector: EyesSelector, name: string, timeout: number, fully: boolean): Promise; checkRegionInFrame(frame: number | Element | EyesSelector, selector: EyesSelector, timeout: number, name: string, fully: boolean): Promise; check(name: string, checkSettings: CheckSettings): Promise; check(checkSettings: CheckSettingsPlain): Promise; locate(settings: VisualLocatorSettings): Promise>>; extractTextRegions(settings: OCRSettings): Promise>>; extractText(regions: Array): Promise>; close(throwErr: boolean): Promise; closeAsync(): Promise; abort(): Promise; abortAsync(): Promise; abortIfNotClosed(): Promise; getViewportSize(): Promise; setViewportSize(size: RectangleSizePlain): Promise; getScrollRootElement(): Element | EyesSelector; setScrollRootElement(scrollRootElement: Element | EyesSelector): void; setLogHandler(handler: LogHandler): void; getLogHandler(): LogHandler; setCutProvider(cutProvider: CutProvider): void; setImageCut(cutProvider: CutProvider): void; getIsCutProviderExplicitlySet(): boolean; getRotation(): ImageRotation; setRotation(rotation: ImageRotationPlain | ImageRotation): void; getScaleRatio(): number; setScaleRatio(scaleRatio: number): void; getSaveDebugScreenshots(): boolean; setSaveDebugScreenshots(save: boolean): void; getDebugScreenshotsPath(): string; setDebugScreenshotsPath(path: string): void; getDebugScreenshotsPrefix(): string; setDebugScreenshotsPrefix(prefix: string): void; addProperty(name: string, value: string): Configuration; clearProperties(): Configuration; getBatch(): BatchInfo; setBatch(batch: BatchInfoPlain): void; setBatch(name: string, id: string, startedAt: string | Date): void; getApiKey(): string; setApiKey(apiKey: string): void; getTestName(): string; setTestName(testName: string): void; getAppName(): string; setAppName(appName: string): void; getBaselineBranchName(): string; setBaselineBranchName(baselineBranchName: string): void; getBaselineName(): string; setBaselineName(baselineName: string): void; getBaselineEnvName(): string; setBaselineEnvName(baselineEnvName: string): void; getBranchName(): string; setBranchName(branchName: string): void; getHostApp(): string; setHostApp(hostApp: string): void; getHostOS(): string; setHostOS(hostOS: string): void; getHostAppInfo(): string; setHostAppInfo(hostAppInfo: string): void; getHostOSInfo(): string; setHostOSInfo(hostOSInfo: string): void; getDeviceInfo(): string; setDeviceInfo(deviceInfo: string): void; setIgnoreCaret(ignoreCaret: boolean): void; getIgnoreCaret(): boolean; getIsDisabled(): boolean; setIsDisabled(isDisabled: boolean): void; getMatchLevel(): MatchLevel; setMatchLevel(matchLevel: MatchLevelPlain): void; getMatchTimeout(): number; setMatchTimeout(matchTimeout: number): void; getParentBranchName(): string; setParentBranchName(parentBranchName: string): void; setProxy(proxy: ProxySettingsPlain): void; setProxy(url: string, username: string, password: string, isHttpOnly: boolean): void; setProxy(isEnabled: false): void; getProxy(): ProxySettings; getSaveDiffs(): boolean; setSaveDiffs(saveDiffs: boolean): void; getSaveNewTests(): boolean; setSaveNewTests(saveNewTests: boolean): void; getServerUrl(): string; setServerUrl(serverUrl: string): void; getSendDom(): boolean; setSendDom(sendDom: boolean): void; getHideCaret(): boolean; setHideCaret(hideCaret: boolean): void; getHideScrollbars(): boolean; setHideScrollbars(hideScrollbars: boolean): void; getForceFullPageScreenshot(): boolean; setForceFullPageScreenshot(forceFullPageScreenshot: boolean): void; getWaitBeforeScreenshots(): number; setWaitBeforeScreenshots(waitBeforeScreenshots: number): void; getStitchMode(): StitchMode; setStitchMode(stitchMode: StitchModePlain): void; getStitchOverlap(): number; setStitchOverlap(stitchOverlap: number): void; getSessionEventHandlers(): SessionEventHandlers; addSessionEventHandler(handler: SessionEventHandler): void; removeSessionEventHandler(handler: SessionEventHandler): void; clearSessionEventHandlers(): void; } export type ConfigurationPlain = { logs?: LogHandlerPlain; debugScreenshots?: { save: boolean; path?: string; prefix?: string; }; agentId?: string; apiKey?: string; serverUrl?: string; proxy?: ProxySettingsPlain; isDisabled?: boolean; connectionTimeout?: number; removeSession?: boolean; remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; }; appName?: string; testName?: string; displayName?: string; viewportSize?: RectangleSizePlain; sessionType?: SessionTypePlain; properties?: Array; batch?: BatchInfoPlain; defaultMatchSettings?: ImageMatchSettingsPlain; hostApp?: string; hostOS?: string; hostAppInfo?: string; hostOSInfo?: string; deviceInfo?: string; baselineEnvName?: string; environmentName?: string; branchName?: string; parentBranchName?: string; baselineBranchName?: string; compareWithParentBranch?: boolean; ignoreBaseline?: boolean; saveFailedTests?: boolean; saveNewTests?: boolean; saveDiffs?: boolean; dontCloseBatches?: boolean; sendDom?: boolean; matchTimeout?: number; forceFullPageScreenshot?: boolean; waitBeforeScreenshots?: number; stitchMode?: StitchModePlain; hideScrollbars?: boolean; hideCaret?: boolean; stitchOverlap?: number; scrollRootElement?: Element | EyesSelector; cut?: CutProviderPlain; rotation?: ImageRotationPlain; scaleRatio?: number; waitBeforeCapture?: number; concurrentSessions?: number; browsersInfo?: Array; visualGridOptions?: Record; layoutBreakpoints?: boolean | Array; disableBrowserFetching?: boolean; }; export class Configuration implements Required { constructor(config: ConfigurationPlain); get logs(): LogHandlerPlain; set logs(logs: LogHandlerPlain); getShowLogs(): boolean; setShowLogs(show: boolean): Configuration; getLogHandler(): LogHandlerPlain; setLogHandler(handler: LogHandlerPlain): Configuration; get debugScreenshots(): { save: boolean; path?: string; prefix?: string; }; set debugScreenshots(debugScreenshots: { save: boolean; path?: string; prefix?: string; }); getSaveDebugScreenshots(): boolean; setSaveDebugScreenshots(save: boolean): Configuration; getDebugScreenshotsPath(): string; setDebugScreenshotsPath(path: string): Configuration; getDebugScreenshotsPrefix(): string; setDebugScreenshotsPrefix(prefix: string): Configuration; get appName(): string; set appName(appName: string); getAppName(): string; setAppName(appName: string): Configuration; get testName(): string; set testName(testName: string); getTestName(): string; setTestName(testName: string): Configuration; get displayName(): string; set displayName(displayName: string); getDisplayName(): string; setDisplayName(displayName: string): Configuration; get isDisabled(): boolean; set isDisabled(isDisabled: boolean); getIsDisabled(): boolean; setIsDisabled(isDisabled: boolean): Configuration; get matchTimeout(): number; set matchTimeout(matchTimeout: number); getMatchTimeout(): number; setMatchTimeout(matchTimeout: number): Configuration; get sessionType(): SessionTypePlain; set sessionType(sessionType: SessionTypePlain); getSessionType(): SessionType; setSessionType(sessionType: SessionTypePlain): Configuration; get viewportSize(): RectangleSizePlain; set viewportSize(viewportSize: RectangleSizePlain); getViewportSize(): RectangleSize; setViewportSize(viewportSize: RectangleSizePlain): Configuration; get agentId(): string; set agentId(agentId: string); getAgentId(): string; setAgentId(agentId: string): Configuration; get apiKey(): string; set apiKey(apiKey: string); getApiKey(): string; setApiKey(apiKey: string): Configuration; get serverUrl(): string; set serverUrl(serverUrl: string); getServerUrl(): string; setServerUrl(serverUrl: string): Configuration; get proxy(): ProxySettingsPlain; set proxy(proxy: ProxySettingsPlain); getProxy(): ProxySettings; setProxy(proxy: ProxySettingsPlain): Configuration; setProxy(url: string, username: string, password: string, isHttpOnly: boolean): Configuration; setProxy(isEnabled: false): Configuration; get connectionTimeout(): number; set connectionTimeout(connectionTimeout: number); getConnectionTimeout(): number; setConnectionTimeout(connectionTimeout: number): Configuration; get removeSession(): boolean; set removeSession(removeSession: boolean); getRemoveSession(): boolean; setRemoveSession(removeSession: boolean): Configuration; get remoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; }; set remoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }); getRemoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; }; setRemoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }): Configuration; get batch(): BatchInfoPlain; set batch(batch: BatchInfoPlain); getBatch(): BatchInfo; setBatch(batch: BatchInfoPlain): Configuration; get properties(): Array; set properties(properties: Array); getProperties(): Array; setProperties(properties: Array): Configuration; addProperty(name: string, value: string): Configuration; addProperty(prop: PropertyDataPlain): Configuration; clearProperties(): Configuration; get baselineEnvName(): string; set baselineEnvName(baselineEnvName: string); getBaselineEnvName(): string; setBaselineEnvName(baselineEnvName: string): Configuration; get environmentName(): string; set environmentName(environmentName: string); getEnvironmentName(): string; setEnvironmentName(environmentName: string): Configuration; get branchName(): string; set branchName(branchName: string); getBranchName(): string; setBranchName(branchName: string): Configuration; get parentBranchName(): string; set parentBranchName(parentBranchName: string); getParentBranchName(): string; setParentBranchName(parentBranchName: string): Configuration; get baselineBranchName(): string; set baselineBranchName(baselineBranchName: string); getBaselineBranchName(): string; setBaselineBranchName(baselineBranchName: string): Configuration; get compareWithParentBranch(): boolean; set compareWithParentBranch(compareWithParentBranch: boolean); getCompareWithParentBranch(): boolean; setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration; get ignoreBaseline(): boolean; set ignoreBaseline(ignoreBaseline: boolean); getIgnoreBaseline(): boolean; setIgnoreBaseline(ignoreBaseline: boolean): Configuration; get saveFailedTests(): boolean; set saveFailedTests(saveFailedTests: boolean); getSaveFailedTests(): boolean; setSaveFailedTests(saveFailedTests: boolean): Configuration; get saveNewTests(): boolean; set saveNewTests(saveNewTests: boolean); getSaveNewTests(): boolean; setSaveNewTests(saveNewTests: boolean): Configuration; get saveDiffs(): boolean; set saveDiffs(saveDiffs: boolean); getSaveDiffs(): boolean; setSaveDiffs(saveDiffs: boolean): Configuration; get sendDom(): boolean; set sendDom(sendDom: boolean); getSendDom(): boolean; setSendDom(sendDom: boolean): Configuration; get hostApp(): string; set hostApp(hostApp: string); getHostApp(): string; setHostApp(hostApp: string): Configuration; get hostOS(): string; set hostOS(hostOS: string); getHostOS(): string; setHostOS(hostOS: string): Configuration; get hostAppInfo(): string; set hostAppInfo(hostAppInfo: string); getHostAppInfo(): string; setHostAppInfo(hostAppInfo: string): Configuration; get hostOSInfo(): string; set hostOSInfo(hostOSInfo: string); getHostOSInfo(): string; setHostOSInfo(hostOSInfo: string): Configuration; get deviceInfo(): string; set deviceInfo(deviceInfo: string); getDeviceInfo(): string; setDeviceInfo(deviceInfo: string): Configuration; get defaultMatchSettings(): ImageMatchSettingsPlain; set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain); getDefaultMatchSettings(): ImageMatchSettingsPlain; setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration; getMatchLevel(): MatchLevel; setMatchLevel(matchLevel: MatchLevelPlain): Configuration; getAccessibilityValidation(): AccessibilitySettings; setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration; getUseDom(): boolean; setUseDom(useDom: boolean): Configuration; getEnablePatterns(): boolean; setEnablePatterns(enablePatterns: boolean): Configuration; getIgnoreDisplacements(): boolean; setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration; getIgnoreCaret(): boolean; setIgnoreCaret(ignoreCaret: boolean): Configuration; get forceFullPageScreenshot(): boolean; set forceFullPageScreenshot(forceFullPageScreenshot: boolean); getForceFullPageScreenshot(): boolean; setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration; get waitBeforeScreenshots(): number; set waitBeforeScreenshots(waitBeforeScreenshots: number); getWaitBeforeScreenshots(): number; setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration; get waitBeforeCapture(): number; set waitBeforeCapture(waitBeforeCapture: number); getWaitBeforeCapture(): number; setWaitBeforeCapture(waitBeforeCapture: number): Configuration; get stitchMode(): StitchModePlain; set stitchMode(stitchMode: StitchModePlain); getStitchMode(): StitchMode; setStitchMode(stitchMode: StitchModePlain): Configuration; get hideScrollbars(): boolean; set hideScrollbars(hideScrollbars: boolean); getHideScrollbars(): boolean; setHideScrollbars(hideScrollbars: boolean): Configuration; get hideCaret(): boolean; set hideCaret(hideCaret: boolean); getHideCaret(): boolean; setHideCaret(hideCaret: boolean): Configuration; get stitchOverlap(): number; set stitchOverlap(stitchOverlap: number); getStitchOverlap(): number; setStitchOverlap(stitchOverlap: number): Configuration; get scrollRootElement(): Element | EyesSelector; set scrollRootElement(scrollRootElement: Element | EyesSelector); getScrollRootElement(): Element | EyesSelector; setScrollRootElement(scrollRootElement: Element | EyesSelector): Configuration; get cut(): CutProviderPlain; set cut(cut: CutProviderPlain); getCut(): CutProviderPlain; setCut(cut: CutProviderPlain): Configuration; get rotation(): ImageRotationPlain; set rotation(rotation: ImageRotationPlain); getRotation(): ImageRotation; setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration; get scaleRatio(): number; set scaleRatio(scaleRatio: number); getScaleRatio(): number; setScaleRatio(scaleRatio: number): Configuration; get concurrentSessions(): number; set concurrentSessions(concurrentSessions: number); getConcurrentSessions(): number; setConcurrentSessions(concurrentSessions: number): Configuration; get browsersInfo(): Array; set browsersInfo(browsersInfo: Array); getBrowsersInfo(): Array; setBrowsersInfo(browsersInfo: Array): Configuration; addBrowsers(browsersInfo: Array): Configuration; addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration; addBrowser(width: number, height: number, name: BrowserTypePlain): Configuration; addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation: ScreenOrientationPlain): Configuration; get visualGridOptions(): { [key: string]: any; }; set visualGridOptions(visualGridOptions: { [key: string]: any; }); getVisualGridOptions(): { [key: string]: any; }; setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration; setVisualGridOption(key: string, value: any): Configuration; get layoutBreakpoints(): boolean | Array; set layoutBreakpoints(layoutBreakpoints: boolean | Array); getLayoutBreakpoints(): boolean | Array; setLayoutBreakpoints(layoutBreakpoints: boolean | Array): Configuration; get disableBrowserFetching(): boolean; set disableBrowserFetching(disableBrowserFetching: boolean); getDisableBrowserFetching(): boolean; setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration; get dontCloseBatches(): boolean; set dontCloseBatches(dontCloseBatches: boolean); getDontCloseBatches(): boolean; setDontCloseBatches(dontCloseBatches: boolean): Configuration; } export type OCRRegion = { target: Element | RegionPlain | EyesSelector; hint?: string; minMatch?: number; language?: string; }; export type CheckSettingsPlain = { name?: string; region?: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); frames?: Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))>; scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }); fully?: boolean; matchLevel?: MatchLevelPlain; useDom?: boolean; sendDom?: boolean; enablePatterns?: boolean; ignoreDisplacements?: boolean; ignoreCaret?: boolean; ignoreRegions?: Array; frame?: EyesSelector; }))>; layoutRegions?: Array; frame?: EyesSelector; }))>; strictRegions?: Array; frame?: EyesSelector; }))>; contentRegions?: Array; frame?: EyesSelector; }))>; floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>; accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); type?: AccessibilityRegionTypePlain; }>; disableBrowserFetching?: boolean; layoutBreakpoints?: boolean | Array; visualGridOptions?: { [key: string]: any; }; hooks?: { beforeCaptureScreenshot: string; }; renderId?: string; variationGroupId?: string; timeout?: number; waitBeforeCapture?: number; }; export class CheckSettings { constructor(settings: CheckSettingsPlain); name(name: string): CheckSettings; withName(name: string): CheckSettings; region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }): CheckSettings; frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }); }): CheckSettings; frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })): CheckSettings; ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; ignoreRegions(regions: Array; frame?: EyesSelector; })))>): CheckSettings; ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; ignores(regions: Array; frame?: EyesSelector; })))>): CheckSettings; layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; layoutRegions(regions: Array; frame?: EyesSelector; })))>): CheckSettings; strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; strictRegions(regions: Array; frame?: EyesSelector; })))>): CheckSettings; contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; contentRegions(regions: Array; frame?: EyesSelector; })))>): CheckSettings; floatingRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }): CheckSettings; floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }))), maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number): CheckSettings; floatingRegions(regions: Array; frame?: EyesSelector; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>): CheckSettings; floatingRegions(maxOffset: number, regions: Array; frame?: EyesSelector; })))>): CheckSettings; floating(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }): CheckSettings; floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; floatings(regions: Array; frame?: EyesSelector; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>): CheckSettings; floatings(maxOffset: number, regions: Array; frame?: EyesSelector; })))>): CheckSettings; accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); type?: AccessibilityRegionTypePlain; }): CheckSettings; accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }))), type: AccessibilityRegionTypePlain): CheckSettings; accessibilityRegions(regions: Array; frame?: EyesSelector; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings; accessibilityRegions(type: AccessibilityRegionTypePlain, regions: Array; frame?: EyesSelector; })))>): CheckSettings; scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })): CheckSettings; fully(fully: boolean): CheckSettings; stitchContent(stitchContent: boolean): CheckSettings; matchLevel(matchLevel: MatchLevelPlain): CheckSettings; layout(): CheckSettings; exact(): CheckSettings; strict(): CheckSettings; content(): CheckSettings; useDom(useDom: boolean): CheckSettings; sendDom(sendDom: boolean): CheckSettings; enablePatterns(enablePatterns: boolean): CheckSettings; ignoreDisplacements(ignoreDisplacements: boolean): CheckSettings; ignoreCaret(ignoreCaret: boolean): CheckSettings; disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings; layoutBreakpoints(layoutBreakpoints: boolean | Array): CheckSettings; hook(name: string, script: string): CheckSettings; beforeRenderScreenshotHook(script: string): CheckSettings; webHook(script: string): CheckSettings; visualGridOption(key: string, value: any): CheckSettings; visualGridOptions(options: { [key: string]: any; }): CheckSettings; renderId(renderId: string): CheckSettings; variationGroupId(variationGroupId: string): CheckSettings; timeout(timeout: number): CheckSettings; waitBeforeCapture(waitBeforeCapture: number): CheckSettings; } export const Target: { window(): CheckSettings; region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })))): CheckSettings; frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }); }): CheckSettings; frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; })): CheckSettings; shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }): CheckSettings; }; export class BatchClose { static close(settings: { batchIds: Array; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }): Promise; constructor(options: { batchIds: Array; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }); close(): Promise; setBatchIds(batchIds: Array): BatchClose; setUrl(serverUrl: string): BatchClose; setApiKey(apiKey: string): BatchClose; setProxy(proxy: ProxySettingsPlain): BatchClose; } export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1"; export enum AccessibilityGuidelinesVersion { WCAG_2_0 = 'WCAG_2_0', WCAG_2_1 = 'WCAG_2_1' } export type AccessibilityLevelPlain = "AA" | "AAA"; export enum AccessibilityLevel { AA = 'AA', AAA = 'AAA' } export type AccessibilityRegionTypePlain = "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; export enum AccessibilityRegionType { IgnoreContrast = 'IgnoreContrast', RegularText = 'RegularText', LargeText = 'LargeText', BoldText = 'BoldText', GraphicalObject = 'GraphicalObject' } export type AccessibilityStatusPlain = "Passed" | "Failed"; export enum AccessibilityStatus { Passed = 'Passed', Failed = 'Failed' } 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"; export enum BrowserType { CHROME = 'chrome', CHROME_ONE_VERSION_BACK = 'chrome-one-version-back', CHROME_TWO_VERSIONS_BACK = 'chrome-two-versions-back', FIREFOX = 'firefox', FIREFOX_ONE_VERSION_BACK = 'firefox-one-version-back', FIREFOX_TWO_VERSIONS_BACK = 'firefox-two-versions-back', IE_11 = 'ie', IE_10 = 'ie10', EDGE = 'edge', EDGE_CHROMIUM = 'edgechromium', EDGE_LEGACY = 'edgelegacy', EDGE_CHROMIUM_ONE_VERSION_BACK = 'edgechromium-one-version-back', EDGE_CHROMIUM_TWO_VERSIONS_BACK = 'edgechromium-two-versions-back', SAFARI = 'safari', SAFARI_EARLY_ACCESS = 'safari-earlyaccess', SAFARI_ONE_VERSION_BACK = 'safari-one-version-back', SAFARI_TWO_VERSIONS_BACK = 'safari-two-versions-back' } export type CorsIframeHandlePlain = "BLANK" | "KEEP" | "SNAPSHOT"; export enum CorsIframeHandle { BLANK = 'BLANK', KEEP = 'KEEP', SNAPSHOT = 'SNAPSHOT' } 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" | "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"; export enum DeviceName { Blackberry_PlayBook = 'Blackberry PlayBook', BlackBerry_Z30 = 'BlackBerry Z30', Galaxy_A5 = 'Galaxy A5', Galaxy_Note_10 = 'Galaxy Note 10', Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus', Galaxy_Note_2 = 'Galaxy Note 2', Galaxy_Note_3 = 'Galaxy Note 3', Galaxy_Note_4 = 'Galaxy Note 4', Galaxy_Note_8 = 'Galaxy Note 8', Galaxy_Note_9 = 'Galaxy Note 9', Galaxy_S3 = 'Galaxy S3', Galaxy_S5 = 'Galaxy S5', Galaxy_S8 = 'Galaxy S8', Galaxy_S8_Plus = 'Galaxy S8 Plus', Galaxy_S9 = 'Galaxy S9', Galaxy_S9_Plus = 'Galaxy S9 Plus', Galaxy_S10 = 'Galaxy S10', Galaxy_S10_Plus = 'Galaxy S10 Plus', Galaxy_S20 = 'Galaxy S20', iPad = 'iPad', iPad_6th_Gen = 'iPad 6th Gen', iPad_7th_Gen = 'iPad 7th Gen', iPad_Air_2 = 'iPad Air 2', iPad_Mini = 'iPad Mini', iPad_Pro = 'iPad Pro', iPhone_11 = 'iPhone 11', iPhone_11_Pro = 'iPhone 11 Pro', iPhone_11_Pro_Max = 'iPhone 11 Pro Max', iPhone_4 = 'iPhone 4', iPhone_5SE = 'iPhone 5/SE', iPhone_6_7_8 = 'iPhone 6/7/8', iPhone_6_7_8_Plus = 'iPhone 6/7/8 Plus', iPhone_X = 'iPhone X', iPhone_XR = 'iPhone XR', iPhone_XS = 'iPhone XS', iPhone_XS_Max = 'iPhone XS Max', Kindle_Fire_HDX = 'Kindle Fire HDX', Laptop_with_HiDPI_screen = 'Laptop with HiDPI screen', Laptop_with_MDPI_screen = 'Laptop with MDPI screen', Laptop_with_touch = 'Laptop with touch', LG_G6 = 'LG G6', LG_Optimus_L70 = 'LG Optimus L70', Microsoft_Lumia_550 = 'Microsoft Lumia 550', Microsoft_Lumia_950 = 'Microsoft Lumia 950', Nexus_10 = 'Nexus 10', Nexus_4 = 'Nexus 4', Nexus_5 = 'Nexus 5', Nexus_5X = 'Nexus 5X', Nexus_6 = 'Nexus 6', Nexus_6P = 'Nexus 6P', Nexus_7 = 'Nexus 7', Nokia_Lumia_520 = 'Nokia Lumia 520', Nokia_N9 = 'Nokia N9', OnePlus_7T = 'OnePlus 7T', OnePlus_7T_Pro = 'OnePlus 7T Pro', Pixel_2 = 'Pixel 2', Pixel_2_XL = 'Pixel 2 XL', Pixel_3 = 'Pixel 3', Pixel_3_XL = 'Pixel 3 XL', Pixel_4 = 'Pixel 4', Pixel_4_XL = 'Pixel 4 XL', Pixel_5 = 'Pixel 5' } export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE"; export enum FailureReport { IMMEDIATE = 'IMMEDIATE', ON_CLOSE = 'ON_CLOSE' } export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)"; export enum IosDeviceName { iPhone_13_Pro_Max = 'iPhone 13 Pro Max', iPhone_13_Pro = 'iPhone 13 Pro', iPhone_13 = 'iPhone 13', iPhone_12_Pro_Max = 'iPhone 12 Pro Max', iPhone_12_Pro = 'iPhone 12 Pro', iPhone_12 = 'iPhone 12', iPhone_12_mini = 'iPhone 12 mini', iPhone_11_Pro = 'iPhone 11 Pro', iPhone_11_Pro_Max = 'iPhone 11 Pro Max', iPhone_11 = 'iPhone 11', iPhone_XR = 'iPhone XR', iPhone_XS = 'iPhone Xs', iPhone_X = 'iPhone X', iPhone_8 = 'iPhone 8', iPhone_7 = 'iPhone 7', iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)', iPad_7 = 'iPad (7th generation)', iPad_9 = 'iPad (9th generation)', iPad_Air_2 = 'iPad Air (2nd generation)' } export type IosVersionPlain = "latest" | "latest-1"; export enum IosVersion { LATEST = 'latest', ONE_VERSION_BACK = 'latest-1', LATEST_ONE_VERSION_BACK = 'latest-1' } export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact"; export enum MatchLevel { None = 'None', LegacyLayout = 'Layout1', Layout = 'Layout', Layout2 = 'Layout2', Content = 'Content', Strict = 'Strict', Exact = 'Exact' } export type ScreenOrientationPlain = "portrait" | "landscape"; export enum ScreenOrientation { PORTRAIT = 'portrait', LANDSCAPE = 'landscape' } export type SessionTypePlain = "SEQUENTIAL" | "PROGRESSION"; export enum SessionType { SEQUENTIAL = 'SEQUENTIAL', PROGRESSION = 'PROGRESSION' } export type StitchModePlain = "Scroll" | "CSS"; export enum StitchMode { SCROLL = 'Scroll', CSS = 'CSS' } export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved"; export enum TestResultsStatus { Passed = 'Passed', Unresolved = 'Unresolved', Failed = 'Failed' } export class EyesError extends Error { } export class TestFailedError extends EyesError { constructor(message: string, results: TestResultsPlain); constructor(results: TestResultsPlain); get testResults(): TestResultsPlain; getTestResults(): TestResults; } export class DiffsFoundError extends TestFailedError { constructor(message: string, results: TestResultsPlain); constructor(results: TestResultsPlain); } export class NewTestError extends TestFailedError { constructor(message: string, results: TestResultsPlain); constructor(results: TestResultsPlain); } export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; }; export class AccessibilityMatchSettings implements Required { constructor(settings: AccessibilityMatchSettingsPlain); constructor(region: RegionPlain); constructor(x: number, y: number, width: number, height: number, type: AccessibilityRegionTypePlain); get region(): RegionPlain; set region(region: RegionPlain); getRegion(): Region; setRegion(region: RegionPlain): void; getLeft(): number; setLeft(left: number): void; getTop(): number; setTop(top: number): void; getWidth(): number; setWidth(width: number): void; getHeight(): number; setHeight(height: number): void; get type(): AccessibilityRegionTypePlain; set type(type: AccessibilityRegionTypePlain); getType(): AccessibilityRegionType; setType(type: AccessibilityRegionTypePlain): void; } export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; }; export type BatchInfoPlain = { id?: string; name?: string; sequenceName?: string; startedAt?: string | Date; notifyOnCompletion?: boolean; properties?: Array; }; export class BatchInfo implements Required { constructor(); constructor(batch: BatchInfoPlain); constructor(name: string, startedAt: string | Date, id: string); get id(): string; set id(id: string); getId(): string; setId(id: string): BatchInfo; get name(): string; set name(name: string); getName(): string; setName(name: string): BatchInfo; get sequenceName(): string; set sequenceName(sequenceName: string); getSequenceName(): string; setSequenceName(sequenceName: string): BatchInfo; get startedAt(): string | Date; set startedAt(startedAt: string | Date); getStartedAt(): string | Date; setStartedAt(startedAt: string | Date): BatchInfo; get notifyOnCompletion(): boolean; set notifyOnCompletion(notifyOnCompletion: boolean); getNotifyOnCompletion(): boolean; setNotifyOnCompletion(notifyOnCompletion: boolean): BatchInfo; get properties(): Array; set properties(properties: Array); getProperties(): Array; setProperties(properties: Array): BatchInfo; addProperty(property: PropertyDataPlain): BatchInfo; } export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; }; export class CutProvider implements Required<{ x: number; y: number; width: number; height: number; top: number; right: number; bottom: number; left: number; }> { constructor(rectOrRegion: CutProviderPlain); constructor(top: number, bottom: number, left: number, right: number); get top(): number; get right(): number; get bottom(): number; get left(): number; get width(): number; get height(): number; get x(): number; get y(): number; scale(scaleRatio: number): CutProvider; } export class FixedCutProvider extends CutProvider { } export class UnscaledFixedCutProvider extends CutProvider { scale(): UnscaledFixedCutProvider; } export type ExactMatchSettingsPlain = { minDiffIntensity: number; minDiffWidth: number; minDiffHeight: number; matchThreshold: number; }; export class ExactMatchSettings implements Required { constructor(settings: ExactMatchSettingsPlain); get minDiffIntensity(): number; set minDiffIntensity(minDiffIntensity: number); getMinDiffIntensity(): number; setMinDiffIntensity(value: number): void; get minDiffWidth(): number; set minDiffWidth(minDiffWidth: number); getMinDiffWidth(): number; setMinDiffWidth(value: number): void; get minDiffHeight(): number; set minDiffHeight(minDiffHeight: number); getMinDiffHeight(): number; setMinDiffHeight(value: number): void; get matchThreshold(): number; set matchThreshold(matchThreshold: number); getMatchThreshold(): number; setMatchThreshold(value: number): void; } export type FloatingMatchSettingsPlain = { region: RegionPlain; maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }; export class FloatingMatchSettings implements Required { constructor(settings: FloatingMatchSettingsPlain); constructor(region: RegionPlain); constructor(x: number, y: number, width: number, height: number, maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number); get region(): RegionPlain; set region(region: RegionPlain); getRegion(): Region; setRegion(region: RegionPlain): void; getLeft(): number; setLeft(left: number): void; getTop(): number; setTop(top: number): void; getWidth(): number; setWidth(width: number): void; getHeight(): number; setHeight(height: number): void; get maxUpOffset(): number; set maxUpOffset(maxUpOffset: number); getMaxUpOffset(): number; setMaxUpOffset(maxUpOffset: number): void; get maxDownOffset(): number; set maxDownOffset(maxDownOffset: number); getMaxDownOffset(): number; setMaxDownOffset(maxDownOffset: number): void; get maxLeftOffset(): number; set maxLeftOffset(maxLeftOffset: number); getMaxLeftOffset(): number; setMaxLeftOffset(maxLeftOffset: number): void; get maxRightOffset(): number; set maxRightOffset(maxRightOffset: number); getMaxRightOffset(): number; setMaxRightOffset(maxRightOffset: number): void; } export type ImageMatchSettingsPlain = { exact?: ExactMatchSettingsPlain; matchLevel?: MatchLevelPlain; ignoreCaret?: boolean; useDom?: boolean; enablePatterns?: boolean; ignoreDisplacements?: boolean; ignoreRegions?: Array; layoutRegions?: Array; strictRegions?: Array; contentRegions?: Array; floatingRegions?: Array; accessibilityRegions?: Array; accessibilitySettings?: AccessibilitySettings; }; export class ImageMatchSettings implements Required { constructor(settings: ImageMatchSettingsPlain); get exact(): ExactMatchSettingsPlain; set exact(exact: ExactMatchSettingsPlain); getExact(): ExactMatchSettings; setExact(exact: ExactMatchSettingsPlain): void; get matchLevel(): MatchLevelPlain; set matchLevel(matchLevel: MatchLevelPlain); getMatchLevel(): MatchLevel; setMatchLevel(matchLevel: MatchLevelPlain): void; get ignoreCaret(): boolean; set ignoreCaret(ignoreCaret: boolean); getIgnoreCaret(): boolean; setIgnoreCaret(ignoreCaret: boolean): void; get useDom(): boolean; set useDom(useDom: boolean); getUseDom(): boolean; setUseDom(useDom: boolean): void; get enablePatterns(): boolean; set enablePatterns(enablePatterns: boolean); getEnablePatterns(): boolean; setEnablePatterns(enablePatterns: boolean): void; get ignoreDisplacements(): boolean; set ignoreDisplacements(ignoreDisplacements: boolean); getIgnoreDisplacements(): boolean; setIgnoreDisplacements(ignoreDisplacements: boolean): void; get ignoreRegions(): Array; set ignoreRegions(ignoreRegions: Array); getIgnoreRegions(): Array; setIgnoreRegions(ignoreRegions: Array): void; get layoutRegions(): Array; set layoutRegions(layoutRegions: Array); get layout(): Array; set layout(layout: Array); getLayoutRegions(): Array; setLayoutRegions(layoutRegions: Array): void; get strictRegions(): Array; set strictRegions(strictRegions: Array); get strict(): Array; set strict(strict: Array); getStrictRegions(): Array; setStrictRegions(strictRegions: Array): void; get contentRegions(): Array; set contentRegions(contentRegions: Array); get content(): Array; set content(content: Array); getContentRegions(): Array; setContentRegions(contentRegions: Array): void; get floatingRegions(): Array; set floatingRegions(floatingRegions: Array); get floating(): Array; set floating(floating: Array); getFloatingRegions(): Array; setFloatingRegions(floatingRegions: Array): void; get accessibilityRegions(): Array; set accessibilityRegions(accessibilityRegions: Array); get accessibility(): Array; set accessibility(accessibility: Array); getAccessibilityRegions(): Array; setAccessibilityRegions(accessibilityRegions: Array): void; get accessibilitySettings(): AccessibilitySettings; set accessibilitySettings(accessibilitySettings: AccessibilitySettings); getAccessibilitySettings(): AccessibilitySettings; setAccessibilitySettings(accessibilitySettings: AccessibilitySettings): void; } export type ImageRotationPlain = 0 | 270 | -270 | 180 | -180 | 90 | -90; export class ImageRotation { constructor(rotation: ImageRotationPlain); get rotation(): ImageRotationPlain; set rotation(rotation: ImageRotationPlain); getRotation(): ImageRotationPlain; setRotation(rotation: ImageRotationPlain): void; } export type LocationPlain = { x: number; y: number; }; export class Location implements Required { constructor(location: LocationPlain); constructor(x: number, y: number); get x(): number; set x(x: number); getX(): number; setX(x: number): void; get y(): number; set y(y: number); getY(): number; setY(y: number): void; } export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain; export type CustomLogHandlerPlain = { log(message: any): void; warn?(message: any): void; error?(message: any): void; fatal?(message: any): void; open?(): void; close?(): void; }; export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; }; export type ConsoleLogHandlerPlain = { type: "console"; }; export abstract class LogHandler implements CustomLogHandlerPlain { constructor(verbose: boolean); get verbose(): boolean; set verbose(verbose: boolean); getIsVerbose(): boolean; setIsVerbose(verbose: boolean): void; log(message: string): void; abstract onMessage(message: string): void; abstract open(): void; abstract close(): void; } export class FileLogHandler extends LogHandler implements FileLogHandlerPlain { constructor(verbose: boolean, filename: string, append: boolean); readonly type: "file"; readonly filename: string; readonly append: boolean; onMessage(): void; open(): void; close(): void; } export class ConsoleLogHandler extends LogHandler implements ConsoleLogHandlerPlain { readonly type: "console"; onMessage(): void; open(): void; close(): void; } export class NullLogHandler extends LogHandler { onMessage(): void; open(): void; close(): void; } export type OCRSettings = { patterns: Array; ignoreCase?: boolean; firstOnly?: boolean; language?: string; }; export type PropertyDataPlain = { name: string; value: string; }; export class PropertyData implements Required { constructor(property: PropertyDataPlain); constructor(name: string, value: string); get name(): string; set name(name: string); getName(): string; setName(name: string): void; get value(): string; set value(value: string); getValue(): string; setValue(value: string): void; } export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; export class ProxySettings implements Required { constructor(proxy: ProxySettingsPlain); constructor(url: string, username: string, password: string, isHttpOnly: boolean); get url(): string; getUri(): string; getUrl(): string; get username(): string; getUsername(): string; get password(): string; getPassword(): string; get isHttpOnly(): boolean; getIsHttpOnly(): boolean; } export type RectangleSizePlain = { width: number; height: number; }; export class RectangleSize implements Required { constructor(size: RectangleSizePlain); constructor(width: number, height: number); get width(): number; set width(width: number); getWidth(): number; setWidth(width: number): void; get height(): number; set height(height: number); getHeight(): number; setHeight(height: number): void; } export type RegionPlain = LocationPlain & RectangleSizePlain; export type LegacyRegionPlain = { left: number; top: number; width: number; height: number; }; export class Region implements Required { constructor(region: RegionPlain); constructor(location: LocationPlain, size: RectangleSizePlain); constructor(x: number, y: number, width: number, height: number); get x(): number; set x(x: number); get left(): number; set left(left: number); getX(): number; setX(x: number): void; getLeft(): number; setLeft(left: number): void; get y(): number; set y(y: number); get top(): number; set top(top: number); getY(): number; setY(y: number): void; getTop(): number; setTop(top: number): void; get width(): number; set width(width: number); getWidth(): number; setWidth(width: number): void; get height(): number; set height(height: number); getHeight(): number; setHeight(height: number): void; } export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; }; export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; }; export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; }; export type RunnerOptionsPlain = { testConcurrency?: number; }; export class RunnerOptionsFluent { testConcurrency(concurrency: number): RunnerOptionsFluent; } export function RunnerOptions(): RunnerOptionsFluent; export type VisualLocatorSettings = { locatorNames: Array; firstOnly: boolean; }; export type ApiUrlsPlain = { readonly baselineImage?: string; readonly currentImage?: string; readonly checkpointImage?: string; readonly checkpointImageThumbnail?: string; readonly diffImage?: string; }; export class ApiUrls implements Required { get baselineImage(): string; getBaselineImage(): string; setBaselineImage(setBaselineImage: string): void; get currentImage(): string; getCurrentImage(): string; setCurrentImage(currentImage: string): void; get checkpointImage(): string; getCheckpointImage(): string; setCheckpointImage(checkpointImage: string): void; get checkpointImageThumbnail(): string; getCheckpointImageThumbnail(): string; setCheckpointImageThumbnail(checkpointImageThumbnail: string): void; get diffImage(): string; getDiffImage(): string; setDiffImage(diffImage: string): void; } export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; }; export class AppUrls implements Required { get step(): string; getStep(): string; setStep(step: string): void; get stepEditor(): string; getStepEditor(): string; setStepEditor(stepEditor: string): void; } export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; }; export class MatchResult implements Required { get asExpected(): boolean; getAsExpected(): boolean; setAsExpected(asExpected: boolean): void; get windowId(): number; getWindowId(): number; setWindowId(windowId: number): void; } export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; }; export class SessionUrls implements Required { get batch(): string; getBatch(): string; setBatch(batch: string): void; get session(): string; getSession(): string; setSession(session: string): void; } export type StepInfoPlain = { readonly name?: string; readonly isDifferent?: boolean; readonly hasBaselineImage?: boolean; readonly hasCurrentImage?: boolean; readonly appUrls?: AppUrlsPlain; readonly apiUrls?: ApiUrlsPlain; readonly renderId?: Array; }; export class StepInfo implements Required { get name(): string; getName(): string; setName(value: string): void; get isDifferent(): boolean; getIsDifferent(): boolean; setIsDifferent(value: boolean): void; get hasBaselineImage(): boolean; getHasBaselineImage(): boolean; setHasBaselineImage(value: boolean): void; get hasCurrentImage(): boolean; getHasCurrentImage(): boolean; setHasCurrentImage(hasCurrentImage: boolean): void; get appUrls(): AppUrlsPlain; getAppUrls(): AppUrls; setAppUrls(appUrls: AppUrlsPlain): void; get apiUrls(): ApiUrlsPlain; getApiUrls(): ApiUrls; setApiUrls(apiUrls: ApiUrlsPlain): void; get renderId(): Array; getRenderId(): Array; setRenderId(renderId: Array): void; } export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; }; export type TestResultsPlain = { readonly id?: string; readonly name?: string; readonly secretToken?: string; readonly status?: TestResultsStatusPlain; readonly appName?: string; readonly batchId?: string; readonly batchName?: string; readonly branchName?: string; readonly hostOS?: string; readonly hostApp?: string; readonly hostDisplaySize?: RectangleSizePlain; readonly accessibilityStatus?: TestAccessibilityStatus; readonly startedAt?: string | Date; readonly duration?: number; readonly isNew?: boolean; readonly isDifferent?: boolean; readonly isAborted?: boolean; readonly appUrls?: SessionUrlsPlain; readonly apiUrls?: SessionUrlsPlain; readonly stepsInfo?: Array; readonly steps?: number; readonly matches?: number; readonly mismatches?: number; readonly missing?: number; readonly exactMatches?: number; readonly strictMatches?: number; readonly contentMatches?: number; readonly layoutMatches?: number; readonly noneMatches?: number; readonly url?: string; }; export class TestResults implements Required { get id(): string; getId(): string; setId(id: string): void; get name(): string; getName(): string; setName(name: string): void; get secretToken(): string; getSecretToken(): string; setSecretToken(secretToken: string): void; get status(): TestResultsStatusPlain; getStatus(): TestResultsStatus; setStatus(status: TestResultsStatus): void; get appName(): string; getAppName(): string; setAppName(appName: string): void; get batchName(): string; getBatchName(): string; setBatchName(batchName: string): void; get batchId(): string; getBatchId(): string; setBatchId(batchId: string): void; get branchName(): string; getBranchName(): string; setBranchName(branchName: string): void; get hostOS(): string; getHostOS(): string; setHostOS(hostOS: string): void; get hostApp(): string; getHostApp(): string; setHostApp(hostApp: string): void; get hostDisplaySize(): RectangleSizePlain; getHostDisplaySize(): RectangleSize; setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void; get accessibilityStatus(): TestAccessibilityStatus; getAccessibilityStatus(): TestAccessibilityStatus; setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void; get startedAt(): string | Date; getStartedAt(): Date; setStartedAt(startedAt: string | Date): void; get duration(): number; getDuration(): number; setDuration(duration: number): void; get isNew(): boolean; getIsNew(): boolean; setIsNew(isNew: boolean): void; get isDifferent(): boolean; getIsDifferent(): boolean; setIsDifferent(isDifferent: boolean): void; get isAborted(): boolean; getIsAborted(): boolean; setIsAborted(isAborted: boolean): void; get appUrls(): SessionUrlsPlain; getAppUrls(): SessionUrls; setAppUrls(appUrls: SessionUrlsPlain): void; get apiUrls(): SessionUrlsPlain; getApiUrls(): SessionUrls; setApiUrls(apiUrls: SessionUrlsPlain): void; get stepsInfo(): Array; getStepsInfo(): Array; setStepsInfo(stepInfo: Array): void; get steps(): number; getSteps(): number; setSteps(steps: number): void; get matches(): number; getMatches(): number; setMatches(matches: number): void; get mismatches(): number; getMismatches(): number; setMismatches(mismatches: number): void; get missing(): number; getMissing(): number; setMissing(missing: number): void; get exactMatches(): number; getExactMatches(): number; setExactMatches(exactMatches: number): void; get strictMatches(): number; getStrictMatches(): number; setStrictMatches(strictMatches: number): void; get contentMatches(): number; getContentMatches(): number; setContentMatches(contentMatches: number): void; get layoutMatches(): number; getLayoutMatches(): number; setLayoutMatches(layoutMatches: number): void; get noneMatches(): number; getNoneMatches(): number; setNoneMatches(noneMatches: number): void; get url(): string; getUrl(): string; setUrl(url: string): void; isPassed(): boolean; delete(): Promise; deleteSession(): Promise; } export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; }; export class TestResultContainer implements Required { get testResults(): TestResultsPlain; getTestResults(): TestResults; get exception(): Error; getException(): Error; } export type TestResultsSummaryPlain = Iterable; export class TestResultsSummary implements TestResultsSummaryPlain { getAllResults(): Array; [Symbol.iterator](): Iterator; } export type TextRegion = { x: number; y: number; width: number; height: number; text: string; }; export type ValidationInfoPlain = { readonly validationId: number; readonly tag: string; }; export class ValidationInfo implements Required { get validationId(): number; getValidationId(): number; get tag(): string; getTag(): string; } export type ValidationResultPlain = { readonly asExpected: boolean; }; export class ValidationResult implements Required { get asExpected(): boolean; getAsExpected(): boolean; } export type EyesSelector = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector; frame?: EyesSelector; }; export class Logger { constructor(options: { show?: boolean; label?: string; handler?: LogHandlerPlain; }); constructor(show: boolean); getLogHandler(): LogHandler; setLogHandler(handler: LogHandlerPlain): void; verbose(messages: Array): void; log(messages: Array): void; warn(messages: Array): void; error(messages: Array): void; fatal(messages: Array): void; open(): void; close(): void; extend(label: string, color: string | Array): Logger; } export function closeBatch(spec: { closeBatches(options: { settings: { batchIds: Array; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }; }): Promise; }): (options: { batchIds: Array; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }) => Promise; export abstract class EyesRunner { getAllTestResults(throwErr: boolean): Promise; } export class ClassicRunner extends EyesRunner { } export class VisualGridRunner extends EyesRunner { constructor(options: RunnerOptionsPlain); constructor(options: RunnerOptionsFluent); constructor(legacyConcurrency: number); get testConcurrency(): number; get legacyConcurrency(): number; getConcurrentSessions(): number; } export abstract class SessionEventHandler { abstract initStarted(): any; abstract initEnded(): any; abstract setSizeWillStart(viewportSize: RectangleSize): any; abstract setSizeEnded(): any; abstract testStarted(sessionId: string): any; abstract testEnded(sessionId: string, testResults: TestResults): any; abstract validationWillStart(sessionId: string, validationInfo: ValidationInfo): any; abstract validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): any; } export class SessionEventHandlers extends SessionEventHandler { addEventHandler(handler: SessionEventHandler): void; removeEventHandler(handler: SessionEventHandler): void; clearEventHandlers(): void; initStarted(): void; initEnded(): void; setSizeWillStart(viewportSize: RectangleSize): void; setSizeEnded(): void; testStarted(sessionId: string): void; testEnded(sessionId: string, testResults: TestResults): void; validationWillStart(sessionId: string, validationInfo: ValidationInfo): void; validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void; } export class RemoteSessionEventHandler extends SessionEventHandler { constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; }); constructor(serverUrl: string, accessKey: string, timeout: number); get serverUrl(): string; set serverUrl(serverUrl: string); getServerUrl(): string; setServerUrl(serverUrl: string): void; get accessKey(): string; set accessKey(accessKey: string); getAccessKey(): string; setAccessKey(accessKey: string): void; get timeout(): number; set timeout(timeout: number); setTimeout(timeout: number): void; getTimeout(): number; initStarted(): void; initEnded(): void; setSizeWillStart(): void; setSizeEnded(): void; testStarted(): void; testEnded(): void; validationWillStart(): void; validationEnded(): void; }