@types/selenium-webdriver/index.d.ts

TypeScript definitions for selenium-webdriver

import LogInspector = require("./bidi/logInspector");
import BrowsingContext = require("./bidi/browsingContext");
import * as chrome from "./chrome";
import * as edge from "./edge";
import * as firefox from "./firefox";
import * as http from "./http";
import * as ie from "./ie";
import { By, ByHash, RelativeBy } from "./lib/by";
import { Browser, Capabilities } from "./lib/capabilities";
import { FileDetector, Key } from "./lib/input";
import * as logging from "./lib/logging";
import * as until from "./lib/until";
import { ShadowRootPromise, WebDriver } from "./lib/webdriver";
import * as safari from "./safari";

export * as chromium from "./chromium";
export * from "./lib/by";
export { Browser, Capabilities, Capability, ITimeouts } from "./lib/capabilities";
export { Actions, Button, FileDetector, Key, Origin } from "./lib/input";
export { promise } from "./lib/promise";
export {
    Alert,
    Condition,
    IWebDriverOptionsCookie,
    Navigation,
    Options,
    TargetLocator,
    WebDriver,
    WebElementCondition,
} from "./lib/webdriver";
export { BrowsingContext, logging, LogInspector, until };

/**
 * Typings for lib/error
 */
export namespace error {
    class IError extends Error {
        constructor(message?: string);
        message: string;
    }

    /**
     * The base WebDriver error type. This error type is only used directly when a
     * more appropriate category is not defined for the offending error.
     */
    class WebDriverError extends IError {
        constructor(message?: string);
        remoteStacktrace?: string | undefined;
    }

    /**
     * Indicates a {@linkplain ./webdriver.WebElement#click click command} could
     * not completed because the click target is obscured by other elements on the
     * page.
     */
    class ElementClickInterceptedError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An attempt was made to select an element that cannot be selected.
     */
    class ElementNotSelectableError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Indicates a command could not be completed because the target element is
     * not pointer or keyboard interactable. This will often occur if an element
     * is present in the DOM, but not rendered (i.e. its CSS style has
     * "display: none").
     */

    class ElementNotInteractableError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Indicates a navigation event caused the browser to generate a certificate
     * warning. This is usually caused by an expired or invalid TLS certificate.
     */
    class InsecureCertificateError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * The arguments passed to a command are either invalid or malformed.
     */
    class InvalidArgumentError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An illegal attempt was made to set a cookie under a different domain than
     * the current page.
     */
    class InvalidCookieDomainError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * The coordinates provided to an interactions operation are invalid.
     */
    class InvalidCoordinatesError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An element command could not be completed because the element is in an
     * invalid state, e.g. attempting to click an element that is no longer
     * attached to the document.
     */
    class InvalidElementStateError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Argument was an invalid selector.
     */
    class InvalidSelectorError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Occurs when a command is directed to a session that does not exist.
     */
    class NoSuchSessionError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An error occurred while executing JavaScript supplied by the user.
     */
    class JavascriptError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * The target for mouse interaction is not in the browser’s viewport and
     * cannot be brought into that viewport.
     */
    class MoveTargetOutOfBoundsError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An attempt was made to operate on a modal dialog when one was not open.
     */
    class NoSuchAlertError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Indicates a named cookie could not be found in the cookie jar for the
     * currently selected document.
     */
    class NoSuchCookieError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An element could not be located on the page using the given search
     * parameters.
     */
    class NoSuchElementError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A request to switch to a frame could not be satisfied because the frame
     * could not be found.
     */
    class NoSuchFrameError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A request to switch to a window could not be satisfied because the window
     * could not be found.
     */
    class NoSuchWindowError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A script did not complete before its timeout expired.
     */
    class ScriptTimeoutError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A new session could not be created.
     */
    class SessionNotCreatedError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An element command failed because the referenced element is no longer
     * attached to the DOM.
     */
    class StaleElementReferenceError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * An operation did not completErrorCodee before its timeout expired.
     */
    class TimeoutError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A request to set a cookie’s value could not be satisfied.
     */
    class UnableToSetCookieError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A screen capture operation was not possible.
     */
    class UnableToCaptureScreenError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * A modal dialog was open, blocking this operation.
     */
    class UnexpectedAlertOpenError extends WebDriverError {
        constructor(message?: string, openAlertText?: string);
        /**
         * @return {(string|undefined)} The text displayed with the unhandled alert,
         *     if available.
         */
        getAlertText(): string;
    }

    /**
     * A command could not be executed because the remote end is not aware of it.
     */
    class UnknownCommandError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * The requested command matched a known URL but did not match an method for
     * that URL.
     */
    class UnknownMethodError extends WebDriverError {
        constructor(message?: string);
    }

    /**
     * Reports an unsupport operation.
     */
    class UnsupportedOperationError extends WebDriverError {
        constructor(message?: string);
    }

    interface Response {
        error: string | number;
        message: string;
    }
    /**
     * Checks a response object from a server that adheres to the W3C WebDriver
     * protocol.
     */
    function checkResponse(data: Response): Response;

    interface MaybeLegacyResponse {
        status?: number | undefined;
        value?: { message: string } | undefined;
        message?: string | undefined;
        getAlertText?(): string;
    }

