selenium-webdriver 4.18.1 → 4.19.0

package/bidi/cookieFilter.js

@@ -0,0 +1,79 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const { SameSite, BytesValue } = require('./networkTypes')
+
+class CookieFilter {
+  #map = new Map()
+
+  name(name) {
+    this.#map.set('name', name)
+    return this
+  }
+
+  value(value) {
+    if (!(value instanceof BytesValue)) {
+      throw new Error(`Value must be an instance of BytesValue. Received:'${value}'`)
+    }
+    this.#map.set('value', Object.fromEntries(value.asMap()))
+    return this
+  }
+
+  domain(domain) {
+    this.#map.set('domain', domain)
+    return this
+  }
+
+  path(path) {
+    this.#map.set('path', path)
+    return this
+  }
+
+  size(size) {
+    this.#map.set('size', size)
+    return this
+  }
+
+  httpOnly(httpOnly) {
+    this.#map.set('httpOnly', httpOnly)
+    return this
+  }
+
+  secure(secure) {
+    this.#map.set('secure', secure)
+    return this
+  }
+
+  sameSite(sameSite) {
+    if (!(sameSite instanceof SameSite)) {
+      throw new Error(`Params must be a value in SameSite. Received:'${sameSite}'`)
+    }
+    this.#map.set('sameSite', sameSite)
+    return this
+  }
+
+  expiry(expiry) {
+    this.#map.set('expiry', expiry)
+    return this
+  }
+
+  asMap() {
+    return this.#map
+  }
+}
+
+module.exports = { CookieFilter }

package/bidi/index.js

@@ -40,6 +40,31 @@ class Index extends EventEmitter {
     })
   }
 
