webdriverio 5.11.11 → 5.11.12

package/build/commands/element/touchAction.js

@@ -7,59 +7,6 @@ exports.default = touchAction;
 
 var _constant = require("../constant");
 
-/**
- *
- * The Touch Action API provides the basis of all gestures that can be automated in Appium.
- * It is currently only available to native apps and can not be used to interact with webapps.
- * At its core is the ability to chain together _ad hoc_ individual actions, which will then be
- * applied to an element in the application on the device. The basic actions that can be used are:
- *
- * - press (pass element or (x,y) or both)
- * - longPress (pass element or (x,y) or both)
- * - tap (pass element or (x,y) or both)
- * - moveTo (pass absolute x,y coordinates)
- * - wait (pass ms (as milliseconds))
- * - release (no arguments)
- *
- * <example>
-    :touchAction.js
-    it('should do a touch gesture', function () {
-        const screen = $('//UITextbox');
-
-        // simple touch action on element
-        screen.touchAction('tap');
-
-        // simple touch action using selector and x y variables
-        // tap location is 30px right and 20px down relative from the center of the element
-        screen.touchAction({
-            action: 'tap', x: 30, y:20
-        })
-
-        // multi action on an element (drag&drop)
-        screen.touchAction([
-            'press',
-            { action: 'moveTo', x: 200, y: 300 },
-            'release'
-        ])
-
-        // drag&drop to element
-        const otherElement = $('//UIAApplication[1]/UIAElement[2]')
-        screen.touchAction([
-            'press',
-            { action: 'moveTo', element: otherElement },
-            'release'
-        ])
-    });
- * </example>
- *
- * @param {String|Object[]} action    action to execute
- *
- * @see https://saucelabs.com/blog/appium-sauce-labs-bootcamp-chapter-2-touch-actions
- * @type mobile
- * @for android, ios
- * @uses mobile/performTouchAction, mobile/performMultiAction
- *
- */
 function touchAction(...args) {
   return _constant.touchAction.apply(this, args);
 }

package/build/commands/element/waitForDisplayed.js

@@ -5,44 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = waitForDisplayed;
 
