/// import type * as Core from '@applitools/core'; import { type SDK } from './SDK'; import { EyesSelector } from './input/EyesSelector'; import { SessionType } from './enums/SessionType'; import { StitchMode, StitchModeEnum } from './enums/StitchMode'; import { MatchLevel, MatchLevelEnum } from './enums/MatchLevel'; import { CheckSettingsAutomation, CheckSettingsAutomationFluent, CheckSettingsImage, CheckSettingsImageFluent } from './input/CheckSettings'; import { Image } from './input/Image'; import { OCRSettings } from './input/OCRSettings'; import { VisualLocatorSettings } from './input/VisualLocatorSettings'; import { ProxySettings, ProxySettingsData } from './input/ProxySettings'; import { BaselineEnvOptions, Configuration, ConfigurationData } from './input/Configuration'; import { BatchInfo, BatchInfoData } from './input/BatchInfo'; import { RectangleSize, RectangleSizeData } from './input/RectangleSize'; import { Region } from './input/Region'; import { OCRRegion } from './input/OCRRegion'; import { ImageRotation, ImageRotationData } from './input/ImageRotation'; import { CutProviderData } from './input/CutProvider'; import { LogHandlerData, LogHandler } from './input/LogHandler'; import { TextRegion } from './output/TextRegion'; import { MatchResultData } from './output/MatchResult'; import { TestResults, TestResultsData } from './output/TestResults'; import { ValidationInfo } from './output/ValidationInfo'; import { ValidationResult } from './output/ValidationResult'; import { SessionEventHandler, SessionEventHandlers } from './SessionEventHandlers'; import { EyesRunner } from './Runners'; import { Logger } from './Logger'; export { CheckSettingsOptIn } from './input/CheckSettings'; export declare class Eyes = CheckSettingsAutomation> { protected static readonly _sdk: SDK; protected get _sdk(): SDK; private _logger; private _config; private _state; private _runner; private _driver?; private _core; private _eyes?; private _spec?; private _events; private _handlers; static getExecutionCloudUrl(config?: Configuration & { maskLog?: boolean; }): Promise; static setViewportSize(driver: unknown, size: RectangleSize): Promise; static setMobileCapabilities>(capabilities: TCapabilities, config?: Configuration): TCapabilities; constructor(runner?: EyesRunner, config?: Configuration); constructor(config?: Configuration); get logger(): Logger; getLogger(): Logger; get runner(): EyesRunner; getRunner(): EyesRunner; get driver(): TSpec['driver']; getDriver(): TSpec['driver']; get configuration(): Configuration; set configuration(config: Configuration); getConfiguration(): ConfigurationData; setConfiguration(config: Configuration): void; get isOpen(): boolean; getIsOpen(): boolean; /** @undocumented */ on(handler: (event: string, data?: Record) => any): () => void; /** @undocumented */ on(event: 'setSizeWillStart', handler: (data: { viewportSize: RectangleSize; }) => any): () => void; /** @undocumented */ on(event: 'setSizeEnded', handler: () => any): () => void; /** @undocumented */ on(event: 'initStarted', handler: () => any): () => void; /** @undocumented */ on(event: 'initEnded', handler: () => any): () => void; /** @undocumented */ on(event: 'testStarted', handler: (data: { sessionId: string; }) => any): () => void; /** @undocumented */ on(event: 'validationWillStart', handler: (data: { sessionId: string; validationInfo: ValidationInfo; }) => any): () => void; /** @undocumented */ on(event: 'validationEnded', handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResult; }) => any): () => void; /** @undocumented */ on(event: 'testEnded', handler: (data: { sessionId: string; testResults: TestResults; }) => any): () => void; /** @undocumented */ off(event: string): void; /** @undocumented */ off(handler: (...args: any[]) => any): void; getExecutionCloudUrl(): Promise; setMobileCapabilities>(capabilities: TCapabilities): TCapabilities; open(driver: TSpec['driver'], config?: Configuration): Promise; open(driver: TSpec['driver'], appName?: string, testName?: string, viewportSize?: RectangleSize, sessionType?: SessionType): Promise; open(config?: Configuration): Promise; open(appName?: string, testName?: string, viewportSize?: RectangleSize, sessionType?: SessionType): Promise; check(name: string, checkSettings: CheckSettingsImageFluent | CheckSettingsAutomationFluent): Promise; check(target: Image, checkSettings?: CheckSettingsImage): Promise; check(checkSettings?: TCheckSettingsWithAutomation): Promise; /** @deprecated */ checkWindow(name?: string, timeout?: number, fully?: boolean): Promise; /** @deprecated */ checkFrame(element: TSpec['element'] | EyesSelector | string | number, timeout?: number, name?: string): Promise; /** @deprecated */ checkElement(element: TSpec['element'], timeout?: number, name?: string): Promise; /** @deprecated */ checkElementBy(selector: EyesSelector, timeout?: number, name?: string): Promise; /** @deprecated */ checkRegion(region: Region, name?: string, timeout?: number): Promise; /** @deprecated */ checkRegion(image: Buffer | URL | string, region: Region, name?: string, ignoreMismatch?: boolean): Promise; /** @deprecated */ checkRegionByElement(element: TSpec['element'], name?: string, timeout?: number): Promise; /** @deprecated */ checkRegionBy(selector: EyesSelector, name?: string, timeout?: number, fully?: boolean): Promise; /** @deprecated */ checkRegionInFrame(frame: TSpec['element'] | EyesSelector | string | number, selector: EyesSelector, timeout?: number, name?: string, fully?: boolean): Promise; /** @deprecated */ checkImage(image: Buffer | URL | string, name?: string, ignoreMismatch?: boolean): Promise; locate(target: Image, settings: VisualLocatorSettings): Promise>; /** @deprecated */ locate(settingsWithImage: VisualLocatorSettings & { image: Image['image']; }): Promise>; locate(settings: VisualLocatorSettings): Promise>; extractTextRegions(target: Image, settings: OCRSettings): Promise>; /** @deprecated */ extractTextRegions(settingsWithImage: OCRSettings & { image: Image['image']; }): Promise>; extractTextRegions(settings: OCRSettings): Promise>; extractText(target: Image, settings: OCRRegion[]): Promise; /** @deprecated */ extractText(settingsWithImage: (OCRRegion & { image: Image['image']; })[]): Promise; extractText(settings: OCRRegion[]): Promise; close(throwErr?: boolean): Promise; closeAsync(): Promise; abort(): Promise; abortAsync(): Promise; /** @deprecated */ abortIfNotClosed(): Promise; getResults(throwErr?: boolean): Promise; getViewportSize(): Promise; setViewportSize(size: RectangleSize): Promise; getScrollRootElement(): TSpec['element'] | EyesSelector; setScrollRootElement(scrollRootElement: TSpec['element'] | EyesSelector): void; setLogHandler(handler: LogHandlerData | LogHandler): void; getLogHandler(): LogHandlerData; setCutProvider(cutProvider: CutProviderData): void; setImageCut(cutProvider: CutProviderData): void; getIsCutProviderExplicitlySet(): boolean; getRotation(): ImageRotationData; setRotation(rotation: ImageRotation | ImageRotationData): 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): ConfigurationData; clearProperties(): ConfigurationData; getBatch(): BatchInfoData; setBatch(batch: BatchInfo): void; setBatch(name: string, id?: string, startedAt?: Date | string): 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; /** @deprecated */ getBaselineName(): string; /** @deprecated */ setBaselineName(baselineName: string): void; getBaselineEnvName(): string; setBaselineEnvName(baselineEnvName: string, options?: BaselineEnvOptions): 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(): MatchLevelEnum; setMatchLevel(matchLevel: MatchLevel): void; getMatchTimeout(): number; setMatchTimeout(matchTimeout: number): void; getParentBranchName(): string; setParentBranchName(parentBranchName: string): void; setProxy(proxy: ProxySettings): void; setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void; setProxy(isEnabled: false): void; getProxy(): ProxySettingsData; 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(): StitchModeEnum; setStitchMode(stitchMode: StitchMode): void; getStitchOverlap(): number; setStitchOverlap(stitchOverlap: number): void; /** * @undocumented * @deprecated */ getSessionEventHandlers(): SessionEventHandlers; /** * @undocumented * @deprecated */ addSessionEventHandler(handler: SessionEventHandler): void; /** * @undocumented * @deprecated */ removeSessionEventHandler(handler: SessionEventHandler): void; /** * @undocumented * @deprecated */ clearSessionEventHandlers(): void; }