@wdio/protocols 5.15.4 → 5.16.7

package/README.md

@@ -1,2 +1,37 @@
-WebdriverIO PROTOCOLS Service
-========================
+WebdriverIO Protocol Helper
+===========================
+
+This package stores the definition for various automation protocols such as [WebDriver](https://w3c.github.io/webdriver/) or vendor specific protocol extensions like for [SauceLabs](https://saucelabs.com/). Unless you are interested in generating a WebDriver client there should be no reason why you should need this package. This package holds the definition of the following protocols:
+
+- [WebDriver](https://w3c.github.io/webdriver/)
+- [JSON Wire Protocol](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol)
+- [Appium](http://appium.io/)
+- [Mobile JSON Wire Protocol](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)
+- [SauceLabs](https://saucelabs.com/)
+- Chrome (WebDriver extension when running Chromedriver)
+- Selenium (when running Selenium Standalone Server)
+
+## Install
+
+To install the package, run:
+
+```sh
+$ npm install @wdio/protocols
+```
+
+## Usage
+
+You can get data by importing the package as follows:
+
+```js
+import { WebDriverProtocol, MJsonWProtocol, JsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol } from '@wdio/protocols'
+
+/**
+ * get description of session command
+ */
+console.log(WebDriverProtocol['/session'].POST.description)
+```
+
+----
+
+For more information on WebdriverIO see the [homepage](https://webdriver.io).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/protocols",
-  "version": "5.15.4",
+  "version": "5.16.7",
   "description": "Utility package providing information about automation protocols",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-protocols",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "858fec0e989ccd0de4336e639f3afcabf4b78ce2"
+  "gitHead": "f85d0659670a517e119fb1987f533a07422f8c15"
 }

package/protocols/jsonwp.json

@@ -2,7 +2,7 @@
   "/status": {
     "GET": {
       "command": "status",
-      "description": "Query the server's current status. The server should respond with a general \"HTTP 200 OK\" response if it is alive and accepting commands. The response body should be a JSON object describing the state of the server. All server implementations should return two basic objects describing the server's current platform and when the server was built. All fields are optional; if omitted, the client should assume the value is uknown. Furthermore, server implementations may include additional fields not listed here.",
+      "description": "Query the server's current status. The server should respond with a general \"HTTP 200 OK\" response if it is alive and accepting commands. The response body should be a JSON object describing the state of the server. All server implementations should return two basic objects describing the server's current platform and when the server was built. All fields are optional; if omitted, the client should assume the value is unknown. Furthermore, server implementations may include additional fields not listed here.",
       "ref": "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#status",
       "parameters": [],
       "returns": {

package/protocols/saucelabs.json

@@ -5,32 +5,6 @@
       "description": "Get webpage specific log information based on the last page load.",
       "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ExtendedDebuggingTools",
       "examples": [
-        [
-          "// Get Application Metrics Logs",
-          "console.log(browser.getPageLogs('sauce:metrics'));",
-          "/**",
-          " * outputs:",
-          " * {",
-          " *   \"firstMeaningfulPaint\": 35036.03356,",
-          " *   \"domContentLoaded\": 35036.122972,",
-          " *   \"navigationStart\": 35035.833805,",
-          " *   ...",
-          " * }",
-          " */"
-        ],
-        [
-          "// Get Network Timing Logs",
-          "console.log(browser.getPageLogs('sauce:timing'));",
-          "/**",
-          " * outputs:",
-          " * {",
-          " *   \"loadEventStart\": 622,",
-          " *   \"loadEventEnd\": 622,",
-          " *   \"domInteractive\": 359,",
-          " *   ...",
-          " * }",
-          " */"
-        ],
         [
           "// Get Network Logs",
           "console.log(browser.getPageLogs('sauce:network'));",
@@ -55,7 +29,7 @@
           " */"
         ],
         [
-          "// Get Performance Logs (coming soon)",
+          "// Get Performance Logs (needs capturePerformance capability see: https://wiki.saucelabs.com/display/DOCS/Measure+Page+Load+Performance+Using+Test+Automation#MeasurePageLoadPerformanceUsingTestAutomation-EnableYourScript)",
           "console.log(browser.getPageLogs('sauce:performance'));",
           "/**",
           " * outputs:",
@@ -71,7 +45,7 @@
       "parameters": [{
         "name": "type",
         "type": "string",
-        "description": "log type (e.g. 'sauce:timing', 'sauce:metrics', 'sauce:network', 'sauce:performance')",
+        "description": "log type (e.g. sauce:network', 'sauce:performance')",
         "required": true
       }],
       "returns": {
@@ -180,7 +154,7 @@
   "/session/:sessionId/sauce/ondemand/performance": {
     "POST": {
       "command": "assertPerformance",
-      "description": "Assert against the performance baseline of your app (private beta service, not yet available to the public).",
+      "description": "Assert against the performance baseline of your app.",
       "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands",
       "examples": [
         [
@@ -204,9 +178,9 @@
         "required": false
       }],
       "returns": {
-        "type": "Boolean",
+        "type": "Object",
         "name": "hasRegression",
-        "description": "Returns true if any metrics have a regression."
+        "description": "An object containing the result as well as metrics about the result."
       }
     }
   },