[js] Marking those as modules

Author: diemol

javascript/node/selenium-webdriver/chrome.js

@@ -118,13 +118,15 @@
  * [PATH]: http://en.wikipedia.org/wiki/PATH_%28variable%29
  * [android]: https://chromedriver.chromium.org/getting-started/getting-started---android
  * [webview]: https://developer.chrome.com/multidevice/webview/overview
+ *
+ * @module selenium-webdriver/chrome
  */
 
-'use strict'
+"use strict";
 
-const { Browser } = require('./lib/capabilities')
-const chromium = require('./chromium')
-const CHROME_CAPABILITY_KEY = 'goog:chromeOptions'
+const { Browser } = require("./lib/capabilities");
+const chromium = require("./chromium");
+const CHROME_CAPABILITY_KEY = "goog:chromeOptions";
 
 /** @type {remote.DriverService} */
 
@@ -134,104 +136,105 @@ const CHROME_CAPABILITY_KEY = 'goog:chromeOptions'
  * server in a child process.
  */
 class ServiceBuilder extends chromium.ServiceBuilder {
-  /**
-   * @param {string=} opt_exe Path to the server executable to use. If omitted,
-   *     the builder will attempt to locate the chromedriver on the current
-   *     PATH. If the chromedriver is not available in path, selenium-manager will
-   *     download the chromedriver
-   * @throws {Error} If provided executable does not exist, or the chromedriver
-   *     cannot be found on the PATH.
-   */
-  constructor(opt_exe) {
-    super(opt_exe)
-  }
+	/**
+	 * @param {string=} opt_exe Path to the server executable to use. If omitted,
+	 *     the builder will attempt to locate the chromedriver on the current
+	 *     PATH. If the chromedriver is not available in path, selenium-manager will
+	 *     download the chromedriver
+	 * @throws {Error} If provided executable does not exist, or the chromedriver
+	 *     cannot be found on the PATH.
+	 */
+	constructor (opt_exe) {
+		super(opt_exe);
+	}
 }
 
 /**
  * Class for managing ChromeDriver specific options.
  */
 class Options extends chromium.Options {
-  /**
-   * Sets the path to the Chrome binary to use. On Mac OS X, this path should
-   * reference the actual Chrome executable, not just the application binary
-   * (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").
-   *
-   * The binary path be absolute or relative to the chromedriver server
-   * executable, but it must exist on the machine that will launch Chrome.
-   *
-   * @param {string} path The path to the Chrome binary to use.
-   * @return {!Options} A self reference.
-   */
-  setChromeBinaryPath(path) {
-    return this.setBinaryPath(path)
-  }
+	/**
+	 * Sets the path to the Chrome binary to use. On Mac OS X, this path should
+	 * reference the actual Chrome executable, not just the application binary
+	 * (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").
+	 *
+	 * The binary path be absolute or relative to the chromedriver server
+	 * executable, but it must exist on the machine that will launch Chrome.
+	 *
+	 * @param {string} path The path to the Chrome binary to use.
+	 * @return {!Options} A self reference.
+	 */
+	setChromeBinaryPath (path) {
+		return this.setBinaryPath(path);
+	}
 
-  /**
-   * Configures the ChromeDriver to launch Chrome on Android via adb. This
-   * function is shorthand for
-   * {@link #androidPackage options.androidPackage('com.android.chrome')}.
-   * @return {!Options} A self reference.
-   */
-  androidChrome() {
-    return this.androidPackage('com.android.chrome')
-  }
+	/**
+	 * Configures the ChromeDriver to launch Chrome on Android via adb. This
+	 * function is shorthand for
+	 * {@link #androidPackage options.androidPackage('com.android.chrome')}.
+	 * @return {!Options} A self reference.
+	 */
+	androidChrome () {
+		return this.androidPackage("com.android.chrome");
+	}
 
-  /**
-   * Sets the path to Chrome's log file. This path should exist on the machine
-   * that will launch Chrome.
-   * @param {string} path Path to the log file to use.
-   * @return {!Options} A self reference.
-   */
-  setChromeLogFile(path) {
-    return this.setBrowserLogFile(path)
-  }
+	/**
+	 * Sets the path to Chrome's log file. This path should exist on the machine
+	 * that will launch Chrome.
+	 * @param {string} path Path to the log file to use.
+	 * @return {!Options} A self reference.
+	 */
+	setChromeLogFile (path) {
+		return this.setBrowserLogFile(path);
+	}
 
-  /**
-   * Sets the directory to store Chrome minidumps in. This option is only
-   * supported when ChromeDriver is running on Linux.
-   * @param {string} path The directory path.
-   * @return {!Options} A self reference.
-   */
-  setChromeMinidumpPath(path) {
-    return this.setBrowserMinidumpPath(path)
-  }
+	/**
+	 * Sets the directory to store Chrome minidumps in. This option is only
+	 * supported when ChromeDriver is running on Linux.
+	 * @param {string} path The directory path.
+	 * @return {!Options} A self reference.
+	 */
+	setChromeMinidumpPath (path) {
+		return this.setBrowserMinidumpPath(path);
+	}
 }
 
 /**
  * Creates a new WebDriver client for Chrome.
  */
 class Driver extends chromium.Driver {
-  /**
-   * Creates a new session with the ChromeDriver.
-   *
-   * @param {(Capabilities|Options)=} opt_config The configuration options.
-   * @param {(remote.DriverService|http.Executor)=} opt_serviceExecutor Either
-   *     a  DriverService to use for the remote end, or a preconfigured executor
-   *     for an externally managed endpoint. If neither is provided, the
-   *     {@linkplain ##getDefaultService default service} will be used by
-   *     default.
-   * @return {!Driver} A new driver instance.
-   */
-  static createSession(opt_config, opt_serviceExecutor) {
-    let caps = opt_config || new Options()
-    return /** @type {!Driver} */ (super.createSession(caps, opt_serviceExecutor, 'goog', CHROME_CAPABILITY_KEY))
-  }
+	/**
+	 * Creates a new session with the ChromeDriver.
+	 *
+	 * @param {(Capabilities|Options)=} opt_config The configuration options.
+	 * @param {(remote.DriverService|http.Executor)=} opt_serviceExecutor Either
+	 *     a  DriverService to use for the remote end, or a preconfigured executor
+	 *     for an externally managed endpoint. If neither is provided, the
+	 *     {@linkplain ##getDefaultService default service} will be used by
+	 *     default.
+	 * @return {!Driver} A new driver instance.
+	 */
+	static createSession (opt_config, opt_serviceExecutor) {
+		let caps = opt_config || new Options();
+		return /** @type {!Driver} */ (super.createSession(caps,
+			opt_serviceExecutor, "goog", CHROME_CAPABILITY_KEY));
+	}
 
-  /**
-   * returns new instance chrome driver service
-   * @returns {remote.DriverService}
-   */
-  static getDefaultService() {
-    return new ServiceBuilder().build()
-  }
+	/**
+	 * returns new instance chrome driver service
+	 * @returns {remote.DriverService}
+	 */
+	static getDefaultService () {
+		return new ServiceBuilder().build();
+	}
 }
 
