selenium-webdriver 4.19.0 → 4.21.0

package/bidi/networkTypes.js

@@ -17,6 +17,11 @@
 
 const { NavigationInfo } = require('./browsingContextTypes')
 
+/**
+ * Represents the possible values for the SameSite attribute of a cookie.
+ * @enum {string}
+ */
+
 const SameSite = {
   STRICT: 'strict',
   LAX: 'lax',
@@ -31,25 +36,46 @@ const SameSite = {
   },
 }
 
+/**
+ * Represents a BytesValue object.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-BytesValue.
+ */
 class BytesValue {
   static Type = {
     STRING: 'string',
     BASE64: 'base64',
   }
 
+  /**
+   * Creates a new BytesValue instance.
+   * @param {string} type - The type of the BytesValue.
+   * @param {string} value - The value of the BytesValue.
+   */
   constructor(type, value) {
     this._type = type
     this._value = value
   }
 
+  /**
+   * Gets the type of the BytesValue.
+   * @returns {string} The type of the BytesValue.
+   */
   get type() {
     return this._type
   }
 
+  /**
+   * Gets the value of the BytesValue.
+   * @returns {string} The value of the BytesValue.
+   */
   get value() {
     return this._value
   }
 
+  /**
+   * Converts the BytesValue to a map.
+   * @returns {Map<string, string>} A map representation of the BytesValue.
+   */
   asMap() {
     const map = new Map()
     map.set('type', this._type)
@@ -58,24 +84,47 @@ class BytesValue {
   }
 }
 
+/**
+ * Represents a header with a name and value.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-Header.
+ */
 class Header {
+  /**
+   * Creates a new Header instance.
+   * @param {string} name - The name of the header.
+   * @param {BytesValue} value - The value of the header.
+   * @throws {Error} If the value is not an instance of BytesValue.
+   */
   constructor(name, value) {
     this._name = name
     if (!(value instanceof BytesValue)) {
-      throw new Error(`Value must be an instance of BytesValue. Received:'${value}'`)
+      throw new Error(`Value must be an instance of BytesValue. Received: '${value}'`)
     }
     this._value = value
   }
 
+  /**
+   * Gets the name of the header.
+   * @returns {string} The name of the header.
+   */
   get name() {
     return this._name
   }
 
+  /**
+   * Gets the value of the header.
+   * @returns {BytesValue} The value of the header.
+   */
   get value() {
     return this._value
   }
 }
 
+/**
+ * Represents a cookie.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-Cookie.
+ * @class
+ */
 class Cookie {
   constructor(name, value, domain, path, size, httpOnly, secure, sameSite, expires) {
     this._name = name
@@ -89,44 +138,85 @@ class Cookie {
     this._sameSite = sameSite
   }
 
+  /**
+   * Gets the name of the cookie.
+   * @returns {string} The name of the cookie.
+   */
   get name() {
     return this._name
   }
 
+  /**
+   * Gets the value of the cookie.
+   * @returns {BytesValue} The value of the cookie.
+   */
   get value() {
     return this._value
   }
 
+  /**
+   * Gets the domain of the cookie.
+   * @returns {string} The domain of the cookie.
+   */
   get domain() {
     return this._domain
   }
 
+  /**
+   * Gets the path of the cookie.
+   * @returns {string} The path of the cookie.
+   */
   get path() {
     return this._path
   }
 
+  /**
+   * Gets the expiration date of the cookie.
+   * @returns {number} The expiration date of the cookie.
+   */
   get expires() {
     return this._expires
   }
 
+  /**
+   * Gets the size of the cookie.
+   * @returns {number} The size of the cookie.
+   */
   get size() {
     return this._size
   }
 
+  /**
+   * Checks if the cookie is HTTP-only.
+   * @returns {boolean} True if the cookie is HTTP-only, false otherwise.
+   */
   get httpOnly() {
     return this._httpOnly
   }
 
+  /**
+   * Checks if the cookie is secure.
+   * @returns {boolean} True if the cookie is secure, false otherwise.
+   */
   get secure() {
     return this._secure
   }
 
+  /**
+   * Gets the same-site attribute of the cookie.
+   * @returns {string} The same-site attribute of the cookie.
+   */
   get sameSite() {
     return this._sameSite
   }
 }
 
 // No tests written for FetchTimingInfo. Must be updated after browsers implment it and corresponding WPT test are written.
+/**
+ * Represents the time of each part of the request.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-FetchTimingInfo.
+ * @class
+ */
 class FetchTimingInfo {
   constructor(
     originTime,
@@ -158,59 +248,128 @@ class FetchTimingInfo {
     this._responseEnd = responseEnd
   }
 
+  /**
+   * Gets the origin time.
+   *
+   * @returns {number} The origin time.
+   */
   get originTime() {
     return this._originTime
   }
 
+  /**
+   * Get the request time.
+   *
+   * @returns {number} The request time.
+   */
   get requestTime() {
     return this._requestTime
   }
 
+  /**
+   * Gets the timestamp when the redirect started.
+   *
+   * @returns {number} The timestamp when the redirect started.
+   */
   get redirectStart() {
     return this._redirectStart
   }
 
+  /**
+   * Gets the timestamp when the redirect ended.
+   *
+   * @returns {number} The timestamp when the redirect ended.
+   */
   get redirectEnd() {
     return this._redirectEnd
   }
 
+  /**
+   * Gets the timestamp when the fetch started.
+   *
+   * @returns {number} The timestamp when the fetch started.
+   */
   get fetchStart() {
     return this._fetchStart
   }
 
+  /**
+   * Gets the timestamp when the domain lookup started.
+   *
+   * @returns {number} The timestamp when the domain lookup started.
+   */
   get dnsStart() {
     return this._dnsStart
   }
 
+  /**
+   * Gets the timestamp when the domain lookup ended.
+   *
+   * @returns {number} The timestamp when the domain lookup ended.
+   */
   get dnsEnd() {
     return this._dnsEnd
   }
 
+  /**
+   * Gets the timestamp when the connection started.
+   *
+   * @returns {number} The timestamp when the connection ended.
+   */
   get connectStart() {
     return this._connectStart
   }
 
+  /**
+   * Gets the timestamp when the connection ended.
+   *
+   * @returns {number} The timestamp when the connection ended.
+   */
   get connectEnd() {
     return this._connectEnd
   }
 
+  /**
+   * Gets the timestamp when the secure connection started.
+   *
+   * @returns {number} The timestamp when the secure connection started.
+   */
   get tlsStart() {
     return this._tlsStart
   }
 
+  /**
+   * Gets the timestamp when the request started.
+   *
+   * @returns {number} The timestamp when the request started.
+   */
   get requestStart() {
     return this._requestStart
   }
 
+  /**
+   * Gets the timestamp when the response started.
+   *
+   * @returns {number} The timestamp when the response started.
+   */
   get responseStart() {
     return this._responseStart
   }
 
+  /**
+   * Gets the timestamp when the response ended.
+   *
+   * @returns {number} The timestamp when the response ended.
+   */
   get responseEnd() {
     return this._responseEnd
   }
 }
 
+/**
+ * Represents the data of a network request.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-RequestData.
+ */
 class RequestData {
   constructor(request, url, method, headers, cookies, headersSize, bodySize, timings) {
     this._request = request
@@ -257,39 +416,75 @@ class RequestData {
     )
   }
 
+  /**
+   * Get the request id.
+   * @returns {string} The request id.
+   */
   get request() {
     return this._request
   }
 
+  /**
+   * Get the URL of the request.
+   * @returns {string} The URL of the request.
+   */
   get url() {
     return this._url
   }
 
+  /**
+   * Get the HTTP method of the request.
+   * @returns {string} The HTTP method of the request.
+   */
   get method() {
     return this._method
   }
 
+  /**
+   * Get the headers of the request.
+   * @returns {Header[]} An array of header objects.
+   */
   get headers() {
     return this._headers
   }
 
+  /**
+   * Get the cookies of the request.
+   * @returns {Cookie[]} An array of cookie objects.
+   */
   get cookies() {
     return this._cookies
   }
 
+  /**
+   * Get the size of the headers in bytes.
+   * @returns {number} The size of the headers in bytes.
+   */
   get headersSize() {
     return this._headersSize
   }
 
+  /**
+   * Get the size of the request body in bytes.
+   * @returns {number} The size of the request body in bytes.
+   */
   get bodySize() {
     return this._bodySize
   }
 
+  /**
+   * Get the timing information of the request.
+   * @returns {FetchTimingInfo} The timing information of the request.
+   */
   get timings() {
     return this._timings
   }
 }
 
+/**
+ * Represents the base parameters for a network request.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-BaseParameters.
+ */
 class BaseParameters {
   constructor(id, navigation, redirectCount, request, timestamp) {
     this._id = id
@@ -311,28 +506,60 @@ class BaseParameters {
     this._timestamp = timestamp
   }
 
+  /**
+   * Gets the browsing context ID of the network request.
+   * @returns {string|null} The browsing context ID of the network request.
+   */
   get id() {
     return this._id
   }
 
+  /**
+   * Gets the navigation information associated with the network request.
+   * @returns {NavigationInfo|null} The navigation information associated with the network request, or null if not available.
+   */
   get navigation() {
     return this._navigation
   }
 
+  /**
+   * Gets the number of redirects that occurred during the network request.
+   * @returns {number} The number of redirects that occurred during the network request.
+   */
   get redirectCount() {
     return this._redirectCount
   }
 
+  /**
+   * Gets the request data for the network request.
+   * @returns {RequestData} The request data for the network request.
+   */
   get request() {
     return this._request
   }
 
+  /**
+   * Gets the timestamp of the network request.
+   * @returns {number} The timestamp of the network request.
+   */
   get timestamp() {
     return this._timestamp
   }
 }
 
+/**
+ * Represents source in the network.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-Initiator.
+ */
 class Initiator {
+  /**
+   * Constructs a new Initiator instance.
+   * @param {string} type - The type of the initiator.
+   * @param {number} columnNumber - The column number.
+   * @param {number} lineNumber - The line number.
+   * @param {string} stackTrace - The stack trace.
+   * @param {string} request - The request id.
+   */
   constructor(type, columnNumber, lineNumber, stackTrace, request) {
     this._type = type
     this._columnNumber = columnNumber
@@ -341,27 +568,53 @@ class Initiator {
     this._request = request
   }
 
+  /**
+   * Gets the type of the initiator.
+   * @returns {string} The type of the initiator.
+   */
   get type() {
     return this._type
   }
 
+  /**
+   * Gets the column number.
+   * @returns {number} The column number.
+   */
   get columnNumber() {
     return this._columnNumber
   }
 
+  /**
+   * Gets the line number.
+   * @returns {number} The line number.
+   */
   get lineNumber() {
     return this._lineNumber
   }
 
+  /**
+   * Gets the stack trace.
+   * @returns {string} The stack trace.
+   */
   get stackTrace() {
     return this._stackTrace
   }
 
+  /**
+   * Gets the request ID.
+   * @returns {string} The request ID.
+   */
   get request() {
     return this._request
   }
 }
 
+/**
+ * Represents the BeforeRequestSent event parameters.
+ * @class
+ * @extends BaseParameters
+ * Described in https://w3c.github.io/webdriver-bidi/#event-network-beforeSendRequest.
+ */
 class BeforeRequestSent extends BaseParameters {
   constructor(id, navigation, redirectCount, request, timestamp, initiator) {
     super(id, navigation, redirectCount, request, timestamp)
@@ -374,22 +627,49 @@ class BeforeRequestSent extends BaseParameters {
     )
   }
 
+  /**
+   * Get the initiator of the request.
+   * @returns {Initiator} The initiator object.
+   */
   get initiator() {
     return this._initiator
   }
 }
 
+/**
+ * Represents the FetchError event parameters.
+ * Described https://w3c.github.io/webdriver-bidi/#event-network-fetchError
+ * @extends BaseParameters
+ */
 class FetchError extends BaseParameters {
+  /**
+   * Creates a new FetchError instance.
+   * @param {string} id - The ID of the error.
+   * @param {string} navigation - The navigation information.
+   * @param {number} redirectCount - The number of redirects.
+   * @param {RequestData} request - The request object.
+   * @param {number} timestamp - The timestamp of the error.
+   * @param {string} errorText - The error text.
+   */
   constructor(id, navigation, redirectCount, request, timestamp, errorText) {
     super(id, navigation, redirectCount, request, timestamp)
     this._errorText = errorText
   }
 
+  /**
+   * Gets the error text.
+   * @returns {string} The error text.
+   */
   get errorText() {
     return this._errorText
   }
 }
 
+/**
+ * Represents the response data received from a network request.
+ * Described in https://w3c.github.io/webdriver-bidi/#type-network-ResponseData.
+ * @class
+ */
 class ResponseData {
   constructor(
     url,
@@ -417,51 +697,112 @@ class ResponseData {
     this._content = content
   }
 
+  /**
+   * Get the URL.
+   *
+   * @returns {string} The URL.
+   */
   get url() {
     return this._url
   }
 
+  /**
+   * Get the protocol.
+   *
+   * @returns {string} The protocol.
+   */
   get protocol() {
     return this._protocol
   }
 
+  /**
+   * Get the HTTP status.
+   *
+   * @returns {string} The HTTP status.
+   */
   get status() {
     return this._status
   }
 
+  /**
+   * Gets the status text.
+   *
+   * @returns {string} The status text.
+   */
   get statusText() {
     return this._statusText
   }
 
+  /**
+   * Gets the value indicating whether the data is retrieved from cache.
+   *
+   * @returns {boolean} The value indicating whether the data is retrieved from cache.
+   */
   get fromCache() {
     return this._fromCache
   }
 
+  /**
+   * Get the headers.
+   *
+   * @returns {Object} The headers object.
+   */
   get headers() {
     return this._headers
   }
 
+  /**
+   * The MIME type of the network resource.
+   *
+   * @type {string}
+   */
   get mimeType() {
     return this._mimeType
   }
 
+  /**
+   * Gets the number of bytes received.
+   *
+   * @returns {number} The number of bytes received.
+   */
   get bytesReceived() {
     return this._bytesReceived
   }
 
+  /**
+   * Get the size of the headers.
+   *
+   * @returns {number} The size of the headers.
+   */
   get headerSize() {
     return this._headersSize
   }
 
+  /**
+   * Get the size of the body.
+   *
+   * @returns {number} The size of the body.
+   */
   get bodySize() {
     return this._bodySize
   }
 
+  /**
+   * Gets the content.
+   *
+   * @returns {any} The content.
+   */
   get content() {
     return this._content
   }
 }
 
+/**
+ * Represents the ResponseStarted event parameters.
+ * Described in https://w3c.github.io/webdriver-bidi/#event-network-responseStarted.
+ * @class
+ * @extends BaseParameters
+ */
 class ResponseStarted extends BaseParameters {
   constructor(id, navigation, redirectCount, request, timestamp, response) {
     super(id, navigation, redirectCount, request, timestamp)
@@ -480,6 +821,10 @@ class ResponseStarted extends BaseParameters {
     )
   }
 
+  /**
+   * Get the response data.
+   * @returns {ResponseData} The response data.
+   */
   get response() {
     return this._response
   }