@appium/types 1.0.0-rc.1 → 1.0.1

package/build/lib/commands/mjsonwp.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Interface for all MJSONWP commands proxied to the external driver.
+ */
+export interface IMJSONWPCommands<Ctx = string> {
+    /**
+     * Get the currently active context
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
+     *
+     * @returns The context name
+     */
+    getCurrentContext?(): Promise<Ctx | null>;
+    /**
+     * Switch to a context by name
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
+     *
+     * @param name - the context name
+     */
+    setContext?(name: string, ...args: any[]): Promise<void>;
+    /**
+     * Get the list of available contexts
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
+     *
+     * @returns The list of context names
+     */
+    getContexts?(): Promise<Ctx[]>;
+    /**
+     * Get the network connection state of a device
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}
+     *
+     * @returns A number which is a bitmask representing categories like Data, Wifi, and Airplane
+     * mode status
+     */
+    getNetworkConnection?(): Promise<number>;
+    /**
+     * Set the network connection of the device
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}
+     *
+     * @param type - the bitmask representing network state
+     * @returns A number which is a bitmask representing categories like Data, Wifi, and Airplane
+     * mode status
+     */
+    setNetworkConnection?(type: number): Promise<number>;
+    /**
+     * Get the current rotation state of the device
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation}
+     *
+     * @returns The Rotation object consisting of x, y, and z rotation values (0 <= n <= 360)
+     */
+    getRotation?(): Promise<Rotation>;
+    /**
+     * Set the device rotation state
+     * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation}
+     *
+     * @param x - the degree to which the device is rotated around the x axis (0 <= x <= 360)
+     * @param y - the degree to which the device is rotated around the y axis (0 <= y <= 360)
+     * @param z - the degree to which the device is rotated around the z axis (0 <= z <= 360)
+     */
+    setRotation?(x: number, y: number, z: number): Promise<void>;
+}
+export interface Rotation {
+    x: number;
+    y: number;
+    z: number;
+}
+//# sourceMappingURL=mjsonwp.d.ts.map

package/build/lib/commands/mjsonwp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mjsonwp.d.ts","sourceRoot":"","sources":["../../../lib/commands/mjsonwp.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG,GAAG,MAAM;IAC5C;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAE/B;;;;;;OAMG;IACH,oBAAoB,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,oBAAoB,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAErD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX"}

package/build/lib/commands/mjsonwp.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mjsonwp.js.map

package/build/lib/commands/mjsonwp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mjsonwp.js","sourceRoot":"","sources":["../../../lib/commands/mjsonwp.ts"],"names":[],"mappings":""}

package/build/lib/commands/other-protocols.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Interface for all WebDriver extension commands from other protocols proxied to the external driver.
+ */
+export interface IOtherProtocolCommands {
+    /**
+     * Execute a devtools command
+     *
+     * @param cmd - the command
+     * @param params - any command-specific command parameters
+     *
+     * @returns The result of the command execution
+     */
+    executeCdp?(cmd: string, params: unknown): Promise<unknown>;
+    /**
+     * Add a virtual authenticator to a browser
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator}
+     *
+     * @param protocol  - the protocol
+     * @param transport - a valid AuthenticatorTransport value
+     * @param hasResidentKey - whether there is a resident key
+     * @param hasUserVerification - whether the authenticator has user verification
+     * @param isUserConsenting - whether it is a user consenting authenticator
+     * @param isUserVerified - whether the user is verified
+     *
+     * @returns The authenticator ID
+     */
+    addVirtualAuthenticator?(protocol: 'ctap/u2f' | 'ctap2' | 'ctap2_1', transport: string, hasResidentKey?: boolean, hasUserVerification?: boolean, isUserConsenting?: boolean, isUserVerified?: boolean): Promise<string>;
+    /**
+     * Remove a virtual authenticator
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator}
+     *
+     * @param authenticatorId - the ID returned in the call to add the authenticator
+     */
+    removeVirtualAuthenticator?(authenticatorId: string): Promise<void>;
+    /**
+     * Inject a public key credential source into a virtual authenticator
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential}
+     *
+     * @param credentialId - the base64 encoded credential ID
+     * @param isResidentCredential - if true, a client-side credential, otherwise a server-side
+     * credential
+     * @param rpId - the relying party ID the credential is scoped to
+     * @param privateKey - the base64 encoded private key package
+     * @param userHandle - the base64 encoded user handle
+     * @param signCount - the initial value for a signature counter
+     */
+    addAuthCredential?(credentialId: string, isResidentCredential: boolean, rpId: string, privateKey: string, userHandle: string, signCount: number, authenticatorId: string): Promise<void>;
+    /**
+     * Get the list of public key credential sources
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials}
+     *
+     * @returns The list of Credentials
+     */
+    getAuthCredential?(): Promise<Credential[]>;
+    /**
+     * Remove all auth credentials
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials}
+     */
+    removeAllAuthCredentials?(): Promise<void>;
+    /**
+     * Remove a specific auth credential
+     *
+     * @param credentialId - the credential ID
+     * @param authenticatorId - the authenticator ID
+     */
+    removeAuthCredential?(credentialId: string, authenticatorId: string): Promise<void>;
+    /**
+     * Set the isUserVerified property of an authenticator
+     * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified}
+     *
+     * @param isUserVerified - the value of the isUserVerified property
+     * @param authenticatorId - the authenticator id
+     */
+    setUserAuthVerified?(isUserVerified: boolean, authenticatorId: string): Promise<void>;
+}
+export interface Credential {
+    credentialId: string;
+    isResidentCredential: boolean;
+    rpId: string;
+    privateKey: string;
+    userHandle?: string;
+    signCount: number;
+    largeBlob?: string;
+}
+//# sourceMappingURL=other-protocols.d.ts.map

