@olib-ai/owl-browser-sdk 2.0.5 → 2.0.6

package/dist/playwright/browser-type.js

@@ -0,0 +1,134 @@
+/**
+ * Playwright-compatible BrowserType class for Owl Browser.
+ *
+ * Provides chromium.connect() and chromium.launch() entry points
+ * that mirror Playwright's top-level API. Owl Browser only supports
+ * remote connections (connect), not local browser launches.
+ *
+ * Includes connectOverCDP(), launchPersistentContext(), and launchServer()
+ * stubs for full Playwright API coverage.
+ */
+import { OwlBrowser } from '../client.js';
+import { Browser } from './browser.js';
+/**
+ * BrowserType provides factory methods for creating Browser instances.
+ *
+ * In Playwright, you access this as `chromium`, `firefox`, or `webkit`.
+ * With Owl Browser, all three aliases point to the same implementation
+ * since Owl Browser uses its own Chromium-based engine.
+ *
+ * @example
+ * ```typescript
+ * import { chromium } from '@olib-ai/owl-browser-sdk/playwright';
+ *
+ * // Connect to a running Owl Browser instance
+ * const browser = await chromium.connect({
+ *   wsEndpoint: 'http://localhost:8080',
+ *   token: 'your-token',
+ * });
+ *
+ * const context = await browser.newContext();
+ * const page = await context.newPage();
+ * await page.goto('https://example.com');
+ * ```
+ */
+export class BrowserType {
+    _name;
+    constructor(name) {
+        this._name = name;
+    }
+    /** Browser engine name. */
+    name() {
+        return this._name;
+    }
+    /** Executable path (not applicable for Owl Browser). */
+    executablePath() {
+        return '';
+    }
+    /**
+     * Connect to a running Owl Browser server.
+     *
+     * This is the primary way to create a Browser instance.
+     * The server must already be running and accessible at the given URL.
+     *
+     * @param options - Connection options (endpoint URL and auth token)
+     * @returns A connected Browser instance
+     *
+     * @example
+     * ```typescript
+     * const browser = await chromium.connect({
+     *   wsEndpoint: 'http://localhost:8080',
+     *   token: 'test-token',
+     * });
+     * ```
+     */
+    async connect(options) {
+        const client = new OwlBrowser({
+            url: options.wsEndpoint,
+            token: options.token,
+            timeout: options.timeout,
+            apiPrefix: options.apiPrefix ?? '',
+        });
+        await client.connect();
+        return new Browser(client);
+    }
+    /**
+     * Connect to a browser over CDP.
+     *
+     * Alias for connect() in Owl Browser context.
+     *
+     * @param options - Connection options
+     * @returns A connected Browser instance
+     */
+    async connectOverCDP(options) {
+        return this.connect(options);
+    }
+    /**
+     * Launch a new browser instance.
+     *
+     * Owl Browser does not support local browser launches.
+     * Use connect() to connect to a running Owl Browser server instead.
+     *
+     * @param options - Launch options (ignored)
+     * @throws Error always - use connect() instead
+     */
+    async launch(options) {
+        void options;
+        throw new Error(`${this._name}.launch() is not supported. ` +
+            `Owl Browser requires a running server. ` +
+            `Use ${this._name}.connect({ wsEndpoint, token }) instead.`);
+    }
+    /**
+     * Launch a browser with a persistent context (user data directory).
+     *
+     * Not supported by Owl Browser. Use connect() with profile_path option
+     * via browser_create_context for persistent profiles.
+     *
+     * @param userDataDir - User data directory path
+     * @param options - Launch and context options
+     * @throws Error always - use connect() instead
+     */
+    async launchPersistentContext(userDataDir, options) {
+        void userDataDir;
+        void options;
+        throw new Error(`${this._name}.launchPersistentContext() is not supported. ` +
+            `Use ${this._name}.connect() and create a context with ` +
+            `profile_path for persistent profiles.`);
+    }
+    /**
+     * Launch a browser server.
+     *
+     * Not supported by Owl Browser. The server must be started independently
+     * (via Docker or direct binary execution).
+     *
+     * @param options - Launch options
+     * @throws Error always - start server externally
+     */
+    async launchServer(options) {
+        void options;
+        throw new Error(`${this._name}.launchServer() is not supported. ` +
+            `Start the Owl Browser server externally (Docker or binary) ` +
+            `then use ${this._name}.connect().`);
+    }
+}
+//# sourceMappingURL=browser-type.js.map

