selenium-webdriver 4.49.0 → 4.50.0

package/bidi/generated/network.d.ts

@@ -1,10 +1,12 @@
 import type { BrowserUserContext } from './browser.js';
+import './browser.js';
 import type { BrowsingContextBrowsingContext, BrowsingContextNavigation } from './browsing_context.js';
-import type { EmptyResult, Extensible, JsInt, JsUint } from './common.js';
+import './browsing_context.js';
+import type { EmptyResult, JsInt, JsUint } from './common.js';
+import './common.js';
 import type { ScriptStackTrace } from './script.js';
-export type NetworkCommand = NetworkAddDataCollector | NetworkAddIntercept | NetworkContinueRequest | NetworkContinueResponse | NetworkContinueWithAuth | NetworkDisownData | NetworkFailRequest | NetworkGetData | NetworkProvideResponse | NetworkRemoveDataCollector | NetworkRemoveIntercept | NetworkSetCacheBehavior | NetworkSetExtraHeaders;
-export type NetworkResult = NetworkAddDataCollectorResult | NetworkAddInterceptResult | NetworkContinueRequestResult | NetworkContinueResponseResult | NetworkContinueWithAuthResult | NetworkDisownDataResult | NetworkFailRequestResult | NetworkGetDataResult | NetworkProvideResponseResult | NetworkRemoveDataCollectorResult | NetworkRemoveInterceptResult | NetworkSetCacheBehaviorResult | NetworkSetExtraHeadersResult;
-export type NetworkEvent = NetworkAuthRequired | NetworkBeforeRequestSent | NetworkFetchError | NetworkResponseCompleted | NetworkResponseStarted;
+import './script.js';
+import { Domain, type EventDescriptor } from '../domain.js';
 export interface NetworkAuthChallenge {
     scheme: string;
     realm: string;
@@ -22,7 +24,7 @@ export interface NetworkBaseParameters {
     request: NetworkRequestData;
     timestamp: JsUint;
     userContext?: BrowserUserContext | null;
-    intercepts?: NetworkIntercept[];
+    intercepts?: Array<NetworkIntercept>;
 }
 export type NetworkBytesValue = NetworkStringValue | NetworkBase64Value;
 export interface NetworkStringValue {
@@ -36,7 +38,7 @@ export interface NetworkBase64Value {
 export type NetworkCollector = string;
 export type NetworkCollectorType = "blob";
 export type NetworkSameSite = "strict" | "lax" | "none" | "default";
-export type NetworkCookie = Extensible & {
+export interface NetworkCookie {
     name: string;
     value: NetworkBytesValue;
     domain: string;
@@ -46,7 +48,7 @@ export type NetworkCookie = Extensible & {
     secure: boolean;
     sameSite: NetworkSameSite;
     expiry?: JsUint;
-};
+}
 export interface NetworkCookieHeader {
     name: string;
     value: NetworkBytesValue;
@@ -76,7 +78,7 @@ export interface NetworkInitiator {
     lineNumber?: JsUint;
     request?: NetworkRequest;
     stackTrace?: ScriptStackTrace;
-    type?: "parser" | "script" | "preflight" | "other";
+    type?: NetworkInitiatorType;
 }
 export type NetworkIntercept = string;
 export type NetworkRequest = string;
@@ -84,8 +86,8 @@ export interface NetworkRequestData {
     request: NetworkRequest;
     url: string;
     method: string;
-    headers: NetworkHeader[];
-    cookies: NetworkCookie[];
+    headers: Array<NetworkHeader>;
+    cookies: Array<NetworkCookie>;
     headersSize: JsUint;
     bodySize: JsUint | null;
     destination: string;
@@ -101,13 +103,13 @@ export interface NetworkResponseData {
     status: JsUint;
     statusText: string;
     fromCache: boolean;
-    headers: NetworkHeader[];
+    headers: Array<NetworkHeader>;
     mimeType: string;
     bytesReceived: JsUint;
     headersSize: JsUint | null;
     bodySize: JsUint | null;
     content: NetworkResponseContent;
-    authChallenges?: NetworkAuthChallenge[];
+    authChallenges?: Array<NetworkAuthChallenge>;
 }
 export interface NetworkSetCookieHeader {
     name: string;
@@ -138,14 +140,11 @@ export interface NetworkAddDataCollector {
     params: NetworkAddDataCollectorParameters;
 }
 export interface NetworkAddDataCollectorParameters {
-    dataTypes: NetworkDataType[];
+    dataTypes: Array<NetworkDataType>;
     maxEncodedDataSize: JsUint;
-    /**
-     * @default 'blob'
-     */
     collectorType?: NetworkCollectorType;
-    contexts?: BrowsingContextBrowsingContext[];
-    userContexts?: BrowserUserContext[];
+    contexts?: Array<BrowsingContextBrowsingContext>;
+    userContexts?: Array<BrowserUserContext>;
 }
 export interface NetworkAddDataCollectorResult {
     collector: NetworkCollector;
@@ -155,9 +154,9 @@ export interface NetworkAddIntercept {
     params: NetworkAddInterceptParameters;
 }
 export interface NetworkAddInterceptParameters {
-    phases: NetworkInterceptPhase[];
-    contexts?: BrowsingContextBrowsingContext[];
-    urlPatterns?: NetworkUrlPattern[];
+    phases: Array<NetworkInterceptPhase>;
+    contexts?: Array<BrowsingContextBrowsingContext>;
+    urlPatterns?: Array<NetworkUrlPattern>;
 }
 export type NetworkInterceptPhase = "beforeRequestSent" | "responseStarted" | "authRequired";
 export interface NetworkAddInterceptResult {
@@ -170,8 +169,8 @@ export interface NetworkContinueRequest {
 export interface NetworkContinueRequestParameters {
     request: NetworkRequest;
     body?: NetworkBytesValue;
-    cookies?: NetworkCookieHeader[];
-    headers?: NetworkHeader[];
+    cookies?: Array<NetworkCookieHeader>;
+    headers?: Array<NetworkHeader>;
     method?: string;
     url?: string;
 }
@@ -182,9 +181,9 @@ export interface NetworkContinueResponse {
 }
 export interface NetworkContinueResponseParameters {
     request: NetworkRequest;
-    cookies?: NetworkSetCookieHeader[];
+    cookies?: Array<NetworkSetCookieHeader>;
     credentials?: NetworkAuthCredentials;
-    headers?: NetworkHeader[];
+    headers?: Array<NetworkHeader>;
     reasonPhrase?: string;
     statusCode?: JsUint;
 }
@@ -193,16 +192,7 @@ export interface NetworkContinueWithAuth {
     method: "network.continueWithAuth";
     params: NetworkContinueWithAuthParameters;
 }
-export type NetworkContinueWithAuthParameters = (NetworkContinueWithAuthCredentials | NetworkContinueWithAuthNoCredentials) & {
-    request: NetworkRequest;
-};
-export interface NetworkContinueWithAuthCredentials {
-    action: "provideCredentials";
-    credentials: NetworkAuthCredentials;
-}
-export interface NetworkContinueWithAuthNoCredentials {
-    action: "default" | "cancel";
-}
+export type NetworkContinueWithAuthParameters = NetworkContinueWithAuthParameters_Credentials | NetworkContinueWithAuthParameters_NoCredentials;
 export type NetworkContinueWithAuthResult = EmptyResult;
 export interface NetworkDisownData {
     method: "network.disownData";
@@ -242,8 +232,8 @@ export interface NetworkProvideResponse {
 export interface NetworkProvideResponseParameters {
     request: NetworkRequest;
     body?: NetworkBytesValue;
-    cookies?: NetworkSetCookieHeader[];
-    headers?: NetworkHeader[];
+    cookies?: Array<NetworkSetCookieHeader>;
+    headers?: Array<NetworkHeader>;
     reasonPhrase?: string;
     statusCode?: JsUint;
 }
@@ -269,8 +259,8 @@ export interface NetworkSetCacheBehavior {
     params: NetworkSetCacheBehaviorParameters;
 }
 export interface NetworkSetCacheBehaviorParameters {
-    cacheBehavior: "default" | "bypass";
-    contexts?: BrowsingContextBrowsingContext[];
+    cacheBehavior: NetworkSetCacheBehaviorParametersCacheBehavior;
+    contexts?: Array<BrowsingContextBrowsingContext>;
 }
 export type NetworkSetCacheBehaviorResult = EmptyResult;
 export interface NetworkSetExtraHeaders {
@@ -278,82 +268,264 @@ export interface NetworkSetExtraHeaders {
     params: NetworkSetExtraHeadersParameters;
 }
 export interface NetworkSetExtraHeadersParameters {
-    headers: NetworkHeader[];
-    contexts?: BrowsingContextBrowsingContext[];
-    userContexts?: BrowserUserContext[];
+    headers: Array<NetworkHeader>;
+    contexts?: Array<BrowsingContextBrowsingContext>;
+    userContexts?: Array<BrowserUserContext>;
 }
 export type NetworkSetExtraHeadersResult = EmptyResult;
 export interface NetworkAuthRequired {
     method: "network.authRequired";
     params: NetworkAuthRequiredParameters;
 }
-export type NetworkAuthRequiredParameters = NetworkBaseParameters & {
+export interface NetworkAuthRequiredParameters {
+    context: BrowsingContextBrowsingContext | null;
+    isBlocked: boolean;
+    navigation: BrowsingContextNavigation | null;
+    redirectCount: JsUint;
+    request: NetworkRequestData;
+    timestamp: JsUint;
+    userContext?: BrowserUserContext | null;
+    intercepts?: Array<NetworkIntercept>;
     response: NetworkResponseData;
-};
+}
 export interface NetworkBeforeRequestSent {
     method: "network.beforeRequestSent";
     params: NetworkBeforeRequestSentParameters;
 }
-export type NetworkBeforeRequestSentParameters = NetworkBaseParameters & {
+export interface NetworkBeforeRequestSentParameters {
+    context: BrowsingContextBrowsingContext | null;
+    isBlocked: boolean;
+    navigation: BrowsingContextNavigation | null;
+    redirectCount: JsUint;
+    request: NetworkRequestData;
+    timestamp: JsUint;
+    userContext?: BrowserUserContext | null;
+    intercepts?: Array<NetworkIntercept>;
     initiator?: NetworkInitiator;
-};
+}
 export interface NetworkFetchError {
     method: "network.fetchError";
     params: NetworkFetchErrorParameters;
 }
-export type NetworkFetchErrorParameters = NetworkBaseParameters & {
+export interface NetworkFetchErrorParameters {
+    context: BrowsingContextBrowsingContext | null;
+    isBlocked: boolean;
+    navigation: BrowsingContextNavigation | null;
+    redirectCount: JsUint;
+    request: NetworkRequestData;
+    timestamp: JsUint;
+    userContext?: BrowserUserContext | null;
+    intercepts?: Array<NetworkIntercept>;
     errorText: string;
-};
+}
 export interface NetworkResponseCompleted {
     method: "network.responseCompleted";
     params: NetworkResponseCompletedParameters;
 }
-export type NetworkResponseCompletedParameters = NetworkBaseParameters & {
+export interface NetworkResponseCompletedParameters {
+    context: BrowsingContextBrowsingContext | null;
+    isBlocked: boolean;
+    navigation: BrowsingContextNavigation | null;
+    redirectCount: JsUint;
+    request: NetworkRequestData;
+    timestamp: JsUint;
+    userContext?: BrowserUserContext | null;
+    intercepts?: Array<NetworkIntercept>;
     response: NetworkResponseData;
-};
+}
 export interface NetworkResponseStarted {
     method: "network.responseStarted";
     params: NetworkResponseStartedParameters;
 }
-export type NetworkResponseStartedParameters = NetworkBaseParameters & {
+export interface NetworkResponseStartedParameters {
+    context: BrowsingContextBrowsingContext | null;
+    isBlocked: boolean;
+    navigation: BrowsingContextNavigation | null;
+    redirectCount: JsUint;
+    request: NetworkRequestData;
+    timestamp: JsUint;
+    userContext?: BrowserUserContext | null;
+    intercepts?: Array<NetworkIntercept>;
     response: NetworkResponseData;
-};
-/** @deprecated Use {@link Network.create} instead — will be removed in a future major version. */
-export declare function getNetworkInstance(driver: unknown): Promise<Network>;
-export declare class Network {
-    private readonly bidi;
-    private constructor();
+}
+export type NetworkInitiatorType = "parser" | "script" | "preflight" | "other";
+export type NetworkContinueWithAuthNoCredentialsAction = "default" | "cancel";
+export type NetworkSetCacheBehaviorParametersCacheBehavior = "default" | "bypass";
+export interface NetworkContinueWithAuthParameters_Credentials {
+    request: NetworkRequest;
+    action: "provideCredentials";
+    credentials: NetworkAuthCredentials;
+}
+export interface NetworkContinueWithAuthParameters_NoCredentials {
+    request: NetworkRequest;
+    action: NetworkContinueWithAuthNoCredentialsAction;
+}
+/**
+ * This is an unsupported API. No compatibility guarantees are provided.
+ * It tracks the W3C WebDriver BiDi specification directly. As the specification
+ * evolves, this API will change or be removed without prior notice.
+ */
+export declare class Network extends Domain {
+    /** @see https://w3c.github.io/webdriver-bidi/#event-network-authRequired */
+    static readonly AUTH_REQUIRED: EventDescriptor<NetworkAuthRequiredParameters>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-network-beforeRequestSent */
+    static readonly BEFORE_REQUEST_SENT: EventDescriptor<NetworkBeforeRequestSentParameters>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-network-fetchError */
+    static readonly FETCH_ERROR: EventDescriptor<NetworkFetchErrorParameters>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-network-responseCompleted */
+    static readonly RESPONSE_COMPLETED: EventDescriptor<NetworkResponseCompletedParameters>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-network-responseStarted */
+    static readonly RESPONSE_STARTED: EventDescriptor<NetworkResponseStartedParameters>;
+    static readonly CollectorType: Readonly<{
+        readonly BLOB: "blob";
+    }>;
+    static readonly SameSite: Readonly<{
+        readonly STRICT: "strict";
+        readonly LAX: "lax";
+        readonly NONE: "none";
+        readonly DEFAULT: "default";
+    }>;
+    static readonly DataType: Readonly<{
+        readonly REQUEST: "request";
+        readonly RESPONSE: "response";
+    }>;
+    static readonly InterceptPhase: Readonly<{
+        readonly BEFORE_REQUEST_SENT: "beforeRequestSent";
+        readonly RESPONSE_STARTED: "responseStarted";
+        readonly AUTH_REQUIRED: "authRequired";
+    }>;
+    static readonly InitiatorType: Readonly<{
+        readonly PARSER: "parser";
+        readonly SCRIPT: "script";
+        readonly PREFLIGHT: "preflight";
+        readonly OTHER: "other";
+    }>;
+    static readonly ContinueWithAuthNoCredentialsAction: Readonly<{
+        readonly DEFAULT: "default";
+        readonly CANCEL: "cancel";
+    }>;
+    static readonly SetCacheBehaviorParametersCacheBehavior: Readonly<{
+        readonly DEFAULT: "default";
+        readonly BYPASS: "bypass";
+    }>;
     static create(driver: unknown): Promise<Network>;
+    /**
+     * @param {NetworkAddDataCollectorParameters} params
+     * @param {Array<NetworkDataType>} params.dataTypes
+     * @param {JsUint} params.maxEncodedDataSize
+     * @param {NetworkCollectorType} [params.collectorType]
+     * @param {Array<BrowsingContextBrowsingContext>} [params.contexts]
+     * @param {Array<BrowserUserContext>} [params.userContexts]
+     * @returns {Promise<NetworkAddDataCollectorResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-addDataCollector
+     */
     addDataCollector(params: NetworkAddDataCollectorParameters): Promise<NetworkAddDataCollectorResult>;
+    /**
+     * @param {NetworkAddInterceptParameters} params
+     * @param {Array<NetworkInterceptPhase>} params.phases
+     * @param {Array<BrowsingContextBrowsingContext>} [params.contexts]
+     * @param {Array<NetworkUrlPattern>} [params.urlPatterns]
+     * @returns {Promise<NetworkAddInterceptResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-addIntercept
+     */
     addIntercept(params: NetworkAddInterceptParameters): Promise<NetworkAddInterceptResult>;
+    /**
+     * @param {NetworkContinueRequestParameters} params
+     * @param {NetworkRequest} params.request
+     * @param {NetworkBytesValue} [params.body]
+     * @param {Array<NetworkCookieHeader>} [params.cookies]
+     * @param {Array<NetworkHeader>} [params.headers]
+     * @param {string} [params.method]
+     * @param {string} [params.url]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-continueRequest
+     */
     continueRequest(params: NetworkContinueRequestParameters): Promise<void>;
+    /**
+     * @param {NetworkContinueResponseParameters} params
+     * @param {NetworkRequest} params.request
+     * @param {Array<NetworkSetCookieHeader>} [params.cookies]
+     * @param {NetworkAuthCredentials} [params.credentials]
+     * @param {Array<NetworkHeader>} [params.headers]
+     * @param {string} [params.reasonPhrase]
+     * @param {JsUint} [params.statusCode]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-continueResponse
+     */
     continueResponse(params: NetworkContinueResponseParameters): Promise<void>;
+    /**
+     * @param {NetworkContinueWithAuthParameters} params
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth
+     */
     continueWithAuth(params: NetworkContinueWithAuthParameters): Promise<void>;
-    /** @deprecated Pass a NetworkContinueWithAuthParameters object instead — will be removed in a future major version. */
-    continueWithAuth(requestId: NetworkRequest, username: string, password: string): Promise<void>;
+    /**
+     * @param {NetworkDisownDataParameters} params
+     * @param {NetworkDataType} params.dataType
+     * @param {NetworkCollector} params.collector
+     * @param {NetworkRequest} params.request
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-disownData
+     */
     disownData(params: NetworkDisownDataParameters): Promise<void>;
+    /**
+     * @param {NetworkFailRequestParameters} params
+     * @param {NetworkRequest} params.request
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-failRequest
+     */
     failRequest(params: NetworkFailRequestParameters): Promise<void>;
+    /**
+     * @param {NetworkGetDataParameters} params
+     * @param {NetworkDataType} params.dataType
+     * @param {NetworkCollector} [params.collector]
+     * @param {boolean} [params.disown]
+     * @param {NetworkRequest} params.request
+     * @returns {Promise<NetworkGetDataResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-getData
+     */
     getData(params: NetworkGetDataParameters): Promise<NetworkGetDataResult>;
+    /**
+     * @param {NetworkProvideResponseParameters} params
+     * @param {NetworkRequest} params.request
+     * @param {NetworkBytesValue} [params.body]
+     * @param {Array<NetworkSetCookieHeader>} [params.cookies]
+     * @param {Array<NetworkHeader>} [params.headers]
+     * @param {string} [params.reasonPhrase]
+     * @param {JsUint} [params.statusCode]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-provideResponse
+     */
     provideResponse(params: NetworkProvideResponseParameters): Promise<void>;
+    /**
+     * @param {NetworkRemoveDataCollectorParameters} params
+     * @param {NetworkCollector} params.collector
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-removeDataCollector
+     */
     removeDataCollector(params: NetworkRemoveDataCollectorParameters): Promise<void>;
+    /**
+     * @param {NetworkRemoveInterceptParameters} params
+     * @param {NetworkIntercept} params.intercept
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept
+     */
     removeIntercept(params: NetworkRemoveInterceptParameters): Promise<void>;
+    /**
+     * @param {NetworkSetCacheBehaviorParameters} params
+     * @param {NetworkSetCacheBehaviorParametersCacheBehavior} params.cacheBehavior
+     * @param {Array<BrowsingContextBrowsingContext>} [params.contexts]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-setCacheBehavior
+     */
     setCacheBehavior(params: NetworkSetCacheBehaviorParameters): Promise<void>;
+    /**
+     * @param {NetworkSetExtraHeadersParameters} params
+     * @param {Array<NetworkHeader>} params.headers
+     * @param {Array<BrowsingContextBrowsingContext>} [params.contexts]
+     * @param {Array<BrowserUserContext>} [params.userContexts]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-network-setExtraHeaders
+     */
     setExtraHeaders(params: NetworkSetExtraHeadersParameters): Promise<void>;
-    onAuthRequired(callback: (params: NetworkAuthRequiredParameters) => void): Promise<void>;
-    onBeforeRequestSent(callback: (params: NetworkBeforeRequestSentParameters) => void): Promise<void>;
-    onFetchError(callback: (params: NetworkFetchErrorParameters) => void): Promise<void>;
-    onResponseCompleted(callback: (params: NetworkResponseCompletedParameters) => void): Promise<void>;
-    onResponseStarted(callback: (params: NetworkResponseStartedParameters) => void): Promise<void>;
-    cancelAuth(requestId: NetworkRequest): Promise<void>;
-    continueWithAuthNoCredentials(requestId: NetworkRequest): Promise<void>;
-    /** @deprecated Use {@link onBeforeRequestSent} instead — will be removed in a future major version. */
-    beforeRequestSent(callback: (params: NetworkBeforeRequestSentParameters) => void): Promise<void>;
-    /** @deprecated Use {@link onAuthRequired} instead — will be removed in a future major version. */
-    authRequired(callback: (params: NetworkAuthRequiredParameters) => void): Promise<void>;
-    /** @deprecated Use {@link onFetchError} instead — will be removed in a future major version. */
-    fetchError(callback: (params: NetworkFetchErrorParameters) => void): Promise<void>;
-    /** @deprecated Use {@link onResponseCompleted} instead — will be removed in a future major version. */
-    responseCompleted(callback: (params: NetworkResponseCompletedParameters) => void): Promise<void>;
-    /** @deprecated Use {@link onResponseStarted} instead — will be removed in a future major version. */
-    responseStarted(callback: (params: NetworkResponseStartedParameters) => void): Promise<void>;
 }