@szymonrybczak/playwright-mcp 0.0.2 → 0.0.5

package/lib/manualPromise.js

@@ -1,111 +0,0 @@
-/**
- * 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.
- */
-export class ManualPromise extends Promise {
-    _resolve;
-    _reject;
-    _isDone;
-    constructor() {
-        let resolve;
-        let reject;
-        super((f, r) => {
-            resolve = f;
-            reject = r;
-        });
-        this._isDone = false;
-        this._resolve = resolve;
-        this._reject = reject;
-    }
-    isDone() {
-        return this._isDone;
-    }
-    resolve(t) {
-        this._isDone = true;
-        this._resolve(t);
-    }
-    reject(e) {
-        this._isDone = true;
-        this._reject(e);
-    }
-    static get [Symbol.species]() {
-        return Promise;
-    }
-    get [Symbol.toStringTag]() {
-        return 'ManualPromise';
-    }
-}
-export class LongStandingScope {
-    _terminateError;
-    _closeError;
-    _terminatePromises = new Map();
-    _isClosed = false;
-    reject(error) {
-        this._isClosed = true;
-        this._terminateError = error;
-        for (const p of this._terminatePromises.keys())
-            p.resolve(error);
-    }
-    close(error) {
-        this._isClosed = true;
-        this._closeError = error;
-        for (const [p, frames] of this._terminatePromises)
-            p.resolve(cloneError(error, frames));
-    }
-    isClosed() {
-        return this._isClosed;
-    }
-    static async raceMultiple(scopes, promise) {
-        return Promise.race(scopes.map(s => s.race(promise)));
-    }
-    async race(promise) {
-        return this._race(Array.isArray(promise) ? promise : [promise], false);
-    }
-    async safeRace(promise, defaultValue) {
-        return this._race([promise], true, defaultValue);
-    }
-    async _race(promises, safe, defaultValue) {
-        const terminatePromise = new ManualPromise();
-        const frames = captureRawStack();
-        if (this._terminateError)
-            terminatePromise.resolve(this._terminateError);
-        if (this._closeError)
-            terminatePromise.resolve(cloneError(this._closeError, frames));
-        this._terminatePromises.set(terminatePromise, frames);
-        try {
-            return await Promise.race([
-                terminatePromise.then(e => safe ? defaultValue : Promise.reject(e)),
-                ...promises
-            ]);
-        }
-        finally {
-            this._terminatePromises.delete(terminatePromise);
-        }
-    }
-}
-function cloneError(error, frames) {
-    const clone = new Error();
-    clone.name = error.name;
-    clone.message = error.message;
-    clone.stack = [error.name + ':' + error.message, ...frames].join('\n');
-    return clone;
-}
-function captureRawStack() {
-    const stackTraceLimit = Error.stackTraceLimit;
-    Error.stackTraceLimit = 50;
-    const error = new Error();
-    const stack = error.stack || '';
-    Error.stackTraceLimit = stackTraceLimit;
-    return stack.split('\n');
-}

package/lib/package.js

