import type {ProtocolMapping} from 'devtools-protocol/types/protocol-mapping.js'; import type {Connection} from '../common/Connection.js'; import {EventEmitter, type EventType} from '../common/EventEmitter.js'; /** * @public */ export type CDPEvents = { [Property in keyof ProtocolMapping.Events]: ProtocolMapping.Events[Property][0]; }; /** * Internal events that the CDPSession class emits. * * @internal */ // eslint-disable-next-line @typescript-eslint/no-namespace export namespace CDPSessionEvent { export const Disconnected = Symbol('CDPSession.Disconnected'); export const Swapped = Symbol('CDPSession.Swapped'); /** * Emitted when the session is ready to be configured during the auto-attach * process. Right after the event is handled, the session will be resumed. */ export const Ready = Symbol('CDPSession.Ready'); export const SessionAttached = Symbol('CDPSession.SessionAttached'); export const SessionDetached = Symbol('CDPSession.SessionDetached'); } /** * @public */ export interface CDPSessionEvents extends CDPEvents, Record { /** @internal */ [CDPSessionEvent.Disconnected]: undefined; /** @internal */ [CDPSessionEvent.Swapped]: CDPSession; /** @internal */ [CDPSessionEvent.Ready]: CDPSession; /** @internal */ [CDPSessionEvent.SessionAttached]: CDPSession; /** @internal */ [CDPSessionEvent.SessionDetached]: CDPSession; } /** * The `CDPSession` instances are used to talk raw Chrome Devtools Protocol. * * @remarks * * Protocol methods can be called with {@link CDPSession.send} method and protocol * events can be subscribed to with `CDPSession.on` method. * * Useful links: {@link https://chromedevtools.github.io/devtools-protocol/ | DevTools Protocol Viewer} * and {@link https://github.com/aslushnikov/getting-started-with-cdp/blob/HEAD/README.md | Getting Started with DevTools Protocol}. * * @example * * ```ts * const client = await page.target().createCDPSession(); * await client.send('Animation.enable'); * client.on('Animation.animationCreated', () => * console.log('Animation created!') * ); * const response = await client.send('Animation.getPlaybackRate'); * console.log('playback rate is ' + response.playbackRate); * await client.send('Animation.setPlaybackRate', { * playbackRate: response.playbackRate / 2, * }); * ``` * * @public */ export abstract class CDPSession extends EventEmitter { /** * @internal */ constructor() { super(); } connection(): Connection | undefined { throw new Error('Not implemented'); } /** * Parent session in terms of CDP's auto-attach mechanism. * * @internal */ parentSession(): CDPSession | undefined { return undefined; } send( method: T, ...paramArgs: ProtocolMapping.Commands[T]['paramsType'] ): Promise; send(): Promise< ProtocolMapping.Commands[T]['returnType'] > { throw new Error('Not implemented'); } /** * Detaches the cdpSession from the target. Once detached, the cdpSession object * won't emit any events and can't be used to send messages. */ async detach(): Promise { throw new Error('Not implemented'); } /** * Returns the session's id. */ id(): string { throw new Error('Not implemented'); } }