+  /**
+   * @returns {WebSocket}
+   */
+  get socket() {
+    return this._ws
+  }
+
+  /**
+   * @returns {boolean|*}
+   */
+  get isConnected() {
+    return this.connected
+  }
+
+  /**
+   * Get Bidi Status
+   * @returns {Promise<*>}
+   */
+  get status() {
+    return this.send({
+      method: 'session.status',
+      params: {},
+    })
+  }
+
   /**
    * Resolve connection
    * @returns {Promise<unknown>}
@@ -56,20 +81,6 @@ class Index extends EventEmitter {
     })
   }
 
-  /**
-   * @returns {WebSocket}
-   */
-  get socket() {
-    return this._ws
-  }
-
-  /**
-   * @returns {boolean|*}
-   */
-  get isConnected() {
-    return this.connected
-  }
-
   /**
    * Sends a bidi request
    * @param params
@@ -183,17 +194,6 @@ class Index extends EventEmitter {
     await this.send(params)
   }
 
-  /**
-   * Get Bidi Status
-   * @returns {Promise<*>}
-   */
-  get status() {
-    return this.send({
-      method: 'session.status',
-      params: {},
-    })
-  }
-
   /**
    * Close ws connection.
    * @returns {Promise<unknown>}

package/bidi/input.js

@@ -18,6 +18,7 @@
 // type: module added to package.json
 // import { WebElement } from '../lib/webdriver'
 const { WebElement } = require('../lib/webdriver')
+const { RemoteReferenceType, ReferenceValue } = require('./protocolValue')
 
 class Input {
   constructor(driver) {
@@ -57,6 +58,25 @@ class Input {
     }
     return await this.bidi.send(command)
   }
+
+  async setFiles(browsingContextId, element, files) {
+    if (typeof element !== 'string' && !(element instanceof ReferenceValue)) {
+      throw Error(`Pass in a WebElement id as a string or a ReferenceValue. Received: ${element}`)
+    }
+
+    const command = {
+      method: 'input.setFiles',
+      params: {
+        context: browsingContextId,
+        element:
+          typeof element === 'string'
+            ? new ReferenceValue(RemoteReferenceType.SHARED_ID, element).asMap()
+            : element.asMap(),
+        files: typeof files === 'string' ? [files] : files,
+      },
+    }
+    await this.bidi.send(command)
+  }
 }
 
 async function updateActions(actions) {

package/bidi/interceptPhase.js

@@ -21,4 +21,4 @@ const InterceptPhase = {
   AUTH_REQUIRED: 'authRequired',
 }
 
-module.exports = {InterceptPhase}
+module.exports = { InterceptPhase }

package/bidi/network.js

@@ -15,8 +15,11 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const { BeforeRequestSent, ResponseStarted, FetchError} = require('./networkTypes')
-const {AddInterceptParameters} = require("./addInterceptParameters");
+const { BeforeRequestSent, ResponseStarted, FetchError } = require('./networkTypes')
+const { AddInterceptParameters } = require('./addInterceptParameters')
+const { ContinueResponseParameters } = require('./continueResponseParameters')
+const { ContinueRequestParameters } = require('./continueRequestParameters')
+const { ProvideResponseParameters } = require('./provideResponseParameters')
 
 class Network {
   constructor(driver, browsingContextIds) {
@@ -92,19 +95,18 @@ class Network {
           )
         }
         callback(response)
-        }
+      }
     })
   }
 
   async addIntercept(params) {
-
-    if (!params instanceof AddInterceptParameters) {
-      throw new Error(`Params must be an instance of AddInterceptParamenters. Received:'${params}'`)
+    if (!(params instanceof AddInterceptParameters)) {
+      throw new Error(`Params must be an instance of AddInterceptParameters. Received:'${params}'`)
     }
 
     const command = {
       method: 'network.addIntercept',
-      params: Object.fromEntries(params.asMap())
+      params: Object.fromEntries(params.asMap()),
     }
 
     let response = await this.bidi.send(command)
@@ -115,7 +117,7 @@ class Network {
   async removeIntercept(interceptId) {
     const command = {
       method: 'network.removeIntercept',
-      params: {intercept: interceptId},
+      params: { intercept: interceptId },
     }
 
     await this.bidi.send(command)
@@ -123,17 +125,27 @@ class Network {
 
   async continueWithAuth(requestId, username, password) {
     const command = {
-            method: 'network.continueWithAuth',
-            params: {
-              request: requestId.toString(),
-              action: 'provideCredentials',
-              credentials: {
-                type: 'password',
-                username: username,
-                password: password
-              },
-            },
-          }
+      method: 'network.continueWithAuth',
+      params: {
+        request: requestId.toString(),
+        action: 'provideCredentials',
+        credentials: {
+          type: 'password',
+          username: username,
+          password: password,
+        },
+      },
+    }
+    await this.bidi.send(command)
+  }
+
+  async failRequest(requestId) {
+    const command = {
+      method: 'network.failRequest',
+      params: {
+        request: requestId.toString(),
+      },
+    }
     await this.bidi.send(command)
   }
 
@@ -142,7 +154,7 @@ class Network {
       method: 'network.continueWithAuth',
       params: {
         request: requestId.toString(),
-        action: 'default'
+        action: 'default',
       },
     }
     await this.bidi.send(command)
@@ -153,20 +165,59 @@ class Network {
       method: 'network.continueWithAuth',
       params: {
         request: requestId.toString(),
-        action: 'cancel'
+        action: 'cancel',
       },
     }
     await this.bidi.send(command)
   }
 
+  async continueRequest(params) {
+    if (!(params instanceof ContinueRequestParameters)) {
+      throw new Error(`Params must be an instance of ContinueRequestParameters. Received:'${params}'`)
+    }
+
+    const command = {
+      method: 'network.continueRequest',
+      params: Object.fromEntries(params.asMap()),
+    }
+
+    await this.bidi.send(command)
+  }
+
+  async continueResponse(params) {
+    if (!(params instanceof ContinueResponseParameters)) {
+      throw new Error(`Params must be an instance of ContinueResponseParameters. Received:'${params}'`)
+    }
+
+    const command = {
+      method: 'network.continueResponse',
+      params: Object.fromEntries(params.asMap()),
+    }
+
+    await this.bidi.send(command)
+  }
+
+  async provideResponse(params) {
+    if (!(params instanceof ProvideResponseParameters)) {
+      throw new Error(`Params must be an instance of ProvideResponseParameters. Received:'${params}'`)
+    }
+
+    const command = {
+      method: 'network.provideResponse',
+      params: Object.fromEntries(params.asMap()),
+    }
+
+    await this.bidi.send(command)
+  }
+
   async close() {
     await this.bidi.unsubscribe(
       'network.beforeRequestSent',
       'network.responseStarted',
       'network.responseCompleted',
-      'network.authRequired')
+      'network.authRequired',
+    )
   }
-
 }
 
 async function getNetworkInstance(driver, browsingContextIds = null) {

package/bidi/networkTypes.js

@@ -17,11 +17,54 @@
 
 const { NavigationInfo } = require('./browsingContextTypes')
 
+const SameSite = {
+  STRICT: 'strict',
+  LAX: 'lax',
+  NONE: 'none',
+
+  findByName(name) {
+    return (
+      Object.values(this).find((type) => {
+        return typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
+      }) || null
+    )
+  },
+}
+
+class BytesValue {
+  static Type = {
+    STRING: 'string',
+    BASE64: 'base64',
+  }
+
+  constructor(type, value) {
+    this._type = type
+    this._value = value
+  }
+
+  get type() {
+    return this._type
+  }
+
+  get value() {
+    return this._value
+  }
+
+  asMap() {
+    const map = new Map()
+    map.set('type', this._type)
+    map.set('value', this._value)
+    return map
+  }
+}
+
 class Header {
-  constructor(name, value, binaryValue) {
+  constructor(name, value) {
     this._name = name
+    if (!(value instanceof BytesValue)) {
+      throw new Error(`Value must be an instance of BytesValue. Received:'${value}'`)
+    }
     this._value = value
-    this._binaryValue = binaryValue
   }
 
   get name() {
@@ -31,17 +74,12 @@ class Header {
   get value() {
     return this._value
   }
-
-  get binaryValue() {
-    return this._binaryValue
-  }
 }
 
 class Cookie {
-  constructor(name, value, binaryValue, domain, path, expires, size, httpOnly, secure, sameSite) {
+  constructor(name, value, domain, path, size, httpOnly, secure, sameSite, expires) {
     this._name = name
     this._value = value
-    this._binaryValue = binaryValue
     this._domain = domain
     this._path = path
     this._expires = expires
@@ -59,10 +97,6 @@ class Cookie {
     return this._value
   }
 
-  get binaryValue() {
-    return this._binaryValue
-  }
-
   get domain() {
     return this._domain
   }
@@ -186,9 +220,8 @@ class RequestData {
     headers.forEach((header) => {
       let name = header.name
       let value = 'value' in header ? header.value : null
-      let binaryValue = 'binaryValue' in header ? header.binaryValue : null
 
-      this._headers.push(new Header(name, value, binaryValue))
+      this._headers.push(new Header(name, new BytesValue(value.type, value.value)))
     })
 
     this._cookies = []
@@ -201,10 +234,9 @@ class RequestData {
       let secure = cookie.secure
       let sameSite = cookie.sameSite
       let value = 'value' in cookie ? cookie.value : null
-      let binaryValue = 'binaryValue' in cookie ? cookie.binaryValue : null
       let expires = 'expires' in cookie ? cookie.expires : null
 
-      this._cookies.push(new Cookie(name, value, binaryValue, domain, path, expires, size, httpOnly, secure, sameSite))
+      this._cookies.push(new Cookie(name, value, domain, path, size, httpOnly, secure, sameSite, expires))
     })
     this._headersSize = headersSize
     this._bodySize = bodySize
@@ -453,4 +485,4 @@ class ResponseStarted extends BaseParameters {
   }
 }
 
-module.exports = { BeforeRequestSent, ResponseStarted, FetchError }
+module.exports = { Header, BytesValue, Cookie, SameSite, BeforeRequestSent, ResponseStarted, FetchError }

package/bidi/partialCookie.js

@@ -0,0 +1,67 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const { BytesValue } = require('./networkTypes')
+
+class PartialCookie {
+  #map = new Map()
+
+  constructor(name, value, domain) {
+    this.#map.set('name', name)
+    if (!(value instanceof BytesValue)) {
+      throw new Error(`Value must be an instance of BytesValue. Received:'${value}'`)
+    }
+    this.#map.set('value', Object.fromEntries(value.asMap()))
+    this.#map.set('domain', domain)
+  }
+
+  path(path) {
+    this.#map.set('path', path)
+    return this
+  }
+
+  size(size) {
+    this.#map.set('size', size)
+    return this
+  }
+
+  httpOnly(httpOnly) {
+    this.#map.set('httpOnly', httpOnly)
+    return this
+  }
+
+  secure(secure) {
+    this.#map.set('secure', secure)
+    return this
+  }
+
+  sameSite(sameSite) {
+    this.#map.set('sameSite', sameSite)
+    return this
+  }
+
+  expiry(expiry) {
+    this.#map.set('expiry', expiry)
+    return this
+  }
+
+  asMap() {
+    return this.#map
+  }
+}
+
+module.exports = { PartialCookie }

package/bidi/partitionDescriptor.js

@@ -0,0 +1,69 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const Type = {
+  CONTEXT: 'context',
+  STORAGE_KEY: 'storageKey',
+}
+
+class PartitionDescriptor {
+  #type
+
+  constructor(type) {
+    this.#type = type
+  }
+}
+
+class BrowsingContextPartitionDescriptor extends PartitionDescriptor {
+  #context = null
+
+  constructor(context) {
+    super(Type.CONTEXT)
+    this.#context = context
+  }
+
+  asMap() {
+    const map = new Map()
+    map.set('type', Type.CONTEXT)
+    map.set('context', this.#context)
+    return map
+  }
+}
+
+class StorageKeyPartitionDescriptor extends PartitionDescriptor {
+  #map = new Map()
+
+  constructor() {
+    super(Type.STORAGE_KEY)
+  }
+
+  userContext(userContext) {
+    this.#map.set('userContext', userContext)
+    return this
+  }
+
+  sourceOrigin(sourceOrigin) {
+    this.#map.set('sourceOrigin', sourceOrigin)
+    return this
+  }
+
+  asMap() {
+    return this.#map
+  }
+}
+
+module.exports = { BrowsingContextPartitionDescriptor, StorageKeyPartitionDescriptor }

package/bidi/partitionKey.js

@@ -0,0 +1,36 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+class PartitionKey {
+  #userContext
+  #sourceOrigin
+
+  constructor(userContext, sourceOrigin) {
+    this.#userContext = userContext
+    this.#sourceOrigin = sourceOrigin
+  }
+
+  get userContext() {
+    return this.#userContext
+  }
+
+  get sourceOrigin() {
+    return this.#sourceOrigin
+  }
+}
+
+module.exports = { PartitionKey }

package/bidi/protocolValue.js

@@ -160,23 +160,27 @@ class RemoteValue {
 }
 
 class ReferenceValue {
+  #handle
+  #sharedId
   constructor(handle, sharedId) {
     if (handle === RemoteReferenceType.HANDLE) {
-      this.handle = sharedId
+      this.#handle = sharedId
+    } else if (handle === RemoteReferenceType.SHARED_ID) {
+      this.#sharedId = sharedId
     } else {
-      this.handle = handle
-      this.sharedId = sharedId
+      this.#handle = handle
+      this.#sharedId = sharedId
     }
   }
 
   asMap() {
     const toReturn = {}
-    if (this.handle != null) {
-      toReturn[RemoteReferenceType.HANDLE] = this.handle
+    if (this.#handle != null) {
+      toReturn[RemoteReferenceType.HANDLE] = this.#handle
     }
 
-    if (this.sharedId != null) {
-      toReturn[RemoteReferenceType.SHARED_ID] = this.sharedId
+    if (this.#sharedId != null) {
+      toReturn[RemoteReferenceType.SHARED_ID] = this.#sharedId
     }
 
     return toReturn