webdriverio 5.11.6 → 5.11.12

package/build/commands/constant.js

@@ -4,10 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.touchAction = exports.validateParameters = exports.formatArgs = void 0;
-
-/**
- * Constants around commands
- */
 const TOUCH_ACTIONS = ['press', 'longPress', 'tap', 'moveTo', 'wait', 'release'];
 const POS_ACTIONS = TOUCH_ACTIONS.slice(0, 4);
 const ACCEPTED_OPTIONS = ['x', 'y', 'element'];
@@ -27,10 +23,6 @@ const formatArgs = function (scope, actions) {
     const formattedAction = {
       action: action.action,
       options: {}
-      /**
-       * don't propagate for actions that don't require element options
-       */
-
     };
     const actionElement = action.element && typeof action.element.elementId === 'string' ? action.element.elementId : scope.elementId;
 
@@ -41,9 +33,6 @@ const formatArgs = function (scope, actions) {
     if (isFinite(action.x)) formattedAction.options.x = action.x;
     if (isFinite(action.y)) formattedAction.options.y = action.y;
     if (action.ms) formattedAction.options.ms = action.ms;
-    /**
-     * remove options property if empty
-     */
 
     if (Object.keys(formattedAction.options).length === 0) {
       delete formattedAction.options;
@@ -52,13 +41,6 @@ const formatArgs = function (scope, actions) {
     return formattedAction;
   });
 };
-/**
- * Make sure action has proper options before sending command to Appium.
- *
- * @param  {Object} params  touchAction parameters
- * @return null
- */
-
 
 exports.formatArgs = formatArgs;
 

package/build/commands/element/$$.js

@@ -9,45 +9,6 @@ var _utils = require("../../utils");
 
 var _getElementObject = require("../../utils/getElementObject");
 
-/**
- * The `$$` command is a short way to call the [`findElements`](/docs/api/webdriver.html#findelements) command in order
- * to fetch multiple elements on the page similar to the `$$` command from the browser scope. The difference when calling
- * it from an element scope is that the driver will look within the children of that element.
- *
- * For more information on how to select specific elements, see [`Selectors`](/docs/selectors.html).
- *
- * <example>
-    :index.html
-    <ul id="menu">
-        <li><a href="/">Home</a></li>
-        <li><a href="/">Developer Guide</a></li>
-        <li><a href="/">API</a></li>
-        <li><a href="/">Contribute</a></li>
-    </ul>
-    :$.js
-    it('should get text a menu link', () => {
-        const text = $('#menu');
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
-
-    it('should get text a menu link - JS Function', () => {
-        const text = $('#menu');
-        console.log(text.$$(function() { // Arrow function is not allowed here.
-            // this is Element https://developer.mozilla.org/en-US/docs/Web/API/Element
-            // in this particular example it is HTMLUListElement
-            // TypeScript users may do something like this
-            // return (this as Element).querySelectorAll('li')
-            return this.querySelectorAll('li'); // Element[]
-        })[2].$('a').getText()); // outputs: "API"
-    });
- * </example>
- *
- * @alias $$
- * @param {String|Function} selector  selector or JS Function to fetch multiple elements
- * @return {Element[]}
- * @type utility
- *
- */
 async function $$(selector) {
   const res = await _utils.findElements.call(this, selector);
   return _getElementObject.getElements.call(this, selector, res);

package/build/commands/element/$.js

@@ -9,49 +9,6 @@ var _utils = require("../../utils");
 
 var _getElementObject = require("../../utils/getElementObject");
 
-/**
- * The `$` command is a short way to call the [`findElement`](/docs/api/webdriver.html#findelement) command in order
- * to fetch a single element on the page similar to the `$` command from the browser scope. The difference when calling
- * it from an element scope is that the driver will look within the children of that element.
- *
- * Note: chaining `$` and `$$` commands only make sense when you use multiple selector strategies. You will otherwise
- * make unnecessary requests that slow down the test (e.g. `$('body').$('div')` will trigger two request whereas
- * `$('body div')` does literary the same with just one request)
- *
- * For more information on how to select specific elements, see [`Selectors`](/docs/selectors.html).
- *
- * <example>
-    :index.html
-    <ul id="menu">
-        <li><a href="/">Home</a></li>
-        <li><a href="/">Developer Guide</a></li>
-        <li><a href="/">API</a></li>
-        <li><a href="/">Contribute</a></li>
-    </ul>
-    :$.js
-    it('should get text a menu link', () => {
-        const text = $('#menu');
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
-
-    it('should get text a menu link - JS Function', () => {
-        const text = $('#menu');
-        console.log(text.$$('li')[2].$(function() { // Arrow function is not allowed here.
-            // this is Element https://developer.mozilla.org/en-US/docs/Web/API/Element
-            // in this particular example it is HTMLLIElement
-            // TypeScript users may do something like this
-            // return (this as Element).querySelector('a')
-            return this.querySelector('a'); // Element
-        }).getText()); // outputs: "API"
-    });
- * </example>
- *
- * @alias $
- * @param {String|Function} selector  selector or JS Function to fetch a certain element
- * @return {Element}
- * @type utility
- *
- */
 async function $(selector) {
   const res = await _utils.findElement.call(this, selector);
   return _getElementObject.getElement.call(this, selector, res);

package/build/commands/element/addValue.js

@@ -7,37 +7,10 @@ exports.default = addValue;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Add a value to an object found by given selector. You can also use unicode
- * characters like Left arrow or Back space. WebdriverIO will take care of
- * translating them into unicode characters. You’ll find all supported characters
- * [here](https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions).
- * To do that, the value has to correspond to a key from the table.
- *
- * <example>
-    :addValue.js
-    it('should demonstrate the addValue command', () => {
-        let input = $('.input')
-        input.addValue('test')
-        input.addValue(123)
-
-        value = input.getValue()
-        assert(value === 'test123') // true
-    })
- * </example>
- *
- * @alias element.addValue
- * @param {string | number | boolean | object | Array<any>}      value     value to be added
- * @uses protocol/elements, protocol/elementIdValue
- * @type action
- *
- */
 function addValue(value) {
   if (!this.isW3C) {
     return this.elementSendKeys(this.elementId, (0, _utils.transformToCharString)(value));
-  } // Workaround https://github.com/appium/appium/issues/12085
-
+  }
 
   if (this.isMobile) {
     return this.elementSendKeys(this.elementId, (0, _utils.transformToCharString)(value).join(''), (0, _utils.transformToCharString)(value));

package/build/commands/element/clearValue.js

@@ -5,32 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = clearValue;
 
-/**
- *
- * Clear a `<textarea>` or text `<input>` element’s value. Make sure you can interact with the
- * element before using this command. You can't clear an input element that is disabled or in
- * readonly mode.
- *
- * <example>
-    :clearValue.js
-    it('should demonstrate the clearValue command', function () {
-        const elem = $('.input')
-        elem.setValue('test123')
-
-        const value = elem.getValue()
-        console.log(value) // returns 'test123'
-
-        elem.clearValue()
-        value = elem.getValue()
-        assert(value === ''); // true
-    })
- * </example>
- *
- * @alias element.clearValue
- * @uses protocol/elements, protocol/elementIdClear
- * @type action
- *
- */
 function clearValue() {
   return this.elementClear(this.elementId);
 }

package/build/commands/element/click.js

@@ -5,49 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = click;
 
-/**
- *
- * Click on an element.
- *
- * Note: This issues a Webdriver `click` command for the selected element, which generally scrolls to and then clicks the
- * selected element. However, if you have fixed-position elements (such as a fixed header or footer) that cover up the
- * selected element after it is scrolled within the viewport, the click will be issued at the given coordinates, but will
- * be received by your fixed (overlaying) element. In these cased the following error is thrown:
- *
- * ```
- * Element is not clickable at point (x, x). Other element would receive the click: ..."
- * ```
- *
- * To work around this, try to find the overlaying element and remove it via `execute` command so it doesn't interfere
- * the click. You also can try to scroll to the element yourself using `scroll` with an offset appropriate for your
- * scenario.
- *
- * <example>
-    :example.html
-    <button id="myButton" onclick="document.getElementById('someText').innerHTML='I was clicked'">Click me</button>
-    <div id="someText">I was not clicked</div>
-    :click.js
-    it('should demonstrate the click command', () => {
-        const myButton = $('#myButton')
-        myButton.click()
-        const myText = $('#someText')
-        const text = myText.getText();
-        assert(text === 'I was clicked'); // true
-    })
-    :example.js
-    it('should fetch menu links and visit each page', () => {
-        const links = $$('#menu a');
-        links.forEach((link) => {
-            link.click();
-        });
-    });
- * </example>
- *
- * @alias element.click
- * @uses protocol/element, protocol/elementIdClick
- * @type action
- *
- */
 function click() {
   return this.elementClick(this.elementId);
 }

package/build/commands/element/doubleClick.js

@@ -5,41 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = doubleClick;
 
-/**
- *
- * Double-click on an element.
- *
- * <example>
-    :example.html
-    <button id="myButton" ondblclick="document.getElementById('someText').innerHTML='I was dblclicked'">Click me</button>
-    <div id="someText">I was not clicked</div>
-    :doubleClick.js
-    it('should demonstrate the doubleClick command', () => {
-        const myButton = $('#myButton')
-        myButton.doubleClick()
-
-        const value = myButton.getText()
-        assert(value === 'I was dblclicked') // true
-    })
- * </example>
- *
- * @alias element.doubleClick
- * @uses protocol/element, protocol/moveTo, protocol/doDoubleClick, protocol/touchDoubleClick
- * @type action
- *
- */
 async function doubleClick() {
-  /**
-   * move to element
-   */
   if (!this.isW3C) {
     await this.moveTo();
     return this.positionDoubleClick();
   }
-  /**
-   * W3C way of handle the double click actions
-   */
-
 
   await this.performActions([{
     type: 'pointer',

package/build/commands/element/dragAndDrop.js

@@ -7,17 +7,6 @@ exports.default = dragAndDrop;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Drag an item to a destination element.
- *
- * @alias element.dragAndDrop
- * @param {Element} target    destination selector
- * @param {Number=}  duration  how long the drag should take place
- * @uses action/moveToObject, protocol/buttonDown, protocol/buttonUp, property/getLocation, protocol/touchDown, protocol/touchMove, protocol/touchUp
- * @type action
- *
- */
 const ACTION_BUTTON = 0;
 
 async function dragAndDrop(target, duration = 100) {
@@ -31,10 +20,6 @@ async function dragAndDrop(target, duration = 100) {
     await target.moveTo();
     return this.buttonUp(ACTION_BUTTON);
   }
-  /**
-   * get coordinates to drag and drop
-   */
-
 
   const sourceRect = await (0, _utils.getElementRect)(this);
   const targetRect = await (0, _utils.getElementRect)(target);
@@ -42,10 +27,6 @@ async function dragAndDrop(target, duration = 100) {
   const sourceY = parseInt(sourceRect.y + sourceRect.height / 2, 10);
   const targetX = parseInt(targetRect.x + targetRect.width / 2, 10) - sourceX;
   const targetY = parseInt(targetRect.y + targetRect.height / 2, 10) - sourceY;
-  /**
-   * W3C way of handle the drag and drop action
-   */
-
   return this.performActions([{
     type: 'pointer',
     id: 'finger1',
@@ -63,8 +44,7 @@ async function dragAndDrop(target, duration = 100) {
     }, {
       type: 'pause',
       duration: 10
-    }, // emulate human pause
-    {
+    }, {
       type: 'pointerMove',
       duration,
       origin: 'pointer',

package/build/commands/element/getAttribute.js

@@ -5,32 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getAttribute;
 
-/**
- *
- * Get an attribute from a DOM-element based on the attribute name.
- *
- * <example>
-    :index.html
-    <form action="/submit" method="post" class="loginForm">
-        <input type="text" name="name" placeholder="username"></input>
-        <input type="text" name="password" placeholder="password"></input>
-        <input type="submit" name="submit" value="submit"></input>
-    </form>
-    :getAttribute.js
-    it('should demonstrate the getAttribute command', () => {
-        const form = $('form')
-        const attr = form.getAttribute('method')
-        console.log(attr) // outputs: "post"
-    })
- * </example>
- *
- * @alias element.getAttribute
- * @param {String} attributeName requested attribute
- * @return {String|null} The value of the attribute, or null if it is not set on the element.
- * @uses protocol/elements, protocol/elementIdAttribute
- * @type property
- *
- */
 function getAttribute(attributeName) {
   return this.getElementAttribute(this.elementId, attributeName);
 }

package/build/commands/element/getCSSProperty.js

@@ -7,72 +7,6 @@ exports.default = getCSSProperty;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Get a css property from a DOM-element selected by given selector. The return value
- * is formatted to be testable. Colors gets parsed via [rgb2hex](https://www.npmjs.org/package/rgb2hex)
- * and all other properties get parsed via [css-value](https://www.npmjs.org/package/css-value).
- *
- * Note that shorthand CSS properties (e.g. background, font, border, margin, padding, list-style, outline,
- * pause, cue) are not returned, in accordance with the DOM CSS2 specification - you should directly access
- * the longhand properties (e.g. background-color) to access the desired values.
- *
- * <example>
-    :example.html
-    <label id="myLabel" for="input" style="color: #0088cc; font-family: helvetica, arial, freesans, clean, sans-serif, width: 100px">Some Label</label>
-    :getCSSProperty.js
-    it('should demonstrate the getCSSProperty command', () => {
-        const elem = $('#myLabel')
-        const color = elem.getCSSProperty('color')
-        console.log(color)
-        // outputs the following:
-        // {
-        //     property: 'color',
-        //     value: 'rgba(0, 136, 204, 1)',
-        //     parsed: {
-        //         hex: '#0088cc',
-        //         alpha: 1,
-        //         type: 'color',
-        //         rgba: 'rgba(0, 136, 204, 1)'
-        //     }
-        // }
-
-        const font = elem.getCSSProperty('font-family')
-        console.log(font)
-        // outputs the following:
-        // {
-        //      property: 'font-family',
-        //      value: 'helvetica',
-        //      parsed: {
-        //          value: [ 'helvetica', 'arial', 'freesans', 'clean', 'sans-serif' ],
-        //          type: 'font',
-        //          string: 'helvetica, arial, freesans, clean, sans-serif'
-        //      }
-        // }
-
-        var width = elem.getCSSProperty('width')
-        console.log(width)
-        // outputs the following:
-        // {
-        //     property: 'width',
-        //     value: '100px',
-        //     parsed: {
-        //         type: 'number',
-        //         string: '100px',
-        //         unit: 'px',
-        //         value: 100
-        //     }
-        // }
-    })
- * </example>
- *
- * @alias element.getCSSProperty
- * @param {String} cssProperty css property name
- * @return {Object} The specified css of the element
- * @uses protocol/elements, protocol/elementIdCssProperty
- * @type property
- *
- */
 async function getCSSProperty(cssProperty) {
   const cssValue = await this.getElementCSSValue(this.elementId, cssProperty);
   return (0, _utils.parseCSS)(cssValue, cssProperty);

package/build/commands/element/getHTML.js

@@ -13,41 +13,9 @@ var _getHTML = _interopRequireDefault(require("../../scripts/getHTML"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Get source code of specified DOM element by selector.
- *
- * <example>
-    :index.html
-    <div id="test">
-        <span>Lorem ipsum dolor amet</span>
-    </div>
-    :getHTML.js
-    it('should get html for certain elements', () => {
-        var outerHTML = $('#test').getHTML();
-        console.log(outerHTML);
-        // outputs:
-        // "<div id="test"><span>Lorem ipsum dolor amet</span></div>"
-
-        var innerHTML = $('#test').getHTML(false);
-        console.log(innerHTML);
-        // outputs:
-        // "<span>Lorem ipsum dolor amet</span>"
-    });
- * </example>
- *
- * @alias element.getHTML
- * @param {Boolean=} includeSelectorTag if true it includes the selector element tag (default: true)
- * @return {String}  the HTML of the specified element
- * @uses action/selectorExecute
- * @type property
- *
- */
 function getHTML(includeSelectorTag = true) {
   return (0, _utils.getBrowserObject)(this).execute(_getHTML.default, {
     [_constants.ELEMENT_KEY]: this.elementId,
-    // w3c compatible
-    ELEMENT: this.elementId // jsonwp compatible
-
+    ELEMENT: this.elementId
   }, includeSelectorTag);
 }

package/build/commands/element/getLocation.js

@@ -7,33 +7,6 @@ exports.default = getLocation;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Determine an element’s location on the page. The point (0, 0) refers to
- * the upper-left corner of the page.
- *
- * <example>
-    :getLocation.js
-    it('should demonstrate the getLocation function', () => {
-        browser.url('http://github.com');
-        const logo = $('.octicon-mark-github')
-        const location = logo.getLocation();
-        console.log(location); // outputs: { x: 150, y: 20 }
-
-        const xLocation = logo.getLocation('x')
-        console.log(xLocation); // outputs: 150
-
-        const yLocation = logo.getLocation('.octicon-mark-github', 'y')
-        console.log(yLocation); // outputs: 20
-    });
- * </example>
- *
- * @alias element.getLocation
- * @param {String} prop    can be "x" or "y" to get a result value directly for easier assertions
- * @return {Object|Number}  The X and Y coordinates for the element on the page (`{x:number, y:number}`)
- * @uses protocol/elementIdLocation
- * @type property
- */
 async function getLocation(prop) {
   let location = {};
 

package/build/commands/element/getProperty.js

@@ -11,22 +11,6 @@ var _getProperty = _interopRequireDefault(require("../../scripts/getProperty"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * The Get Element Property command will return the result of getting a property of an element.
- *
- * <example>
-    :getProperty.js
-    it('should demonstrate the getCSSProperty command', () => {
-        var elem = $('body')
-        var color = elem.getProperty('tagName')
-        console.log(color) // outputs: "BODY"
-    })
- * </example>
- *
- * @alias element.getProperty
- * @param {String} property  name of the element property
- * @return {Object|String} the value of the property of the selected element
- */
 function getProperty(property) {
   if (this.isW3C) {
     return this.getElementProperty(this.elementId, property);

package/build/commands/element/getSize.js

@@ -7,33 +7,6 @@ exports.default = getSize;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Get the width and height for an DOM-element.
- *
- * <example>
-    :getSize.js
-    it('should demonstrate the getSize command', () => {
-        browser.url('http://github.com')
-        const logo = $('.octicon-mark-github')
-
-        const size = logo.getSize()
-        console.log(size) // outputs: { width: 32, height: 32 }
-
-        const width = logo.getSize('width')
-        console.log(width) // outputs: 32
-
-        const height = logo.getSize('height')
-        console.log(height) // outputs: 32
-    })
- * </example>
- *
- * @alias element.getElementSize
- * @param {String=} prop     size to receive [optional] ("width" or "height")
- * @return {Object|Number}    requested element size (`{ width: <Number>, height: <Number> }`) or actual width/height as number if prop param is given
- * @type property
- *
- */
 async function getSize(prop = null) {
   let rect = {};
 

package/build/commands/element/getTagName.js

@@ -5,29 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getTagName;
 
-/**
- *
- * Get tag name of a DOM-element.
- *
- * <example>
-    :index.html
-    <div id="elem">Lorem ipsum</div>
-
-    :getTagName.js
-    it('should demonstrate the getTagName command', () => {
-        const elem = $('#elem');
-
-        const tagName = elem.getTagName();
-        console.log(tagName); // outputs: "div"
-    })
- * </example>
- *
- * @alias element.getTagName
- * @return {String} the element's tag name, as a lowercase string
- * @uses protocol/elements, protocol/elementIdName
- * @type property
- *
- */
 function getTagName() {
   return this.getElementTagName(this.elementId);
 }

package/build/commands/element/getText.js

@@ -5,46 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getText;
 
-/**
- *
- * Get the text content from a DOM-element. Make sure the element
- * you want to request the text from [is interactable](http://www.w3.org/TR/webdriver/#interactable)
- * otherwise you will get an empty string as return value. If the element is disabled or not
- * visible and you still want to receive the text content use [getHTML](https://webdriver.io/docs/api/element/getHTML.html)
- * as a workaround.
- *
- * <example>
-    :index.html
-    <div id="elem">
-        Lorem ipsum <strong>dolor</strong> sit amet,<br>
-        consetetur sadipscing elitr
-    </div>
-    <span style="display: none">I am invisible</span>
-    :getText.js
-    it('should demonstrate the getText function', () => {
-        const elem = $('#elem');
-        console.log(elem.getText());
-        // outputs the following:
-        // "Lorem ipsum dolor sit amet,consetetur sadipscing elitr"
-
-        const span = $('span');
-        console.log(span.getText());
-        // outputs "" (empty string) since element is not interactable
-    });
-    it('get content from table cell', () => {
-        browser.url('http://the-internet.herokuapp.com/tables');
-        const rows = $$('#table1 tr');
-        const columns = rows[1].$$('td'); // get columns of 2nd row
-        console.log(columns[2].getText()); // get text of 3rd column
-    });
- * </example>
- *
- * @alias element.getText
- * @return {String} content of selected element (all HTML tags are removed)
- * @uses protocol/elements, protocol/elementIdText
- * @type property
- *
- */
 function getText() {
   return this.getElementText(this.elementId);
 }