webdriverio 5.11.11 → 5.11.12

package/build/commands/browser/reloadSession.js

@@ -9,33 +9,8 @@ var _request = _interopRequireDefault(require("webdriver/build/request"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Creates a new Selenium session with your current capabilities. This is useful if you
- * test highly stateful application where you need to clean the browser session between
- * the tests in your spec file to avoid creating hundreds of single test files with WDIO.
- * Be careful though, this command affects your test time tremendously since spawning
- * new Selenium sessions is very time consuming especially when using cloud services.
- *
- * <example>
-    :reloadSync.js
-    it('should reload my session with current capabilities', () => {
-        console.log(browser.sessionId) // outputs: e042b3f3cd5a479da4e171825e96e655
-        browser.reloadSession()
-        console.log(browser.sessionId) // outputs: 9a0d9bf9d4864160aa982c50cf18a573
-    })
- * </example>
- *
- * @alias browser.reloadSession
- * @type utility
- *
- */
 async function reloadSession() {
   const oldSessionId = this.sessionId;
-  /**
-   * end current running session
-   */
-
   await this.deleteSession();
   const {
     w3cCaps,
@@ -43,9 +18,7 @@ async function reloadSession() {
   } = this.options.requestedCapabilities;
   const sessionRequest = new _request.default('POST', '/session', {
     capabilities: w3cCaps,
-    // W3C compliant
-    desiredCapabilities: jsonwpCaps // JSONWP compliant
-
+    desiredCapabilities: jsonwpCaps
   });
   const response = await sessionRequest.makeRequest(this.options);
   const newSessionId = response.sessionId || response.value && response.value.sessionId;

package/build/commands/browser/saveRecordingScreen.js

@@ -11,30 +11,7 @@ var _utils = require("../../utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Appium only. Save a video started by startRecordingScreen command to file.
- * See [Appium docs](http://appium.io/docs/en/commands/device/recording-screen/start-recording-screen/)
- *
- * <example>
-    :saveRecordingScreen.js
-    it('should save a video', () => {
-        browser.startRecordingScreen();
-        $('~BUTTON').click();
-        browser.saveRecordingScreen('./some/path/video.mp4');
-    });
- * </example>
- *
- * @alias browser.saveRecordingScreen
- * @param   {String}  filepath  full or relative to the execution directory path to the generated video
- * @return  {Buffer}            video buffer
- * @type utility
- *
- */
 async function saveRecordingScreen(filepath) {
-  /**
-   * type check
-   */
   if (typeof filepath !== 'string') {
     throw new Error('saveRecordingScreen expects a filepath');
   }

package/build/commands/browser/saveScreenshot.js

@@ -11,29 +11,7 @@ var _utils = require("../../utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Save a screenshot of the current browsing context to a PNG file on your OS. Be aware that
- * some browser drivers take screenshots of the whole document (e.g. Geckodriver with Firefox)
- * and others only of the current viewport (e.g. Chromedriver with Chrome).
- *
- * <example>
-    :saveScreenshot.js
-    it('should save a screenshot of the browser view', function () {
-        browser.saveScreenshot('./some/path/screenshot.png');
-    });
- * </example>
- *
- * @alias browser.saveScreenshot
- * @param   {String}  filepath  path to the generated image (`.png` suffix is required) relative to the execution directory
- * @return  {Buffer}            screenshot buffer
- * @type utility
- *
- */
 async function saveScreenshot(filepath) {
-  /**
-   * type check
-   */
   if (typeof filepath !== 'string' || !filepath.endsWith('.png')) {
     throw new Error('saveScreenshot expects a filepath of type string and ".png" file ending');
   }

package/build/commands/browser/setCookies.js

@@ -5,52 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = setCookies;
 
-/**
- *
- * Sets one or more [cookies](https://w3c.github.io/webdriver/#cookies) for the current page. Make sure you are
- * on the page that should receive the cookie. You can't set a cookie for an arbitrary page without
- * being on that page.
- *
- * <example>
-    :setCookies.js
-    it('should set a cookie for the page', () => {
-        browser.url('/')
-
-        // set a single cookie
-        browser.setCookies({
-            name: 'test1',
-            value: 'one'
-            // The below options are optional
-            // path: '/foo', // The cookie path. Defaults to "/"
-            // domain: '.example.com', // The domain the cookie is visible to. Defaults to the current browsing context’s active document’s URL domain
-            // secure: true, // Whether the cookie is a secure cookie. Defaults to false
-            // httpOnly: true, // Whether the cookie is an HTTP only cookie. Defaults to false
-            // expiry: 1551393875 // When the cookie expires, specified in seconds since Unix Epoch
-        })
-
-        // set multiple cookies
-        browser.setCookies([
-            {name: 'test2', value: 'two'},
-            {name: 'test3', value: 'three'}
-        ])
-
-        const cookies = browser.getCookies()
-        console.log(cookies);
-        // outputs:
-        // [
-        //      {name: 'test1', value: 'one', domain: 'www.example.com'},
-        //      {name: 'test2', value: 'two', domain: 'www.example.com'},
-        //      {name: 'test3', value: 'three', domain: 'www.example.com'}
-        // ]
-    });
- * </example>
- *
- * @alias browser.setCookies
- * @param {Object} cookie cookie object or object array
- * @uses protocol/addCookie
- * @type cookie
- *
- */
 async function setCookies(cookieObjs) {
   const cookieObjsList = !Array.isArray(cookieObjs) ? [cookieObjs] : cookieObjs;
 

package/build/commands/browser/setTimeout.js

@@ -5,43 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = setTimeout;
 
-/**
- *
- * Sets the timeouts associated with the current session, timeout durations control such
- * behaviour as timeouts on script injection, document navigation, and element retrieval.
- * For more information and examples, see [timeouts guide](https://webdriver.io/docs/timeouts.html#selenium-timeouts).
- *
- * <example>
-    :setTimeout.js
-    it('should change timeout duration for session with long code duration', () => {
-        browser.setTimeout({
-            'pageLoad': 10000,
-            'script': 60000
-        });
-        // Execute code which takes a long time
-        browser.executeAsync((done) => {
-            console.log('Wake me up before you go!');
-            setTimeout(done, 59000);
-        });
-    });
- * </example>
- *
- * @param {Object} timeouts  Object containing session timeout values
- * @param {Number} timeouts.implicit  (Optional) Time in milliseconds to retry the element location strategy when finding an element.
- * @param {Number} timeouts.pageLoad  (Optional) Time in milliseconds to wait for the document to finish loading.
- * @param {Number} timeouts.script  (Optional) Scripts injected with [`execute`](https://webdriver.io/docs/api/browser/execute.html) or [`executeAsync`](https://webdriver.io/docs/api/browser/executeAsync.html) will run until they hit the script timeout duration, which is also given in milliseconds.
- * @see https://w3c.github.io/webdriver/#set-timeouts
- *
- */
 async function setTimeout(timeouts) {
   if (typeof timeouts !== 'object') {
     throw new Error('Parameter for "setTimeout" command needs to be an object');
   }
-  /**
-   * If value is not an integer, or it is less than 0 or greater than the maximum safe
-   * integer, return error with error code invalid argument.
-   */
-
 
   const timeoutValues = Object.values(timeouts);
 
@@ -49,13 +16,9 @@ async function setTimeout(timeouts) {
     throw new Error('Specified timeout values are not valid integer (see https://webdriver.io/docs/api/browser/setTimeout.html for documentation).');
   }
 
-  const implicit = timeouts.implicit; // Previously also known as `page load` with JsonWireProtocol
-
+  const implicit = timeouts.implicit;
   const pageLoad = timeouts['page load'] || timeouts.pageLoad;
   const script = timeouts.script;
-  /**
-   * JsonWireProtocol action
-   */
 
   if (!this.isW3C) {
     return Promise.all([isFinite(implicit) && this.setTimeouts('implicit', implicit), isFinite(pageLoad) && this.setTimeouts('page load', pageLoad), isFinite(script) && this.setTimeouts('script', script)].filter(Boolean));

package/build/commands/browser/setWindowSize.js

@@ -7,38 +7,13 @@ exports.default = setWindowSize;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Resizes browser window outer size according to provided width and height.
- *
- * <example>
- * :setWindowSize.js
-    it('should re-size browser outer window with 500 width and 600 height', function () {
-        browser.setWindowSize(500, 600);
-    });
- * </example>
- *
- * @alias browser.setWindowSize
- * @param {Number} width browser will be resized to provided width
- * @param {Number} height browser will be resized to provided height
- * @return {Null|Object} Null for *NO*W3C browser and Object{x, y, width, height} for W3C browser
- * @type window
- *
- */
 function setWindowSize(width, height) {
   const minWindowSize = 0;
   const maxWindowSize = 2147483647;
-  /**
-   * type check
-   */
 
   if (typeof width !== 'number' || typeof height !== 'number') {
     throw new Error('setWindowSize expects width and height of type number');
   }
-  /**
-   * value check
-   */
-
 
   if (width < minWindowSize || width > maxWindowSize || height < minWindowSize || height > maxWindowSize) {
     throw new Error('setWindowSize expects width and height to be a number in the 0 to 2^31 − 1 range');

package/build/commands/browser/switchWindow.js

@@ -5,37 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = switchWindow;
 
-/**
- *
- * Switch focus to a particular tab / window.
- *
- * <example>
-    :switchWindow.js
-    it('should switch to another window', () => {
-        // open url
-        browser.url('https://google.com')
-        // create new window
-        browser.newWindow('https://webdriver.io')
-
-        // switch back via url match
-        browser.switchWindow('google.com')
-
-        // switch back via title match
-        browser.switchWindow('Next-gen WebDriver test framework')
-    });
- * </example>
- *
- * @param {String|RegExp}  urlOrTitleToMatch  String or regular expression that matches the title or url of the page
- *
- * @uses protocol/getWindowHandles, protocol/switchToWindow, protocol/getUrl, protocol/getTitle
- * @alias browser.switchTab
- * @type window
- *
- */
 async function switchWindow(urlOrTitleToMatch) {
-  /*!
-   * parameter check
-   */
   if (typeof urlOrTitleToMatch !== 'string' && !(urlOrTitleToMatch instanceof RegExp)) {
     throw new Error('Unsupported parameter for switchWindow, required is "string" or an RegExp');
   }
@@ -44,19 +14,11 @@ async function switchWindow(urlOrTitleToMatch) {
 
   for (const tab of tabs) {
     await this.switchToWindow(tab);
-    /**
-     * check if url matches
-     */
-
     const url = await this.getUrl();
 
     if (url.match(urlOrTitleToMatch)) {
       return tab;
     }
-    /**
-     * check title
-     */
-
 
     const title = await this.getTitle();
 

package/build/commands/browser/touchAction.js

@@ -7,66 +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
-        browser.touchAction({
-            action: 'tap',
-            element: screen
-        });
-
-        // simple touch action x y variables
-        // tap location is 30px right and 20px down relative from the viewport
-        browser.touchAction({
-            action: 'tap',
-            x: 30,
-            y:20
-        })
-
-        // simple touch action x y variables
-        // tap location is 30px right and 20px down relative from the center of the element
-        browser.touchAction({
-            action: 'tap',
-            x: 30,
-            y:20,
-            element: screen
-        })
-
-        // multi action on an element
-        // drag&drop from position 200x200 down 100px on the screen
-        browser.touchAction([
-            { action: 'press', x: 200, y: 200 },
-            { action: 'moveTo', x: 200, y: 300 },
-            '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/browser/uploadFile.js

@@ -13,41 +13,10 @@ var _archiver = _interopRequireDefault(require("archiver"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * Uploads a file to the Selenium Standalone server or other browser driver
- * (e.g. Chromedriver) by using the [`file`](/api/protocol/file.html) command.
- * _Note:_ that this command is only supported if you use a Selenium Hub or
- * Chromedriver directly.
- *
- * <example>
-    :touchAction.js
-    const path = require('path');
-
-    it('should upload a file', function () {
-        const filePath = path.join(__dirname, '/local/path/to/your/file');
-
-        const remoteFilePath = browser.uploadFile(filePath);
-        $('.upload-data-file-input').setValue(remoteFilePath);
-    });
- * </example>
- *
- * @alias browser.uploadFile
- * @param {String} localPath local path to file
- * @type utility
- * @uses protocol/file
- * @returns {String} remote URL
- */
 async function uploadFile(localPath) {
-  /**
-   * parameter check
-   */
   if (typeof localPath !== 'string') {
     throw new Error('number or type of arguments don\'t agree with uploadFile command');
   }
-  /**
-   * check if command is available
-   */
-
 
   if (typeof this.file !== 'function') {
     throw new Error(`The uploadFile command is not available in ${this.capabilities.browserName}`);
@@ -61,7 +30,6 @@ async function uploadFile(localPath) {
     (0, _archiver.default)('zip').on('error', err => reject(err)).on('data', data => zipData.push(data)).on('end', () => this.file(Buffer.concat(zipData).toString('base64')).then(resolve, reject)).append(source, {
       name: _path.default.basename(localPath)
     }).finalize(err => {
-      /* istanbul ignore next */
       if (err) {
         reject(err);
       }

package/build/commands/browser/url.js

@@ -11,39 +11,6 @@ var _utils = require("../../utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Protocol binding to load or get the URL of the browser. If a baseUrl is
- * specified in the config, it will be prepended to the url parameter using
- * node's url.resolve() method.
- *
- * <example>
-    :url.js
-    // navigate to a new URL
-    browser.url('https://webdriver.io');
-    // receive url
-    console.log(browser.getUrl()); // outputs: "https://webdriver.io"
-
-    :baseUrlResolutions.js
-    // With a base URL of http://example.com/site, the following url parameters resolve as such:
-    // When providing a scheme:
-    // https://webdriver.io
-    browser.url('https://webdriver.io');
-    // When not starting with a slash, the URL resolves relative to the baseUrl
-    // http://example.com/site/relative
-    browser.url('relative');
-    // When starting with a slash, the URL resolves relative to the root path of the baseUrl
-    // http://example.com/rootRelative
-    browser.url('/rootRelative');
- * </example>
- *
- * @param {String=} url  the URL to navigate to
- *
- * @see  https://w3c.github.io/webdriver/webdriver-spec.html#dfn-get
- * @see  https://nodejs.org/api/url.html#url_url_resolve_from_to
- * @type protocol
- *
- */
 function url(path) {
   if (typeof path !== 'string') {
     throw new Error('Parameter for "url" command needs to be type of string');

package/build/commands/browser/waitUntil.js

@@ -9,50 +9,10 @@ var _Timer = _interopRequireDefault(require("../../utils/Timer"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * This wait command is your universal weapon if you want to wait on something. It expects a condition
- * and waits until that condition is fulfilled with a truthy value. If you use the WDIO testrunner the
- * commands within the condition are getting executed synchronously like in your test.
- *
- * A common example is to wait until a certain element contains a certain text (see example).
- *
- * <example>
-    :example.html
-    <div id="someText">I am some text</div>
-    <script>
-      setTimeout(() => {
-        $('#someText').html('I am now different');
-      }, 1000);
-    </script>
-
-    :waitUntil.js
-    it('should wait until text has changed', () => {
-        browser.waitUntil(() => {
-          return $('#someText').getText() === 'I am now different'
-        }, 5000, 'expected text to be different after 5s');
-    });
- * </example>
- *
- *
- * @alias browser.waitUntil
- * @param {Function} condition  condition to wait on
- * @param {Number=}  timeout    timeout in ms (default: 5000)
- * @param {String=}  timeoutMsg error message to throw when waitUntil times out
- * @param {Number=}  interval   interval between condition checks (default: 500)
- * @return {Boolean} true if condition is fulfilled
- * @uses utility/pause
- * @type utility
- *
- */
 function _default(condition, timeout, timeoutMsg, interval) {
   if (typeof condition !== 'function') {
     throw new Error('Condition is not a function');
   }
-  /*!
-   * ensure that timeout and interval are set properly
-   */
-
 
   if (typeof timeout !== 'number') {
     timeout = this.options.waitforTimeout;

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);