selenium-webdriver 4.48.0 → 4.50.0

package/bidi/generated/permissions.js

@@ -17,27 +17,41 @@
 // under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Permissions = void 0;
+// DO NOT EDIT! This file is generated by javascript/selenium-webdriver/generate_bidi.mjs.
+// Regenerate with: `bazel build //javascript/selenium-webdriver:create-bidi-src`
+// Built from the WebDriver BiDi CDDL spec (v1.0).
+// Source: https://github.com/w3c/webref/tree/main/ed/cddl
+const record_js_1 = require("../serialization/record.js");
+const enum_js_1 = require("../serialization/enum.js");
+const domain_js_1 = require("../domain.js");
+const PermissionsPermissionDescriptor = (0, record_js_1.defineRecord)('permissions.PermissionDescriptor', [{ "name": "name", "wire": "name", "required": true, "type": { "primitive": "string" } }]);
+const PermissionsPermissionStateEnum = (0, enum_js_1.defineEnum)('permissions.PermissionState', ["granted", "denied", "prompt"]);
+const PermissionsSetPermission = (0, record_js_1.defineRecord)('permissions.setPermission', [{ "name": "method", "wire": "method", "required": true, "type": { "const": "permissions.setPermission" } }, { "name": "params", "wire": "params", "required": true, "type": { "ref": "permissions.SetPermissionParameters" } }]);
+const PermissionsSetPermissionParameters = (0, record_js_1.defineRecord)('permissions.SetPermissionParameters', [{ "name": "descriptor", "wire": "descriptor", "required": true, "type": { "ref": "permissions.PermissionDescriptor" } }, { "name": "state", "wire": "state", "required": true, "type": { "ref": "permissions.PermissionState" } }, { "name": "origin", "wire": "origin", "required": true, "type": { "primitive": "string" } }, { "name": "embeddedOrigin", "wire": "embeddedOrigin", "required": false, "type": { "primitive": "string" } }, { "name": "userContext", "wire": "userContext", "required": false, "type": { "primitive": "string" } }]);
 // --- Implementation ---