package/dist/playwright/browser-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-type.js","sourceRoot":"","sources":["../../src/playwright/browser-type.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAOvC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,WAAW;IACL,KAAK,CAAS;IAE/B,YAAY,IAAY;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,2BAA2B;IAC3B,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,wDAAwD;IACxD,cAAc;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CAAC,OAA8B;QAC1C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC;YAC5B,GAAG,EAAE,OAAO,CAAC,UAAU;YACvB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE;SACnC,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,OAA8B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,OAAuB;QAClC,KAAK,OAAO,CAAC;QACb,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,KAAK,8BAA8B;YAC3C,yCAAyC;YACzC,OAAO,IAAI,CAAC,KAAK,0CAA0C,CAC5D,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,uBAAuB,CAC3B,WAAmB,EACnB,OAA+C;QAE/C,KAAK,WAAW,CAAC;QACjB,KAAK,OAAO,CAAC;QACb,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,KAAK,+CAA+C;YAC5D,OAAO,IAAI,CAAC,KAAK,uCAAuC;YACxD,uCAAuC,CACxC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,OAAuB;QACxC,KAAK,OAAO,CAAC;QACb,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,KAAK,oCAAoC;YACjD,6DAA6D;YAC7D,YAAY,IAAI,CAAC,KAAK,aAAa,CACpC,CAAC;IACJ,CAAC;CACF"}

package/dist/playwright/browser.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Playwright-compatible Browser class for Owl Browser.
+ *
+ * Wraps the OwlBrowser client to provide the Playwright Browser API surface.
+ * A Browser instance represents a connection to an Owl Browser server
+ * and manages one or more BrowserContext instances.
+ *
+ * Supports full context creation options: viewport, proxy, locale, timezone,
+ * geolocation, permissions, colorScheme, storageState, recordVideo, and more.
+ */
+import type { OwlBrowser } from '../client.js';
+import { BrowserContext } from './context.js';
+import type { Page } from './page.js';
+import type { BrowserContextOptions } from './types.js';
+/**
+ * Browser represents a connection to an Owl Browser instance.
+ *
+ * Use browser.newContext() to create isolated browsing sessions.
+ * Each context has independent cookies, storage, and optionally
+ * its own proxy configuration and fingerprint profile.
+ *
+ * @example
+ * ```typescript
+ * const browser = await chromium.connect({
+ *   wsEndpoint: 'http://localhost:8080',
+ *   token: 'test-token',
+ * });
+ *
+ * const context = await browser.newContext({
+ *   viewport: { width: 1280, height: 720 },
+ *   locale: 'en-US',
+ *   proxy: { server: 'http://proxy:8080' },
+ * });
+ *
+ * const page = await context.newPage();
+ * await page.goto('https://example.com');
+ *
+ * await context.close();
+ * await browser.close();
+ * ```
+ */
+export declare class Browser {
+    private readonly _client;
+    private readonly _contexts;
+    private _connected;
+    constructor(client: OwlBrowser);
+    /**
+     * Create a new isolated browser context.
+     *
+     * Each context gets its own cookies, local storage, and session.
+     * Supports full Playwright context options including proxy, viewport,
+     * locale, timezone, geolocation, storage state, and video recording.
+     *
+     * @param options - Context configuration options
+     * @returns A new BrowserContext instance
+     */
+    newContext(options?: BrowserContextOptions): Promise<BrowserContext>;
+    /**
+     * Create a new context and page in one call (convenience method).
+     *
+     * @param options - Context configuration options
+     * @returns A new Page instance
+     */
+    newPage(options?: BrowserContextOptions): Promise<Page>;
+    /**
+     * Get all open browser contexts.
+     *
+     * @returns Array of BrowserContext instances
+     */
+    contexts(): BrowserContext[];
+    /**
+     * Close the browser and all contexts.
+     *
+     * Closes every open context and disconnects from the server.
+     */
+    close(): Promise<void>;
+    /**
+     * Whether the browser is still connected to the server.
+     *
+     * @returns true if connected
+     */
+    isConnected(): boolean;
+    /**
+     * Browser version string.
+     *
+     * @returns Version identifier
+     */
+    version(): string;
+    /**
+     * Apply BrowserContextOptions that require post-creation API calls.
+     *
+     * Some options (viewport, proxy) are handled during browser_create_context.
+     * Others (cookies, extra headers, geolocation, offline) require separate
+     * tool executions after the context is created.
+     */
+    private _applyContextOptions;
+}
+//# sourceMappingURL=browser.d.ts.map

