Files
browse/src/browser.ts
T
Adam Ladachowski f5df8c67f3 💬 Commit message: Update 2026-02-11 12:18:05, 14 files, 1838 lines
📁 Files changed: 14
📝 Lines changed: 1838

  • CLAUDE.md
  • README.md
  • TODO.md
  • browser.d.ts
  • browser.d.ts.map
  • browser.js
  • browser.js.map
  • mcp.js
  • mcp.js.map
  • types.d.ts
  • types.d.ts.map
  • browser.ts
  • mcp.ts
  • types.ts
2026-02-11 12:18:06 +01:00

864 lines
28 KiB
TypeScript

import { resolve } from 'node:path';
import { type Browser, type BrowserContext, type Page, type Route, webkit } from 'playwright';
import * as image from './image.js';
import type {
A11yNode,
BrowserCommand,
BrowserOptions,
CommandResponse,
ConsoleMessage,
CookiesCommand,
DialogCommand,
DialogEntry,
ElementInfo,
MetricsData,
NetworkEntry,
PageError,
StorageCommand,
} from './types.js';
export class ClaudeBrowser {
private browser: Browser | null = null;
private context: BrowserContext | null = null;
private page: Page | null = null;
private options: Required<BrowserOptions>;
private consoleMessages: ConsoleMessage[] = [];
private networkEntries: NetworkEntry[] = [];
private pageErrors: PageError[] = [];
private dialogHistory: DialogEntry[] = [];
private dialogConfig = { autoAccept: false, autoDismiss: false, promptText: '' };
private interceptPatterns: Map<
string,
{
action: 'block' | 'mock';
response?: { status?: number; body?: string; contentType?: string };
}
> = new Map();
constructor(options: BrowserOptions = {}) {
this.options = {
headless: options.headless ?? true,
width: options.width ?? 1280,
height: options.height ?? 800,
};
}
async launch(): Promise<void> {
this.browser = await webkit.launch({ headless: this.options.headless });
this.context = await this.browser.newContext({
viewport: {
width: this.options.width,
height: this.options.height,
},
});
this.page = await this.context.newPage();
this.setupConsoleListener(this.page);
this.setupNetworkListener(this.page);
this.setupErrorListener(this.page);
this.setupDialogListener(this.page);
}
private setupErrorListener(page: Page): void {
page.on('pageerror', (error) => {
this.pageErrors.push({
message: error.message,
stack: error.stack,
timestamp: Date.now(),
});
});
}
private setupDialogListener(page: Page): void {
page.on('dialog', async (dialog) => {
const entry: DialogEntry = {
type: dialog.type() as DialogEntry['type'],
message: dialog.message(),
defaultValue: dialog.defaultValue() || undefined,
timestamp: Date.now(),
};
if (this.dialogConfig.autoAccept) {
await dialog.accept(this.dialogConfig.promptText || undefined);
entry.response = this.dialogConfig.promptText || true;
} else if (this.dialogConfig.autoDismiss) {
await dialog.dismiss();
entry.response = false;
} else {
// Default: accept to prevent blocking
await dialog.accept();
entry.response = true;
}
this.dialogHistory.push(entry);
});
}
private setupConsoleListener(page: Page): void {
page.on('console', (msg) => {
const location = msg.location();
this.consoleMessages.push({
level: msg.type(),
text: msg.text(),
timestamp: Date.now(),
location: location.url ? `${location.url}:${location.lineNumber}` : undefined,
});
});
}
private setupNetworkListener(page: Page): void {
const pendingRequests = new Map<string, NetworkEntry>();
page.on('request', (request) => {
const entry: NetworkEntry = {
url: request.url(),
method: request.method(),
resourceType: request.resourceType(),
requestHeaders: request.headers(),
timing: { startTime: Date.now() },
};
pendingRequests.set(request.url() + request.method(), entry);
});
page.on('response', async (response) => {
const request = response.request();
const key = request.url() + request.method();
const entry = pendingRequests.get(key);
if (entry) {
entry.status = response.status();
entry.statusText = response.statusText();
entry.responseHeaders = response.headers();
if (entry.timing) {
entry.timing.endTime = Date.now();
entry.timing.duration = entry.timing.endTime - entry.timing.startTime;
}
try {
const body = await response.body();
entry.size = body.length;
} catch {
// Body may not be available for some responses
}
this.networkEntries.push(entry);
pendingRequests.delete(key);
}
});
page.on('requestfailed', (request) => {
const key = request.url() + request.method();
const entry = pendingRequests.get(key);
if (entry) {
entry.error = request.failure()?.errorText || 'Request failed';
if (entry.timing) {
entry.timing.endTime = Date.now();
entry.timing.duration = entry.timing.endTime - entry.timing.startTime;
}
this.networkEntries.push(entry);
pendingRequests.delete(key);
}
});
}
async close(): Promise<void> {
if (this.browser) {
await this.browser.close();
this.browser = null;
this.context = null;
this.page = null;
}
}
private ensurePage(): Page {
if (!this.page) {
throw new Error('Browser not launched. Call launch() first.');
}
return this.page;
}
/** Get the current page instance (for advanced usage) */
getPage(): Page | null {
return this.page;
}
/** Get the browser context (for advanced usage like cookies) */
getContext(): BrowserContext | null {
return this.context;
}
async goto(url: string): Promise<{ url: string; title: string }> {
const page = this.ensurePage();
await page.goto(url, { waitUntil: 'networkidle' });
return { url: page.url(), title: await page.title() };
}
async click(selector: string): Promise<{ url: string }> {
const page = this.ensurePage();
await page.click(selector);
await page.waitForLoadState('networkidle').catch(() => {});
return { url: page.url() };
}
async type(selector: string, text: string): Promise<void> {
const page = this.ensurePage();
await page.fill(selector, text);
}
async query(selector: string): Promise<ElementInfo[]> {
const page = this.ensurePage();
return page.$$eval(selector, (nodes) =>
nodes.map((el) => {
const attrs: Record<string, string> = {};
for (const attr of el.attributes) {
attrs[attr.name] = attr.value;
}
return {
tag: el.tagName.toLowerCase(),
text: el.textContent?.trim().slice(0, 200) || '',
attributes: attrs,
};
})
);
}
async screenshot(path?: string, fullPage = false): Promise<{ path: string; buffer?: Buffer }> {
const page = this.ensurePage();
const resolvedPath = resolve(path || 'screenshot.png');
const buffer = await page.screenshot({ path: resolvedPath, fullPage });
return { path: resolvedPath, buffer };
}
async getUrl(): Promise<{ url: string; title: string }> {
const page = this.ensurePage();
return { url: page.url(), title: await page.title() };
}
async getHtml(full = false): Promise<string> {
const page = this.ensurePage();
const html = await page.content();
return full ? html : html.slice(0, 10000);
}
async back(): Promise<{ url: string }> {
const page = this.ensurePage();
await page.goBack();
return { url: page.url() };
}
async forward(): Promise<{ url: string }> {
const page = this.ensurePage();
await page.goForward();
return { url: page.url() };
}
async reload(): Promise<{ url: string }> {
const page = this.ensurePage();
await page.reload();
return { url: page.url() };
}
async wait(ms = 1000): Promise<void> {
const page = this.ensurePage();
await page.waitForTimeout(ms);
}
async newPage(): Promise<void> {
if (!this.context) {
throw new Error('Browser not launched. Call launch() first.');
}
this.page = await this.context.newPage();
this.setupConsoleListener(this.page);
this.setupNetworkListener(this.page);
this.setupErrorListener(this.page);
this.setupDialogListener(this.page);
}
async eval(script: string): Promise<unknown> {
const page = this.ensurePage();
return page.evaluate(script);
}
getConsole(level?: string, clear = false): ConsoleMessage[] {
let messages = this.consoleMessages;
if (level && level !== 'all') {
messages = messages.filter((m) => m.level === level);
}
if (clear) {
this.consoleMessages = [];
}
return messages;
}
clearConsole(): void {
this.consoleMessages = [];
}
getNetwork(filter?: string, clear = false): NetworkEntry[] {
let entries = this.networkEntries;
if (filter && filter !== 'all') {
if (filter === 'failed') {
entries = entries.filter((e) => e.error || (e.status && e.status >= 400));
} else {
entries = entries.filter((e) => e.resourceType === filter);
}
}
if (clear) {
this.networkEntries = [];
}
return entries;
}
clearNetwork(): void {
this.networkEntries = [];
}
getErrors(clear = false): PageError[] {
const errors = this.pageErrors;
if (clear) {
this.pageErrors = [];
}
return errors;
}
clearErrors(): void {
this.pageErrors = [];
}
async getMetrics(includeResources = false): Promise<MetricsData> {
const page = this.ensurePage();
const metricsScript = `(() => {
const timing = performance.timing;
const navigationStart = timing.navigationStart;
const paintEntries = performance.getEntriesByType('paint');
const firstPaint = paintEntries.find(e => e.name === 'first-paint');
const fcp = paintEntries.find(e => e.name === 'first-contentful-paint');
return {
timing: {
domContentLoaded: timing.domContentLoadedEventEnd - navigationStart,
load: timing.loadEventEnd - navigationStart,
firstPaint: firstPaint ? firstPaint.startTime : undefined,
firstContentfulPaint: fcp ? fcp.startTime : undefined,
},
dom: {
nodes: document.getElementsByTagName('*').length,
scripts: document.getElementsByTagName('script').length,
stylesheets: document.getElementsByTagName('link').length,
images: document.getElementsByTagName('img').length,
},
};
})()`;
const metrics = (await page.evaluate(metricsScript)) as MetricsData;
if (includeResources) {
const resourcesScript = `(() => {
return performance.getEntriesByType('resource').map(entry => ({
name: entry.name,
type: entry.initiatorType,
duration: Math.round(entry.duration),
size: entry.transferSize || 0,
}));
})()`;
const resources = (await page.evaluate(resourcesScript)) as MetricsData['resources'];
return { ...metrics, resources };
}
return metrics;
}
async getA11y(selector?: string): Promise<A11yNode | null> {
const page = this.ensurePage();
// Build a11y tree using ARIA attributes and semantic roles
const selectorArg = selector ? JSON.stringify(selector) : 'null';
const script = `((selector) => {
function getA11yNode(el) {
const role = el.getAttribute('role') || getImplicitRole(el);
const name = getAccessibleName(el);
const node = { role, name: name || undefined };
const value = el.value || el.getAttribute('aria-valuenow');
if (value) node.value = String(value);
const desc = el.getAttribute('aria-describedby');
if (desc) {
const descEl = document.getElementById(desc);
if (descEl) node.description = descEl.textContent?.trim();
}
const children = [];
for (const child of el.children) {
if (isAccessible(child)) children.push(getA11yNode(child));
}
if (children.length) node.children = children;
return node;
}
function getImplicitRole(el) {
const tag = el.tagName.toLowerCase();
const roleMap = { button:'button', a:'link', input:'textbox', img:'img',
h1:'heading', h2:'heading', h3:'heading', h4:'heading', nav:'navigation',
main:'main', footer:'contentinfo', header:'banner', aside:'complementary',
form:'form', table:'table', ul:'list', ol:'list', li:'listitem' };
return roleMap[tag] || 'generic';
}
function getAccessibleName(el) {
return el.getAttribute('aria-label') || el.getAttribute('alt')
|| el.getAttribute('title') || (el.tagName === 'INPUT' ? el.placeholder : null)
|| el.textContent?.trim().slice(0, 100);
}
function isAccessible(el) {
if (el.nodeType !== 1) return false;
if (el.getAttribute('aria-hidden') === 'true') return false;
const style = getComputedStyle(el);
return style.display !== 'none' && style.visibility !== 'hidden';
}
const root = selector ? document.querySelector(selector) : document.body;
return root ? getA11yNode(root) : null;
})(${selectorArg})`;
return page.evaluate(script) as Promise<A11yNode | null>;
}
getDialogs(): DialogEntry[] {
return this.dialogHistory;
}
clearDialogs(): void {
this.dialogHistory = [];
}
setDialogConfig(config: { autoAccept?: boolean; autoDismiss?: boolean; text?: string }): void {
if (config.autoAccept !== undefined) this.dialogConfig.autoAccept = config.autoAccept;
if (config.autoDismiss !== undefined) this.dialogConfig.autoDismiss = config.autoDismiss;
if (config.text !== undefined) this.dialogConfig.promptText = config.text;
}
getDialogConfig(): { autoAccept: boolean; autoDismiss: boolean } {
return { autoAccept: this.dialogConfig.autoAccept, autoDismiss: this.dialogConfig.autoDismiss };
}
async addIntercept(
pattern: string,
action: 'block' | 'mock',
response?: { status?: number; body?: string; contentType?: string }
): Promise<void> {
const page = this.ensurePage();
this.interceptPatterns.set(pattern, { action, response });
await page.route(pattern, (route) => this.handleIntercept(pattern, route));
}
private async handleIntercept(pattern: string, route: Route): Promise<void> {
const config = this.interceptPatterns.get(pattern);
if (!config) {
await route.continue();
return;
}
if (config.action === 'block') {
await route.abort();
return;
}
if (config.action === 'mock' && config.response) {
await route.fulfill({
status: config.response.status || 200,
contentType: config.response.contentType || 'application/json',
body: config.response.body || '',
});
return;
}
await route.continue();
}
async clearIntercepts(): Promise<void> {
const page = this.ensurePage();
for (const pattern of this.interceptPatterns.keys()) {
await page.unroute(pattern);
}
this.interceptPatterns.clear();
}
getInterceptPatterns(): string[] {
return Array.from(this.interceptPatterns.keys());
}
// Phase 6: Cookies & Storage
async getCookies(
name?: string
): Promise<Array<{ name: string; value: string; domain: string; path: string }>> {
const context = this.getContext();
if (!context) throw new Error('Browser not launched');
const cookies = await context.cookies();
const filtered = name ? cookies.filter((c) => c.name === name) : cookies;
return filtered.map((c) => ({ name: c.name, value: c.value, domain: c.domain, path: c.path }));
}
async setCookie(name: string, value: string, url?: string): Promise<void> {
const context = this.getContext();
if (!context) throw new Error('Browser not launched');
const page = this.ensurePage();
await context.addCookies([{ name, value, url: url || page.url() }]);
}
async deleteCookie(name: string): Promise<void> {
const context = this.getContext();
if (!context) throw new Error('Browser not launched');
const cookies = await context.cookies();
const toKeep = cookies.filter((c) => c.name !== name);
await context.clearCookies();
if (toKeep.length > 0) await context.addCookies(toKeep);
}
async clearCookies(): Promise<void> {
const context = this.getContext();
if (!context) throw new Error('Browser not launched');
await context.clearCookies();
}
async getStorage(type: 'local' | 'session', key?: string): Promise<Record<string, string>> {
const page = this.ensurePage();
const storage = type === 'local' ? 'localStorage' : 'sessionStorage';
const script = key
? `({ [${JSON.stringify(key)}]: ${storage}.getItem(${JSON.stringify(key)}) || '' })`
: `Object.fromEntries(Array.from({ length: ${storage}.length }, (_, i) => {
const k = ${storage}.key(i); return [k, ${storage}.getItem(k)];
}))`;
return page.evaluate(script) as Promise<Record<string, string>>;
}
async setStorage(type: 'local' | 'session', key: string, value: string): Promise<void> {
const page = this.ensurePage();
const storage = type === 'local' ? 'localStorage' : 'sessionStorage';
await page.evaluate(`${storage}.setItem(${JSON.stringify(key)}, ${JSON.stringify(value)})`);
}
async deleteStorage(type: 'local' | 'session', key: string): Promise<void> {
const page = this.ensurePage();
const storage = type === 'local' ? 'localStorage' : 'sessionStorage';
await page.evaluate(`${storage}.removeItem(${JSON.stringify(key)})`);
}
async clearStorage(type: 'local' | 'session'): Promise<void> {
const page = this.ensurePage();
const storage = type === 'local' ? 'localStorage' : 'sessionStorage';
await page.evaluate(`${storage}.clear()`);
}
// Phase 7: Advanced Interactions
async hover(selector: string): Promise<void> {
const page = this.ensurePage();
await page.hover(selector);
}
async select(selector: string, value: string | string[]): Promise<string[]> {
const page = this.ensurePage();
return page.selectOption(selector, value);
}
async keys(keys: string): Promise<void> {
const page = this.ensurePage();
await page.keyboard.press(keys);
}
async upload(selector: string, files: string[]): Promise<void> {
const page = this.ensurePage();
await page.setInputFiles(selector, files);
}
async scroll(selector?: string, x?: number, y?: number): Promise<void> {
const page = this.ensurePage();
if (selector) {
await page.locator(selector).scrollIntoViewIfNeeded();
} else {
await page.evaluate(`window.scrollTo(${x || 0}, ${y || 0})`);
}
}
// Phase 8: Viewport & Emulation
async setViewport(width: number, height: number): Promise<{ width: number; height: number }> {
const page = this.ensurePage();
await page.setViewportSize({ width, height });
return { width, height };
}
async emulate(device: string): Promise<{ width: number; height: number }> {
const page = this.ensurePage();
const { devices } = await import('playwright');
const deviceConfig = devices[device];
if (!deviceConfig)
throw new Error(`Unknown device: ${device}. Try 'iPhone 13', 'Pixel 5', etc.`);
await page.setViewportSize(deviceConfig.viewport);
return deviceConfig.viewport;
}
private handleDialogCommand(cmd: DialogCommand): CommandResponse {
switch (cmd.action) {
case 'status':
return { ok: true, dialogs: this.getDialogs(), dialogConfig: this.getDialogConfig() };
case 'accept':
this.setDialogConfig({ autoAccept: true, autoDismiss: false, text: cmd.text });
return { ok: true, dialogConfig: this.getDialogConfig() };
case 'dismiss':
this.setDialogConfig({ autoAccept: false, autoDismiss: true });
return { ok: true, dialogConfig: this.getDialogConfig() };
case 'config':
this.setDialogConfig({
autoAccept: cmd.autoAccept,
autoDismiss: cmd.autoDismiss,
text: cmd.text,
});
return { ok: true, dialogConfig: this.getDialogConfig() };
default:
return { ok: false, error: 'Unknown dialog action' };
}
}
private async handleCookiesCommand(cmd: CookiesCommand): Promise<CommandResponse> {
switch (cmd.action) {
case 'get': {
const cookies = await this.getCookies(cmd.name);
return { ok: true, cookies, count: cookies.length };
}
case 'set': {
if (!cmd.name || !cmd.value) return { ok: false, error: 'Name and value required' };
await this.setCookie(cmd.name, cmd.value, cmd.url);
return { ok: true };
}
case 'delete': {
if (!cmd.name) return { ok: false, error: 'Name required' };
await this.deleteCookie(cmd.name);
return { ok: true };
}
case 'clear': {
await this.clearCookies();
return { ok: true };
}
default:
return { ok: false, error: 'Unknown cookies action' };
}
}
private async handleStorageCommand(cmd: StorageCommand): Promise<CommandResponse> {
switch (cmd.action) {
case 'get': {
const storage = await this.getStorage(cmd.type, cmd.key);
return { ok: true, storage, count: Object.keys(storage).length };
}
case 'set': {
if (!cmd.key || cmd.value === undefined)
return { ok: false, error: 'Key and value required' };
await this.setStorage(cmd.type, cmd.key, cmd.value);
return { ok: true };
}
case 'delete': {
if (!cmd.key) return { ok: false, error: 'Key required' };
await this.deleteStorage(cmd.type, cmd.key);
return { ok: true };
}
case 'clear': {
await this.clearStorage(cmd.type);
return { ok: true };
}
default:
return { ok: false, error: 'Unknown storage action' };
}
}
async executeCommand(cmd: BrowserCommand): Promise<CommandResponse> {
try {
switch (cmd.cmd) {
case 'goto': {
const result = await this.goto(cmd.url);
return { ok: true, ...result };
}
case 'click': {
const result = await this.click(cmd.selector);
return { ok: true, ...result };
}
case 'type': {
await this.type(cmd.selector, cmd.text);
return { ok: true };
}
case 'query': {
const elements = await this.query(cmd.selector);
return { ok: true, count: elements.length, elements };
}
case 'screenshot': {
const result = await this.screenshot(cmd.path, cmd.fullPage);
return { ok: true, path: result.path };
}
case 'url': {
const result = await this.getUrl();
return { ok: true, ...result };
}
case 'html': {
const html = await this.getHtml(cmd.full);
return { ok: true, html };
}
case 'back': {
const result = await this.back();
return { ok: true, ...result };
}
case 'forward': {
const result = await this.forward();
return { ok: true, ...result };
}
case 'reload': {
const result = await this.reload();
return { ok: true, ...result };
}
case 'wait': {
await this.wait(cmd.ms);
return { ok: true };
}
case 'newpage': {
await this.newPage();
return { ok: true };
}
case 'close': {
await this.close();
return { ok: true };
}
case 'eval': {
const result = await this.eval(cmd.script);
return { ok: true, result };
}
case 'console': {
const messages = this.getConsole(cmd.level, cmd.clear);
return { ok: true, count: messages.length, messages };
}
case 'network': {
const requests = this.getNetwork(cmd.filter, cmd.clear);
return { ok: true, count: requests.length, requests };
}
case 'intercept': {
if (cmd.action === 'list') {
const patterns = this.getInterceptPatterns();
return { ok: true, count: patterns.length, patterns };
}
if (cmd.action === 'clear') {
await this.clearIntercepts();
return { ok: true };
}
if (!cmd.pattern) {
return { ok: false, error: 'Pattern required for block/mock actions' };
}
await this.addIntercept(cmd.pattern, cmd.action, cmd.response);
return { ok: true, patterns: this.getInterceptPatterns() };
}
case 'errors': {
const errors = this.getErrors(cmd.clear);
return { ok: true, count: errors.length, errors };
}
case 'metrics': {
const metrics = await this.getMetrics(cmd.resources);
return { ok: true, metrics };
}
case 'a11y': {
const a11y = await this.getA11y(cmd.selector);
return { ok: true, a11y: a11y || undefined };
}
case 'dialog':
return this.handleDialogCommand(cmd);
case 'cookies':
return this.handleCookiesCommand(cmd);
case 'storage':
return this.handleStorageCommand(cmd);
case 'hover': {
await this.hover(cmd.selector);
return { ok: true };
}
case 'select': {
const selected = await this.select(cmd.selector, cmd.value);
return { ok: true, selected };
}
case 'keys': {
await this.keys(cmd.keys);
return { ok: true };
}
case 'upload': {
await this.upload(cmd.selector, cmd.files);
return { ok: true };
}
case 'scroll': {
await this.scroll(cmd.selector, cmd.x, cmd.y);
return { ok: true };
}
case 'viewport': {
const viewport = await this.setViewport(cmd.width, cmd.height);
return { ok: true, viewport };
}
case 'emulate': {
const viewport = await this.emulate(cmd.device);
return { ok: true, viewport };
}
case 'favicon': {
const result = await image.createFavicon(cmd.input, cmd.outputDir);
return { ok: true, files: result.files, outputDir: result.outputDir };
}
case 'convert': {
const result = await image.convert(cmd.input, cmd.output, cmd.format);
return {
ok: true,
path: result.path,
width: result.width,
height: result.height,
format: result.format,
size: result.size,
};
}
case 'resize': {
const result = await image.resize(cmd.input, cmd.output, cmd.width, cmd.height, cmd.fit);
return {
ok: true,
path: result.path,
width: result.width,
height: result.height,
format: result.format,
size: result.size,
};
}
case 'crop': {
const result = await image.crop(
cmd.input,
cmd.output,
cmd.left,
cmd.top,
cmd.width,
cmd.height
);
return {
ok: true,
path: result.path,
width: result.width,
height: result.height,
format: result.format,
size: result.size,
};
}
case 'compress': {
const result = await image.compress(cmd.input, cmd.output, cmd.quality);
return {
ok: true,
path: result.path,
width: result.width,
height: result.height,
format: result.format,
size: result.size,
};
}
case 'thumbnail': {
const result = await image.thumbnail(cmd.input, cmd.output, cmd.size);
return {
ok: true,
path: result.path,
width: result.width,
height: result.height,
format: result.format,
size: result.size,
};
}
default: {
const _exhaustive: never = cmd;
return { ok: false, error: `Unknown command: ${(_exhaustive as { cmd: string }).cmd}` };
}
}
} catch (err) {
return { ok: false, error: (err as Error).message };
}
}
}