/**
* PlaywrightClient - HTTP client for Playwright Server
*/
import type { SearchOptions, SearchResponse } from '../types/search.js';
export interface ActionResponse {
success: boolean;
action: string;
pageId: string;
[key: string]: any;
}
export interface PageInfo {
id: string;
name: string;
description: string;
url: string;
title: string;
}
export class PlaywrightClient {
constructor(private baseUrl: string = 'http://localhost:3102') {}
private async request(method: string, path: string, body?: any): Promise<any> {
const response = await fetch(`${this.baseUrl}${path}`, {
method,
headers: {
'Content-Type': 'application/json',
},
body: body ? JSON.stringify(body) : undefined,
});
if (!response.ok) {
const error = await response.text();
throw new Error(`HTTP ${response.status}: ${error}`);
}
return response.json();
}
// Page Management
async createPage(name: string, description: string, url?: string): Promise<ActionResponse> {
return this.request('POST', '/api/pages', { name, description, url });
}
async listPages(): Promise<PageInfo[]> {
return this.request('GET', '/api/pages');
}
async closePage(pageId: string): Promise<void> {
await this.request('DELETE', `/api/pages/${pageId}`);
}
// Navigation
async navigate(pageId: string, url: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/navigate`, { url });
}
// Actions using ref
async click(pageId: string, ref: string, element?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/click`, {
ref,
element: element || `Element with ref=${ref}`
});
}
async type(pageId: string, ref: string, text: string, element?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/type`, {
ref,
text,
element: element || `Element with ref=${ref}`
});
}
async fill(pageId: string, ref: string, value: string, element?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/fill`, {
ref,
value,
element: element || `Element with ref=${ref}`
});
}
async select(pageId: string, ref: string, value: string | string[], element?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/select`, {
ref,
value,
element: element || `Element with ref=${ref}`
});
}
// Screenshot
async screenshot(pageId: string, fullPage: boolean = true): Promise<string> {
const result = await this.request('POST', `/api/pages/${pageId}/screenshot`, { fullPage });
return result.screenshot;
}
// Browser Actions - Additional
async browserHover(pageId: string, ref: string, element?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/hover`, {
ref,
element: element || `Element with ref=${ref}`
});
}
async browserPressKey(pageId: string, key: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/press`, { key });
}
async browserFileUpload(pageId: string, ref: string, files: string[]): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/upload`, { ref, files });
}
async browserHandleDialog(pageId: string, accept: boolean, text?: string): Promise<{ success: boolean }> {
return this.request('POST', `/api/pages/${pageId}/dialog`, { accept, text });
}
async browserNavigateBack(pageId: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/back`);
}
async browserNavigateForward(pageId: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/forward`);
}
async scrollToBottom(pageId: string, ref?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/scroll-bottom`, { ref });
}
async scrollToTop(pageId: string, ref?: string): Promise<ActionResponse> {
return this.request('POST', `/api/pages/${pageId}/scroll-top`, { ref });
}
async waitForTimeout(pageId: string, timeout: number): Promise<{ success: boolean }> {
return this.request('POST', `/api/pages/${pageId}/wait-timeout`, { timeout });
}
async waitForSelector(pageId: string, selector: string, options?: any): Promise<{ success: boolean }> {
return this.request('POST', `/api/pages/${pageId}/wait-selector`, { selector, options });
}
// Aliases for compatibility
async browserClick(pageId: string, ref: string, element?: string): Promise<ActionResponse> {
return this.click(pageId, ref, element);
}
async browserType(pageId: string, ref: string, text: string, element?: string): Promise<ActionResponse> {
return this.type(pageId, ref, text, element);
}
async browserSelectOption(pageId: string, ref: string, value: string | string[], element?: string): Promise<ActionResponse> {
return this.select(pageId, ref, value, element);
}
async browserNavigate(pageId: string, url: string): Promise<ActionResponse> {
return this.navigate(pageId, url);
}
// Get page outline - structured summary with intelligent folding (fixed 200 lines)
async getOutline(pageId: string): Promise<string> {
const result = await this.request('POST', `/api/pages/${pageId}/outline`);
return result.outline;
}
// Search snapshot - search snapshot content with regular expressions
async searchSnapshot(pageId: string, pattern: string, options?: Partial<Omit<SearchOptions, 'pattern'>>): Promise<SearchResponse> {
const searchOptions: SearchOptions = {
pattern,
ignoreCase: options?.ignoreCase || false,
lineLimit: options?.lineLimit || 100
};
return this.request('POST', `/api/pages/${pageId}/search`, searchOptions);
}
}
// Export for CommonJS compatibility
export default PlaywrightClient;