package/dist/playwright/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/playwright/browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,qBAAqB,EAAwB,MAAM,YAAY,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAClD,OAAO,CAAC,UAAU,CAAQ;gBAEd,MAAM,EAAE,UAAU;IAI9B;;;;;;;;;OASG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IA2C1E;;;;;OAKG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7D;;;;OAIG;IACH,QAAQ,IAAI,cAAc,EAAE;IAI5B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB5B;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;;;OAMG;YACW,oBAAoB;CAgFnC"}

package/dist/playwright/browser.js

@@ -0,0 +1,229 @@
+/**
+ * Playwright-compatible Browser class for Owl Browser.
+ *
+ * Wraps the OwlBrowser client to provide the Playwright Browser API surface.
+ * A Browser instance represents a connection to an Owl Browser server
+ * and manages one or more BrowserContext instances.
+ *
+ * Supports full context creation options: viewport, proxy, locale, timezone,
+ * geolocation, permissions, colorScheme, storageState, recordVideo, and more.
+ */
+import { BrowserContext } from './context.js';
+/**
+ * Browser represents a connection to an Owl Browser instance.
+ *
+ * Use browser.newContext() to create isolated browsing sessions.
+ * Each context has independent cookies, storage, and optionally
+ * its own proxy configuration and fingerprint profile.
+ *
+ * @example
+ * ```typescript
+ * const browser = await chromium.connect({
+ *   wsEndpoint: 'http://localhost:8080',
+ *   token: 'test-token',
+ * });
+ *
+ * const context = await browser.newContext({
+ *   viewport: { width: 1280, height: 720 },
+ *   locale: 'en-US',
+ *   proxy: { server: 'http://proxy:8080' },
+ * });
+ *
+ * const page = await context.newPage();
+ * await page.goto('https://example.com');
+ *
+ * await context.close();
+ * await browser.close();
+ * ```
+ */
+export class Browser {
+    _client;
+    _contexts = [];
+    _connected = true;
+    constructor(client) {
+        this._client = client;
+    }
+    /**
+     * Create a new isolated browser context.
+     *
+     * Each context gets its own cookies, local storage, and session.
+     * Supports full Playwright context options including proxy, viewport,
+     * locale, timezone, geolocation, storage state, and video recording.
+     *
+     * @param options - Context configuration options
+     * @returns A new BrowserContext instance
+     */
+    async newContext(options) {
+        const params = {};
+        // Proxy configuration
+        if (options?.proxy) {
+            try {
+                const proxyUrl = new URL(options.proxy.server);
+                params['proxy_type'] = proxyUrl.protocol.replace(':', '');
+                params['proxy_host'] = proxyUrl.hostname;
+                if (proxyUrl.port) {
+                    params['proxy_port'] = proxyUrl.port;
+                }
+            }
+            catch {
+                params['proxy_host'] = options.proxy.server;
+            }
+            if (options.proxy.username)
+                params['proxy_username'] = options.proxy.username;
+            if (options.proxy.password)
+                params['proxy_password'] = options.proxy.password;
+        }
+        // Timezone
+        if (options?.timezoneId) {
+            params['timezone'] = options.timezoneId;
+        }
+        // Viewport / screen size
+        if (options?.viewport) {
+            params['screen_size'] = `${options.viewport.width}x${options.viewport.height}`;
+        }
+        // Create the context
+        const result = await this._client.execute('browser_create_context', params);
+        const res = result;
+        const contextId = String(res['context_id'] ?? '');
+        const context = new BrowserContext(this._client, contextId, this);
+        this._contexts.push(context);
+        // Apply post-creation options
+        await this._applyContextOptions(context, contextId, options);
+        return context;
+    }
+    /**
+     * Create a new context and page in one call (convenience method).
+     *
+     * @param options - Context configuration options
+     * @returns A new Page instance
+     */
+    async newPage(options) {
+        const context = await this.newContext(options);
+        return context.newPage();
+    }
+    /**
+     * Get all open browser contexts.
+     *
+     * @returns Array of BrowserContext instances
+     */
+    contexts() {
+        return [...this._contexts];
+    }
+    /**
+     * Close the browser and all contexts.
+     *
+     * Closes every open context and disconnects from the server.
+     */
+    async close() {
+        for (const context of this._contexts) {
+            try {
+                await context.close();
+            }
+            catch {
+                // Context may already be closed
+            }
+        }
+        this._contexts.length = 0;
+        try {
+            await this._client.close();
+        }
+        catch {
+            // Connection may already be closed
+        }
+        this._connected = false;
+    }
+    /**
+     * Whether the browser is still connected to the server.
+     *
+     * @returns true if connected
+     */
+    isConnected() {
+        return this._connected && this._client.connected;
+    }
+    /**
+     * Browser version string.
+     *
+     * @returns Version identifier
+     */
+    version() {
+        return 'owl-browser';
+    }
+    /**
+     * Apply BrowserContextOptions that require post-creation API calls.
+     *
+     * Some options (viewport, proxy) are handled during browser_create_context.
+     * Others (cookies, extra headers, geolocation, offline) require separate
+     * tool executions after the context is created.
+     */
+    async _applyContextOptions(context, contextId, options) {
+        if (!options)
+            return;
+        // Storage state (cookies + local storage)
+        if (options.storageState) {
+            let state;
+            if (typeof options.storageState === 'string') {
+                const { readFile } = await import('node:fs/promises');
+                const data = await readFile(options.storageState, 'utf-8');
+                state = JSON.parse(data);
+            }
+            else {
+                state = options.storageState;
+            }
+            if (state.cookies && state.cookies.length > 0) {
+                await context.addCookies(state.cookies);
+            }
+            // Restore local storage via evaluate
+            if (state.origins) {
+                for (const origin of state.origins) {
+                    for (const item of origin.localStorage) {
+                        await this._client.execute('browser_evaluate', {
+                            context_id: contextId,
+                            script: `localStorage.setItem(${JSON.stringify(item.name)}, ${JSON.stringify(item.value)})`,
+                            return_value: false,
+                        });
+                    }
+                }
+            }
+        }
+        // Extra HTTP headers
+        if (options.extraHTTPHeaders) {
+            await context.setExtraHTTPHeaders(options.extraHTTPHeaders);
+        }
+        // Geolocation
+        if (options.geolocation) {
+            await context.setGeolocation(options.geolocation);
+        }
+        // Offline mode
+        if (options.offline) {
+            await context.setOffline(true);
+        }
+        // Viewport (also set during creation, but ensure Page gets it)
+        if (options.viewport) {
+            await this._client.execute('browser_set_viewport', {
+                context_id: contextId,
+                width: options.viewport.width,
+                height: options.viewport.height,
+            });
+        }
+        // Video recording
+        if (options.recordVideo) {
+            const videoParams = {
+                context_id: contextId,
+            };
+            await this._client.execute('browser_start_video_recording', videoParams);
+        }
+        // Download path (acceptDownloads)
+        if (options.acceptDownloads !== false) {
+            try {
+                await this._client.execute('browser_set_download_path', {
+                    context_id: contextId,
+                    path: '/tmp/downloads',
+                });
+            }
+            catch {
+                // Download path may not be configurable
+            }
+        }
+    }
+}
+//# sourceMappingURL=browser.js.map