-Options.prototype.CAPABILITY_KEY = CHROME_CAPABILITY_KEY
-Options.prototype.BROWSER_NAME_VALUE = Browser.CHROME
+Options.prototype.CAPABILITY_KEY = CHROME_CAPABILITY_KEY;
+Options.prototype.BROWSER_NAME_VALUE = Browser.CHROME;
 
 // PUBLIC API
 module.exports = {
-  Driver,
-  Options,
-  ServiceBuilder,
-}
+	Driver,
+	Options,
+	ServiceBuilder
+};

javascript/node/selenium-webdriver/chromium.js

@@ -73,13 +73,15 @@
  * {@link ./builder.Builder selenium-webdriver.Builder}.
  *
  * [WebDriver (Chromium)]: https://docs.microsoft.com/en-us/microsoft-edge/webdriver-chromium
+ *
+ * @module selenium-webdriver/edge
  */
 
-'use strict'
+"use strict";
 
-const { Browser } = require('./lib/capabilities')
-const chromium = require('./chromium')
-const EDGE_CAPABILITY_KEY = 'ms:edgeOptions'
+const { Browser } = require("./lib/capabilities");
+const chromium = require("./chromium");
+const EDGE_CAPABILITY_KEY = "ms:edgeOptions";
 
 /** @type {remote.DriverService} */
 
