@wdio/protocols 6.1.14 → 6.6.0

package/index.d.ts

@@ -0,0 +1,85 @@
+declare namespace WDIOProtocols {
+    type CommandPath = 'string'
+    type CommandMethod = 'POST' | 'GET' | 'DELETE'
+    type Protocol = Record<CommandPath, Record<CommandMethod, CommandEndpoint>>
+
+    /**
+     * describes a command endpoint
+     */
+    interface CommandEndpoint {
+        /**
+         * command name
+         */
+        command: string
+        /**
+         * command description
+         */
+        description: string
+        /**
+         * link to specification reference
+         */
+        ref: URL
+        /**
+         * supported command parameters
+         */
+        parameters: CommandParameters[]
+        /**
+         * variables within the command path (e.g. /:sessionId/element)
+         */
+        variables?: CommandPathVariables[]
+        /**
+         * supported environments
+         */
+        support?: SupportedEnvironments
+        /**
+         * set to true if command is only supported in Selenium Hub Node
+         */
+        isHubCommand?: boolean,
+        /**
+         * information on return data
+         */
+        returns?: CommandReturnObject
+    }
+
+    interface CommandReturnObject {
+        type: string
+        name: string
+        description: string
+    }
+
+    interface CommandPathVariables {
+        name: string
+        description: string
+    }
+
+    interface CommandParameters {
+        name: string,
+        type: string,
+        description: string,
+        required: boolean
+    }
+
+    type Platform = 'ios' | 'android'
+    type Environments = 'XCUITest' | 'UIAutomation' | 'UiAutomator'
+
+    /**
+     * supported mobile environments, e.g.
+     * ```
+     * "ios": {
+     *   "UIAutomation": "8.0 to 9.3"
+     * }
+     * ```
+     */
+    type SupportedEnvironments = Record<Platform, Record<Environments, string>>
+}
+
+declare module "@wdio/protocols" {
+    export default WDIOProtocols
+    export const WebDriverProtocol: WDIOProtocols.Protocol
+    export const MJsonWProtocol: WDIOProtocols.Protocol
+    export const JsonWProtocol: WDIOProtocols.Protocol
+    export const AppiumProtocol: WDIOProtocols.Protocol
+    export const ChromiumProtocol: WDIOProtocols.Protocol
+    export const SauceLabsProtocol: WDIOProtocols.Protocol
+    export const SeleniumProtocol: WDIOProtocols.Protocol
+}

package/package.json

@@ -1,19 +1,15 @@
 {
   "name": "@wdio/protocols",
-  "version": "6.1.14",
+  "version": "6.6.0",
   "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",
   "license": "MIT",
   "main": "./index",
+  "types": "./index.d.ts",
   "engines": {
     "node": ">=10.0.0"
   },
-  "scripts": {
-    "compile": "echo \"nothing to compile\"",
-    "build": "echo \"nothing to build\"",
-    "test": "echo \"run json linting tests\""
-  },
   "repository": {
     "type": "git",
     "url": "git://github.com/webdriverio/webdriverio.git"
@@ -28,5 +24,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1db0b8de0f2efd9e63bf76b01fe01f7e9985f03f"
+  "gitHead": "643b1f237c0c7e4eb0e28fca31d963d3b19a073c"
 }

package/protocols/saucelabs.json

@@ -49,7 +49,7 @@
         "required": true
       }],
       "returns": {
-        "type": "Object",
+        "type": "object",
         "name": "log",
         "description": "log output of desired type (see example)"
       }
@@ -178,7 +178,7 @@
         "required": false
       }],
       "returns": {
-        "type": "Object",
+        "type": "object",
         "name": "hasRegression",
         "description": "An object containing the result as well as metrics about the result."
       }
@@ -198,10 +198,78 @@
       ],
       "parameters": [],
       "returns": {
-        "type": "Object",
+        "type": "object",
         "name": "testResults",
         "description": "An object containing the score as well as metrics around how smooth the UX of the page was during the test."
       }
     }
+  },
+  "/session/:sessionId/sauce/ondemand/mock": {
+    "POST": {
+      "command": "mockRequest",
+      "description": "Mocks a network resource.",
+      "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands",
+      "parameters": [{
+        "name": "url",
+        "type": "string",
+        "description": "URL glob to match url to mock.",
+        "required": true
+      }, {
+        "name": "filterOptions",
+        "description": "Additional filter options for url to mock (e.g. headers, method).",
+        "type": "object",
+        "required": false
+      }],
+      "returns": {
+        "type": "object",
+        "name": "mockId",
+        "description": "An object containing the id of a mock resource."
+      }
+    }
+  },
+  "/session/:sessionId/sauce/ondemand/mock/:mockId": {
+    "GET": {
+      "command": "getMockCalls",
+      "description": "Receive request information about requests that match the mocked resource.",
+      "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands",
+      "variables": [{
+        "name": "mockId",
+        "description": "the id of a mock"
+      }],
+      "parameters": [],
+      "returns": {
+        "type": "object",
+        "name": "requests",
+        "description": "A list of request information."
+      }
+    },
+    "DELETE": {
+      "command": "clearMockCalls",
+      "description": "Clear list of mock calls.",
+      "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands",
+      "variables": [{
+        "name": "mockId",
+        "description": "the id of a mock"
+      }],
+      "parameters": [{
+        "type": "boolean",
+        "name": "restore",
+        "description": "Set to true if mock should be restored as well."
+      }]
+    },
+    "POST": {
+      "command": "respondMock",
+      "description": "Respond if mock matches a specific resource.",
+      "ref": "https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands",
+      "variables": [{
+        "name": "mockId",
+        "description": "the id of a mock"
+      }],
+      "parameters": [{
+        "type": "object",
+        "name": "payload",
+        "description": "Information on mock response."
+      }]
+    }
   }
 }

package/protocols/webdriver.json

@@ -730,7 +730,7 @@
       "ref": "https://w3c.github.io/webdriver/#dfn-delete-cookie",
       "variables": [{
         "name": "name",
-        "description": "name of the cookie to retrieve"
+        "description": "name of the cookie to delete"
       }],
       "parameters": []
     }