package/dist/playwright/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../src/playwright/browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAI9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,OAAO;IACD,OAAO,CAAa;IACpB,SAAS,GAAqB,EAAE,CAAC;IAC1C,UAAU,GAAG,IAAI,CAAC;IAE1B,YAAY,MAAkB;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CAAC,OAA+B;QAC9C,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,sBAAsB;QACtB,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC/C,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC1D,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACzC,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAClB,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC;gBACvC,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAC9C,CAAC;YACD,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ;gBAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC9E,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ;gBAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;QAChF,CAAC;QAED,WAAW;QACX,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;YACxB,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;QAC1C,CAAC;QAED,yBAAyB;QACzB,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;YACtB,MAAM,CAAC,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjF,CAAC;QAED,qBAAqB;QACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;QAC5E,MAAM,GAAG,GAAG,MAAiC,CAAC;QAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAElD,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE7B,8BAA8B;QAC9B,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAE7D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,OAA+B;QAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACxB,CAAC;YAAC,MAAM,CAAC;gBACP,gCAAgC;YAClC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,mCAAmC;QACrC,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,oBAAoB,CAChC,OAAuB,EACvB,SAAiB,EACjB,OAA+B;QAE/B,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,0CAA0C;QAC1C,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,IAAI,KAAmB,CAAC;YACxB,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC7C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;gBACtD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;gBAC3D,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAiB,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC;YAC/B,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9C,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC;YAED,qCAAqC;YACrC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBACnC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;wBACvC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,EAAE;4BAC7C,UAAU,EAAE,SAAS;4BACrB,MAAM,EAAE,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;4BAC3F,YAAY,EAAE,KAAK;yBACpB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,qBAAqB;QACrB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC9D,CAAC;QAED,cAAc;QACd,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,MAAM,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QAED,eAAe;QACf,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,+DAA+D;QAC/D,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,EAAE;gBACjD,UAAU,EAAE,SAAS;gBACrB,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAC7B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM;aAChC,CAAC,CAAC;QACL,CAAC;QAED,kBAAkB;QAClB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,MAAM,WAAW,GAA4B;gBAC3C,UAAU,EAAE,SAAS;aACtB,CAAC;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,+BAA+B,EAAE,WAAW,CAAC,CAAC;QAC3E,CAAC;QAED,kCAAkC;QAClC,IAAI,OAAO,CAAC,eAAe,KAAK,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,2BAA2B,EAAE;oBACtD,UAAU,EAAE,SAAS;oBACrB,IAAI,EAAE,gBAAgB;iBACvB,CAAC,CAAC;YACL,CAAC;YAAC,MAAM,CAAC;gBACP,wCAAwC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/playwright/context.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Playwright-compatible BrowserContext class for Owl Browser.
+ *
+ * A BrowserContext maps to an Owl Browser context (created via browser_create_context).
+ * It provides isolated cookie/storage/session management, page (tab) creation,
+ * network interception, storage state, proxy configuration, and more.
+ */
+import type { OwlBrowser } from '../client.js';
+import { Page } from './page.js';
+import { Route } from './page-helpers.js';
+import type { Cookie, StorageState, Geolocation, RouteOptions } from './types.js';
+import type { Browser } from './browser.js';
+/**
+ * BrowserContext provides an isolated browser session.
+ *
+ * Each context has independent cookies, local storage, and session storage.
+ * Pages created within a context share these storage mechanisms.
+ * Supports network interception, storage state persistence, proxy configuration,
+ * geolocation override, and extra HTTP headers.
+ *
+ * @example
+ * ```typescript
+ * const context = await browser.newContext({
+ *   viewport: { width: 1280, height: 720 },
+ *   locale: 'en-US',
+ *   timezoneId: 'America/New_York',
+ * });
+ * const page = await context.newPage();
+ * await page.goto('https://example.com');
+ * await context.close();
+ * ```
+ */
+export declare class BrowserContext {
+    private readonly _client;
+    private readonly _contextId;
+    private readonly _pages;
+    private readonly _browser;
+    private readonly _routes;
+    private _closed;
+    private _firstPageCreated;
+    constructor(client: OwlBrowser, contextId: string, browser: Browser);
+    /** The parent Browser instance. */
+    get browser(): Browser;
+    /** The underlying Owl Browser context ID. */
+    get contextId(): string;
+    /**
+     * Create a new page (tab) in this context.
+     *
+     * The first call returns a Page wrapping the default tab that was
+     * created with the context. Subsequent calls create new tabs via
+     * browser_new_tab.
+     *
+     * @returns A new Page instance
+     */
+    newPage(): Promise<Page>;
+    /**
+     * Get all pages (tabs) in this context.
+     *
+     * @returns Array of Page instances created in this context
+     */
+    pages(): Page[];
+    /**
+     * Close the context and all its pages.
+     *
+     * Releases all resources associated with the context, including
+     * cookies, storage, network connections, and route handlers.
+     */
+    close(): Promise<void>;
+    /**
+     * Get cookies for the context.
+     *
+     * @param urls - Optional URL(s) to filter cookies by
+     * @returns Array of cookies
+     */
+    cookies(urls?: string | string[]): Promise<Cookie[]>;
+    /**
+     * Add cookies to the context.
+     *
+     * @param cookies - Array of cookie objects to add
+     */
+    addCookies(cookies: Cookie[]): Promise<void>;
+    /**
+     * Clear all cookies from the context.
+     */
+    clearCookies(): Promise<void>;
+    /**
+     * Get the storage state (cookies and local storage origins).
+     *
+     * Use this to persist session state between runs.
+     *
+     * @param options - Optional path to save the state to
+     * @returns StorageState object
+     */
+    storageState(options?: {
+        path?: string;
+    }): Promise<StorageState>;
+    /**
+     * Intercept network requests matching a URL pattern at the context level.
+     *
+     * @param url - URL pattern (glob) or RegExp to match
+     * @param handler - Handler function to process intercepted requests
+     * @param options - Route options (e.g., times)
+     */
+    route(url: string | RegExp, handler: (route: Route) => void | Promise<void>, options?: RouteOptions): Promise<void>;
+    /**
+     * Remove a previously registered context-level route handler.
+     *
+     * @param url - URL pattern that was registered
+     * @param handler - Optional specific handler to remove
+     */
+    unroute(url: string | RegExp, handler?: (route: Route) => void | Promise<void>): Promise<void>;
+    /**
+     * Remove all route handlers.
+     */
+    unrouteAll(): Promise<void>;
+    /**
+     * Set extra HTTP headers for all requests in this context.
+     *
+     * @param headers - Object with header name/value pairs
+     */
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
+    /**
+     * Set the geolocation for the context.
+     *
+     * @param geolocation - Geolocation coordinates or null to clear
+     */
+    setGeolocation(geolocation: Geolocation | null): Promise<void>;
+    /**
+     * Grant permissions to the context.
+     *
+     * Stub: Browser permissions are managed at the profile level in Owl Browser.
+     *
+     * @param permissions - Array of permission names
+     * @param options - Optional origin filter
+     */
+    grantPermissions(permissions: string[], options?: {
+        origin?: string;
+    }): Promise<void>;
+    /**
+     * Clear granted permissions.
+     */
+    clearPermissions(): Promise<void>;
+    /**
+     * Set the context to offline/online mode.
+     *
+     * @param offline - true to emulate offline, false for online
+     */
+    setOffline(offline: boolean): Promise<void>;
+    /**
+     * Configure proxy settings for this context.
+     *
+     * @param proxy - Proxy configuration
+     */
+    setProxy(proxy: {
+        server: string;
+        username?: string;
+        password?: string;
+    }): Promise<void>;
+    /**
+     * Add a script that runs in every page before any other script.
+     *
+     * @param script - JavaScript code or script path
+     * @param arg - Optional argument
+     */
+    addInitScript(script: string | {
+        path: string;
+    }, arg?: unknown): Promise<void>;
+    /**
+     * Expose a function to all pages in this context.
+     *
+     * @param name - Global function name
+     * @param callback - Function implementation
+     */
+    exposeFunction(name: string, callback: (...args: unknown[]) => unknown): Promise<void>;
+    /**
+     * Register a context-level event handler.
+     *
+     * @param event - Event name ('page', 'close', etc.)
+     * @param handler - Event handler function
+     */
+    on(event: string, handler: (...args: unknown[]) => void): this;
+    /**
+     * Register a one-time context-level event handler.
+     *
+     * @param event - Event name
+     * @param handler - Event handler function
+     */
+    once(event: string, handler: (...args: unknown[]) => void): this;
+    /**
+     * Wait for a context-level event.
+     *
+     * @param event - Event name (e.g., 'page')
+     * @param options - Wait options
+     * @returns Event data
+     */
+    waitForEvent(event: string, options?: {
+        predicate?: (data: unknown) => boolean;
+        timeout?: number;
+    }): Promise<unknown>;
+    /**
+     * Tracing interface stub.
+     *
+     * Owl Browser does not support Playwright tracing, but provides
+     * a compatible API surface to prevent errors in migrated code.
+     */
+    get tracing(): {
+        start: (options?: unknown) => Promise<void>;
+        stop: (options?: unknown) => Promise<void>;
+    };
+}
+//# sourceMappingURL=context.d.ts.map