-class Permissions {
-    constructor(bidi) {
-        this.bidi = bidi;
-    }
+/**
+ * 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.
+ */
+class Permissions extends domain_js_1.Domain {
     static async create(driver) {
-        const caps = await driver.getCapabilities();
-        if (!caps.get('webSocketUrl')) {
-            throw new Error('WebDriver instance must support BiDi protocol');
-        }
-        const bidi = await driver.getBidi();
-        return new Permissions(bidi);
+        return new Permissions(await domain_js_1.Domain.connect(driver), domain_js_1.DOMAIN_TOKEN);
     }
+    /**
+     * @param {PermissionsSetPermissionParameters} params
+     * @param {PermissionsPermissionDescriptor} params.descriptor
+     * @param {PermissionsPermissionState} params.state
+     * @param {string} params.origin
+     * @param {string} [params.embeddedOrigin]
+     * @param {string} [params.userContext]
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-permissions-setPermission
+     */
     async setPermission(params) {
-        const response = await this.bidi.send({
-            method: 'permissions.setPermission',
-            params: params,
-        });
-        if (response['type'] === 'error') {
-            throw new Error(`${response['error']}: ${response['message']}`);
-        }
+        const validatedParams = new PermissionsSetPermissionParameters(params);
+        await this.send('permissions.setPermission', validatedParams);
     }
 }
 exports.Permissions = Permissions;
+Permissions.PermissionState = Object.freeze({ GRANTED: "granted", DENIED: "denied", PROMPT: "prompt" });

package/bidi/generated/script.d.ts

@@ -1,9 +1,10 @@
 import type { BrowserUserContext } from './browser.js';
+import './browser.js';
 import type { BrowsingContextBrowsingContext } from './browsing_context.js';
-import type { EmptyResult, Extensible, JsUint } from './common.js';
-export type ScriptCommand = ScriptAddPreloadScript | ScriptCallFunction | ScriptDisown | ScriptEvaluate | ScriptGetRealms | ScriptRemovePreloadScript;
-export type ScriptResult = ScriptAddPreloadScriptResult | ScriptCallFunctionResult | ScriptDisownResult | ScriptEvaluateResult | ScriptGetRealmsResult | ScriptRemovePreloadScriptResult;
-export type ScriptEvent = ScriptMessage | ScriptRealmCreated | ScriptRealmDestroyed;
+import './browsing_context.js';
+import type { EmptyResult, JsUint } from './common.js';
+import './common.js';
+import { Domain, type EventDescriptor } from '../domain.js';
 export type ScriptChannel = string;
 export interface ScriptChannelValue {
     type: "channel";
@@ -35,7 +36,7 @@ export interface ScriptExceptionDetails {
 export type ScriptHandle = string;
 export type ScriptInternalId = string;
 export type ScriptLocalValue = ScriptRemoteReference | ScriptPrimitiveProtocolValue | ScriptChannelValue | ScriptArrayLocalValue | ScriptDateLocalValue | ScriptMapLocalValue | ScriptObjectLocalValue | ScriptRegExpLocalValue | ScriptSetLocalValue;
-export type ScriptListLocalValue = ScriptLocalValue[];
+export type ScriptListLocalValue = Array<ScriptLocalValue>;
 export interface ScriptArrayLocalValue {
     type: "array";
     value: ScriptListLocalValue;
@@ -44,7 +45,7 @@ export interface ScriptDateLocalValue {
     type: "date";
     value: string;
 }
-export type ScriptMappingLocalValue = (ScriptLocalValue | ScriptLocalValue)[];
+export type ScriptMappingLocalValue = Array<Array<ScriptLocalValue | string>>;
 export interface ScriptMapLocalValue {
     type: "map";
     value: ScriptMappingLocalValue;
@@ -81,7 +82,7 @@ export interface ScriptStringValue {
 export type ScriptSpecialNumber = "NaN" | "-0" | "Infinity" | "-Infinity";
 export interface ScriptNumberValue {
     type: "number";
-    value: Number | ScriptSpecialNumber;
+    value: number | ScriptSpecialNumber;
 }
 export interface ScriptBooleanValue {
     type: "boolean";
@@ -96,47 +97,63 @@ export interface ScriptBaseRealmInfo {
     realm: ScriptRealm;
     origin: string;
 }
-export type ScriptWindowRealmInfo = ScriptBaseRealmInfo & {
+export interface ScriptWindowRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "window";
     context: BrowsingContextBrowsingContext;
     userContext?: BrowserUserContext;
     sandbox?: string;
-};
-export type ScriptDedicatedWorkerRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptDedicatedWorkerRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "dedicated-worker";
-    owners: ScriptRealm[];
-};
-export type ScriptSharedWorkerRealmInfo = ScriptBaseRealmInfo & {
+    owners: Array<ScriptRealm>;
+}
+export interface ScriptSharedWorkerRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "shared-worker";
-};
-export type ScriptServiceWorkerRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptServiceWorkerRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "service-worker";
-};
-export type ScriptWorkerRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptWorkerRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "worker";
-};
-export type ScriptPaintWorkletRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptPaintWorkletRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "paint-worklet";
-};
-export type ScriptAudioWorkletRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptAudioWorkletRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "audio-worklet";
-};
-export type ScriptWorkletRealmInfo = ScriptBaseRealmInfo & {
+}
+export interface ScriptWorkletRealmInfo {
+    realm: ScriptRealm;
+    origin: string;
     type: "worklet";
-};
+}
 export type ScriptRealmType = "window" | "dedicated-worker" | "shared-worker" | "service-worker" | "worker" | "paint-worklet" | "audio-worklet" | "worklet";
 export type ScriptRemoteReference = ScriptSharedReference | ScriptRemoteObjectReference;
-export type ScriptSharedReference = Extensible & {
+export interface ScriptSharedReference {
     sharedId: ScriptSharedId;
     handle?: ScriptHandle;
-};
-export type ScriptRemoteObjectReference = Extensible & {
+}
+export interface ScriptRemoteObjectReference {
     handle: ScriptHandle;
     sharedId?: ScriptSharedId;
-};
+}
 export type ScriptRemoteValue = ScriptPrimitiveProtocolValue | ScriptSymbolRemoteValue | ScriptArrayRemoteValue | ScriptObjectRemoteValue | ScriptFunctionRemoteValue | ScriptRegExpRemoteValue | ScriptDateRemoteValue | ScriptMapRemoteValue | ScriptSetRemoteValue | ScriptWeakMapRemoteValue | ScriptWeakSetRemoteValue | ScriptGeneratorRemoteValue | ScriptErrorRemoteValue | ScriptProxyRemoteValue | ScriptPromiseRemoteValue | ScriptTypedArrayRemoteValue | ScriptArrayBufferRemoteValue | ScriptNodeListRemoteValue | ScriptHtmlCollectionRemoteValue | ScriptNodeRemoteValue | ScriptWindowProxyRemoteValue;