@@ -89,90 +91,91 @@ const EDGE_CAPABILITY_KEY = 'ms:edgeOptions'
  * server in a child process.
  */
 class ServiceBuilder extends chromium.ServiceBuilder {
-  /**
-   * @param {string=} opt_exe Path to the server executable to use. If omitted,
-   *     the builder will attempt to locate the msedgedriver on the current
-   *     PATH.
-   * @throws {Error} If provided executable does not exist, or the msedgedriver
-   *     cannot be found on the PATH.
-   */
-  constructor(opt_exe) {
-    super(opt_exe)
-    this.setLoopback(true)
-  }
+	/**
+	 * @param {string=} opt_exe Path to the server executable to use. If omitted,
+	 *     the builder will attempt to locate the msedgedriver on the current
+	 *     PATH.
+	 * @throws {Error} If provided executable does not exist, or the msedgedriver
+	 *     cannot be found on the PATH.
+	 */
+	constructor (opt_exe) {
+		super(opt_exe);
+		this.setLoopback(true);
+	}
 }
 
 /**
  * Class for managing edge chromium specific options.
  */
 class Options extends chromium.Options {
-  /**
-   * Sets the path to the edge binary to use
-   *
-   * The binary path be absolute or relative to the msedgedriver server
-   * executable, but it must exist on the machine that will launch edge chromium.
-   *
-   * @param {string} path The path to the msedgedriver binary to use.
-   * @return {!Options} A self reference.
-   */
-  setEdgeChromiumBinaryPath(path) {
-    return this.setBinaryPath(path)
-  }
+	/**
+	 * Sets the path to the edge binary to use
+	 *
+	 * The binary path be absolute or relative to the msedgedriver server
+	 * executable, but it must exist on the machine that will launch edge chromium.
+	 *
+	 * @param {string} path The path to the msedgedriver binary to use.
+	 * @return {!Options} A self reference.
+	 */
+	setEdgeChromiumBinaryPath (path) {
+		return this.setBinaryPath(path);
+	}
 
-  /**
-   * Changes the browser name to 'webview2' to enable
-   * <a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/how-to/webdriver">
-   *   test automation of WebView2 apps with Microsoft Edge WebDriver
-   * </a>
-   *
-   * @param {boolean} enable  flag to enable or disable the 'webview2' usage
-   */
-  useWebView(enable) {
-    const browserName = enable ? 'webview2' : Browser.EDGE
-    return this.setBrowserName(browserName)
-  }
+	/**
+	 * Changes the browser name to 'webview2' to enable
+	 * <a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/how-to/webdriver">
+	 *   test automation of WebView2 apps with Microsoft Edge WebDriver
+	 * </a>
+	 *
+	 * @param {boolean} enable  flag to enable or disable the 'webview2' usage
+	 */
+	useWebView (enable) {
+		const browserName = enable ? "webview2" : Browser.EDGE;
+		return this.setBrowserName(browserName);
+	}
 }
 
 /**
  * Creates a new WebDriver client for Microsoft's Edge.
  */
 class Driver extends chromium.Driver {
-  /**
-   * Creates a new browser session for Microsoft's Edge browser.
-   *
-   * @param {(Capabilities|Options)=} opt_config The configuration options.
-   * @param {remote.DriverService=} opt_serviceExecutor The service to use; will create
-   *     a new Legacy or Chromium service based on {@linkplain Options} by default.
-   * @return {!Driver} A new driver instance.
-   */
-  static createSession(opt_config, opt_serviceExecutor) {
-    let caps = opt_config || new Options()
-    return /** @type {!Driver} */ (super.createSession(caps, opt_serviceExecutor, 'ms', EDGE_CAPABILITY_KEY))
-  }
+	/**
+	 * Creates a new browser session for Microsoft's Edge browser.
+	 *
+	 * @param {(Capabilities|Options)=} opt_config The configuration options.
+	 * @param {remote.DriverService=} opt_serviceExecutor The service to use; will create
+	 *     a new Legacy or Chromium service based on {@linkplain Options} by default.
+	 * @return {!Driver} A new driver instance.
+	 */
+	static createSession (opt_config, opt_serviceExecutor) {
+		let caps = opt_config || new Options();
+		return /** @type {!Driver} */ (super.createSession(caps,
+			opt_serviceExecutor, "ms", EDGE_CAPABILITY_KEY));
+	}
 
-  /**
-   * returns new instance of edge driver service
-   * @returns {remote.DriverService}
-   */
-  static getDefaultService() {
-    return new ServiceBuilder().build()
-  }
+	/**
+	 * returns new instance of edge driver service
+	 * @returns {remote.DriverService}
+	 */
+	static getDefaultService () {
+		return new ServiceBuilder().build();
+	}
 
-  /**
-   * This function is a no-op as file detectors are not supported by this
-   * implementation.
-   * @override
-   */
-  setFileDetector() {}
+	/**
+	 * This function is a no-op as file detectors are not supported by this
+	 * implementation.
+	 * @override
+	 */
+	setFileDetector () {}
 }
 