-/**
- *
- * Wait for an element for the provided amount of
- * milliseconds to be displayed or not displayed.
- *
- * <example>
-    :index.html
-    <div id="elem" style="visibility: hidden;">Hello World!</div>
-    <script type="text/javascript">
-        setTimeout(() => {
-            document.getElementById('elem').style.visibility = 'visible';
-        }, 2000);
-    </script>
-    :waitForVisibleExample.js
-    it('should detect when element is visible', () => {
-        const elem = $('#elem')
-        elem.waitForDisplayed(3000);
-    });
-    it('should detect when element is no longer visible', () => {
-        const elem = $('#elem')
-        // passing 'undefined' allows us to keep the default timeout value without overwriting it
-        elem.waitForDisplayed(undefined, true);
-    });
- * </example>
- *
- * @alias element.waitForDisplayed
- * @param {Number=}  ms       time in ms (default: 500)
- * @param {Boolean=} reverse  if true it waits for the opposite (default: false)
- * @param {String=}  error    if exists it overrides the default error message
- * @return {Boolean} true     if element is displayed (or doesn't if flag is set)
- * @uses utility/waitUntil, state/isDisplayed
- * @type utility
- *
- */
 async function waitForDisplayed(ms, reverse = false, error) {
-  /*
-   * ensure that ms is set properly
-   */
   if (typeof ms !== 'number') {
     ms = this.options.waitforTimeout;
   }

package/build/commands/element/waitForEnabled.js

@@ -5,42 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = waitForEnabled;
 
-/**
- *
- * Wait for an element (selected by css selector) for the provided amount of
- * milliseconds to be (dis/en)abled. If multiple elements get queried by given
- * selector, it returns true if at least one element is (dis/en)abled.
- *
- * <example>
-    :index.html
-    <input type="text" id="username" value="foobar" disabled="disabled"></input>
-    <script type="text/javascript">
-        setTimeout(() => {
-            document.getElementById('username').disabled = false
-        }, 2000);
-    </script>
-    :waitForEnabledExample.js
-    it('should detect when element is enabled', () => {
-        $('#username').waitForEnabled(3000);
-    });
-
-    it('should detect when element is disabled', () => {
-        elem = $('#username');
-        elem.waitForEnabled(3000, true)
-    });
- * </example>
- *
- * @alias element.waitForEnabled
- * @param {Number=}  ms       time in ms (default: 500)
- * @param {Boolean=} reverse  if true it waits for the opposite (default: false)
- * @param {String=}  error    if exists it overrides the default error message
- * @return {Boolean} true     if element is (dis/en)abled
- * @uses utility/waitUntil, state/isEnabled
- * @type utility
- *
- */
 async function waitForEnabled(ms, reverse = false, error) {
-  // If the element doesn't already exist, wait for it to exist
   if (!this.elementId && !reverse) {
     await this.waitForExist(ms, false, error);
   }

package/build/commands/element/waitForExist.js

@@ -5,45 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = waitForExist;
 
-/**
- *
- * Wait for an element for the provided amount of
- * milliseconds to be present within the DOM. Returns true if the selector
- * matches at least one element that exists in the DOM, otherwise throws an
- * error. If the reverse flag is true, the command will instead return true
- * if the selector does not match any elements.
- *
- * <example>
-    :waitForExistSyncExample.js
-    it('should display a notification message after successful form submit', function () {
-        const form = $('form');
-        const notification = $('.notification');
-        form.submit();
-        notification.waitForExist(5000);
-        expect(notification.getText()).to.be.equal('Data transmitted successfully!')
-    });
-    it('should remove a message after successful form submit', function () {
-        const form = $('form');
-        const message = $('.message');
-        form.submit();
-        // passing 'undefined' allows us to keep the default timeout value without overwriting it
-        message.waitForExist(undefined, true);
-    });
- * </example>
- *
- * @alias element.waitForExist
- * @param {Number=}  ms       time in ms (default: 500)
- * @param {Boolean=} reverse  if true it instead waits for the selector to not match any elements (default: false)
- * @param {String=}  error    if exists it overrides the default error message
- * @return {Boolean} true     if element exists (or doesn't if flag is set)
- * @uses utility/waitUntil, state/isExisting
- * @type utility
- *
- */
 function waitForExist(ms, reverse = false, error) {
-  /*!
-   * ensure that ms is set properly
-   */
   if (typeof ms !== 'number') {
     ms = this.options.waitforTimeout;
   }

package/build/commands/element/waitUntil.js

@@ -9,11 +9,5 @@ var _waitUntil = _interopRequireDefault(require("../browser/waitUntil"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * Nothing to see here!
- * The original implementation is in the browser scope. Since the element
- * scope should be able to query sub elements of itself this command is
- * just a placeholder so it gets picked up as regular command.
- */
 var _default = _waitUntil.default;
 exports.default = _default;

package/build/constants.js

@@ -4,25 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.APPIUM_CAPABILITES = exports.APPIUM_IOS_CAPABILITIES = exports.APPIUM_ANDROID_CAPABILITIES = exports.JSONWP_CAPABILITIES = exports.W3C_CAPABILITIES = exports.W3C_SELECTOR_STRATEGIES = exports.UNICODE_CHARACTERS = exports.WDIO_DEFAULTS = exports.ELEMENT_KEY = void 0;
-
-/* istanbul ignore next */
 const HOOK_DEFINITION = {
   type: param => {
-    /**
-     * option must be an array
-     */
     if (!Array.isArray(param)) {
       throw new Error('a hook option needs to be a list of functions');
     }
-    /**
-     * array elements must be functions
-     */
-
 
     for (const option of param) {
-      /**
-       * either a string
-       */
       if (typeof option === 'function') {
         continue;
       }
@@ -36,9 +24,6 @@ const HOOK_DEFINITION = {
 const ELEMENT_KEY = 'element-6066-11e4-a52e-4f735466cecf';
 exports.ELEMENT_KEY = ELEMENT_KEY;
 const WDIO_DEFAULTS = {
-  /**
-   * define specs for test execution
-   */
   specs: {
     type: param => {
       if (!Array.isArray(param)) {
@@ -46,10 +31,6 @@ const WDIO_DEFAULTS = {
       }
     }
   },
-
-  /**
-   * exclude specs from test execution
-   */
   exclude: {
     type: param => {
       if (!Array.isArray(param)) {
@@ -57,23 +38,11 @@ const WDIO_DEFAULTS = {
       }
     }
   },
-
-  /**
-   * key/value definition of suites (named by key) and a list of specs as value
-   * to specify a specific set of tests to execute
-   */
   suites: {
     type: 'object'
   },
-
-  /**
-   * capabilities of WebDriver sessions
-   */
   capabilities: {
     type: param => {
-      /**
-       * should be an object
-       */
       if (!Array.isArray(param)) {
         if (typeof param === 'object') {
           return true;
@@ -81,14 +50,9 @@ const WDIO_DEFAULTS = {
 
         throw new Error('the "capabilities" options needs to be an object or a list of objects');
       }
-      /**
-       * or an array of objects
-       */
-
 
       for (const option of param) {
         if (typeof option === 'object') {
-          // Check does not work recursively
           continue;
         }
 
@@ -99,84 +63,36 @@ const WDIO_DEFAULTS = {
     },
     required: true
   },
-
-  /**
-   * Shorten navigateTo command calls by setting a base url
-   */
   baseUrl: {
     type: 'string'
   },
-
-  /**
-   * If you only want to run your tests until a specific amount of tests have failed use
-   * bail (default is 0 - don't bail, run all tests).
-   */
   bail: {
     type: 'number',
     default: 0
   },
-
-  /**
-   * Default interval for all waitFor* commands
-   */
   waitforInterval: {
     type: 'number',
     default: 500
   },
-
-  /**
-   * Default timeout for all waitFor* commands
-   */
   waitforTimeout: {
     type: 'number',
     default: 3000
   },
-
-  /**
-   * supported test framework by wdio testrunner
-   */
   framework: {
     type: 'string'
   },
-
-  /**
-   * list of reporters to use, a reporter can be either a string or an object with
-   * reporter options, e.g.:
-   * [
-   *  'dot',
-   *  {
-   *    name: 'spec',
-   *    outputDir: __dirname + '/reports'
-   *  }
-   * ]
-   */
   reporters: {
     type: param => {
-      /**
-       * option must be an array
-       */
       if (!Array.isArray(param)) {
         throw new Error('the "reporters" options needs to be a list of strings');
       }
 
       const isValidReporter = option => typeof option === 'string' || typeof option === 'function';
-      /**
-       * array elements must be:
-       */
-
 
       for (const option of param) {
-        /**
-         * either a string or a function (custom reporter)
-         */
         if (isValidReporter(option)) {
           continue;
         }
-        /**
-         * or an array with the name of the reporter as first element and the options
-         * as second element
-         */
-
 
         if (Array.isArray(option) && typeof option[1] === 'object' && isValidReporter(option[0])) {
           continue;
@@ -188,22 +104,11 @@ const WDIO_DEFAULTS = {
       return true;
     }
   },
-
-  /**
-   * set of WDIO services to use
-   */
   services: {
     type: param => {
-      /**
-       * should be an array
-       */
       if (!Array.isArray(param)) {
         throw new Error('the "services" options needs to be a list of strings and/or arrays');
       }
-      /**
-       * with arrays and/or strings
-       */
-
 
       for (const option of param) {
         if (!Array.isArray(option)) {
@@ -219,10 +124,6 @@ const WDIO_DEFAULTS = {
     },
     default: []
   },
-
-  /**
-   * Node arguments to specify when launching child processes
-   */
   execArgv: {
     type: param => {
       if (!Array.isArray(param)) {
@@ -231,32 +132,16 @@ const WDIO_DEFAULTS = {
     },
     default: []
   },
-
-  /**
-   * amount of instances to be allowed to run in total
-   */
   maxInstances: {
     type: 'number'
   },
-
-  /**
-   * amount of instances to be allowed to run per capability
-   */
   maxInstancesPerCapability: {
     type: 'number'
   },
-
-  /**
-   * directory for log files
-   */
   outputDir: {
     type: 'string',
     default: process.cwd()
   },
-
-  /**
-   * list of strings to watch of `wdio` command is called with `--watch` flag
-   */
   filesToWatch: {
     type: param => {
       if (!Array.isArray(param)) {
@@ -264,10 +149,6 @@ const WDIO_DEFAULTS = {
       }
     }
   },
-
-  /**
-   * hooks
-   */
   onPrepare: HOOK_DEFINITION,
   before: HOOK_DEFINITION,
   beforeSession: HOOK_DEFINITION,
@@ -283,21 +164,12 @@ const WDIO_DEFAULTS = {
   after: HOOK_DEFINITION,
   onComplete: HOOK_DEFINITION,
   onReload: HOOK_DEFINITION,
-
-  /**
-   * cucumber specific hooks
-   */
   beforeFeature: HOOK_DEFINITION,
   beforeScenario: HOOK_DEFINITION,
   beforeStep: HOOK_DEFINITION,
   afterFeature: HOOK_DEFINITION,
   afterScenario: HOOK_DEFINITION,
   afterStep: HOOK_DEFINITION
-  /**
-   * unicode characters
-   * https://w3c.github.io/webdriver/webdriver-spec.html#character-types
-   */
-
 };
 exports.WDIO_DEFAULTS = WDIO_DEFAULTS;
 const UNICODE_CHARACTERS = {

package/build/index.js

@@ -19,13 +19,6 @@ var _utils = require("./utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * A method to create a new session with WebdriverIO
- *
- * @param  {Object} [params={}]       Options to create the session with
- * @param  {function} remoteModifier  Modifier function to change the monad object
- * @return {object}                   browser object with sessionId
- */
 const remote = async function (params = {}, remoteModifier) {
   const config = (0, _config.validateConfig)(_constants.WDIO_DEFAULTS, params);
 
@@ -48,11 +41,6 @@ const remote = async function (params = {}, remoteModifier) {
 
   const prototype = (0, _utils.getPrototype)('browser');
   const instance = await _webdriver.default.newSession(params, modifier, prototype, _config.wrapCommand);
-  /**
-   * we need to overwrite the original addCommand and overwriteCommand
-   * in order to wrap the function within Fibers
-   */
-
   const origAddCommand = instance.addCommand.bind(instance);
 
   instance.addCommand = (name, fn, attachToElement) => origAddCommand(name, (0, _config.runFnInFiberContext)(fn), attachToElement);
@@ -76,10 +64,6 @@ exports.attach = attach;
 const multiremote = async function (params = {}) {
   const multibrowser = new _multiremote.default();
   const browserNames = Object.keys(params);
-  /**
-   * create all instance sessions
-   */
-
   await Promise.all(browserNames.map(browserName => {
     const config = (0, _config.validateConfig)(_constants.WDIO_DEFAULTS, params[browserName]);
 
@@ -94,10 +78,6 @@ const multiremote = async function (params = {}) {
 
     return multibrowser.addInstance(browserName, instance);
   }));
-  /**
-   * use attachToSession capability to wrap instances around blank pod
-   */
-
   const prototype = (0, _utils.getPrototype)('browser');
   const sessionParams = {
     sessionId: '',
@@ -106,11 +86,6 @@ const multiremote = async function (params = {}) {
   };
 
   const driver = _webdriver.default.attachToSession(sessionParams, multibrowser.modifier.bind(multibrowser), prototype, _config.wrapCommand);
-  /**
-   * in order to get custom command overwritten or added to multiremote instance
-   * we need to pass in the prototype of the multibrowser
-   */
-
 
   const origAddCommand = driver.addCommand.bind(driver);
 

package/build/middlewares.js

@@ -11,12 +11,6 @@ var _implicitWait = _interopRequireDefault(require("./utils/implicitWait"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * This method is an command wrapper for elements that checks if a command is called
- * that wasn't found on the page and automatically waits for it
- *
- * @param  {Function} fn  commandWrap from wdio-sync package (or shim if not running in sync)
- */
 const elementErrorHandler = fn => (commandName, commandFn) => {
   return function elementErrorHandlerCallback(...args) {
     return fn(commandName, async function elementErrorHandlerCallbackFn() {
@@ -25,10 +19,6 @@ const elementErrorHandler = fn => (commandName, commandFn) => {
 
       try {
         const result = await fn(commandName, commandFn).apply(this, args);
-        /**
-         * assume Safari responses like { error: 'no such element', message: '', stacktrace: '' }
-         * as `stale element reference`
-         */
 
         if (result && result.error === 'no such element') {
           const err = new Error();
@@ -50,10 +40,6 @@ const elementErrorHandler = fn => (commandName, commandFn) => {
     }).apply(this);
   };
 };
-/**
- * handle single command calls from multiremote instances
- */
-
 
 exports.elementErrorHandler = elementErrorHandler;
 

package/build/multiremote.js

@@ -25,26 +25,15 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-/**
- * Multiremote class
- */
 class MultiRemote {
   constructor() {
     this.instances = {};
   }
-  /**
-   * add instance to multibrowser instance
-   */
-
 
   async addInstance(browserName, client) {
     this.instances[browserName] = await client;
     return this.instances[browserName];
   }
-  /**
-   * modifier for multibrowser instance
-   */
-
 
   modifier(wrapperClient) {
     const propertiesObject = {};
@@ -67,9 +56,6 @@ class MultiRemote {
     };
     this.baseInstance = new MultiRemoteDriver(this.instances, propertiesObject);
     const client = Object.create(this.baseInstance, propertiesObject);
-    /**
-     * attach instances to wrapper client
-     */
 
     for (const [identifier, instance] of Object.entries(this.instances)) {
       client[identifier] = instance;
@@ -77,22 +63,6 @@ class MultiRemote {
 
     return client;
   }
-  /**
-   * helper method to generate element objects from results, so that we can call, e.g.
-   *
-   * ```
-   * const elem = $('#elem')
-   * elem.getHTML()
-   * ```
-   *
-   * or in case multiremote is used
-   *
-   * ```
-   * const elems = $$('div')
-   * elems[0].getHTML()
-   * ```
-   */
-
 
   static elementWrapper(instances, result, propertiesObject) {
     const prototype = _objectSpread({}, propertiesObject, {}, (0, _lodash2.default)((0, _utils.getPrototype)('element')), {
@@ -100,9 +70,6 @@ class MultiRemote {
     });
 
     const element = (0, _webdriver.webdriverMonad)({}, client => {
-      /**
-       * attach instances to wrapper client
-       */
       for (const [i, identifier] of Object.entries(Object.keys(instances))) {
         client[identifier] = result[i];
       }
@@ -113,18 +80,11 @@ class MultiRemote {
     }, prototype);
     return element(this.sessionId, (0, _middlewares.multiremoteHandler)(_config.wrapCommand));
   }
-  /**
-   * handle commands for multiremote instances
-   */
-
 
   commandWrapper(commandName) {
     const instances = this.instances;
     return (0, _config.wrapCommand)(commandName, async function (...args) {
       const result = await Promise.all(Object.entries(instances).map(([, instance]) => instance[commandName](...args)));
-      /**
-       * return element object to call commands directly
-       */
 
       if (commandName === '$') {
         return MultiRemote.elementWrapper(instances, result, this.__propertiesObject__);
@@ -138,12 +98,6 @@ class MultiRemote {
   }
 
 }
-/**
- * event listener class that propagates events to sub drivers
- */
-
-/* istanbul ignore next */
-
 
 exports.default = MultiRemote;
 

package/build/scripts/getHTML.js

@@ -5,13 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getHTML;
 
-/**
- * get HTML of selector element
- *
- * @param  {String}  element             element to get HTML from
- * @param  {Boolean} includeSelectorTag  if true, selector tag gets included (uses outerHTML)
- * @return {String}                      html source
- */
 function getHTML(element, includeSelectorTag) {
   return element[includeSelectorTag ? 'outerHTML' : 'innerHTML'];
 }

package/build/scripts/getProperty.js

@@ -5,12 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getProperty;
 
-/**
- * get property from element
- * @param  {String} element    element with requested property
- * @param  {String} property   requested property
- * @return {String}            the value of the property
- */
 function getProperty(element, property) {
   return element[property];
 }