chromium-bidi 0.4.2 → 0.4.4

package/LICENSE

@@ -198,4 +198,4 @@
    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.
+   limitations under the License.

package/README.md

@@ -1,15 +1,135 @@
 # WebDriver BiDi for Chromium [![chromium-bidi on npm](https://img.shields.io/npm/v/chromium-bidi)](https://www.npmjs.com/package/chromium-bidi)
 
+![Unit Tests](https://github.com/GoogleChromeLabs/chromium-bidi/actions/workflows/unit.yml/badge.svg)
+![E2E Tests](https://github.com/GoogleChromeLabs/chromium-bidi/actions/workflows/e2e.yml/badge.svg)
+![WPT Tests (mapper)](https://github.com/GoogleChromeLabs/chromium-bidi/actions/workflows/wpt-mapper.yml/badge.svg)
+![WPT Tests (chromedriver)](https://github.com/GoogleChromeLabs/chromium-bidi/actions/workflows/wpt-chromedriver.yml/badge.svg)
+
+![pre-commit](https://github.com/GoogleChromeLabs/chromium-bidi/actions/workflows/pre-commit.yml/badge.svg)
+
 This is an implementation of the
-[WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) protocol for Chromium,
-implemented as a JavaScript layer translating between BiDi and CDP, running
-inside a Chrome tab.
+[WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) protocol with some
+extensions (**BiDi+**)
+for Chromium, implemented as a JavaScript layer translating between BiDi and CDP,
+running inside a Chrome tab.
 
-Current status can be checked here:
-[Chromium BiDi progress](https://docs.google.com/spreadsheets/d/1acM-kHlubpwnW1mFboS9hePawq3u1kf21oQzD16q-Ao/edit?usp=sharing&resourcekey=0-PuLHQYLmDJUOXH_mFO-QiA)
-.
+Current status can be checked
+at [WPT WebDriver BiDi status](https://wpt.fyi/results/webdriver/tests/bidi).
+
+## BiDi+
+
+**"BiDi+"** is an extension of the WebDriver BiDi protocol. In addition to [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) it has:
+
+### Command `cdp.sendCommand`
+
+```cddl
+CdpSendCommandCommand = {
+  method: "cdp.sendCommand",
+  params: ScriptEvaluateParameters,
+}
+
+CdpSendCommandParameters = {
+   cdpMethod: text,
+   cdpParams: any,
+   cdpSession?: text,
+}
+
+CdpSendCommandResult = {
+   result: any,
+   cdpSession: text,
+}
+```
+
+The command runs the
+described [CDP command](https://chromedevtools.github.io/devtools-protocol)
+and returns result.
+
+### Command `cdp.getSession`
+
+```cddl
+CdpGetSessionCommand = {
+   method: "cdp.sendCommand",
+   params: ScriptEvaluateParameters,
+}
+
+CdpGetSessionParameters = {
+   context: BrowsingContext,
+}
+
+CdpGetSessionResult = {
+   cdpSession: text,
+}
+```
+
+The command returns the default CDP session for the selected browsing context.
 
-# Setup
+### Event `cdp.eventReceived`
+
+```cddl
+CdpEventReceivedEvent = {
+   method: "cdp.eventReceived",
+   params: ScriptEvaluateParameters,
+}
+
+CdpEventReceivedParameters = {
+   cdpMethod: text,
+   cdpParams: any,
+   cdpSession: string,
+}
+```
+
+The event contains a CDP event.
+
+### Field `channel`
+
+Each command can be extended with a `channel`:
+
+```cddl
+Command = {
+   id: js-uint,
+   channel?: text,
+   CommandData,
+   Extensible,
+}
+```
+
+If provided and non-empty string, the very same `channel` is added to the response:
+
+```cddl
+CommandResponse = {
+   id: js-uint,
+   channel?: text,
+   result: ResultData,
+   Extensible,
+}
+
+ErrorResponse = {
+  id: js-uint / null,
+  channel?: text,
+  error: ErrorCode,
+  message: text,
+  ?stacktrace: text,
+  Extensible
+}
+```
+
+When client uses
+commands [`session.subscribe`](https://w3c.github.io/webdriver-bidi/#command-session-subscribe)
+and [`session.unsubscribe`](https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe)
+with `channel`, the subscriptions are handled per channel, and the corresponding
+`channel` filed is added to the event message:
+
+```cddl
+Event = {
+  channel?: text,
+  EventData,
+  Extensible,
+}
+```
+
+## Dev Setup
+
+### `npm`
 
 This is a Node.js project, so install dependencies as usual:
 
@@ -17,14 +137,19 @@ This is a Node.js project, so install dependencies as usual:
 npm install
 ```
 
-# Starting the Server
+### pre-commit.com integration
+
+Refer to the documentation at [.pre-commit-config.yaml](.pre-commit-config.yaml).
+
+### Starting the Server
+
+This will run the server on port `8080`:
 
 ```sh
 npm run server
 ```
 
-This will run the server on port 8080. Use the `PORT` environment variable
-or `--port=...` argument to run it on another port:
+Use the `PORT=` environment variable or `--port=` argument to run it on another port:
 
 ```sh
 PORT=8081 npm run server
@@ -43,7 +168,18 @@ Use the CLI argument `--headless=false` to run browser in headful mode:
 npm run server -- --headless=false
 ```
 
-## Starting on Linux and Mac
+Use the `CHANNEL=...` environment variable or `--channel=...` argument with one of
+the following values to run the specific Chrome channel: `chrome`,
+`chrome-beta`, `chrome-canary`, `chrome-dev`.
+
+The requested Chrome version should be installed.
+
+```sh
+CHANNEL=chrome-dev npm run server
+npm run server -- --channel=chrome-dev
+```
+
+### Starting on Linux and Mac
 
 TODO: verify if it works on Windows.
 
@@ -54,19 +190,19 @@ output to the file `log.txt`:
 ./runBiDiServer.sh --port=8081 --headless=false
 ```
 
-# Running
+## Running
 
-## Unit tests
+### Unit tests
 
 Running:
 
 ```sh
-npm run unit
+npm test
 ```
 
-## e2e tests
+### E2E tests
 
-The e2e tests are written using Python, in order to learn how to eventually do
+The E2E tests are written using Python, in order to learn how to eventually do
 this in web-platform-tests.
 
 ### Installation
@@ -79,7 +215,7 @@ python3 -m pip install --user -r tests/requirements.txt
 
 ### Running
 
-The e2e tests require BiDi server running on the same host. By default, tests
+The E2E tests require BiDi server running on the same host. By default, tests
 try to connect to the port `8080`. The server can be run from the project root:
 
 ```sh
@@ -92,50 +228,22 @@ Use the `PORT` environment variable to connect to another port:
 PORT=8081 npm run e2e
 ```
 
-## Examples
-
-The examples are stored in the `/examples` folder and are intended to show who
-the BiDi protocol can be used. Examples are based on
-[Puppeteer's examples](https://github.com/puppeteer/puppeteer/tree/main/examples)
-.
-
-### Instalation
-
-The examples are written using Python, to align with e2e test. Python 3.6+ and
-some dependencies are required:
-
-```sh
-python3 -m pip install --user -r tests/requirements.txt
-```
-
-### Running
-
-The examples require BiDi server running on the same host on the port `8080`.
-The server can be run from the project root:
-
-```sh
-npm run server
-```
-
-After running server, examples can be simply run:
+### Examples
 
-```sh
-python3 examples/cross-browser.py
-```
+Refer to [examples/README.md](examples/README.md).
 
-## WPT
+## WPT (Web Platform Tests)
 
 WPT is added as
-a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To get
-run WPT tests:
+a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To get run
+WPT tests:
 
-### Check out WPT and setup
+### Check out and setup WPT
 
 #### 1. Check out WPT
 
 ```sh
-git submodule init
-git submodule update
+git submodule update --init
 ```
 
 #### 2. Go to the WPT folder
@@ -156,13 +264,13 @@ Follow
 the [`hosts` File Setup](https://web-platform-tests.org/running-tests/from-local-system.html#hosts-file-setup)
 instructions.
 
-##### On Linux, macOS or other UNIX-like system
+##### 4.a On Linux, macOS or other UNIX-like system
 
 ```sh
 ./wpt make-hosts-file | sudo tee -a /etc/hosts
 ```
 
-##### And on **Windows**
+##### 4.b On **Windows**
 
 This must be run in a PowerShell session with Administrator privileges:
 
@@ -170,26 +278,48 @@ This must be run in a PowerShell session with Administrator privileges:
 python wpt make-hosts-file | Out-File $env:SystemRoot\System32\drivers\etc\hosts -Encoding ascii -Append
 ```
 
-If you are behind a proxy, you also need to make sure the domains above are
-excluded from your proxy lookups.
+If you are behind a proxy, you also need to make sure the domains above are excluded
+from your proxy lookups.
+
+#### 5. Set `WPT_BROWSER_PATH`
 
-#### 5. Set the `WPT_BROWSER_PATH` environment variable to a Chrome, Edge or Chromium binary to launch. For example, on macOS:
+Set the `WPT_BROWSER_PATH` environment variable to a Chrome, Edge or Chromium binary to launch.
+For example, on macOS:
 
 ```sh
+# Chrome
 export WPT_BROWSER_PATH="/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary"
-export WPT_BROWSER_PATH="/Applications/Microsoft Edge Canary.app/Contents/MacOS/Microsoft Edge Canary"
+export WPT_BROWSER_PATH="/Applications/Google Chrome Dev.app/Contents/MacOS/Google Chrome Dev"
+export WPT_BROWSER_PATH="/Applications/Google Chrome Beta.app/Contents/MacOS/Google Chrome Beta"
+export WPT_BROWSER_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
 export WPT_BROWSER_PATH="/Applications/Chromium.app/Contents/MacOS/Chromium"
+
+# Edge
+export WPT_BROWSER_PATH="/Applications/Microsoft Edge Canary.app/Contents/MacOS/Microsoft Edge Canary"
+export WPT_BROWSER_PATH="/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge"
 ```
 
 ### Run WPT tests
 
-#### 1. Build ChromeDriver BiDi
+#### 1. Make sure you have Chrome Dev installed
+
+https://www.google.com/chrome/dev/
+
+#### 2. Build ChromeDriver BiDi
+
+Oneshot:
 
 ```sh
 npm run build
 ```
 
-#### 2. Run
+Continuously:
+
+```sh
+npm run watch
+```
+
+#### 3. Run
 
 ```sh
 ./wpt/wpt run \
@@ -226,7 +356,7 @@ npm run build
   ./wptreport.json
 ```
 
-# How does it work?
+## How does it work?
 
 The architecture is described in the
 [WebDriver BiDi in Chrome Context implementation plan](https://docs.google.com/document/d/1VfQ9tv0wPSnb5TI-MOobjoQ5CXLnJJx9F_PxOMQc8kY)
@@ -234,17 +364,17 @@ The architecture is described in the
 
 There are 2 main modules:
 
-1. backend WS server in `src`. It runs webSocket server, and for each ws
-   connection runs an instance of browser with BiDi Mapper.
-2. front-end BiDi Mapper in `src/bidiMapper`. Gets BiDi commands from the
-   backend, and map them to CDP commands.
+1. backend WS server in `src`. It runs webSocket server, and for each ws connection
+   runs an instance of browser with BiDi Mapper.
+2. front-end BiDi Mapper in `src/bidiMapper`. Gets BiDi commands from the backend,
+   and map them to CDP commands.
 
-## Contributing
+### Contributing
 
-The BiDi commands are processed in the `src/bidiMapper/commandProcessor.ts`. To
-add a new command, add it to `_processCommand`, write and call processor for it.
+The BiDi commands are processed in the `src/bidiMapper/commandProcessor.ts`. To add a
+new command, add it to `_processCommand`, write and call processor for it.
 
-## Publish new `npm` release
+### Publish new `npm` release
 
 1. On the `main` branch, bump the chromium-bidi version number in `package.json`:
 

package/lib/cjs/bidiMapper/BidiServer.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Copyright 2021 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 { BidiParser } from './CommandProcessor.js';
+import { BidiTransport } from './BidiTransport.js';
+import { BrowsingContextStorage } from './domains/context/browsingContextStorage.js';
+import { CdpConnection } from './CdpConnection.js';
+import { EventEmitter } from '../utils/EventEmitter.js';
+import { LoggerFn } from '../utils/log.js';
+import type { Message } from '../protocol/protocol.js';
+import { OutgoingBidiMessage } from './OutgoingBidiMessage.js';
+declare type BidiServerEvents = {
+    message: Message.RawCommandRequest;
+};
+export declare class BidiServer extends EventEmitter<BidiServerEvents> {
+    #private;
+    private constructor();
+    static createAndStart(bidiTransport: BidiTransport, cdpConnection: CdpConnection, selfTargetId: string, parser?: BidiParser, logger?: LoggerFn): Promise<BidiServer>;
+    topLevelContextsLoaded(): Promise<void>;
+    /**
+     * Sends BiDi message.
+     */
+    emitOutgoingMessage(messageEntry: Promise<OutgoingBidiMessage>): void;
+    close(): void;
+    getBrowsingContextStorage(): BrowsingContextStorage;
+}
+export {};

package/lib/cjs/bidiMapper/BidiServer.js

@@ -0,0 +1,89 @@
+"use strict";
+/**
+ * Copyright 2021 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BidiServer = void 0;
+const CommandProcessor_js_1 = require("./CommandProcessor.js");
+const browsingContextStorage_js_1 = require("./domains/context/browsingContextStorage.js");
+const EventEmitter_js_1 = require("../utils/EventEmitter.js");
+const EventManager_js_1 = require("./domains/events/EventManager.js");
+const processingQueue_js_1 = require("../utils/processingQueue.js");
+const realmStorage_js_1 = require("./domains/script/realmStorage.js");
+class BidiServer extends EventEmitter_js_1.EventEmitter {
+    #messageQueue;
+    #transport;
+    #commandProcessor;
+    #browsingContextStorage;
+    #realmStorage;
+    #logger;
+    constructor(bidiTransport, cdpConnection, selfTargetId, parser, logger) {
+        super();
+        this.#logger = logger;
+        this.#browsingContextStorage = new browsingContextStorage_js_1.BrowsingContextStorage();
+        this.#realmStorage = new realmStorage_js_1.RealmStorage();
+        this.#messageQueue = new processingQueue_js_1.ProcessingQueue(this.#processOutgoingMessage, undefined, this.#logger);
+        this.#transport = bidiTransport;
+        this.#transport.setOnMessage(this.#handleIncomingMessage);
+        this.#commandProcessor = new CommandProcessor_js_1.CommandProcessor(this.#realmStorage, cdpConnection, new EventManager_js_1.EventManager(this), selfTargetId, parser, this.#browsingContextStorage, this.#logger);
+        this.#commandProcessor.on('response', (response) => {
+            this.emitOutgoingMessage(response);
+        });
+    }
+    static async createAndStart(bidiTransport, cdpConnection, selfTargetId, parser, logger) {
+        const server = new BidiServer(bidiTransport, cdpConnection, selfTargetId, parser, logger);
+        const cdpClient = cdpConnection.browserClient();
+        // Needed to get events about new targets.
+        await cdpClient.sendCommand('Target.setDiscoverTargets', { discover: true });
+        // Needed to automatically attach to new targets.
+        await cdpClient.sendCommand('Target.setAutoAttach', {
+            autoAttach: true,
+            waitForDebuggerOnStart: true,
+            flatten: true,
+        });
+        await server.topLevelContextsLoaded();
+        return server;
+    }
+    async topLevelContextsLoaded() {
+        await Promise.all(this.#browsingContextStorage
+            .getTopLevelContexts()
+            .map((c) => c.awaitLoaded()));
+    }
+    #processOutgoingMessage = async (messageEntry) => {
+        const message = messageEntry.message;
+        if (messageEntry.channel !== null) {
+            message['channel'] = messageEntry.channel;
+        }
+        await this.#transport.sendMessage(message);
+    };
+    /**
+     * Sends BiDi message.
+     */
+    emitOutgoingMessage(messageEntry) {
+        this.#messageQueue.add(messageEntry);
+    }
+    close() {
+        this.#transport.close();
+    }
+    #handleIncomingMessage = async (message) => {
+        this.#commandProcessor.processCommand(message);
+    };
+    getBrowsingContextStorage() {
+        return this.#browsingContextStorage;
+    }
+}
+exports.BidiServer = BidiServer;
+//# sourceMappingURL=BidiServer.js.map

package/lib/cjs/bidiMapper/BidiServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BidiServer.js","sourceRoot":"","sources":["../../../src/bidiMapper/BidiServer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,+DAAmE;AAEnE,2FAAmF;AAEnF,8DAAsD;AACtD,sEAA8D;AAI9D,oEAA4D;AAC5D,sEAA8D;AAM9D,MAAa,UAAW,SAAQ,8BAA8B;IAC5D,aAAa,CAAuC;IACpD,UAAU,CAAgB;IAC1B,iBAAiB,CAAmB;IACpC,uBAAuB,CAAyB;IAChD,aAAa,CAAe;IAC5B,OAAO,CAAY;IAEnB,YACE,aAA4B,EAC5B,aAA4B,EAC5B,YAAoB,EACpB,MAAmB,EACnB,MAAiB;QAEjB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,uBAAuB,GAAG,IAAI,kDAAsB,EAAE,CAAC;QAC5D,IAAI,CAAC,aAAa,GAAG,IAAI,8BAAY,EAAE,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,oCAAe,CACtC,IAAI,CAAC,uBAAuB,EAC5B,SAAS,EACT,IAAI,CAAC,OAAO,CACb,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;QAChC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,GAAG,IAAI,sCAAgB,CAC3C,IAAI,CAAC,aAAa,EAClB,aAAa,EACb,IAAI,8BAAY,CAAC,IAAI,CAAC,EACtB,YAAY,EACZ,MAAM,EACN,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CAAC,OAAO,CACb,CAAC;QACF,IAAI,CAAC,iBAAiB,CAAC,EAAE,CACvB,UAAU,EACV,CAAC,QAAsC,EAAE,EAAE;YACzC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAChC,aAA4B,EAC5B,aAA4B,EAC5B,YAAoB,EACpB,MAAmB,EACnB,MAAiB;QAEjB,MAAM,MAAM,GAAG,IAAI,UAAU,CAC3B,aAAa,EACb,aAAa,EACb,YAAY,EACZ,MAAM,EACN,MAAM,CACP,CAAC;QACF,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,0CAA0C;QAC1C,MAAM,SAAS,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QAE3E,iDAAiD;QACjD,MAAM,SAAS,CAAC,WAAW,CAAC,sBAAsB,EAAE;YAClD,UAAU,EAAE,IAAI;YAChB,sBAAsB,EAAE,IAAI;YAC5B,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,sBAAsB,EAAE,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,sBAAsB;QAC1B,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,uBAAuB;aACzB,mBAAmB,EAAE;aACrB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAC/B,CAAC;IACJ,CAAC;IAED,uBAAuB,GAAG,KAAK,EAAE,YAAiC,EAAE,EAAE;QACpE,MAAM,OAAO,GAAG,YAAY,CAAC,OAAc,CAAC;QAE5C,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,EAAE;YACjC,OAAO,CAAC,SAAS,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC;SAC3C;QAED,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF;;OAEG;IACH,mBAAmB,CAAC,YAA0C;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED,sBAAsB,GAAG,KAAK,EAAE,OAAkC,EAAE,EAAE;QACpE,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,yBAAyB;QACvB,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACtC,CAAC;CACF;AA7GD,gCA6GC"}

package/lib/cjs/bidiMapper/BidiTransport.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2022 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 { Message } from '../protocol/protocol.js';
+export interface BidiTransport {
+    setOnMessage: (handler: (message: Message.RawCommandRequest) => Promise<void>) => void;
+    sendMessage: (message: Message.OutgoingMessage) => Promise<void>;
+    close(): void;
+}

package/lib/cjs/bidiMapper/BidiTransport.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Copyright 2022 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BidiTransport.js.map

package/lib/cjs/bidiMapper/BidiTransport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BidiTransport.js","sourceRoot":"","sources":["../../../src/bidiMapper/BidiTransport.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG"}

package/lib/cjs/bidiMapper/CdpConnection.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2022 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 { EventEmitter } from '../utils/EventEmitter.js';
+import type { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping.js';
+declare type CdpEvents = {
+    [Property in keyof ProtocolMapping.Events]: ProtocolMapping.Events[Property][0];
+};
+/**
+ * CDP interfaces that BiDi Mapper expects.
+ */
+export interface CdpConnection {
+    browserClient(): CdpClient;
+    getCdpClient(sessionId: string): CdpClient;
+}
+export interface CdpClient extends EventEmitter<CdpEvents> {
+    sendCommand<T extends keyof ProtocolMapping.Commands>(method: T, ...params: ProtocolMapping.Commands[T]['paramsType']): Promise<ProtocolMapping.Commands[T]['returnType']>;
+}
+export {};

package/lib/cjs/bidiMapper/CdpConnection.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Copyright 2022 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CdpConnection.js.map

package/lib/cjs/bidiMapper/CdpConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CdpConnection.js","sourceRoot":"","sources":["../../../src/bidiMapper/CdpConnection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG"}

package/lib/cjs/bidiMapper/CommandProcessor.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2021 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 { BrowsingContext, CDP, Message, Script, Session } from '../protocol/protocol.js';
+import { BrowsingContextStorage } from './domains/context/browsingContextStorage.js';
+import { CdpConnection } from './CdpConnection.js';
+import { EventEmitter } from '../utils/EventEmitter.js';
+import { IEventManager } from './domains/events/EventManager.js';
+import { LoggerFn } from '../utils/log.js';
+import { OutgoingBidiMessage } from './OutgoingBidiMessage.js';
+import { RealmStorage } from './domains/script/realmStorage.js';
+declare type CommandProcessorEvents = {
+    response: Promise<OutgoingBidiMessage>;
+};
+export interface BidiParser {
+    parseGetRealmsParams(params: object): Script.GetRealmsParameters;
+    parseCallFunctionParams(params: object): Script.CallFunctionParameters;
+    parseEvaluateParams(params: object): Script.EvaluateParameters;
+    parseDisownParams(params: object): Script.DisownParameters;
+    parseSendCommandParams(params: object): CDP.SendCommandParams;
+    parseGetSessionParams(params: object): CDP.GetSessionParams;
+    parseNavigateParams(params: object): BrowsingContext.NavigateParameters;
+    parseGetTreeParams(params: object): BrowsingContext.GetTreeParameters;
+    parseSubscribeParams(params: object): Session.SubscribeParameters;
+    parseCreateParams(params: object): BrowsingContext.CreateParameters;
+    parseCloseParams(params: object): BrowsingContext.CloseParameters;
+}
+export declare class CommandProcessor extends EventEmitter<CommandProcessorEvents> {
+    #private;
+    constructor(realmStorage: RealmStorage, cdpConnection: CdpConnection, eventManager: IEventManager, selfTargetId: string, parser: BidiParser | undefined, browsingContextStorage: BrowsingContextStorage, logger?: LoggerFn);
+    processCommand: (command: Message.RawCommandRequest) => Promise<void>;
+}
+export {};