CdpConnection.d.ts 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. /**
  2. * Copyright 2021 Google LLC.
  3. * Copyright (c) Microsoft Corporation.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. import type { Protocol } from 'devtools-protocol';
  18. import type { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping.js';
  19. import type { LoggerFn } from '../utils/log.js';
  20. import type { Transport } from '../utils/transport.js';
  21. import { MapperCdpClient, type CdpClient } from './CdpClient.js';
  22. export interface CdpConnection {
  23. getCdpClient(sessionId: Protocol.Target.SessionID): CdpClient;
  24. }
  25. /**
  26. * Represents a high-level CDP connection to the browser backend.
  27. *
  28. * Manages all CdpClients (each backed by a Session ID) instance for each active
  29. * CDP session.
  30. */
  31. export declare class MapperCdpConnection implements CdpConnection {
  32. #private;
  33. static readonly LOGGER_PREFIX_RECV: "cdp:RECV ◂";
  34. static readonly LOGGER_PREFIX_SEND: "cdp:SEND ▸";
  35. constructor(transport: Transport, logger?: LoggerFn);
  36. /** Closes the connection to the browser. */
  37. close(): void;
  38. createBrowserSession(): Promise<MapperCdpClient>;
  39. /**
  40. * Gets a CdpClient instance attached to the given session ID,
  41. * or null if the session is not attached.
  42. */
  43. getCdpClient(sessionId: Protocol.Target.SessionID): MapperCdpClient;
  44. sendCommand<CdpMethod extends keyof ProtocolMapping.Commands>(method: CdpMethod, params?: ProtocolMapping.Commands[CdpMethod]['paramsType'][0], sessionId?: Protocol.Target.SessionID): Promise<object>;
  45. }