@types/selenium-webdriver - npm Package Compare versions

Comparing version 4.0.5 to 4.0.6

selenium-webdriver/lib/capabilities.d.ts

+import Symbols from './symbols';
+import { logging, ProxyConfig } from '../';
+
+/**
+ * Recognized browser names.
+ * @enum {string}
+ */
+export interface IBrowser {
+  CHROME: string;
+  EDGE: string;
+  FIREFOX: string;
+  IE: string;
+  INTERNET_EXPLORER: string;
+  SAFARI: string;
+}
+
+/**
+ * Instace of
+ */
+export const Browser: IBrowser;
+
+/**
+ * Common platform names. These platforms are not explicitly defined by the
+ * WebDriver spec, however, their use is encouraged for interoperability.
+ *
+ * @enum {string}
+ * @see <https://w3c.github.io/webdriver/webdriver-spec.html>
+ */
+export interface IPlatform {
+  LINUX: string;
+  MAC: string;
+  WINDOWS: string;
+}
+
+export const Platform: IPlatform;
+
+/**
+ * Strategies for waiting for [document readiness] after a navigation event.
+ *
+ * [document readiness]: https://html.spec.whatwg.org/#current-document-readiness
+ *
+ * @enum {string}
+ */
+export interface IPageLoadStrategy {
+  /**
+   * Indicates WebDriver should not wait on the document readiness state after a
+   * navigation event.
+   */
+  NONE: string;
+
+  /**
+   * Indicates WebDriver should wait for the document readiness state to
+   * become "interactive" after navigation.
+   */
+  EAGER: string;
+
+  /**
+   * Indicates WebDriver should wait for the document readiness state to
+   * be "complete" after navigation. This is the default page loading strategy.
+   */
+  NORMAL: string;
+}
+
+export const PageLoadStrategy: IPageLoadStrategy;
+
+/**
+ * The possible default actions a WebDriver session can take to respond to
+ * unhandled user prompts (`window.alert()`, `window.confirm()`, and
+ * `window.prompt()`).
+ *
+ * @enum {string}
+ */
+export interface IUserPromptHandler {
+  /** All prompts should be silently accepted. */
+  ACCEPT: string;
+  /** All prompts should be silently dismissed. */
+  DISMISS: string;
+  /**
+   * All prompts should be automatically accepted, but an error should be
+   * returned to the next (or currently executing) WebDriver command.
+   */
+  ACCEPT_AND_NOTIFY: string;
+  /**
+   * All prompts should be automatically dismissed, but an error should be
+   * returned to the next (or currently executing) WebDriver command.
+   */
+  DISMISS_AND_NOTIFY: string;
+  /** All prompts should be left unhandled. */
+  IGNORE: string;
+}
+
+export const UserPromptHandler: IUserPromptHandler;
+
+/**
+ * Common webdriver capability keys.
+ * @enum {string}
+ */
+export interface ICapability {
+  /**
+   * Indicates whether a WebDriver session implicitly trusts otherwise untrusted
+   * and self-signed TLS certificates during navigation.
+   */
+  ACCEPT_INSECURE_TLS_CERTS: string;
+
+  /**
+   * The browser name. Common browser names are defined in the
+   * {@link ./capabilities.Browser Browser} enum.
+   */
+  BROWSER_NAME: string;
+
+  /** Identifies the browser version. */
+  BROWSER_VERSION: string;
+
+  /**
+   * Key for the logging driver logging preferences.
+   */
+  LOGGING_PREFS: string;
+
+  /**
+   * Defines the session's
+   * {@linkplain ./capabilities.PageLoadStrategy page loading strategy}.
+   */
+  PAGE_LOAD_STRATEGY: string;
+
+  /**
+   * Identifies the operating system of the endpoint node. Common values
+   * recognized by the most WebDriver server implementations are predefined in
+   * the {@link ./capabilities.Platform Platform} enum.
+   */
+  PLATFORM_NAME: string;
+
+  /**
+   * Describes the proxy configuration to use for a new WebDriver session.
+   */
+  PROXY: string;
+
+  /**
+   * Indicates whether the remote end supports all of the window resizing and
+   * positioning commands:
+   *
+   * -  {@linkplain ./webdriver.Window#getRect Window.getRect()}
+   * -  {@linkplain ./webdriver.Window#setRect Window.setRect()}
+   * -  {@linkplain ./webdriver.Window#maximize Window.maximize()}
+   * -  {@linkplain ./webdriver.Window#minimize Window.minimize()}
+   * -  {@linkplain ./webdriver.Window#fullscreen Window.fullscreen()}
+   */
+  SET_WINDOW_RECT: string;
+
+  /**
+   * Describes the {@linkplain ./capabilities.Timeouts timeouts} imposed on
+   * certain session operations.
+   */
+  TIMEOUTS: string;
+
+  /**
+   * Defines how a WebDriver session should
+   * {@linkplain ./capabilities.UserPromptHandler respond} to unhandled user
+   * prompts.
+   */
+  UNHANDLED_PROMPT_BEHAVIOR: string;
+}
+
+/**
+ * The standard WebDriver capability keys.
+ */
+export const Capability: ICapability;
+
+/**
+ * Describes a set of capabilities for a WebDriver session.
+ */
+export class Capabilities {
+  // region Constructors
+
+  /**
+   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
+   *     capabilities to initialize this instance from.
+   */
+  constructor(other?: Capabilities|Map<string, any>|{});
+
+  // endregion
+
+  // region Static Methods
+
+  /**
+   * @return {!Capabilities} A basic set of capabilities for Chrome.
+   */
+  static chrome(): Capabilities;
+
+  /**
+   * @return {!Capabilities} A basic set of capabilities for Microsoft Edge.
+   */
+  static edge(): Capabilities;
+
+  /**
+   * @return {!Capabilities} A basic set of capabilities for Firefox.
+   */
+  static firefox(): Capabilities;
+
+  /**
+   * @return {!Capabilities} A basic set of capabilities for
+   *     Internet Explorer.
+   */
+  static ie(): Capabilities;
+
+  /**
+   * @return {!Capabilities} A basic set of capabilities for Safari.
+   */
+  static safari(): Capabilities;
+
+  // endregion
+
+  // region Methods
+
+  /**
+   * @return {!Object<string, ?>} The JSON representation of this instance.
+   *     Note, the returned object may contain nested promised values.
+   * @suppress {checkTypes} Suppress [] access on a struct (state inherited from
+   *     Map).
+   */
+  [Symbols.serialize](): {}
+
+  /**
+   * @param {string} key The capability to return.
+   * @return {*} The capability with the given key, or {@code null} if it has
+   *     not been set.
+   */
+  get(key: string): any;
+
+  /**
+   * @param {string} key The capability to check.
+   * @return {boolean} Whether the specified capability is set.
+   */
+  has(key: string): boolean;
+
+  /**
+   * @return {!Iterator<string>} an iterator of the keys set.
+   */
+  keys(): IterableIterator<string>;
+
+  /**
+   * Merges another set of capabilities into this instance.
+   * @param {!(Capabilities|Map<String, ?>|Object<string, ?>)} other The other
+   *     set of capabilities to merge.
+   * @return {!Capabilities} A self reference.
+   */
+  merge(other: Capabilities|Map<string, any>|{}): Capabilities;
+
+  /**
+   * Deletes an entry from this set of capabilities.
+   *
+   * @param {string} key the capability key to delete.
+   */
+  delete(key: string): boolean;
+
+  /**
+   * @param {string} key The capability key.
+   * @param {*} value The capability value.
+   * @return {!Capabilities} A self reference.
+   * @throws {TypeError} If the `key` is not a string.
+   */
+  set(key: string, value: any): Capabilities;
+
+  /**
+   * Sets whether a WebDriver session should implicitly accept self-signed, or
+   * other untrusted TLS certificates on navigation.
+   *
+   * @param {boolean} accept whether to accept insecure certs.
+   * @return {!Capabilities} a self reference.
+   */
+  setAcceptInsecureCerts(accept: boolean): Capabilities;
+
+  /**
+   * @return {boolean} whether the session is configured to accept insecure
+   *     TLS certificates.
+   */
+  getAcceptInsecureCerts(): boolean;
+
+  /**
+   * Sets the name of the target browser.
+   *
+   * @param {(Browser|string)} name the browser name.
+   * @return {!Capabilities} a self reference.
+   */
+  setBrowserName(name: string): Capabilities;
+
+  /**
+   * @return {(string|undefined)} the configured browser name, or undefined if
+   *     not set.
+   */
+  getBrowserName(): string|undefined;
+
+  /**
+   * Sets the desired version of the target browser.
+   *
+   * @param {string} version the desired version.
+   * @return {!Capabilities} a self reference.
+   */
+  setBrowserVersion(version: string): Capabilities;
+
+  /**
+   * @return {(string|undefined)} the configured browser version, or undefined
+   *     if not set.
+   */
+  getBrowserVersion(): string|undefined;
+
+  /**
+   * Sets the desired page loading strategy for a new WebDriver session.
+   *
+   * @param {PageLoadStrategy} strategy the desired strategy.
+   * @return {!Capabilities} a self reference.
+   */
+  setPageLoadStrategy(strategy: string): Capabilities;
+
+  /**
+   * Returns the configured page load strategy.
+   *
+   * @return {(string|undefined)} the page load strategy.
+   */
+  getPageLoadStrategy(): string|undefined;
+
+  /**
+   * Sets the target platform.
+   *
+   * @param {(Platform|string)} platform the target platform.
+   * @return {!Capabilities} a self reference.
+   */
+  setPlatform(platform: string): Capabilities;
+
+  /**
+   * @return {(string|undefined)} the configured platform or undefined if not
+   *     set.
+   */
+  getPlatform(): string|undefined;
+
+  /**
+   * Sets the logging preferences. Preferences may be specified as a
+   * {@link ./logging.Preferences} instance, or as a map of log-type to
+   * log-level.
+   * @param {!(./logging.Preferences|Object<string>)} prefs The logging
+   *     preferences.
+   * @return {!Capabilities} A self reference.
+   */
+  setLoggingPrefs(prefs: logging.Preferences|{}): Capabilities;
+
+  /**
+   * Sets the proxy configuration for this instance.
+   * @param {proxy.Config} proxy The desired proxy configuration.
+   * @return {!Capabilities} A self reference.
+   */
+  setProxy(proxy: ProxyConfig): Capabilities;
+
+  /**
+   * @return {(proxy.Config|undefined)} the configured proxy settings, or
+   *     undefined if not set.
+   */
+  getProxy(): ProxyConfig|undefined;
+
+  /**
+   * Sets the default action to take with an unexpected alert before returning
+   * an error. If unspecified, WebDriver will default to
+   * {@link UserPromptHandler.DISMISS_AND_NOTIFY}.
+   *
+   * @param {?UserPromptHandler} behavior The way WebDriver should respond to
+   *     unhandled user prompts.
+   * @return {!Capabilities} A self reference.
+   */
+  setAlertBehavior(behavior: string): Capabilities;
+
+  /**
+   * @return {(UserPromptHandler|undefined)} the behavior pattern for responding
+   *     to unhandled user prompts, or undefined if not set.
+   */
+  getAlertBehavior(): string|undefined;
+
+  // endregion
+}
+
+export interface ITimeouts {
+  /**
+   * Defines when, in milliseconds, to interrupt a script that is being
+   * {@linkplain ./webdriver.IWebDriver#executeScript evaluated}.
+   */
+  script?: number;
+
+  /**
+   * The timeout, in milliseconds, to apply to navigation events along with the
+   * {@link PageLoadStrategy}.
+   */
+  pageLoad?: number;
+
+  /**
+   * The maximum amount of time, in milliseconds, to spend attempting to
+   * {@linkplain ./webdriver.IWebDriver#findElement locate} an element on the
+   * current page.
+   */
+  implicit?: number;
+}

