node_modules/chromium-bidi/lib/protocol/cdp.d.ts

/**
 * Copyright 2023 Google LLC.
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed 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.
 */
import type { Protocol } from 'devtools-protocol';
import type { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping.js';
import type { BrowsingContext, JsUint, Script } from './generated/webdriver-bidi.js';
export type EventNames = Event['method'];
export type Message = CommandResponse | Event;
export type Command = {
    id: JsUint;
} & CommandData;
export type CommandData = SendCommandCommand | GetSessionCommand | ResolveRealmCommand;
export interface CommandResponse {
    type: 'success';
    id: JsUint;
    result: ResultData;
}
export type ResultData = SendCommandResult | GetSessionResult | ResolveRealmResult;
export interface SendCommandCommand {
    method: 'goog:cdp.sendCommand';
    params: SendCommandParameters;
}
export interface SendCommandParameters<Command extends keyof ProtocolMapping.Commands = keyof ProtocolMapping.Commands> {
    method: Command;
    params?: ProtocolMapping.Commands[Command]['paramsType'][0];
    session?: Protocol.Target.SessionID;
}
export interface SendCommandResult {
    result: ProtocolMapping.Commands[keyof ProtocolMapping.Commands]['returnType'];
    session?: Protocol.Target.SessionID;
}
export interface GetSessionCommand {
    method: 'goog:cdp.getSession';
    params: GetSessionParameters;
}
export interface GetSessionParameters {
    context: BrowsingContext.BrowsingContext;
}
export interface GetSessionResult {
    session?: Protocol.Target.SessionID;
}
export interface ResolveRealmCommand {
    method: 'goog:cdp.resolveRealm';
    params: ResolveRealmParameters;
}
export interface ResolveRealmParameters {
    realm: Script.Realm;
}
export interface ResolveRealmResult {
    executionContextId: Protocol.Runtime.ExecutionContextId;
}
export type Event = {
    type: 'event';
} & EventData;
export type EventData = EventDataFor<keyof ProtocolMapping.Events>;
export interface EventDataFor<EventName extends keyof ProtocolMapping.Events> {
    method: `goog:cdp.${EventName}`;
    params: EventParametersFor<EventName>;
}
export interface EventParametersFor<EventName extends keyof ProtocolMapping.Events> {
    event: EventName;
    params: ProtocolMapping.Events[EventName][0];
    session: Protocol.Target.SessionID;
}