-export type ScriptListRemoteValue = ScriptRemoteValue[];
-export type ScriptMappingRemoteValue = (ScriptRemoteValue | ScriptRemoteValue)[];
+export type ScriptListRemoteValue = Array<ScriptRemoteValue>;
+export type ScriptMappingRemoteValue = Array<Array<ScriptRemoteValue | string>>;
 export interface ScriptSymbolRemoteValue {
     type: "symbol";
     handle?: ScriptHandle;
@@ -159,14 +176,18 @@ export interface ScriptFunctionRemoteValue {
     handle?: ScriptHandle;
     internalId?: ScriptInternalId;
 }
-export type ScriptRegExpRemoteValue = ScriptRegExpLocalValue & {
+export interface ScriptRegExpRemoteValue {
+    type: "regexp";
+    value: ScriptRegExpValue;
     handle?: ScriptHandle;
     internalId?: ScriptInternalId;
-};
-export type ScriptDateRemoteValue = ScriptDateLocalValue & {
+}
+export interface ScriptDateRemoteValue {
+    type: "date";
+    value: string;
     handle?: ScriptHandle;
     internalId?: ScriptInternalId;
-};
+}
 export interface ScriptMapRemoteValue {
     type: "map";
     handle?: ScriptHandle;
@@ -241,11 +262,11 @@ export interface ScriptNodeRemoteValue {
 export interface ScriptNodeProperties {
     nodeType: JsUint;
     childNodeCount: JsUint;
-    attributes?: Record<string, string>;
-    children?: ScriptNodeRemoteValue[];
+    attributes?: ScriptNodePropertiesAttributes;
+    children?: Array<ScriptNodeRemoteValue>;
     localName?: string;
-    mode?: "open" | "closed";
-    namespaceUri?: string;
+    mode?: ScriptNodePropertiesMode;
+    namespaceURI?: string;
     nodeValue?: string;
     shadowRoot?: ScriptNodeRemoteValue | null;
 }
@@ -261,14 +282,8 @@ export interface ScriptWindowProxyProperties {
 export type ScriptResultOwnership = "root" | "none";
 export interface ScriptSerializationOptions {
     maxDomDepth?: JsUint | null;
-    /**
-     * @default null
-     */
     maxObjectDepth?: JsUint | null;
-    /**
-     * @default 'none'
-     */
-    includeShadowTree?: "none" | "open" | "all";
+    includeShadowTree?: ScriptSerializationOptionsIncludeShadowTree;
 }
 export type ScriptSharedId = string;
 export interface ScriptStackFrame {
@@ -278,7 +293,7 @@ export interface ScriptStackFrame {
     url: string;
 }
 export interface ScriptStackTrace {
-    callFrames: ScriptStackFrame[];
+    callFrames: Array<ScriptStackFrame>;
 }
 export interface ScriptSource {
     realm: ScriptRealm;
@@ -299,9 +314,9 @@ export interface ScriptAddPreloadScript {
 }
 export interface ScriptAddPreloadScriptParameters {
     functionDeclaration: string;
-    arguments?: ScriptChannelValue[];
-    contexts?: BrowsingContextBrowsingContext[];
-    userContexts?: BrowserUserContext[];
+    arguments?: Array<ScriptChannelValue>;
+    contexts?: Array<BrowsingContextBrowsingContext>;
+    userContexts?: Array<BrowserUserContext>;
     sandbox?: string;
 }
 export interface ScriptAddPreloadScriptResult {
@@ -312,7 +327,7 @@ export interface ScriptDisown {
     params: ScriptDisownParameters;
 }
 export interface ScriptDisownParameters {
-    handles: ScriptHandle[];
+    handles: Array<ScriptHandle>;
     target: ScriptTarget;
 }
 export type ScriptDisownResult = EmptyResult;
@@ -324,7 +339,7 @@ export interface ScriptCallFunctionParameters {
     functionDeclaration: string;
     awaitPromise: boolean;
     target: ScriptTarget;
-    arguments?: ScriptLocalValue[];
+    arguments?: Array<ScriptLocalValue>;
     resultOwnership?: ScriptResultOwnership;
     serializationOptions?: ScriptSerializationOptions;
     this?: ScriptLocalValue;
@@ -352,7 +367,7 @@ export interface ScriptGetRealmsParameters {
     type?: ScriptRealmType;
 }
 export interface ScriptGetRealmsResult {
-    realms: ScriptRealmInfo[];
+    realms: Array<ScriptRealmInfo>;
 }
 export interface ScriptRemovePreloadScript {
     method: "script.removePreloadScript";
@@ -382,29 +397,110 @@ export interface ScriptRealmDestroyed {
 export interface ScriptRealmDestroyedParameters {
     realm: ScriptRealm;
 }
-/** @deprecated Use {@link Script.create} instead — will be removed in a future major version. */
-export declare function getScriptManagerInstance(driver: unknown): Promise<Script>;
-export declare class Script {
-    private readonly bidi;
-    private constructor();
+export type ScriptNodePropertiesMode = "open" | "closed";
+export type ScriptSerializationOptionsIncludeShadowTree = "none" | "open" | "all";
+export interface ScriptNodePropertiesAttributes {
+}
+/**
+ * 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 Script extends Domain {
+    /** @see https://w3c.github.io/webdriver-bidi/#event-script-message */
+    static readonly MESSAGE: EventDescriptor<ScriptMessageParameters>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-script-realmCreated */
+    static readonly REALM_CREATED: EventDescriptor<ScriptRealmInfo>;
+    /** @see https://w3c.github.io/webdriver-bidi/#event-script-realmDestroyed */
+    static readonly REALM_DESTROYED: EventDescriptor<ScriptRealmDestroyedParameters>;
+    static readonly SpecialNumber: Readonly<{
+        readonly NA_N: "NaN";
+        readonly _0: "-0";
+        readonly INFINITY: "Infinity";
+        readonly _INFINITY: "-Infinity";
+    }>;
+    static readonly RealmType: Readonly<{
+        readonly WINDOW: "window";
+        readonly DEDICATED_WORKER: "dedicated-worker";
+        readonly SHARED_WORKER: "shared-worker";
+        readonly SERVICE_WORKER: "service-worker";
+        readonly WORKER: "worker";
+        readonly PAINT_WORKLET: "paint-worklet";
+        readonly AUDIO_WORKLET: "audio-worklet";
+        readonly WORKLET: "worklet";
+    }>;
+    static readonly ResultOwnership: Readonly<{
+        readonly ROOT: "root";
+        readonly NONE: "none";
+    }>;
+    static readonly NodePropertiesMode: Readonly<{
+        readonly OPEN: "open";
+        readonly CLOSED: "closed";
+    }>;
+    static readonly SerializationOptionsIncludeShadowTree: Readonly<{
+        readonly NONE: "none";
+        readonly OPEN: "open";
+        readonly ALL: "all";
+    }>;
     static create(driver: unknown): Promise<Script>;
+    /**
+     * @param {ScriptAddPreloadScriptParameters} params
+     * @param {string} params.functionDeclaration
+     * @param {Array<ScriptChannelValue>} [params.arguments]
+     * @param {Array<BrowsingContextBrowsingContext>} [params.contexts]
+     * @param {Array<BrowserUserContext>} [params.userContexts]
+     * @param {string} [params.sandbox]
+     * @returns {Promise<ScriptAddPreloadScriptResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript
+     */
     addPreloadScript(params: ScriptAddPreloadScriptParameters): Promise<ScriptAddPreloadScriptResult>;
+    /**
+     * @param {ScriptCallFunctionParameters} params
+     * @param {string} params.functionDeclaration
+     * @param {boolean} params.awaitPromise
+     * @param {ScriptTarget} params.target
+     * @param {Array<ScriptLocalValue>} [params.arguments]
+     * @param {ScriptResultOwnership} [params.resultOwnership]
+     * @param {ScriptSerializationOptions} [params.serializationOptions]
+     * @param {ScriptLocalValue} [params.this]
+     * @param {boolean} [params.userActivation]
+     * @returns {Promise<ScriptCallFunctionResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-callFunction
+     */
     callFunction(params: ScriptCallFunctionParameters): Promise<ScriptCallFunctionResult>;
+    /**
+     * @param {ScriptDisownParameters} params
+     * @param {Array<ScriptHandle>} params.handles
+     * @param {ScriptTarget} params.target
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-disown
+     */
     disown(params: ScriptDisownParameters): Promise<void>;
+    /**
+     * @param {ScriptEvaluateParameters} params
+     * @param {string} params.expression
+     * @param {ScriptTarget} params.target
+     * @param {boolean} params.awaitPromise
+     * @param {ScriptResultOwnership} [params.resultOwnership]
+     * @param {ScriptSerializationOptions} [params.serializationOptions]
+     * @param {boolean} [params.userActivation]
+     * @returns {Promise<ScriptEvaluateResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-evaluate
+     */
     evaluate(params: ScriptEvaluateParameters): Promise<ScriptEvaluateResult>;
+    /**
+     * @param {ScriptGetRealmsParameters} params
+     * @param {BrowsingContextBrowsingContext} [params.context]
+     * @param {ScriptRealmType} [params.type]
+     * @returns {Promise<ScriptGetRealmsResult>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-getRealms
+     */
     getRealms(params: ScriptGetRealmsParameters): Promise<ScriptGetRealmsResult>;
+    /**
+     * @param {ScriptRemovePreloadScriptParameters} params
+     * @param {ScriptPreloadScript} params.script
+     * @returns {Promise<void>}
+     * @see https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript
+     */
     removePreloadScript(params: ScriptRemovePreloadScriptParameters): Promise<void>;
-    onMessage(callback: (params: ScriptMessageParameters) => void): Promise<void>;
-    onRealmCreated(callback: (params: ScriptRealmInfo) => void): Promise<void>;
-    onRealmDestroyed(callback: (params: ScriptRealmDestroyedParameters) => void): Promise<void>;
-    getAllRealms(): Promise<ScriptGetRealmsResult>;
-    getRealmsByType(type: ScriptRealmType): Promise<ScriptGetRealmsResult>;
-    getRealmsInBrowsingContext(context: BrowsingContextBrowsingContext): Promise<ScriptGetRealmsResult>;
-    getRealmsInBrowsingContextByType(context: BrowsingContextBrowsingContext, type: ScriptRealmType): Promise<ScriptGetRealmsResult>;
-    callFunctionInRealm(realmId: ScriptRealm, functionDeclaration: string, awaitPromise: boolean, args?: ScriptLocalValue[], resultOwnership?: ScriptResultOwnership, serializationOptions?: ScriptSerializationOptions, userActivation?: boolean): Promise<ScriptEvaluateResult>;
-    callFunctionInBrowsingContext(browsingContextId: BrowsingContextBrowsingContext, functionDeclaration: string, awaitPromise: boolean, args?: ScriptLocalValue[], sandbox?: string, resultOwnership?: ScriptResultOwnership, serializationOptions?: ScriptSerializationOptions, userActivation?: boolean): Promise<ScriptEvaluateResult>;
-    evaluateFunctionInRealm(realmId: ScriptRealm, expression: string, awaitPromise: boolean, resultOwnership?: ScriptResultOwnership, serializationOptions?: ScriptSerializationOptions, userActivation?: boolean): Promise<ScriptEvaluateResult>;
-    evaluateFunctionInBrowsingContext(browsingContextId: BrowsingContextBrowsingContext, expression: string, awaitPromise: boolean, sandbox?: string, resultOwnership?: ScriptResultOwnership, serializationOptions?: ScriptSerializationOptions, userActivation?: boolean): Promise<ScriptEvaluateResult>;
-    disownRealmScript(realmId: ScriptRealm, handles: ScriptHandle[]): Promise<void>;
-    disownBrowsingContextScript(browsingContextId: BrowsingContextBrowsingContext, handles: ScriptHandle[], sandbox?: string): Promise<void>;
 }