    /**
     * Checks a legacy response from the Selenium 2.0 wire protocol for an error.
     */
    function checkLegacyResponse(response: MaybeLegacyResponse): MaybeLegacyResponse;

    interface ErrorData {
        error: string | number;
        message: string;
        [key: string]: string | number;
    }

    /**
     * Throws an error coded from the W3C protocol. A generic error will be thrown
     * if the provided `data` is not a valid encoded error.
     */
    function throwDecodedError(data: ErrorData | string): never;

    interface ErrorCodeType {
        [key: string]: number;
    }

    const ErrorCode: ErrorCodeType;

    /**
     * Lookup the err in table of errors.
     */
    function encodeError(err: any): { error: string; message: string };
}

/**
 * x,y
 */
export interface ILocation {
    x: number;
    y: number;
}

/**
 * width, height
 */
export interface ISize {
    width: number;
    height: number;
}

/**
 * x,y,w,h
 */
export interface IRectangle {
    x: number;
    y: number;
    width: number;
    height: number;
}

/**
 * Class for defining sequences of user touch interactions. Each sequence
 * will not be executed until {@link #perform} is called.
 *
 * Example:
 *
 *     new TouchSequence(driver).
 *         tapAndHold({x: 0, y: 0}).
 *         move({x: 3, y: 4}).
 *         release({x: 10, y: 10}).
 *         perform();
 */
export class TouchSequence {
    /*
     * @param {!WebDriver} driver The driver instance to use.
     * @constructor
     */
    constructor(driver: WebDriver);

    /**
     * Executes this action sequence.
     * @return {!Promise} A promise that will be resolved once
     *     this sequence has completed.
     */
    perform(): Promise<void>;

    /**
     * Taps an element.
     *
     * @param {!WebElement} elem The element to tap.
     * @return {!TouchSequence} A self reference.
     */
    tap(elem: WebElement): TouchSequence;

    /**
     * Double taps an element.
     *
     * @param {!WebElement} elem The element to double tap.
     * @return {!TouchSequence} A self reference.
     */
    doubleTap(elem: WebElement): TouchSequence;

    /**
     * Long press on an element.
     *
     * @param {!WebElement} elem The element to long press.
     * @return {!TouchSequence} A self reference.
     */
    longPress(elem: WebElement): TouchSequence;

    /**
     * Touch down at the given location.
     *
     * @param {{ x: number, y: number }} location The location to touch down at.
     * @return {!TouchSequence} A self reference.
     */
    tapAndHold(location: ILocation): TouchSequence;

    /**
     * Move a held {@linkplain #tapAndHold touch} to the specified location.
     *
     * @param {{x: number, y: number}} location The location to move to.
     * @return {!TouchSequence} A self reference.
     */
    move(location: ILocation): TouchSequence;

    /**
     * Release a held {@linkplain #tapAndHold touch} at the specified location.
     *
     * @param {{x: number, y: number}} location The location to release at.
     * @return {!TouchSequence} A self reference.
     */
    release(location: ILocation): TouchSequence;

    /**
     * Scrolls the touch screen by the given offset.
     *
     * @param {{x: number, y: number}} offset The offset to scroll to.
     * @return {!TouchSequence} A self reference.
     */
    scroll(offset: IOffset): TouchSequence;

    /**
     * Scrolls the touch screen, starting on `elem` and moving by the specified
     * offset.
     *
     * @param {!WebElement} elem The element where scroll starts.
     * @param {{x: number, y: number}} offset The offset to scroll to.
     * @return {!TouchSequence} A self reference.
     */
    scrollFromElement(elem: WebElement, offset: IOffset): TouchSequence;

    /**
     * Flick, starting anywhere on the screen, at speed xspeed and yspeed.
     *
     * @param {{xspeed: number, yspeed: number}} speed The speed to flick in each
     *    direction, in pixels per second.
     * @return {!TouchSequence} A self reference.
     */
    flick(speed: ISpeed): TouchSequence;

    /**
     * Flick starting at elem and moving by x and y at specified speed.
     *
     * @param {!WebElement} elem The element where flick starts.
     * @param {{x: number, y: number}} offset The offset to flick to.
     * @param {number} speed The speed to flick at in pixels per second.
     * @return {!TouchSequence} A self reference.
     */
    flickElement(elem: WebElement, offset: IOffset, speed: number): TouchSequence;
}

/**
 * x.y again
 */
export interface IOffset {
    x: number;
    y: number;
}

/**
 * delta x,y
 */
export interface ISpeed {
    xspeed: number;
    yspeed: number;
}

/**
 * ProxyConfig
 */
export interface ProxyConfig {
    proxyType: string;
    proxyAutoconfigUrl?: string | undefined;
    ftpProxy?: string | undefined;
    httpProxy?: string | undefined;
    sslProxy?: string | undefined;
    noProxy?: string | undefined;
    socksProxy?: string | undefined;
    socksUsername?: string | undefined;
    socksPassword?: string | undefined;
}

