@orkestrel/browser 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orkestrel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @orkestrel/browser
+
+A typed [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/)
+browser automation library for the `@orkestrel` line. The environment-agnostic
+core (`src/core` — `CDPClient` speaking the CDP wire protocol over an injected
+`CDPTransportInterface`, plus `BrowserContext`, `BrowserPage`, and
+`BrowserCodegen`) never touches `node:*` or the DOM; the Node runtime (`src/server`)
+adapts it with a `WebSocketCDPTransport`, browser process launch/discovery
+(`node:child_process` + `fetch`), a filesystem screenshot writer, and the
+`Browser` façade that ties launch → context → page together. Part of the
+`@orkestrel` line.
+
+## Install
+
+```sh
+npm install @orkestrel/browser
+```
+
+## Requirements
+
+- Node.js >= 24 for the server surface (the core surface is environment-agnostic)
+- ESM and CommonJS builds ship for both the core and server entry points
+
+## Usage
+
+Launch or connect to a browser and drive a page from Node:
+
+```ts
+import { createBrowser } from '@orkestrel/browser/server'
+
+const browser = createBrowser()
+await browser.connect()
+const page = await browser.create({ url: 'https://example.com' })
+await page.click('#submit')
+await page.screenshot({ path: 'example.png' })
+await browser.destroy()
+```
+
+Drive the same protocol from any environment by injecting your own transport
+over the environment-agnostic core:
+
+```ts
+import { CDPClient } from '@orkestrel/browser'
+import type { CDPTransportInterface } from '@orkestrel/browser'
+
+const transport: CDPTransportInterface = /* your injected transport */
+const client = new CDPClient({ transport })
+await client.connect()
+const result = await client.send('Page.navigate', { url: 'https://example.com' })
+```
+
+## Guide
+
+For the full surface — the CDP dispatch core, the `BrowserContext` /
+`BrowserPage` / `BrowserCodegen` entities, the server transports, and usage
+patterns — see [`guides/src/browser.md`](guides/src/browser.md).
+
+## Package
+
+Published with two entry points per the `exports` field in `package.json`:
+the environment-agnostic core (`.`) — `CDPClient`, `BrowserContext`,
+`BrowserPage`, `BrowserCodegen`, `createCDPClient`, `CDPTransportInterface` —
+and the Node-only server surface (`./server`) — `Browser`, `createBrowser`,
+`createCDPTransport`, `createScreenshotWriter`, `WebSocketCDPTransport`.
+
+## License
+
+MIT © [Orkestrel](https://github.com/orkestrel) — see [LICENSE](./LICENSE).