@wdio/protocols 6.10.6 → 6.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/protocols",
-  "version": "6.10.6",
+  "version": "6.12.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",
@@ -24,5 +24,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c3fa466d4e0fece382f2d04ead5f19f97eaa71fe"
+  "gitHead": "e8bae1e8becee38ee362989dc91bdd0c831512e9"
 }

package/protocols/chromium.json

@@ -252,23 +252,6 @@
       }
     }
   },
-  "/session/:sessionId/reporting/generate_test_report": {
-    "POST": {
-      "command": "generateTestReport",
-      "description": "Generates a report for testing. Extension for [Reporting API](https://developers.google.com/web/updates/2018/09/reportingapi).",
-      "ref": "https://w3c.github.io/reporting/#generate-test-report-command",
-      "parameters": [{
-        "name": "message",
-        "type": "string",
-        "description": "Message to be displayed in the report.",
-        "required": true
-      }, {
-        "name": "group",
-        "type": "string",
-        "description": "Specifies the endpoint group to deliver the report to."
-      }]
-    }
-  },
   "/session/:sessionId/file": {
     "POST": {
       "command": "file",

package/protocols/webdriver.json

@@ -930,5 +930,293 @@
         "description": "The result of a Accessible Name and Description Computation for the Accessible Name of the element."
       }
     }