/**
 * Creates new {@link WebDriver WebDriver} instances. The environment
 * variables listed below may be used to override a builder's configuration,
 * allowing quick runtime changes.
 *
 * - {@code SELENIUM_BROWSER}: defines the target browser in the form
 *   {@code browser[:version][:platform]}.
 *
 * - {@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder
 *   instances. This environment variable should be set to a fully qualified
 *   URL for a WebDriver server (e.g. http://localhost:4444/wd/hub). This
 *   option always takes precedence over {@code SELENIUM_SERVER_JAR}.
 *
 * - {@code SELENIUM_SERVER_JAR}: defines the path to the
 *   <a href='http://selenium-release.storage.googleapis.com/index.html'>
 *   standalone Selenium server</a> jar to use. The server will be started the
 *   first time a WebDriver instance and be killed when the process exits.
 *
 * Suppose you had mytest.js that created WebDriver with
 *
 *     var driver = new Builder()
 *         .forBrowser('chrome')
 *         .build();
 *
 * This test could be made to use Firefox on the local machine by running with
 * `SELENIUM_BROWSER=firefox node mytest.js`. Rather than change the code to
 * target Google Chrome on a remote machine, you can simply set the
 * `SELENIUM_BROWSER` and `SELENIUM_REMOTE_URL` environment variables:
 *
 *     SELENIUM_BROWSER=chrome:36:LINUX \
 *     SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub \
 *     node mytest.js
 *
 * You could also use a local copy of the standalone Selenium server:
 *
 *     SELENIUM_BROWSER=chrome:36:LINUX \
 *     SELENIUM_SERVER_JAR=/path/to/selenium-server-standalone.jar \
 *     node mytest.js
 */
export class Builder {
    // region Constructors

    /** */
    constructor();

    // endregion

    // region Methods

    /**
     * Configures this builder to ignore any environment variable overrides and to
     * only use the configuration specified through this instance's API.
     *
     * @return {!Builder} A self reference.
     */
    disableEnvironmentOverrides(): Builder;

    /**
     * Creates a new WebDriver client based on this builder's current
     * configuration.
     *
     * This method will return a {@linkplain ThenableWebDriver} instance, allowing
     * users to issue commands directly without calling `then()`. The returned
     * thenable wraps a promise that will resolve to a concrete
     * {@linkplain webdriver.WebDriver WebDriver} instance. The promise will be
     * rejected if the remote end fails to create a new session.
     *
     * @return {!ThenableWebDriver} A new WebDriver instance.
     * @throws {Error} If the current configuration is invalid.
     */
    build(): ThenableWebDriver;

    /**
     * Configures the target browser for clients created by this instance.
     * Any calls to {@link #withCapabilities} after this function will
     * overwrite these settings.
     *
     * <p>You may also define the target browser using the {@code
     * SELENIUM_BROWSER} environment variable. If set, this environment variable
     * should be of the form {@code browser[:[version][:platform]]}.
     *
     * @param {(string|Browser)} name The name of the target browser;
     *     common defaults are available on the {@link Browser} enum.
     * @param {string=} opt_version A desired version; may be omitted if any
     *     version should be used.
     * @param {string=} opt_platform The desired platform; may be omitted if any
     *     version may be used.
     * @return {!Builder} A self reference.
     */
    forBrowser(name: string, opt_version?: string, opt_platform?: string): Builder;

    /**
     * Returns the base set of capabilities this instance is currently configured
     * to use.
     * @return {!Capabilities} The current capabilities for this builder.
     */
    getCapabilities(): Capabilities;

    /**
     * @return {string} The URL of the WebDriver server this instance is
     *     configured to use.
     */
    getServerUrl(): string;

    /**
     * @return {?string} The URL of the proxy server to use for the WebDriver's
     *    HTTP connections, or `null` if not set.
     */
    getWebDriverProxy(): string | null;

    /**
     * Sets the default action to take with an unexpected alert before returning
     * an error.
     * @param {string} beahvior The desired behavior; should be 'accept',
     *     'dismiss', or 'ignore'. Defaults to 'dismiss'.
     * @return {!Builder} A self reference.
     */
    setAlertBehavior(behavior?: string): Builder;

    /**
     * Sets Chrome-specific options for drivers created by this builder. Any
     * logging or proxy settings defined on the given options will take precedence
     * over those set through {@link #setLoggingPrefs} and {@link #setProxy},
     * respectively.
     *
     * @param {!chrome.Options} options The ChromeDriver options to use.
     * @return {!Builder} A self reference.
     */
    setChromeOptions(options: chrome.Options): Builder;

    /**
     * @return {chrome.Options} the Chrome specific options currently configured
     *     for this builder.
     */
    getChromeOptions(): chrome.Options;

    /**
     * Sets the service builder to use for managing the chromedriver child process
     * when creating new Chrome sessions.
     *
     * @param {chrome.ServiceBuilder} service the service to use.
     * @return {!Builder} A self reference.
     */
    setChromeService(service: chrome.ServiceBuilder): Builder;

    /**
     * Set {@linkplain edge.Options options} specific to Microsoft's Edge browser
     * for drivers created by this builder. Any proxy settings defined on the
     * given options will take precedence over those set through
     * {@link #setProxy}.
     *
     * @param {!edge.Options} options The MicrosoftEdgeDriver options to use.
     * @return {!Builder} A self reference.
     */
    setEdgeOptions(options: edge.Options): Builder;

    /**
     * Sets the {@link edge.ServiceBuilder} to use to manage the
     * MicrosoftEdgeDriver child process when creating sessions locally.
     *
     * @param {edge.ServiceBuilder} service the service to use.
     * @return {!Builder} a self reference.
     */
    setEdgeService(service: edge.ServiceBuilder): Builder;

