94 lines
3.4 KiB
TypeScript
94 lines
3.4 KiB
TypeScript
/**
|
|
* 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 | DeprecatedSendCommandCommand | DeprecatedGetSessionCommand | DeprecatedResolveRealmCommand;
|
|
export type CommandResponse = {
|
|
type: 'success';
|
|
id: JsUint;
|
|
result: ResultData;
|
|
};
|
|
export type ResultData = SendCommandResult | GetSessionResult | ResolveRealmResult;
|
|
export type DeprecatedSendCommandCommand = {
|
|
method: 'cdp.sendCommand';
|
|
params: SendCommandParameters;
|
|
};
|
|
export type SendCommandCommand = {
|
|
method: 'goog:cdp.sendCommand';
|
|
params: SendCommandParameters;
|
|
};
|
|
export type SendCommandParameters<Command extends keyof ProtocolMapping.Commands = keyof ProtocolMapping.Commands> = {
|
|
method: Command;
|
|
params?: ProtocolMapping.Commands[Command]['paramsType'][0];
|
|
session?: Protocol.Target.SessionID;
|
|
};
|
|
export type SendCommandResult = {
|
|
result: ProtocolMapping.Commands[keyof ProtocolMapping.Commands]['returnType'];
|
|
session?: Protocol.Target.SessionID;
|
|
};
|
|
export type DeprecatedGetSessionCommand = {
|
|
method: 'cdp.getSession';
|
|
params: GetSessionParameters;
|
|
};
|
|
export type GetSessionCommand = {
|
|
method: 'goog:cdp.getSession';
|
|
params: GetSessionParameters;
|
|
};
|
|
export type GetSessionParameters = {
|
|
context: BrowsingContext.BrowsingContext;
|
|
};
|
|
export type GetSessionResult = {
|
|
session?: Protocol.Target.SessionID;
|
|
};
|
|
export type DeprecatedResolveRealmCommand = {
|
|
method: 'cdp.resolveRealm';
|
|
params: ResolveRealmParameters;
|
|
};
|
|
export type ResolveRealmCommand = {
|
|
method: 'goog:cdp.resolveRealm';
|
|
params: ResolveRealmParameters;
|
|
};
|
|
export type ResolveRealmParameters = {
|
|
realm: Script.Realm;
|
|
};
|
|
export type ResolveRealmResult = {
|
|
executionContextId: Protocol.Runtime.ExecutionContextId;
|
|
};
|
|
export type Event = {
|
|
type: 'event';
|
|
} & EventData;
|
|
export type EventData = EventDataFor<keyof ProtocolMapping.Events> | DeprecatedEventDataFor<keyof ProtocolMapping.Events>;
|
|
export type DeprecatedEventDataFor<EventName extends keyof ProtocolMapping.Events> = {
|
|
method: `cdp.${EventName}`;
|
|
params: EventParametersFor<EventName>;
|
|
};
|
|
export type EventDataFor<EventName extends keyof ProtocolMapping.Events> = {
|
|
method: `goog:cdp.${EventName}`;
|
|
params: EventParametersFor<EventName>;
|
|
};
|
|
export type EventParametersFor<EventName extends keyof ProtocolMapping.Events> = {
|
|
event: EventName;
|
|
params: ProtocolMapping.Events[EventName][0];
|
|
session: Protocol.Target.SessionID;
|
|
};
|