+  },
+  "/session/:sessionId/permissions": {
+    "POST": {
+      "command": "setPermissions",
+      "description": "Simulates user modification of a PermissionDescriptor's permission state. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/permissions/#set-permission-command",
+      "examples": [
+        [
+          "// set midi permissions",
+          "browser.setPermissions({",
+          "  name: 'midi',",
+          "  sysex; true",
+          ", 'granted'); // can be also 'denied' or 'prompt'"
+        ]
+      ],
+      "parameters": [{
+        "name": "descriptor",
+        "type": "object",
+        "description": "Each powerful feature has one or more aspects that websites can request permission to access. To describe these aspects, each feature defines a subtype of PermissionDescriptor to be its permission descriptor type. __Note:__ this feature has not landed in all browsers yet.",
+        "required": true
+      }, {
+        "name": "state",
+        "type": "string",
+        "description": "Determines whether permission is granted, denied or prompted.",
+        "required": true
+      }, {
+        "name": "oneRealm",
+        "type": "boolean",
+        "description": "Whether or not to apply permissions to all execution contexts.",
+        "required": false
+      }]
+    }
+  },
+  "/session/:sessionId/reporting/generate_test_report": {
+    "POST": {
+      "command": "generateTestReport",
+      "description": "Generates a report for testing. Extension for [Reporting API](https://developers.google.com/web/updates/2018/09/reportingapi). __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/reporting/#automation",
+      "parameters": [{
+        "name": "message",
+        "type": "string",
+        "description": "Message to be displayed in the report.",
+        "required": true
+      }, {
+        "name": "group",
+        "type": "string",
+        "description": "Specifies the endpoint group to deliver the report to."
+      }]
+    }
+  },
+  "/session/:sessionId/sensor": {
+    "POST": {
+      "command": "createMockSensor",
+      "description": "Creates a mock sensor to emulate sensors like Ambient Light Sensor. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/sensors/#create-mock-sensor-command",
+      "parameters": [{
+        "name": "mockSensorType",
+        "type": "string",
+        "description": "Type of sensor API to mock, e.g. 'ambient-light'",
+        "required": true
+      }, {
+        "name": "maxSamplingFrequency",
+        "type": "number",
+        "description": "A double representing frequency in Hz that is used to set maximum supported sampling frequency for the associated mock sensor."
+      }, {
+        "name": "minSamplingFrequency",
+        "type": "number",
+        "description": "A double representing frequency in Hz that is used to set minimum supported sampling frequency for the associated mock sensor."
+      }]
+    }
+  },
+  "/session/:sessionId/sensor/:type": {
+    "GET": {
+      "command": "getMockSensor",
+      "description": "Retrieves information about a given type of mock sensor. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/sensors/#get-mock-sensor-command",
+      "variables": [{
+        "name": "type",
+        "description": "Mock sensor type to retrieve information from."
+      }],
+      "parameters": [],
+      "returns": {
+        "type": "object",
+        "name": "sensorReading",
+        "description": "Values of the mock sensor reading."
+      }
+    },
+    "POST": {
+      "command": "updateMockSensor",
+      "description": "Updates the mock sensor type. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/sensors/#update-mock-sensor-reading-command",
+      "variables": [{
+        "name": "type",
+        "description": "Mock sensor type to update information for."
+      }],
+      "parameters": [{
+        "name": "mockSensorType",
+        "type": "string",
+        "description": "Type of sensor API to mock, e.g. 'ambient-light'",
+        "required": true
+      }, {
+        "name": "maxSamplingFrequency",
+        "type": "number",
+        "description": "A double representing frequency in Hz that is used to set maximum supported sampling frequency for the associated mock sensor."
+      }, {
+        "name": "minSamplingFrequency",
+        "type": "number",
+        "description": "A double representing frequency in Hz that is used to set minimum supported sampling frequency for the associated mock sensor."
+      }]
+    },
+    "DELETE": {
+      "command": "deleteMockSensor",
+      "description": "The Delete Session command closes any top-level browsing contexts associated with the current session, terminates the connection, and finally closes the current session. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/sensors/#delete-mock-sensor-command",
+      "variables": [{
+        "name": "type",
+        "description": "Mock sensor type to delete."
+      }],
+      "parameters": []
+    }
+  },
+  "/session/:sessionId/time_zone": {
+    "POST": {
+      "command": "setTimeZone",
+      "description": "Simulates the changing of a time zone for the purposes of testing. __Note:__ this feature has not landed in all browsers yet.",
+      "ref": "https://w3c.github.io/sensors/#create-mock-sensor-command",
+      "parameters": [{
+        "name": "time_zone",
+        "type": "string",
+        "description": "Name of the timezone, e.g. Asia/Tokyo",
+        "required": true
+      }]
+    }
+  },
+  "/session/:sessionId/authenticator": {
+    "POST": {
+      "command": "addVirtualAuthenticator",
+      "description": "Creates a software [Virtual Authenticator](https://www.w3.org/TR/webauthn-2/#virtual-authenticators).",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator",
+      "parameters": [{
+        "name": "protocol",
+        "type": "string",
+        "description": "Valid values: 'ctap1/u2f', 'ctap2', 'ctap2_1'",
+        "required": false
+      }, {
+        "name": "transport",
+        "type": "string",
+        "description": "Valid values: 'usb', 'nfc', 'ble' or 'internal'",
+        "required": false
+      }, {
+        "name": "hasResidentKey",
+        "type": "boolean",
+        "description": "",
+        "required": false
+      }, {
+        "name": "hasUserVerification",
+        "type": "boolean",
+        "description": "",
+        "required": false
+      }, {
+        "name": "isUserConsenting",
+        "type": "boolean",
+        "description": "",
+        "required": false
+      }, {
+        "name": "isUserVerified",
+        "type": "boolean",
+        "description": "",
+        "required": false
+      }, {
+        "name": "extensions",
+        "type": "object[]",
+        "description": "",
+        "required": false
+      }, {
+        "name": "uvm",
+        "type": "object[]",
+        "description": "",
+        "required": false
+      }]
+    }
+  },
+  "/session/:sessionId/authenticator/:authenticatorId": {
+    "DELETE": {
+      "command": "removeVirtualAuthenticator",
+      "description": "Removes a previously created Virtual Authenticator.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator",
+      "variables": [{
+        "name": "authenticatorId",
+        "description": "id of authenticator"
+      }],
+      "parameters": []
+    }
+  },
+  "/session/:sessionId/authenticator/:authenticatorId/credential": {
+    "POST": {
+      "command": "addCredential",
+      "description": "Injects a Public Key Credential Source into an existing Virtual Authenticator.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential",
+      "parameters": [{
+        "name": "credentialId",
+        "type": "string",
+        "description": "The Credential ID encoded using Base64url Encoding.",
+        "required": true
+      }, {
+        "name": "isResidentCredential",
+        "type": "boolean",
+        "description": "If set to true, a client-side discoverable credential is created. If set to false, a server-side credential is created instead.",
+        "required": true
+      }, {
+        "name": "rpId",
+        "type": "string",
+        "description": "The Relying Party ID the credential is scoped to.",
+        "required": true
+      }, {
+        "name": "privateKey",
+        "type": "string",
+        "description": "An asymmetric key package containing a single private key per [RFC5958], encoded using Base64url Encoding.",
+        "required": true
+      }, {
+        "name": "userHandle",
+        "type": "string",
+        "description": "The userHandle associated to the credential encoded using Base64url Encoding. This property may not be defined.",
+        "required": true
+      }, {
+        "name": "signCount",
+        "type": "number",
+        "description": "The initial value for a signature counter associated to the public key credential source.",
+        "required": true
+      }, {
+        "name": "largeBlob",
+        "type": "string",
+        "description": "The large, per-credential blob associated to the public key credential source, encoded using Base64url Encoding. This property may not be defined.",
+        "required": true
+      }]
+    }
+  },
+  "/session/:sessionId/authenticator/:authenticatorId/credentials": {
+    "GET": {
+      "command": "getCredentials",
+      "description": "Returns one Credential Parameters object for every Public Key Credential Source stored in a Virtual Authenticator, regardless of whether they were stored using Add Credential or `navigator.credentials.create()`.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials",
+      "variables": [{
+        "name": "authenticatorId",
+        "description": "id of authenticator"
+      }],
+      "parameters": []
+    },
+    "DELETE": {
+      "command": "removeAllCredentials",
+      "description": "Removes all Public Key Credential Sources stored on a Virtual Authenticator.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials",
+      "variables": [{
+        "name": "authenticatorId",
+        "description": "id of authenticator"
+      }],
+      "parameters": []
+    }
+  },
+  "/session/:sessionId/authenticator/:authenticatorId/credentials/:credentialId": {
+    "DELETE": {
+      "command": "removeCredential",
+      "description": "Removes a Public Key Credential Source stored on a Virtual Authenticator.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-credential",
+      "variables": [{
+        "name": "authenticatorId",
+        "description": "id of authenticator"
+      }, {
+        "name": "credentialId",
+        "description": "id of credential"
+      }],
+      "parameters": []
+    }
+  },
+  "/session/:sessionId/authenticator/:authenticatorId/credentials/:credentialId/uv": {
+    "POST": {
+      "command": "setUserVerified",
+      "description": "The Set User Verified extension command sets the isUserVerified property on the Virtual Authenticator.",
+      "ref": "https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified",
+      "variables": [{
+        "name": "authenticatorId",
+        "description": "id of authenticator"
+      }, {
+        "name": "credentialId",
+        "description": "id of credential"
+      }],
+      "parameters": []
+    }
   }
 }