    /**
     * Sets Firefox-specific options for drivers created by this builder. Any
     * logging or proxy settings defined on the given options will take precedence
     * over those set through {@link #setLoggingPrefs} and {@link #setProxy},
     * respectively.
     *
     * @param {!firefox.Options} options The FirefoxDriver options to use.
     * @return {!Builder} A self reference.
     */
    setFirefoxOptions(options: firefox.Options): Builder;

    /**
     * @return {firefox.Options} the Firefox specific options currently configured
     *     for this instance.
     */
    getFirefoxOptions(): firefox.Options;

    /**
     * Sets the {@link firefox.ServiceBuilder} to use to manage the geckodriver
     * child process when creating Firefox sessions locally.
     *
     * @param {firefox.ServiceBuilder} service the service to use.
     * @return {!Builder} a self reference.
     */
    setFirefoxService(service: firefox.ServiceBuilder): Builder;

    /**
     * Set Internet Explorer specific {@linkplain ie.Options options} for drivers
     * created by this builder. Any proxy settings defined on the given options
     * will take precedence over those set through {@link #setProxy}.
     *
     * @param {!ie.Options} options The IEDriver options to use.
     * @return {!Builder} A self reference.
     */
    setIeOptions(options: ie.Options): Builder;

    /**
     * Sets the {@link ie.ServiceBuilder} to use to manage the geckodriver
     * child process when creating IE sessions locally.
     *
     * @param {ie.ServiceBuilder} service the service to use.
     * @return {!Builder} a self reference.
     */
    setIeService(service: ie.ServiceBuilder): Builder;

    /**
     * Sets the logging preferences for the created session. Preferences may be
     * changed by repeated calls, or by calling {@link #withCapabilities}.
     * @param {!(logging.Preferences|Object.<string, string>)} prefs The
     *     desired logging preferences.
     * @return {!Builder} A self reference.
     */
    setLoggingPrefs(prefs: logging.Preferences | {}): Builder;

    /**
     * Sets the proxy configuration to use for WebDriver clients created by this
     * builder. Any calls to {@link #withCapabilities} after this function will
     * overwrite these settings.
     * @param {!capabilities.ProxyConfig} config The configuration to use.
     * @return {!Builder} A self reference.
     */
    setProxy(config: ProxyConfig): Builder;

    /**
     * Sets Safari specific {@linkplain safari.Options options} for drivers
     * created by this builder. Any logging settings defined on the given options
     * will take precedence over those set through {@link #setLoggingPrefs}.
     *
     * @param {!safari.Options} options The Safari options to use.
     * @return {!Builder} A self reference.
     */
    setSafariOptions(options: safari.Options): Builder;

    /**
     * @return {safari.Options} the Safari specific options currently configured
     *     for this instance.
     */
    getSafariOptions(): safari.Options;

    /**
     * Sets the http agent to use for each request.
     * If this method is not called, the Builder will use http.globalAgent by
     * default.
     *
     * @param {http.Agent} agent The agent to use for each request.
     * @return {!Builder} A self reference.
     */
    usingHttpAgent(agent: any): Builder;

    /**
     * @return {http.Agent} The http agent used for each request
     */
    getHttpAgent(): any | null;

    /**
     * Sets the URL of a remote WebDriver server to use. Once a remote URL has
     * been specified, the builder direct all new clients to that server. If this
     * method is never called, the Builder will attempt to create all clients
     * locally.
     *
     * <p>As an alternative to this method, you may also set the
     * {@code SELENIUM_REMOTE_URL} environment variable.
     *
     * @param {string} url The URL of a remote server to use.
     * @return {!Builder} A self reference.
     */
    usingServer(url: string): Builder;

    /**
     * Sets the URL of the proxy to use for the WebDriver's HTTP connections.
     * If this method is never called, the Builder will create a connection
     * without a proxy.
     *
     * @param {string} proxy The URL of a proxy to use.
     * @return {!Builder} A self reference.
     */
    usingWebDriverProxy(proxy: string): Builder;

    /**
     * Sets the desired capabilities when requesting a new session. This will
     * overwrite any previously set capabilities.
     * @param {!(Object|Capabilities)} capabilities The desired
     *     capabilities for a new session.
     * @return {!Builder} A self reference.
     */
    withCapabilities(capabilities: {} | Capabilities): Builder;

    // endregion
}

export type Locator = By | Function | ByHash | RelativeBy;

/**
 * Describes an event listener registered on an {@linkplain EventEmitter}.
 */
export class Listener {
    /**
     * @param {!Function} fn The acutal listener function.
     * @param {(Object|undefined)} scope The object in whose scope to invoke the
     *     listener.
     * @param {boolean} oneshot Whether this listener should only be used once.
     */
    constructor(fn: Function, scope: {}, oneshot: boolean);
}

/**
 * Object that can emit events for others to listen for. This is used instead
 * of Closure's event system because it is much more light weight. The API is
 * based on Node's EventEmitters.
 */
export class EventEmitter {
    // region Constructors

    /** */
    constructor();

    // endregion

    // region Methods

    /**
     * Fires an event and calls all listeners.
     * @param {string} type The type of event to emit.
     * @param {...*} var_args Any arguments to pass to each listener.
     */
    emit(type: string, ...var_args: any[]): void;