-Options.prototype.BROWSER_NAME_VALUE = Browser.EDGE
-Options.prototype.CAPABILITY_KEY = EDGE_CAPABILITY_KEY
+Options.prototype.BROWSER_NAME_VALUE = Browser.EDGE;
+Options.prototype.CAPABILITY_KEY = EDGE_CAPABILITY_KEY;
 
 // PUBLIC API
 
 module.exports = {
-  Driver,
-  Options,
-  ServiceBuilder,
-}
+	Driver,
+	Options,
+	ServiceBuilder
+};

javascript/node/selenium-webdriver/edge.js

@@ -17,15 +17,17 @@
 
 /**
  * @fileoverview Defines a WebDriver client for Safari.
+ *
+ * @module selenium-webdriver/safari
  */
 
-'use strict'
+"use strict";
 
-const http = require('./http')
-const remote = require('./remote')
-const webdriver = require('./lib/webdriver')
-const { Browser, Capabilities } = require('./lib/capabilities')
-const { getBinaryPaths } = require('./common/driverFinder')
+const http = require("./http");
+const remote = require("./remote");
+const webdriver = require("./lib/webdriver");
+const { Browser, Capabilities } = require("./lib/capabilities");
+const { getBinaryPaths } = require("./common/driverFinder");
 
 /**
  * Creates {@link remote.DriverService} instances that manage
@@ -34,68 +36,68 @@ const { getBinaryPaths } = require('./common/driverFinder')
  * [safaridriver]: https://developer.apple.com/library/prerelease/content/releasenotes/General/WhatsNewInSafari/Articles/Safari_10_0.html#//apple_ref/doc/uid/TP40014305-CH11-DontLinkElementID_28
  */
 class ServiceBuilder extends remote.DriverService.Builder {
-  /**
-   * @param {string=} opt_exe Path to the server executable to use. If omitted,
-   *     the builder will attempt to locate the safaridriver on the system PATH.
-   */
-  constructor(opt_exe) {
-    super(opt_exe)
-    this.setLoopback(true) // Required.
-  }
+	/**
+	 * @param {string=} opt_exe Path to the server executable to use. If omitted,
+	 *     the builder will attempt to locate the safaridriver on the system PATH.
+	 */
+	constructor (opt_exe) {
+		super(opt_exe);
+		this.setLoopback(true); // Required.
+	}
 }
 