@@ -1,20 +0,0 @@
-/**
- * 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 fs from 'node:fs';
-import url from 'node:url';
-import path from 'node:path';
-const __filename = url.fileURLToPath(import.meta.url);
-export const packageJSON = JSON.parse(fs.readFileSync(path.join(path.dirname(__filename), '..', 'package.json'), 'utf8'));

package/lib/pageSnapshot.js

@@ -1,43 +0,0 @@
-/**
- * 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 { callOnPageNoTrace } from './tools/utils.js';
-export class PageSnapshot {
-    _page;
-    _text;
-    constructor(page) {
-        this._page = page;
-    }
-    static async create(page) {
-        const snapshot = new PageSnapshot(page);
-        await snapshot._build();
-        return snapshot;
-    }
-    text() {
-        return this._text;
-    }
-    async _build() {
-        const snapshot = await callOnPageNoTrace(this._page, page => page._snapshotForAI());
-        this._text = [
-            `- Page Snapshot`,
-            '```yaml',
-            snapshot,
-            '```',
-        ].join('\n');
-    }
-    refLocator(params) {
-        return this._page.locator(`aria-ref=${params.ref}`).describe(params.element);
-    }
-}

package/lib/program.js

@@ -1,72 +0,0 @@
-/**
- * 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 { program } from 'commander';
-// @ts-ignore
-import { startTraceViewerServer } from '@szymonrybczak/patchright/lib/server';
-import { startHttpServer, startHttpTransport, startStdioTransport } from './transport.js';
-import { resolveCLIConfig } from './config.js';
-import { Server } from './server.js';
-import { packageJSON } from './package.js';
-program
-    .version('Version ' + packageJSON.version)
-    .name(packageJSON.name)
-    .option('--allowed-origins <origins>', 'semicolon-separated list of origins to allow the browser to request. Default is to allow all.', semicolonSeparatedList)
-    .option('--blocked-origins <origins>', 'semicolon-separated list of origins to block the browser from requesting. Blocklist is evaluated before allowlist. If used without the allowlist, requests not matching the blocklist are still allowed.', semicolonSeparatedList)
-    .option('--block-service-workers', 'block service workers')
-    .option('--browser <browser>', 'browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.')
-    .option('--browser-agent <endpoint>', 'Use browser agent (experimental).')
-    .option('--caps <caps>', 'comma-separated list of capabilities to enable, possible values: tabs, pdf, history, wait, files, install. Default is all.')
-    .option('--cdp-endpoint <endpoint>', 'CDP endpoint to connect to.')
-    .option('--config <path>', 'path to the configuration file.')
-    .option('--device <device>', 'device to emulate, for example: "iPhone 15"')
-    .option('--executable-path <path>', 'path to the browser executable.')
-    .option('--headless', 'run browser in headless mode, headed by default')
-    .option('--host <host>', 'host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.')
-    .option('--ignore-https-errors', 'ignore https errors')
-    .option('--isolated', 'keep the browser profile in memory, do not save it to disk.')
-    .option('--image-responses <mode>', 'whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.')
-    .option('--no-sandbox', 'disable the sandbox for all process types that are normally sandboxed.')
-    .option('--output-dir <path>', 'path to the directory for output files.')
-    .option('--port <port>', 'port to listen on for SSE transport.')
-    .option('--proxy-bypass <bypass>', 'comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"')
-    .option('--proxy-server <proxy>', 'specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"')
-    .option('--save-trace', 'Whether to save the Playwright Trace of the session into the output directory.')
-    .option('--storage-state <path>', 'path to the storage state file for isolated sessions.')
-    .option('--user-agent <ua string>', 'specify user agent string')
-    .option('--user-data-dir <path>', 'path to the user data directory. If not specified, a temporary directory will be created.')
-    .option('--viewport-size <size>', 'specify browser viewport size in pixels, for example "1280, 720"')
-    .option('--vision', 'Run server that uses screenshots (Aria snapshots are used by default)')
-    .action(async (options) => {
-    const config = await resolveCLIConfig(options);
-    const httpServer = config.server.port !== undefined ? await startHttpServer(config.server) : undefined;
-    const server = new Server(config);
-    server.setupExitWatchdog();
-    if (httpServer)
-        startHttpTransport(httpServer, server);
-    else
-        await startStdioTransport(server);
-    if (config.saveTrace) {
-        const server = await startTraceViewerServer();
-        const urlPrefix = server.urlPrefix('human-readable');
-        const url = urlPrefix + '/trace/index.html?trace=' + config.browser.launchOptions.tracesDir + '/trace.json';
-        // eslint-disable-next-line no-console
-        console.error('\nTrace viewer listening on ' + url);
-    }
-});
-function semicolonSeparatedList(value) {
-    return value.split(';').map(v => v.trim());
-}
-void program.parseAsync(process.argv);

package/lib/server.js

@@ -1,48 +0,0 @@
-/**
- * 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 { createConnection } from './connection.js';
-import { contextFactory } from './browserContextFactory.js';
-export class Server {
-    config;
-    _connectionList = [];
-    _browserConfig;
-    _contextFactory;
-    constructor(config) {
-        this.config = config;
-        this._browserConfig = config.browser;
-        this._contextFactory = contextFactory(this._browserConfig);
-    }
-    async createConnection(transport) {
-        const connection = createConnection(this.config, this._contextFactory);
-        this._connectionList.push(connection);
-        await connection.server.connect(transport);
-        return connection;
-    }
-    setupExitWatchdog() {
-        let isExiting = false;
-        const handleExit = async () => {
-            if (isExiting)
-                return;
-            isExiting = true;
-            setTimeout(() => process.exit(0), 15000);
-            await Promise.all(this._connectionList.map(connection => connection.close()));
-            process.exit(0);
-        };
-        process.stdin.on('close', handleExit);
-        process.on('SIGINT', handleExit);
-        process.on('SIGTERM', handleExit);
-    }
-}

package/lib/tab.js

@@ -1,101 +0,0 @@
-/**
- * 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 { PageSnapshot } from './pageSnapshot.js';
-import { callOnPageNoTrace } from './tools/utils.js';
-export class Tab {
-    context;
-    page;
-    _consoleMessages = [];
-    _requests = new Map();
-    _snapshot;
-    _onPageClose;
-    constructor(context, page, onPageClose) {
-        this.context = context;
-        this.page = page;
-        this._onPageClose = onPageClose;
-        page.on('console', event => this._consoleMessages.push(event));
-        page.on('request', request => this._requests.set(request, null));
-        page.on('response', response => this._requests.set(response.request(), response));
-        page.on('close', () => this._onClose());
-        page.on('filechooser', chooser => {
-            this.context.setModalState({
-                type: 'fileChooser',
-                description: 'File chooser',
-                fileChooser: chooser,
-            }, this);
-        });
-        page.on('dialog', dialog => this.context.dialogShown(this, dialog));
-        page.on('download', download => {
-            void this.context.downloadStarted(this, download);
-        });
-        page.setDefaultNavigationTimeout(60000);
-        page.setDefaultTimeout(5000);
-    }
-    _clearCollectedArtifacts() {
-        this._consoleMessages.length = 0;
-        this._requests.clear();
-    }
-    _onClose() {
-        this._clearCollectedArtifacts();
-        this._onPageClose(this);
-    }
-    async title() {
-        return await callOnPageNoTrace(this.page, page => page.title());
-    }
-    async waitForLoadState(state, options) {
-        await callOnPageNoTrace(this.page, page => page.waitForLoadState(state, options).catch(() => { }));
-    }
-    async navigate(url) {
-        this._clearCollectedArtifacts();
-        const downloadEvent = callOnPageNoTrace(this.page, page => page.waitForEvent('download').catch(() => { }));
-        try {
-            await this.page.goto(url, { waitUntil: 'domcontentloaded' });
-        }
-        catch (_e) {
-            const e = _e;
-            const mightBeDownload = e.message.includes('net::ERR_ABORTED') // chromium
-                || e.message.includes('Download is starting'); // firefox + webkit
-            if (!mightBeDownload)
-                throw e;
-            // on chromium, the download event is fired *after* page.goto rejects, so we wait a lil bit
-            const download = await Promise.race([
-                downloadEvent,
-                new Promise(resolve => setTimeout(resolve, 1000)),
-            ]);
-            if (!download)
-                throw e;
-        }
-        // Cap load event to 5 seconds, the page is operational at this point.
-        await this.waitForLoadState('load', { timeout: 5000 });
-    }
-    hasSnapshot() {
-        return !!this._snapshot;
-    }
-    snapshotOrDie() {
-        if (!this._snapshot)
-            throw new Error('No snapshot available');
-        return this._snapshot;
-    }
-    consoleMessages() {
-        return this._consoleMessages;
-    }
-    requests() {
-        return this._requests;
-    }
-    async captureSnapshot() {
-        this._snapshot = await PageSnapshot.create(this.page);
-    }
-}

package/lib/tools/common.js

@@ -1,68 +0,0 @@
-/**
- * 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 { z } from 'zod';
-import { defineTool } from './tool.js';
-const close = defineTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_close',
-        title: 'Close browser',
-        description: 'Close the page',
-        inputSchema: z.object({}),
-        type: 'readOnly',
-    },
-    handle: async (context) => {
-        await context.close();
-        return {
-            code: [`await page.close()`],
-            captureSnapshot: false,
-            waitForNetwork: false,
-        };
-    },
-});
-const resize = captureSnapshot => defineTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_resize',
-        title: 'Resize browser window',
-        description: 'Resize the browser window',
-        inputSchema: z.object({
-            width: z.coerce.number().describe('Width of the browser window'),
-            height: z.coerce.number().describe('Height of the browser window'),
-        }),
-        type: 'readOnly',
-    },
-    handle: async (context, params) => {
-        const tab = context.currentTabOrDie();
-        const code = [
-            `// Resize browser window to ${params.width}x${params.height}`,
-            `await page.setViewportSize({ width: ${params.width}, height: ${params.height} });`
-        ];
-        const action = async () => {
-            await tab.page.setViewportSize({ width: params.width, height: params.height });
-        };
-        return {
-            code,
-            action,
-            captureSnapshot,
-            waitForNetwork: true
-        };
-    },
-});
-export default (captureSnapshot) => [
-    close,
-    resize(captureSnapshot)
-];

package/lib/tools/console.js

@@ -1,44 +0,0 @@
-/**
- * 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 { z } from 'zod';
-import { defineTool } from './tool.js';
-const console = defineTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_console_messages',
-        title: 'Get console messages',
-        description: 'Returns all console messages',
-        inputSchema: z.object({}),
-        type: 'readOnly',
-    },
-    handle: async (context) => {
-        const messages = context.currentTabOrDie().consoleMessages();
-        const log = messages.map(message => `[${message.type().toUpperCase()}] ${message.text()}`).join('\n');
-        return {
-            code: [`// <internal code to get console messages>`],
-            action: async () => {
-                return {
-                    content: [{ type: 'text', text: log }]
-                };
-            },
-            captureSnapshot: false,
-            waitForNetwork: false,
-        };
-    },
-});
-export default [
-    console,
-];

package/lib/tools/dialogs.js

@@ -1,52 +0,0 @@
-/**
- * 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 { z } from 'zod';
-import { defineTool } from './tool.js';
-const handleDialog = captureSnapshot => defineTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_handle_dialog',
-        title: 'Handle a dialog',
-        description: 'Handle a dialog',
-        inputSchema: z.object({
-            accept: z.coerce.boolean().describe('Whether to accept the dialog.'),
-            promptText: z.string().optional().describe('The text of the prompt in case of a prompt dialog.'),
-        }),
-        type: 'destructive',
-    },
-    handle: async (context, params) => {
-        const dialogState = context.modalStates().find(state => state.type === 'dialog');
-        if (!dialogState)
-            throw new Error('No dialog visible');
-        if (params.accept)
-            await dialogState.dialog.accept(params.promptText);
-        else
-            await dialogState.dialog.dismiss();
-        context.clearModalState(dialogState);
-        const code = [
-            `// <internal code to handle "${dialogState.dialog.type()}" dialog>`,
-        ];
-        return {
-            code,
-            captureSnapshot,
-            waitForNetwork: false,
-        };
-    },
-    clearsModalState: 'dialog',
-});
-export default (captureSnapshot) => [
-    handleDialog(captureSnapshot),
-];

package/lib/tools/files.js

@@ -1,51 +0,0 @@
-/**
- * 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 { z } from 'zod';
-import { defineTool } from './tool.js';
-const uploadFile = captureSnapshot => defineTool({
-    capability: 'files',
-    schema: {
-        name: 'browser_file_upload',
-        title: 'Upload files',
-        description: 'Upload one or multiple files',
-        inputSchema: z.object({
-            paths: z.array(z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
-        }),
-        type: 'destructive',
-    },
-    handle: async (context, params) => {
-        const modalState = context.modalStates().find(state => state.type === 'fileChooser');
-        if (!modalState)
-            throw new Error('No file chooser visible');
-        const code = [
-            `// <internal code to chose files ${params.paths.join(', ')}`,
-        ];
-        const action = async () => {
-            await modalState.fileChooser.setFiles(params.paths);
-            context.clearModalState(modalState);
-        };
-        return {
-            code,
-            action,
-            captureSnapshot,
-            waitForNetwork: true,
-        };
-    },
-    clearsModalState: 'fileChooser',
-});
-export default (captureSnapshot) => [
-    uploadFile(captureSnapshot),
-];

package/lib/tools/install.js

@@ -1,57 +0,0 @@
-/**
- * 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 { fork } from 'child_process';
-import path from 'path';
-import { z } from 'zod';
-import { defineTool } from './tool.js';
-import { fileURLToPath } from 'node:url';
-const install = defineTool({
-    capability: 'install',
-    schema: {
-        name: 'browser_install',
-        title: 'Install the browser specified in the config',
-        description: 'Install the browser specified in the config. Call this if you get an error about the browser not being installed.',
-        inputSchema: z.object({}),
-        type: 'destructive',
-    },
-    handle: async (context) => {
-        const channel = context.config.browser?.launchOptions?.channel ?? context.config.browser?.browserName ?? 'chrome';
-        const cliUrl = import.meta.resolve('@szymonrybczak/patchright/package.json');
-        const cliPath = path.join(fileURLToPath(cliUrl), '..', 'cli.js');
-        const child = fork(cliPath, ['install', channel], {
-            stdio: 'pipe',
-        });
-        const output = [];
-        child.stdout?.on('data', data => output.push(data.toString()));
-        child.stderr?.on('data', data => output.push(data.toString()));
-        await new Promise((resolve, reject) => {
-            child.on('close', code => {
-                if (code === 0)
-                    resolve();
-                else
-                    reject(new Error(`Failed to install browser: ${output.join('')}`));
-            });
-        });
-        return {
-            code: [`// Browser ${channel} installed`],
-            captureSnapshot: false,
-            waitForNetwork: false,
-        };
-    },
-});
-export default [
-    install,
-];