    /**
     * Returns a mutable list of listeners for a specific type of event.
     * @param {string} type The type of event to retrieve the listeners for.
     * @return {!Set<!Listener>} The registered listeners for the given event
     *     type.
     */
    listeners(type: string): any;

    /**
     * Registers a listener.
     * @param {string} type The type of event to listen for.
     * @param {!Function} fn The function to invoke when the event is fired.
     * @param {Object=} opt_self The object in whose scope to invoke the listener.
     * @param {boolean=} opt_oneshot Whether the listener should b (e removed
     *     after
     *    the first event is fired.
     * @return {!EventEmitter} A self reference.
     */
    addListener(type: string, fn: Function, opt_scope?: any, opt_oneshot?: boolean): EventEmitter;

    /**
     * Registers a one-time listener which will be called only the first time an
     * event is emitted, after which it will be removed.
     * @param {string} type The type of event to listen for.
     * @param {!Function} fn The function to invoke when the event is fired.
     * @param {Object=} opt_scope The object in whose scope to invoke the
     *     listener.
     * @return {!EventEmitter} A self reference.
     */
    once(type: string, fn: any, opt_scope?: any): EventEmitter;

    /**
     * An alias for {@code #addListener()}.
     * @param {string} type The type of event to listen for.
     * @param {!Function} fn The function to invoke when the event is fired.
     * @param {Object=} opt_scope The object in whose scope to invoke the
     *     listener.
     * @return {!EventEmitter} A self reference.
     */
    on(type: string, fn: Function, opt_scope?: any): EventEmitter;

    /**
     * Removes a previously registered event listener.
     * @param {string} type The type of event to unregister.
     * @param {!Function} listenerFn The handler function to remove.
     * @return {!EventEmitter} A self reference.
     */
    removeListener(type: string, listenerFn: Function): EventEmitter;

    /**
     * Removes all listeners for a specific type of event. If no event is
     * specified, all listeners across all types will be removed.
     * @param {string=} opt_type The type of event to remove listeners from.
     * @return {!EventEmitter} A self reference.
     */
    removeAllListeners(opt_type?: string): EventEmitter;

    // endregion
}

/**
 * An interface for managing the current window.
 */
export class Window {
    // region Constructors

    /**
     * @param {!WebDriver} driver The parent driver.
     */
    constructor(driver: WebDriver);

    // endregion

    // region Methods

    /**
     * Retrieves the window's current position, relative to the top left corner of
     * the screen.
     * @return {!Promise} A promise that will be resolved with the
     *     window's position in the form of a {x:number, y:number} object literal.
     */
    getPosition(): Promise<ILocation>;

    /**
     * Repositions the current window.
     * @param {number} x The desired horizontal position, relative to the left
     *     side of the screen.
     * @param {number} y The desired vertical position, relative to the top of the
     *     of the screen.
     * @return {!Promise} A promise that will be resolved when the
     *     command has completed.
     */
    setPosition(x: number, y: number): Promise<void>;

    /**
     * Retrieves the window's current size.
     * @return {!Promise} A promise that will be resolved with the
     *     window's size in the form of a {width:number, height:number} object
     *     literal.
     */
    getSize(): Promise<ISize>;

    /**
     * Resizes the current window.
     * @param {number} width The desired window width.
     * @param {number} height The desired window height.
     * @return {!Promise} A promise that will be resolved when the
     *     command has completed.
     */
    setSize(width: number, height: number): Promise<void>;

    /**
     * Returns the current top-level window's size and position.
     */
    getRect(): Promise<IRectangle>;

    /**
     * Sets the current top-level window's size and position. You may update
     * just the size by omitting `x` & `y`, or just the position by omitting
     * `width` & `height` options.
     */
    setRect({ x, y, width, height }: Partial<IRectangle>): Promise<IRectangle>;

    /**
     * Maximizes the current window. The exact behavior of this command is
     * specific to individual window managers, but typically involves increasing
     * the window to the maximum available size without going full-screen.
     * @return {!Promise} A promise that will be resolved when the
     *     command has completed.
     */
    maximize(): Promise<void>;

    /**
     * Minimizes the current window. The exact behavior of this command is
     * specific to individual window managers, but typically involves hiding
     * the window in the system tray.
     * @return {!Promise} A promise that will be resolved when the
     *     command has completed.
     */
    minimize(): Promise<void>;

    /**
     * Invokes the "full screen" operation on the current window. The exact
     * behavior of this command is specific to individual window managers, but
     * this will typically increase the window size to the size of the physical
     * display and hide the browser chrome.
     *
     * @return {!Promise<void>} A promise that will be resolved when the command
     *     has completed.
     * @see <https://fullscreen.spec.whatwg.org/#fullscreen-an-element>
     */
    fullscreen(): Promise<void>;

    // endregion
}

/**
 * Interface for managing WebDriver log records.
 */
export class Logs {
    // region Constructors

    /**
     * @param {!WebDriver} driver The parent driver.
     */
    constructor(driver: WebDriver);

    // endregion

    // region

    /**
     * Fetches available log entries for the given type.
     *
     * <p/>Note that log buffers are reset after each call, meaning that
     * available log entries correspond to those entries not yet returned for a
     * given log type. In practice, this means that this call will return the
     * available log entries since the last call, or from the start of the
     * session.
     *
     * @param {!logging.Type} type The desired log type.
     * @return {!Promise.<!Array.<!logging.Entry>>} A
     *   promise that will resolve to a list of log entries for the specified
     *   type.
     */
    get(type: string): Promise<logging.Entry[]>;