selenium-webdriver/lib/symbols.d.ts

+export interface ISymbols {
+  /**
+   * The serialize symbol specifies a method that returns an object's serialized
+   * representation. If an object's serialized form is not immediately
+   * available, the serialize method will return a promise that will be resolved
+   * with the serialized form.
+   *
+   * Note that the described method is analogous to objects that define a
+   * `toJSON()` method, except the serialized result may be a promise, or
+   * another object with a promised property.
+   */
+  readonly serialize: unique symbol;
+}
+
+declare const Symbols: ISymbols;
+export default Symbols;

selenium-webdriver/edge.d.ts

@@ -28,20 +28,4 @@ import * as webdriver from './index';
  */
-export class Options extends webdriver.Capabilities {
-  /**
-   * Sets the proxy settings for the new session.
-   * @param {capabilities.ProxyConfig} proxy The proxy configuration to use.
-   * @return {!Options} A self reference.
-   */
-  setProxy(proxy: webdriver.ProxyConfig): Options;
+export class Options extends webdriver.Capabilities {}
 
-  /**
-   * Sets the page load strategy for Edge.
-   * Supported values are 'normal', 'eager', and 'none';
-   *
-   * @param {string} pageLoadStrategy The page load strategy to use.
-   * @return {!Options} A self reference.
-   */
-  setPageLoadStrategy(pageLoadStrategy: string): Options;
-}
-
 /**
@@ -48,0 +32,0 @@ * Creates {@link remote.DriverService} instances that manage a

selenium-webdriver/package.json

 {
     "name": "@types/selenium-webdriver",
-    "version": "4.0.5",
+    "version": "4.0.6",
     "description": "TypeScript definitions for Selenium WebDriverJS",
@@ -54,3 +54,3 @@ "license": "MIT",
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
@@ -63,4 +63,4 @@ "type": "git",
     "dependencies": {},
-    "typesPublisherContentHash": "2ffbc30fe02c8fc600cc2a41d32813fd3afca846dc8284f894d95d527db5d17b",
-    "typeScriptVersion": "2.4"
+    "typesPublisherContentHash": "fddb6ab9a0f4573caa171248f5f7da1a181c9778e35259c5f9d4f366e04e53aa",
+    "typeScriptVersion": "2.8"
 }

selenium-webdriver/README.md

@@ -8,6 +8,6 @@ # Installation
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/selenium-webdriver
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/selenium-webdriver.
 
-Additional Details
- * Last updated: Mon, 14 Oct 2019 23:34:59 GMT
+### Additional Details
+ * Last updated: Mon, 16 Dec 2019 11:34:48 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Bill Armstrong <https://github.com/BillArmstrong>, Yuki Kokubun <https://github.com/Kuniwak>, Craig Nishina <https://github.com/cnishina>, Simon Gellis <https://github.com/SupernaviX>, Ben Dixon <https://github.com/bendxn>, Ziyu <https://github.com/oddui>, Johann Wolf <https://github.com/beta-vulgaris>, Aleksey Chemakin <https://github.com/Dzenly>, and thislooksfun <https://github.com/thislooksfun>.
+These definitions were written by Bill Armstrong (https://github.com/BillArmstrong), Yuki Kokubun (https://github.com/Kuniwak), Craig Nishina (https://github.com/cnishina), Simon Gellis (https://github.com/SupernaviX), Ben Dixon (https://github.com/bendxn), Ziyu (https://github.com/oddui), Johann Wolf (https://github.com/beta-vulgaris), Aleksey Chemakin (https://github.com/Dzenly), and thislooksfun (https://github.com/thislooksfun).

selenium-webdriver/safari.d.ts

@@ -38,7 +38,9 @@ import * as webdriver from './index';
   /**
-   * Sets the logging preferences for the new session.
-   * @param {!./lib/logging.Preferences} prefs The logging preferences.
+   * Instruct the SafariDriver to use the Safari Technology Preview if true.
+   * Otherwise, use the release version of Safari. Defaults to using the release version of Safari.
+   *
+   * @param {boolean} useTechnologyPreview
    * @return {!Options} A self reference.
    */
-  setLoggingPrefs(prefs: webdriver.logging.Preferences): Options;
+  setTechnologyPreview(useTechnologyPreview: boolean): Options;
 }
@@ -45,0 +47,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

198652

0.77%

Number of package files

18

12.5%

Lines of code

5174

1.25%

Worsened metrics

Number of low supply chain risk alerts

29

3.57%

No dependency changes