package/build/lib/commands/other-protocols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"other-protocols.d.ts","sourceRoot":"","sources":["../../../lib/commands/other-protocols.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IAGrC;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAI5D;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,CACtB,QAAQ,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,EAC1C,SAAS,EAAE,MAAM,EACjB,cAAc,CAAC,EAAE,OAAO,EACxB,mBAAmB,CAAC,EAAE,OAAO,EAC7B,gBAAgB,CAAC,EAAE,OAAO,EAC1B,cAAc,CAAC,EAAE,OAAO,GACvB,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnB;;;;;OAKG;IACH,0BAA0B,CAAC,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,CAChB,YAAY,EAAE,MAAM,EACpB,oBAAoB,EAAE,OAAO,EAC7B,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAE5C;;;OAGG;IACH,wBAAwB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;OAKG;IACH,oBAAoB,CAAC,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpF;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvF;AAID,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/build/lib/commands/other-protocols.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=other-protocols.js.map

package/build/lib/commands/other-protocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"other-protocols.js","sourceRoot":"","sources":["../../../lib/commands/other-protocols.ts"],"names":[],"mappings":""}

package/build/lib/commands/webdriver.d.ts

@@ -0,0 +1,418 @@
+import type { ActionSequence } from '../action';
+import type { Element } from '../util';
+/**
+ * Interface for all standard WebDriver Classic commands proxied to the external driver.
+ */
+export interface IWDClassicCommands {
+    /**
+     * Navigate to a given url
+     * @see {@link https://w3c.github.io/webdriver/#navigate-to}
+     *
+     * @param url - the url
+     */
+    setUrl?(url: string): Promise<void>;
+    /**
+     * Get the current url
+     * @see {@link https://w3c.github.io/webdriver/#get-current-url}
+     *
+     * @returns The url
+     */
+    getUrl?(): Promise<string>;
+    /**
+     * Navigate back in the page history
+     * @see {@link https://w3c.github.io/webdriver/#back}
+     */
+    back?(): Promise<void>;
+    /**
+     * Navigate forward in the page history
+     * @see {@link https://w3c.github.io/webdriver/#forward}
+     */
+    forward?(): Promise<void>;
+    /**
+     * Refresh the page
+     * @see {@link https://w3c.github.io/webdriver/#refresh}
+     */
+    refresh?(): Promise<void>;
+    /**
+     * Get the current page title
+     * @see {@link https://w3c.github.io/webdriver/#get-title}
+     *
+     * @returns The title
+     *
+     * @example
+     * ```js
+     * await driver.getTitle()
+     * ```
+     * ```py
+     * driver.title
+     * ```
+     * ```java
+     * driver.getTitle();
+     * ```
+     */
+    title?(): Promise<string>;
+    /**
+     * Get the handle (id) associated with the current browser window
+     * @see {@link https://w3c.github.io/webdriver/#get-window-handle}
+     *
+     * @returns The handle string
+     */
+    getWindowHandle?(): Promise<string>;
+    /**
+     * Close the current browsing context (window)
+     * @see {@link https://w3c.github.io/webdriver/#close-window}
+     *
+     * @returns An array of window handles representing currently-open windows
+     */
+    closeWindow?(): Promise<string[]>;
+    /**
+     * Switch to a specified window
+     * @see {@link https://w3c.github.io/webdriver/#switch-to-window}
+     *
+     * @param handle - the window handle of the window to make active
+     */
+    setWindow?(handle: string): Promise<void>;
+    /**
+     * Get a set of handles representing open browser windows
+     * @see {@link https://w3c.github.io/webdriver/#get-window-handles}
+     *
+     * @returns An array of window handles representing currently-open windows
+     */
+    getWindowHandles?(): Promise<string[]>;
+    /**
+     * Create a new browser window
+     * @see {@link https://w3c.github.io/webdriver/#new-window}
+     *
+     * @param type - a hint to the driver whether to create a "tab" or "window"
+     *
+     * @returns An object containing the handle of the newly created window and its type
+     */
+    createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
+    /**
+     * Switch the current browsing context to a frame
+     * @see {@link https://w3c.github.io/webdriver/#switch-to-frame}
+     *
+     * @param id - the frame id, index, or `null` (indicating the top-level context)
+     */
+    setFrame?(id: null | number | string): Promise<void>;
+    /**
+     * Set the current browsing context to the parent of the current context
+     * @see {@link https://w3c.github.io/webdriver/#switch-to-parent-frame}
+     */
+    switchToParentFrame?(): Promise<void>;
+    /**
+     * Get the size and position of the current window
+     * @see {@link https://w3c.github.io/webdriver/#get-window-rect}
+     *
+     * @returns A `Rect` JSON object with x, y, width, and height properties
+     */
+    getWindowRect?(): Promise<Rect>;
+    /**
+     * Set the current window's size and position
+     * @see {@link https://w3c.github.io/webdriver/#set-window-rect}
+     *
+     * @param x - the screen coordinate for the new left edge of the window
+     * @param y - the screen coordinate for the new top edge of the window
+     * @param width - the width in pixels to resize the window to
+     * @param height - the height in pixels to resize the window to
+     *
+     * @returns The actual `Rect` of the window after running the command
+     */
+    setWindowRect?(x: number, y: number, width: number, height: number): Promise<Rect>;
+    /**
+     * Run the window-manager specific 'maximize' operation on the current window
+     * @see {@link https://w3c.github.io/webdriver/#maximize-window}
+     *
+     * @returns The actual `Rect` of the window after running the command
+     */
+    maximizeWindow?(): Promise<Rect>;
+    /**
+     * Run the window-manager specific 'minimize' operation on the current window
+     * @see {@link https://w3c.github.io/webdriver/#minimize-window}
+     *
+     * @returns The actual `Rect` of the window after running the command
+     */
+    minimizeWindow?(): Promise<Rect>;
+    /**
+     * Put the current window into full screen mode
+     * @see {@link https://w3c.github.io/webdriver/#fullscreen-window}
+     *
+     * @returns The actual `Rect` of the window after running the command
+     */
+    fullScreenWindow?(): Promise<Rect>;
+    /**
+     * Get the active element
+     * @see {@link https://w3c.github.io/webdriver/#get-active-element}
+     *
+     * @returns The JSON object encapsulating the active element reference
+     */
+    active?(): Promise<Element>;
+    /**
+     * Get the shadow root of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-element-shadow-root}
+     *
+     * @param elementId - the id of the element to retrieve the shadow root for
+     *
+     * @returns The shadow root for an element, as an element
+     */
+    elementShadowRoot?(elementId: string): Promise<Element>;
+    /**
+     * Determine if the reference element is selected or not
+     * @see {@link https://w3c.github.io/webdriver/#is-element-selected}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns True if the element is selected, False otherwise
+     */
+    elementSelected?(elementId: string): Promise<boolean>;
+    /**
+     * Retrieve the value of an element's attribute
+     * @see {@link https://w3c.github.io/webdriver/#get-element-attribute}
+     *
+     * @param name - the attribute name
+     * @param elementId - the id of the element
+     *
+     * @returns The attribute value
+     */
+    getAttribute?(name: string, elementId: string): Promise<string | null>;
+    /**
+     * Retrieve the value of a named property of an element's JS object
+     * @see {@link https://w3c.github.io/webdriver/#get-element-property}
+     *
+     * @param name - the object property name
+     * @param elementId - the id of the element
+     *
+     * @returns The property value
+     */
+    getProperty?(name: string, elementId: string): Promise<string | null>;
+    /**
+     * Retrieve the value of a CSS property of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-element-css-value}
+     *
+     * @param name - the CSS property name
+     * @param elementId - the id of the element
+     *
+     * @returns The property value
+     */
+    getCssProperty?(name: string, elementId: string): Promise<string>;
+    /**
+     * Get the text of an element as rendered
+     * @see {@link https://w3c.github.io/webdriver/#get-element-text}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns The text rendered for the element
+     */
+    getText?(elementId: string): Promise<string>;
+    /**
+     * Get the tag name of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-element-tag-name}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns The tag name
+     */
+    getName?(elementId: string): Promise<string>;
+    /**
+     * Get the dimensions and position of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-element-rect}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns The Rect object containing x, y, width, and height properties
+     */
+    getElementRect?(elementId: string): Promise<Rect>;
+    /**
+     * Determine whether an element is enabled
+     * @see {@link https://w3c.github.io/webdriver/#is-element-enabled}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns True if the element is enabled, False otherwise
+     */
+    elementEnabled?(elementId: string): Promise<boolean>;
+    /**
+     * Get the WAI-ARIA role of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-computed-role}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns The role
+     */
+    getComputedRole?(elementId: string): Promise<string | null>;
+    /**
+     * Get the accessible name/label of an element
+     * @see {@link https://w3c.github.io/webdriver/#get-computed-label}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns The accessible name
+     */
+    getComputedLabel?(elementId: string): Promise<string | null>;
+    /**
+     * Determine whether an element is displayed
+     * @see {@link https://w3c.github.io/webdriver/#element-displayedness}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns True if any part of the element is rendered within the viewport, False otherwise
+     */
+    elementDisplayed?(elementId: string): Promise<boolean>;
+    /**
+     * Click/tap an element
+     * @see {@link https://w3c.github.io/webdriver/#element-click}
+     *
+     * @param elementId - the id of the element
+     */
+    click?(elementId: string): Promise<void>;
+    /**
+     * Clear the text/value of an editable element
+     * @see {@link https://w3c.github.io/webdriver/#element-clear}
+     *
+     * @param elementId - the id of the element
+     */
+    clear?(elementId: string): Promise<void>;
+    /**
+     * Send keystrokes to an element (or otherwise set its value)
+     * @see {@link https://w3c.github.io/webdriver/#element-send-keys}
+     *
+     * @param text - the text to send to the element
+     * @param elementId - the id of the element
+     */
+    setValue?(text: string, elementId: string): Promise<void>;
+    /**
+     * Execute JavaScript (or some other kind of script) in the browser/app context
+     * @see {@link https://w3c.github.io/webdriver/#execute-script}
+     *
+     * @param script - the string to be evaluated as the script, which will be made the body of an
+     * anonymous function in the case of JS
+     * @param args - the list of arguments to be applied to the script as a function
+     *
+     * @returns The return value of the script execution
+     */
+    execute?(script: string, args: unknown[]): Promise<unknown>;
+    /**
+     * Execute JavaScript (or some other kind of script) in the browser/app context, asynchronously
+     * @see {@link https://w3c.github.io/webdriver/#execute-async-script}
+     *
+     * @param script - the string to be evaluated as the script, which will be made the body of an
+     * anonymous function in the case of JS
+     * @param args - the list of arguments to be applied to the script as a function
+     *
+     * @returns The promise resolution of the return value of the script execution (or an error
+     * object if the promise is rejected)
+     */
+    executeAsync?(script: string, args: unknown[]): Promise<unknown>;
+    /**
+     * Get all cookies known to the browsing context
+     * @see {@link https://w3c.github.io/webdriver/#get-all-cookies}
+     *
+     * @returns A list of serialized cookies
+     */
+    getCookies?(): Promise<Cookie[]>;
+    /**
+     * Get a cookie by name
+     * @see {@link https://w3c.github.io/webdriver/#get-named-cookie}
+     *
+     * @param name - the name of the cookie
+     *
+     * @returns A serialized cookie
+     */
+    getCookie?(name: string): Promise<Cookie>;
+    /**
+     * Add a cookie to the browsing context
+     * @see {@link https://w3c.github.io/webdriver/#add-cookie}
+     *
+     * @param cookie - the cookie data including properties like name, value, path, domain,
+     * secure, httpOnly, expiry, and samesite
+     */
+    setCookie?(cookie: Cookie): Promise<void>;
+    /**
+     * Delete a named cookie
+     * @see {@link https://w3c.github.io/webdriver/#delete-cookie}
+     *
+     * @param name - the name of the cookie to delete
+     */
+    deleteCookie?(name: string): Promise<void>;
+    /**
+     * Delete all cookies
+     * @see {@link https://w3c.github.io/webdriver/#delete-all-cookies}
+     */
+    deleteCookies?(): Promise<void>;
+    /**
+     * Perform touch or keyboard actions
+     * @see {@link https://w3c.github.io/webdriver/#perform-actions}
+     *
+     * @param actions - the action sequence
+     */
+    performActions?(actions: ActionSequence[]): Promise<void>;
+    /**
+     * Release all keys or buttons that are currently pressed
+     * @see {@link https://w3c.github.io/webdriver/#release-actions}
+     */
+    releaseActions?(): Promise<void>;
+    /**
+     * Dismiss a simple dialog/alert
+     * @see {@link https://w3c.github.io/webdriver/#dismiss-alert}
+     */
+    postDismissAlert?(): Promise<void>;
+    /**
+     * Accept a simple dialog/alert
+     * @see {@link https://w3c.github.io/webdriver/#accept-alert}
+     */
+    postAcceptAlert?(): Promise<void>;
+    /**
+     * Get the text of the displayed alert
+     * @see {@link https://w3c.github.io/webdriver/#get-alert-text}
+     *
+     * @returns The text of the alert
+     */
+    getAlertText?(): Promise<string | null>;
+    /**
+     * Set the text field of an alert prompt
+     * @see {@link https://w3c.github.io/webdriver/#send-alert-text}
+     *
+     * @param text - the text to send to the prompt
+     */
+    setAlertText?(text: string): Promise<void>;
+    /**
+     * Get a screenshot of the current document as rendered
+     * @see {@link https://w3c.github.io/webdriver/#take-screenshot}
+     *
+     * @returns A base64-encoded string representing the PNG image data
+     */
+    getScreenshot?(): Promise<string>;
+    /**
+     * Get an image of a single element as rendered on screen
+     * @see {@link https://w3c.github.io/webdriver/#take-element-screenshot}
+     *
+     * @param elementId - the id of the element
+     *
+     * @returns A base64-encoded string representing the PNG image data for the element rect
+     */
+    getElementScreenshot?(elementId: string): Promise<string>;
+}
+export type NewWindowType = 'tab' | 'window';
+export interface NewWindow {
+    handle: string;
+    type: NewWindowType;
+}
+export interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export type Size = Pick<Rect, 'width' | 'height'>;
+export type Position = Pick<Rect, 'x' | 'y'>;
+export interface Cookie {
+    name: string;
+    value: string;
+    path?: string;
+    domain?: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    expiry?: number;
+    sameSite?: 'Lax' | 'Strict';
+}
+//# sourceMappingURL=webdriver.d.ts.map