    /**
     * Retrieves the log types available to this driver.
     * @return {!Promise.<!Array.<!logging.Type>>} A
     *     promise that will resolve to a list of available log types.
     */
    getAvailableLogTypes(): Promise<string[]>;

    // endregion
}

export type CreateSessionCapabilities = Capabilities | {
    desired?: Capabilities | undefined;
    required?: Capabilities | undefined;
};

/**
 * A thenable wrapper around a {@linkplain webdriver.IWebDriver IWebDriver}
 * instance that allows commands to be issued directly instead of having to
 * repeatedly call `then`:
 *
 *     let driver = new Builder().build();
 *     driver.then(d => d.get(url));  // You can do this...
 *     driver.get(url);               // ...or this
 *
 * If the driver instance fails to resolve (e.g. the session cannot be created),
 * every issued command will fail.
 *
 * @interface
 */
export interface ThenableWebDriver extends WebDriver, Promise<WebDriver> {}

export interface IWebElementId {
    [ELEMENT: string]: string;
}

/**
 * Represents a DOM element. WebElements can be found by searching from the
 * document root using a {@code WebDriver} instance, or by searching
 * under another {@code WebElement}:
 * <pre><code>
 *   driver.get('http://www.google.com');
 *   var searchForm = driver.findElement(By.tagName('form'));
 *   var searchBox = searchForm.findElement(By.name('q'));
 *   searchBox.sendKeys('webdriver');
 * </code></pre>
 *
 * The WebElement is implemented as a promise for compatibility with the promise
 * API. It will always resolve itself when its internal state has been fully
 * resolved and commands may be issued against the element. This can be used to
 * catch errors when an element cannot be located on the page:
 * <pre><code>
 *   driver.findElement(By.id('not-there')).then(function(element) {
 *     alert('Found an element that was not expected to be there!');
 *   }, function(error) {
 *     alert('The element was not found, as expected');
 *   });
 * </code></pre>
 */
export interface IWebElement {
    // region Methods

    /**
     * Schedules a command to click on this element.
     * @return {!Promise} A promise that will be resolved when
     *     the click command has completed.
     */
    click(): Promise<void>;

    /**
     * Schedules a command to type a sequence on the DOM element represented by
     * this instance.
     *
     * Modifier keys (SHIFT, CONTROL, ALT, META) are stateful; once a modifier is
     * processed in the key sequence, that key state is toggled until one of the
     * following occurs:
     *
     * - The modifier key is encountered again in the sequence. At this point the
     *   state of the key is toggled (along with the appropriate keyup/down
     *   events).
     * - The {@link input.Key.NULL} key is encountered in the sequence. When
     *   this key is encountered, all modifier keys current in the down state are
     *   released (with accompanying keyup events). The NULL key can be used to
     *   simulate common keyboard shortcuts:
     *
     *         element.sendKeys('text was',
     *                          Key.CONTROL, 'a', Key.NULL,
     *                          'now text is');
     *         // Alternatively:
     *         element.sendKeys('text was',
     *                          Key.chord(Key.CONTROL, 'a'),
     *                          'now text is');
     *
     * - The end of the key sequence is encountered. When there are no more keys
     *   to type, all depressed modifier keys are released (with accompanying
     *   keyup events).
     *
     * If this element is a file input ({@code <input type='file'>}), the
     * specified key sequence should specify the path to the file to attach to
     * the element. This is analogous to the user clicking 'Browse...' and
     * entering the path into the file select dialog.
     *
     *     var form = driver.findElement(By.css('form'));
     *     var element = form.findElement(By.css('input[type=file]'));
     *     element.sendKeys('/path/to/file.txt');
     *     form.submit();
     *
     * For uploads to function correctly, the entered path must reference a file
     * on the _browser's_ machine, not the local machine running this script. When
     * running against a remote Selenium server, a {@link input.FileDetector}
     * may be used to transparently copy files to the remote machine before
     * attempting to upload them in the browser.
     *
     * __Note:__ On browsers where native keyboard events are not supported
     * (e.g. Firefox on OS X), key events will be synthesized. Special
     * punctuation keys will be synthesized according to a standard QWERTY en-us
     * keyboard layout.
     *
     * @param {...(number|string|!IThenable<(number|string)>)} var_args The
     *     sequence of keys to type. Number keys may be referenced numerically or
     *     by string (1 or '1'). All arguments will be joined into a single
     *     sequence.
     * @return {!Promise} A promise that will be resolved when all
     *     keys have been typed.
     */
    sendKeys(...var_args: Array<number | string | Promise<string | number>>): Promise<void>;

    /**
     * Schedules a command to query for the tag/node name of this element.
     * @return {!Promise} A promise that will be resolved with the
     *     element's tag name.
     */
    getTagName(): Promise<string>;

    /**
     * Schedules a command to query for the computed style of the element
     * represented by this instance. If the element inherits the named style from
     * its parent, the parent will be queried for its value.  Where possible,
     * color values will be converted to their hex representation (e.g. #00ff00
     * instead of rgb(0, 255, 0)). <p/> <em>Warning:</em> the value returned will
     * be as the browser interprets it, so it may be tricky to form a proper
     * assertion.
     *
     * @param {string} cssStyleProperty The name of the CSS style property to look
     *     up.
     * @return {!Promise} A promise that will be resolved with the
     *     requested CSS value.
     */
    getCssValue(cssStyleProperty: string): Promise<string>;

