@wdio/protocols 5.16.4 → 5.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/protocols",
-  "version": "5.16.4",
+  "version": "5.22.1",
   "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": "79d4df021ff141232e90bbb51021d330f5561c77"
+  "gitHead": "35907149e4faa3f84e3cb4803b54606ab31b11fa"
 }

package/protocols/appium.json

@@ -704,6 +704,19 @@
       }
     }
   },
+  "/session/:sessionId/appium/device/network_speed": {
+    "POST": {
+      "command": "toggleNetworkSpeed",
+      "description": "Set network speed (Emulator only)",
+      "ref": "http://appium.io/docs/en/commands/device/network/network-speed/",
+      "parameters": [],
+      "support": {
+        "android": {
+          "UiAutomator": "4.2+"
+        }
+      }
+    }
+  },
   "/session/:sessionId/appium/device/open_notifications": {
     "POST": {
       "command": "openNotifications",
@@ -1308,6 +1321,45 @@
         "description": "The type of action to perform (e.g. moveTo, release, press, tap, wait)",
         "required": true
       }],
+      "examples": [
+        [
+          "// do a horizontal swipe by percentage",
+          "const startPercentage = 10;",
+          "const endPercentage = 90;",
+          "const anchorPercentage = 50;",
+          "",
+          "const { width, height } = driver.getWindowSize();",
+          "const anchor = height * anchorPercentage / 100;",
+          "const startPoint = width * startPercentage / 100;",
+          "const endPoint = width * endPercentage / 100;",
+          "driver.touchPerform([",
+          "  {",
+          "    action: 'press',",
+          "    options: {",
+          "      x: startPoint,",
+          "      y: anchor,",
+          "    },",
+          "  },",
+          "  {",
+          "    action: 'wait',",
+          "    options: {",
+          "      ms: 100,",
+          "    },",
+          "  },",
+          "  {",
+          "    action: 'moveTo',",
+          "    options: {",
+          "      x: endPoint,",
+          "      y: anchor,",
+          "    },",
+          "  },",
+          "  {",
+          "    action: 'release',",
+          "    options: {},",
+          "  },",
+          "]);"
+        ]
+      ],
       "support": {
         "android": {
           "UiAutomator": "4.2+"
@@ -1374,5 +1426,41 @@
         "description": "An object containing two fields: 'result', which is the return value of the script itself, and 'logs', which contains 3 inner fields, 'log', 'warn', and 'error', which hold an array of strings logged by console.log, console.warn, and console.error in the script's execution."
       }
     }
+  },
+  "/session/:sessionId/appium/events": {
+    "POST": {
+      "command": "getEvents",
+      "description": "Get events stored in appium server.",
+      "ref": "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md",
+      "parameters": [{
+        "name": "type",
+        "type": "string[]",
+        "description": "Get events which are filtered with the type if the type is provided.",
+        "required": true
+      }],
+      "returns": {
+        "type": "object",
+        "name": "result",
+        "description": "A JSON hash of events like `{'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }`."
+      }
+    }
+  },
+  "/session/:sessionId/appium/log_event": {
+    "POST": {
+      "command": "logEvent",
+      "description": "Store a custom event.",
+      "ref": "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md",
+      "parameters": [{
+        "name": "vendor",
+        "type": "string",
+        "description": "The name of vendor. It will be `vendor` in `vendor:event`.",
+        "required": true
+      }, {
+        "name": "event",
+        "type": "string",
+        "description": "The name of event. It will be `event` in `vendor:event`.",
+        "required": true
+      }]
+    }
   }
 }

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": {

package/protocols/webdriver.json

@@ -206,8 +206,8 @@
       "ref": "https://w3c.github.io/webdriver/#dfn-switch-to-frame",
       "parameters": [{
         "name": "id",
-        "type": "(number|string|object|null)",
-        "description": "one of three possible types: null: this represents the top-level browsing context (i.e., not an iframe), a Number, representing the index of the window object corresponding to a frame, a string representing an element id that can be received using `findElement`.",
+        "type": "(number|object|null)",
+        "description": "one of three possible types: null: this represents the top-level browsing context (i.e., not an iframe), a Number, representing the index of the window object corresponding to a frame, an Element object received using `findElement`.",
         "required": true
       }]
     }