-const OPTIONS_CAPABILITY_KEY = 'safari:options'
-const TECHNOLOGY_PREVIEW_OPTIONS_KEY = 'technologyPreview'
+const OPTIONS_CAPABILITY_KEY = "safari:options";
+const TECHNOLOGY_PREVIEW_OPTIONS_KEY = "technologyPreview";
 
 /**
  * Configuration options specific to the {@link Driver SafariDriver}.
  */
 class Options extends Capabilities {
-  /**
-   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
-   *     capabilities to initialize this instance from.
-   */
-  constructor(other = undefined) {
-    super(other)
-
-    /** @private {!Object} */
-    this.options_ = this.get(OPTIONS_CAPABILITY_KEY) || {}
-
-    this.set(OPTIONS_CAPABILITY_KEY, this.options_)
-    this.setBrowserName(Browser.SAFARI)
-  }
-
-  /**
-   * 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.
-   */
-  setTechnologyPreview(useTechnologyPreview) {
-    this.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY] = !!useTechnologyPreview
-    return this
-  }
+	/**
+	 * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
+	 *     capabilities to initialize this instance from.
+	 */
+	constructor (other = undefined) {
+		super(other);
+
+		/** @private {!Object} */
+		this.options_ = this.get(OPTIONS_CAPABILITY_KEY) || {};
+
+		this.set(OPTIONS_CAPABILITY_KEY, this.options_);
+		this.setBrowserName(Browser.SAFARI);
+	}
+
+	/**
+	 * 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.
+	 */
+	setTechnologyPreview (useTechnologyPreview) {
+		this.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY] = !!useTechnologyPreview;
+		return this;
+	}
 }
 
 /**
  * @param  {(Capabilities|Object<string, *>)=} o The options object
  * @return {boolean}
  */
-function useTechnologyPreview(o) {
-  if (o instanceof Capabilities) {
-    let options = o.get(OPTIONS_CAPABILITY_KEY)
-    return !!(options && options[TECHNOLOGY_PREVIEW_OPTIONS_KEY])
-  }
+function useTechnologyPreview (o) {
+	if (o instanceof Capabilities) {
+		let options = o.get(OPTIONS_CAPABILITY_KEY);
+		return !!(options && options[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
+	}
 
-  if (o && typeof o === 'object') {
-    return !!o[TECHNOLOGY_PREVIEW_OPTIONS_KEY]
-  }
+	if (o && typeof o === "object") {
+		return !!o[TECHNOLOGY_PREVIEW_OPTIONS_KEY];
+	}
 
-  return false
+	return false;
 }
 
-const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver'
+const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = "/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver";
 
 /**
  * A WebDriver client for Safari. This class should never be instantiated
@@ -107,32 +109,34 @@ const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = '/Applications/Safari Technology Pre
  *
  */
 class Driver extends webdriver.WebDriver {
-  /**
-   * Creates a new Safari session.
-   *
-   * @param {(Options|Capabilities)=} options The configuration options.
-   * @return {!Driver} A new driver instance.
-   */
-  static createSession(options) {
-    let caps = options || new Options()
-
-    let exe
-    if (useTechnologyPreview(caps.get(OPTIONS_CAPABILITY_KEY))) {
-      exe = SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE
-    }
-
-    let service = new ServiceBuilder(exe).build()
-    if (!service.getExecutable()) {
-      service.setExecutable(getBinaryPaths(caps).driverPath)
-    }
-    let executor = new http.Executor(service.start().then((url) => new http.HttpClient(url)))
-
-    return /** @type {!Driver} */ (super.createSession(executor, caps, () => service.kill()))
-  }
+	/**
+	 * Creates a new Safari session.
+	 *
+	 * @param {(Options|Capabilities)=} options The configuration options.
+	 * @return {!Driver} A new driver instance.
+	 */
+	static createSession (options) {
+		let caps = options || new Options();
+
+		let exe;
+		if (useTechnologyPreview(caps.get(OPTIONS_CAPABILITY_KEY))) {
+			exe = SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE;
+		}
+
+		let service = new ServiceBuilder(exe).build();
+		if (!service.getExecutable()) {
+			service.setExecutable(getBinaryPaths(caps).driverPath);
+		}
+		let executor = new http.Executor(
+			service.start().then((url) => new http.HttpClient(url)));
+
+		return /** @type {!Driver} */ (super.createSession(executor, caps,
+			() => service.kill()));
+	}
 }
 
 // Public API
 
-exports.Driver = Driver
-exports.Options = Options
-exports.ServiceBuilder = ServiceBuilder
+exports.Driver = Driver;
+exports.Options = Options;
+exports.ServiceBuilder = ServiceBuilder;