    /**
     * Schedules a command to query for the value of the given attribute of the
     * element. Will return the current value even if it has been modified after
     * the page has been loaded. More exactly, this method will return the value
     * of the given attribute, unless that attribute is not present, in which case
     * the value of the property with the same name is returned. If neither value
     * is set, null is returned. The 'style' attribute is converted as best can be
     * to a text representation with a trailing semi-colon. The following are
     * deemed to be 'boolean' attributes and will be returned as thus:
     *
     * <p>async, autofocus, autoplay, checked, compact, complete, controls,
     * declare, defaultchecked, defaultselected, defer, disabled, draggable,
     * ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap,
     * itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate,
     * nowrap, open, paused, pubdate, readonly, required, reversed, scoped,
     * seamless, seeking, selected, spellcheck, truespeed, willvalidate
     *
     * <p>Finally, the following commonly mis-capitalized attribute/property names
     * are evaluated as expected:
     * <ul>
     *   <li>'class'
     *   <li>'readonly'
     * </ul>
     * @param {string} attributeName The name of the attribute to query.
     * @return {!Promise} A promise that will be resolved with the
     *     attribute's value.
     */
    getAttribute(attributeName: string): Promise<string>;

    /**
     * Get the visible (i.e. not hidden by CSS) innerText of this element,
     * including sub-elements, without any leading or trailing whitespace.
     * @return {!Promise} A promise that will be resolved with the
     *     element's visible text.
     */
    getText(): Promise<string>;

    /**
     * Schedules a command to compute the size of this element's bounding box, in
     * pixels.
     * @return {!Promise} A promise that will be resolved with the
     *     element's size as a {@code {width:number, height:number}} object.
     */
    getSize(): Promise<ISize>;

    /**
     * Returns an object describing an element's location, in pixels relative to
     * the document element, and the element's size in pixels.
     */
    getRect(): Promise<IRectangle>;

    /**
     * Schedules a command to compute the location of this element in page space.
     * @return {!Promise} A promise that will be resolved to the
     *     element's location as a {@code {x:number, y:number}} object.
     */
    getLocation(): Promise<ILocation>;

    /**
     * Schedules a command to query whether the DOM element represented by this
     * instance is enabled, as dicted by the {@code disabled} attribute.
     * @return {!Promise} A promise that will be resolved with
     *     whether this element is currently enabled.
     */
    isEnabled(): Promise<boolean>;

    /**
     * Schedules a command to query whether this element is selected.
     * @return {!Promise} A promise that will be resolved with
     *     whether this element is currently selected.
     */
    isSelected(): Promise<boolean>;

    /**
     * Schedules a command to submit the form containing this element (or this
     * element if it is a FORM element). This command is a no-op if the element is
     * not contained in a form.
     * @return {!Promise} A promise that will be resolved when
     *     the form has been submitted.
     */
    submit(): Promise<void>;

    /**
     * Schedules a command to clear the {@code value} of this element. This
     * command has no effect if the underlying DOM element is neither a text INPUT
     * element nor a TEXTAREA element.
     * @return {!Promise} A promise that will be resolved when
     *     the element has been cleared.
     */
    clear(): Promise<void>;

    /**
     * Schedules a command to test whether this element is currently displayed.
     * @return {!Promise} A promise that will be resolved with
     *     whether this element is currently visible on the page.
     */
    isDisplayed(): Promise<boolean>;

    /**
     * @return {!Promise.<WebElement.Id>} A promise
     *     that resolves to this element's JSON representation as defined by the
     *     WebDriver wire protocol.
     * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol
     */
    getId(): Promise<IWebElementId>;

    // endregion
}

export interface IWebElementFinders {
    /**
     * Schedule a command to find a descendant of this element. If the element
     * cannot be found, a {@code bot.ErrorCode.NO_SUCH_ELEMENT} result will
     * be returned by the driver. Unlike other commands, this error cannot be
     * suppressed. In other words, scheduling a command to find an element doubles
     * as an assert that the element is present on the page. To test whether an
     * element is present on the page, use {@code #findElements}.
     *
     * <p>The search criteria for an element may be defined using one of the
     * factories in the {@link By} namespace, or as a short-hand
     * {@link By.Hash} object. For example, the following two statements
     * are equivalent:
     * <code><pre>
     * var e1 = element.findElement(By.id('foo'));
     * var e2 = element.findElement({id:'foo'});
     * </pre></code>
     *
     * <p>You may also provide a custom locator function, which takes as input
     * this WebDriver instance and returns a {@link WebElement}, or a
     * promise that will resolve to a WebElement. For example, to find the first
     * visible link on a page, you could write:
     * <code><pre>
     * var link = element.findElement(firstVisibleLink);
     *
     * function firstVisibleLink(element) {
     *   var links = element.findElements(By.tagName('a'));
     *   return promise.filter(links, function(link) {
     *     return links.isDisplayed();
     *   }).then(function(visibleLinks) {
     *     return visibleLinks[0];
     *   });
     * }
     * </pre></code>
     *
     * @param {!(Locator|By.Hash|Function)} locator The
     *     locator strategy to use when searching for the element.
     * @return {!WebElement} A WebElement that can be used to issue
     *     commands against the located element. If the element is not found, the
     *     element will be invalidated and all scheduled commands aborted.
     */
    findElement(locator: Locator): WebElementPromise;