package/build/lib/commands/webdriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webdriver.d.ts","sourceRoot":"","sources":["../../../lib/commands/webdriver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,eAAe,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,WAAW,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAElC;;;;;OAKG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;OAGG;IACH,mBAAmB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnF;;;;;OAKG;IACH,cAAc,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,cAAc,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtD;;;;;;;;OAQG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEvE;;;;;;;;OAQG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEtE;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5D;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvD;;;;;OAKG;IACH,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5D;;;;;;;;;;OAUG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;OAGG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;OAGG;IACH,cAAc,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;;;OAKG;IACH,YAAY,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAExC;;;;;OAKG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;OAKG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,oBAAoB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3D;AAED,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE7C,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;CACrB;AAGD,MAAM,WAAW,IAAI;IACnB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC;AAGlD,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;AAE7C,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;CAC7B"}

package/build/lib/commands/webdriver.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=webdriver.js.map

package/build/lib/commands/webdriver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webdriver.js","sourceRoot":"","sources":["../../../lib/commands/webdriver.ts"],"names":[],"mappings":""}

package/build/lib/constraints.d.ts

@@ -1,3 +1,22 @@
+/**
+ * A collection of constraints describing the allowed capabilities for a driver.
+ */
+export type Constraints = {
+    readonly [name: string]: Constraint;
+};
+export interface Constraint {
+    readonly presence?: boolean | Readonly<{
+        allowEmpty: boolean;
+    }>;
+    readonly isString?: boolean;
+    readonly isNumber?: boolean;
+    readonly isBoolean?: boolean;
+    readonly isObject?: boolean;
+    readonly isArray?: boolean;
+    readonly deprecated?: boolean;
+    readonly inclusion?: Readonly<[string, ...string[]]>;
+    readonly inclusionCaseInsensitive?: Readonly<[string, ...string[]]>;
+}
 export declare const BASE_DESIRED_CAP_CONSTRAINTS: {
     readonly platformName: {
         readonly presence: true;

package/build/lib/constraints.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constraints.d.ts","sourceRoot":"","sources":["../../lib/constraints.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDT,CAAC;AAEjC,MAAM,MAAM,wBAAwB,GAAG,OAAO,4BAA4B,CAAC"}
+{"version":3,"file":"constraints.d.ts","sourceRoot":"","sources":["../../lib/constraints.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;CACrC,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,wBAAwB,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;CACrE;AAED,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDT,CAAC;AAEjC,MAAM,MAAM,wBAAwB,GAAG,OAAO,4BAA4B,CAAC"}

package/build/lib/constraints.js.map

@@ -1 +1 @@
-{"version":3,"file":"constraints.js","sourceRoot":"","sources":["../../lib/constraints.ts"],"names":[],"mappings":";;;AAEa,QAAA,4BAA4B,GAAG;IAC1C,YAAY,EAAE;QACZ,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KACf;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,IAAI;KACf;IACD,eAAe,EAAE;QACf,QAAQ,EAAE,IAAI;KACf;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,IAAI;KAChB;IACD,iBAAiB,EAAE;QACjB,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,SAAS,EAAE,IAAI;KAChB;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,SAAS,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;KACrC;IACD,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;KAChB;IACD,OAAO,EAAE;QACP,SAAS,EAAE,IAAI;KAChB;IACD,SAAS,EAAE;QACT,SAAS,EAAE,IAAI;KAChB;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;KACf;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,IAAI;KAChB;IACD,4BAA4B,EAAE;QAC5B,SAAS,EAAE,IAAI;KAChB;CAC6B,CAAC"}
+{"version":3,"file":"constraints.js","sourceRoot":"","sources":["../../lib/constraints.ts"],"names":[],"mappings":";;;AAmBa,QAAA,4BAA4B,GAAG;IAC1C,YAAY,EAAE;QACZ,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KACf;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,IAAI;KACf;IACD,eAAe,EAAE;QACf,QAAQ,EAAE,IAAI;KACf;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,IAAI;KAChB;IACD,iBAAiB,EAAE;QACjB,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,SAAS,EAAE,IAAI;KAChB;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,SAAS,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;KACrC;IACD,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;KAChB;IACD,OAAO,EAAE;QACP,SAAS,EAAE,IAAI;KAChB;IACD,SAAS,EAAE;QACT,SAAS,EAAE,IAAI;KAChB;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;KACf;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,IAAI;KAChB;IACD,4BAA4B,EAAE;QAC5B,SAAS,EAAE,IAAI;KAChB;CAC6B,CAAC"}