    /**
     * Schedules a command to find all of the descendants of this element that
     * match the given search criteria.
     *
     * @param {!(Locator|By.Hash|Function)} locator The
     *     locator strategy to use when searching for the elements.
     * @return {!Promise.<!Array.<!WebElement>>} A
     *     promise that will resolve to an array of WebElements.
     */
    findElements(locator: Locator): Promise<WebElement[]>;
}

/**
 * Defines an object that can be asynchronously serialized to its WebDriver
 * wire representation.
 *
 * @template T
 */
export interface Serializable<T> {
    /**
     * Returns either this instance's serialized represention, if immediately
     * available, or a promise for its serialized representation. This function is
     * conceptually equivalent to objects that have a {@code toJSON()} property,
     * except the serialize() result may be a promise or an object containing a
     * promise (which are not directly JSON friendly).
     *
     * @return {!(T|IThenable.<!T>)} This instance's serialized wire format.
     */
    serialize(): T | Promise<T>;
}

/**
 * Represents a DOM element. WebElements can be found by searching from the
 * document root using a {@link WebDriver} instance, or by searching
 * under another WebElement:
 *
 *     driver.get('http://www.google.com');
 *     var searchForm = driver.findElement(By.tagName('form'));
 *     var searchBox = searchForm.findElement(By.name('q'));
 *     searchBox.sendKeys('webdriver');
 *
 * The WebElement is implemented as a promise for compatibility with the promise
 * API. It will always resolve itself when its internal state has been fully
 * resolved and commands may be issued against the element. This can be used to
 * catch errors when an element cannot be located on the page:
 *
 *     driver.findElement(By.id('not-there')).then(function(element) {
 *       alert('Found an element that was not expected to be there!');
 *     }, function(error) {
 *       alert('The element was not found, as expected');
 *     });
 */
export class WebElement implements Serializable<IWebElementId> {
    /**
     * @param {!WebDriver} driver the parent WebDriver instance for this element.
     * @param {(!IThenable<string>|string)} id The server-assigned opaque ID for
     *     the underlying DOM element.
     */
    constructor(driver: WebDriver, id: Promise<string> | string);

    /**
     * @param {string} id The raw ID.
     * @param {boolean=} opt_noLegacy Whether to exclude the legacy element key.
     * @return {!Object} The element ID for use with WebDriver's wire protocol.
     */
    static buildId(id: string, opt_noLegacy?: boolean): IWebElementId;

    /**
     * Extracts the encoded WebElement ID from the object.
     *
     * @param {?} obj The object to extract the ID from.
     * @return {string} the extracted ID.
     * @throws {TypeError} if the object is not a valid encoded ID.
     */
    static extractId(obj: IWebElementId): string;

    /**
     * @param {?} obj the object to test.
     * @return {boolean} whether the object is a valid encoded WebElement ID.
     */
    static isId(obj: IWebElementId): boolean;

    /**
     * Compares two WebElements for equality.
     *
     * @param {!WebElement} a A WebElement.
     * @param {!WebElement} b A WebElement.
     * @return {!Promise<boolean>} A promise that will be
     *     resolved to whether the two WebElements are equal.
     */
    static equals(a: WebElement, b: WebElement): Promise<boolean>;

    /**
     * @return {!WebDriver} The parent driver for this instance.
     */
    getDriver(): WebDriver;

    /**
     * @return {!Promise<string>} A promise that resolves to
     *     the server-assigned opaque ID assigned to this element.
     */
    getId(): Promise<string>;

    /**
     * Schedule a command to find a descendant of this element. If the element
     * cannot be found, a {@link bot.ErrorCode.NO_SUCH_ELEMENT} result will
     * be returned by the driver. Unlike other commands, this error cannot be
     * suppressed. In other words, scheduling a command to find an element doubles
     * as an assert that the element is present on the page. To test whether an
     * element is present on the page, use {@link #findElements}.
     *
     * The search criteria for an element may be defined using one of the
     * factories in the {@link By} namespace, or as a short-hand
     * {@link By.Hash} object. For example, the following two statements
     * are equivalent:
     *
     *     var e1 = element.findElement(By.id('foo'));
     *     var e2 = element.findElement({id:'foo'});
     *
     * You may also provide a custom locator function, which takes as input
     * this WebDriver instance and returns a {@link WebElement}, or a
     * promise that will resolve to a WebElement. For example, to find the first
     * visible link on a page, you could write:
     *
     *     var link = element.findElement(firstVisibleLink);
     *
     *     function firstVisibleLink(element) {
     *       var links = element.findElements(By.tagName('a'));
     *       return promise.filter(links, function(link) {
     *         return links.isDisplayed();
     *       }).then(function(visibleLinks) {
     *         return visibleLinks[0];
     *       });
     *     }
     *
     * @param {!(by.By|Function)} locator The locator strategy to use when
     *     searching for the element.
     * @return {!WebElementPromise} A WebElement that can be used to issue
     *     commands against the located element. If the el