@playwright/mcp 0.0.36-alpha-2025-09-02 → 0.0.36-alpha-2025-09-04

package/lib/extension/cdpRelay.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,6 +14,44 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CDPRelayServer = void 0;
 /**
  * WebSocket server that bridges Playwright MCP and Chrome Extension
  *
@@ -20,31 +59,22 @@
  * - /cdp/guid - Full CDP interface for Playwright MCP
  * - /extension/guid - Extension connection for chrome.debugger forwarding
  */
-import { spawn } from 'child_process';
-import debug from 'debug';
-import { WebSocket, WebSocketServer } from 'ws';
-import { httpAddressToString } from '../mcp/http.js';
-import { logUnhandledError } from '../utils/log.js';
-import { ManualPromise } from '../mcp/manualPromise.js';
-import * as protocol from './protocol.js';
+const child_process_1 = require("child_process");
+const debug_1 = __importDefault(require("debug"));
+const ws_1 = require("ws");
 // @ts-ignore
-const { registry } = await import('playwright-core/lib/server/registry/index');
-const debugLogger = debug('pw:mcp:relay');
-export class CDPRelayServer {
-    _wsHost;
-    _browserChannel;
-    _userDataDir;
-    _executablePath;
-    _cdpPath;
-    _extensionPath;
-    _wss;
-    _playwrightConnection = null;
-    _extensionConnection = null;
-    _connectedTabInfo;
-    _nextSessionId = 1;
-    _extensionConnectionPromise;
+const index_1 = require("playwright-core/lib/server/registry/index");
+const http_1 = require("../sdk/http");
+const log_1 = require("../log");
+const manualPromise_1 = require("../sdk/manualPromise");
+const protocol = __importStar(require("./protocol"));
+const debugLogger = (0, debug_1.default)('pw:mcp:relay');
+class CDPRelayServer {
     constructor(server, browserChannel, userDataDir, executablePath) {
-        this._wsHost = httpAddressToString(server.address()).replace(/^http/, 'ws');
+        this._playwrightConnection = null;
+        this._extensionConnection = null;
+        this._nextSessionId = 1;
+        this._wsHost = (0, http_1.httpAddressToString)(server.address()).replace(/^http/, 'ws');
         this._browserChannel = browserChannel;
         this._userDataDir = userDataDir;
         this._executablePath = executablePath;
@@ -52,7 +82,7 @@ export class CDPRelayServer {
         this._cdpPath = `/cdp/${uuid}`;
         this._extensionPath = `/extension/${uuid}`;
         this._resetExtensionConnection();
-        this._wss = new WebSocketServer({ server });
+        this._wss = new ws_1.WebSocketServer({ server });
         this._wss.on('connection', this._onConnection.bind(this));
     }
     cdpEndpoint() {
@@ -71,12 +101,13 @@ export class CDPRelayServer {
             this._extensionConnectionPromise,
             new Promise((_, reject) => setTimeout(() => {
                 reject(new Error(`Extension connection timeout. Make sure the "Playwright MCP Bridge" extension is installed. See https://github.com/microsoft/playwright-mcp/blob/main/extension/README.md for installation instructions.`));
-            }, process.env.PWMCP_TEST_CONNECTION_TIMEOUT ? parseInt(process.env.PWMCP_TEST_CONNECTION_TIMEOUT, 10) : 5_000)),
+            }, process.env.PWMCP_TEST_CONNECTION_TIMEOUT ? parseInt(process.env.PWMCP_TEST_CONNECTION_TIMEOUT, 10) : 5000)),
             new Promise((_, reject) => abortSignal.addEventListener('abort', reject))
         ]);
         debugLogger('Extension connection established');
     }
     _connectBrowser(clientInfo, toolName) {
+        var _a;
         const mcpRelayEndpoint = `${this._wsHost}${this._extensionPath}`;
         // Need to specify "key" in the manifest.json to make the id stable when loading from file.
         const url = new URL('chrome-extension://jakfalbnbhgkpmoaakfflhflbfpkailf/connect.html');
@@ -86,13 +117,13 @@ export class CDPRelayServer {
             version: clientInfo.version,
         };
         url.searchParams.set('client', JSON.stringify(client));
-        url.searchParams.set('protocolVersion', process.env.PWMCP_TEST_PROTOCOL_VERSION ?? protocol.VERSION.toString());
+        url.searchParams.set('protocolVersion', (_a = process.env.PWMCP_TEST_PROTOCOL_VERSION) !== null && _a !== void 0 ? _a : protocol.VERSION.toString());
         if (toolName)
             url.searchParams.set('newTab', String(toolName === 'browser_navigate'));
         const href = url.toString();
         let executablePath = this._executablePath;
         if (!executablePath) {
-            const executableInfo = registry.findExecutable(this._browserChannel);
+            const executableInfo = index_1.registry.findExecutable(this._browserChannel);
             if (!executableInfo)
                 throw new Error(`Unsupported channel: "${this._browserChannel}"`);
             executablePath = executableInfo.executablePath();
@@ -103,7 +134,7 @@ export class CDPRelayServer {
         if (this._userDataDir)
             args.push(`--user-data-dir=${this._userDataDir}`);
         args.push(href);
-        spawn(executablePath, args, {
+        (0, child_process_1.spawn)(executablePath, args, {
             windowsHide: true,
             detached: true,
             shell: false,
@@ -161,18 +192,20 @@ export class CDPRelayServer {
         debugLogger('Playwright MCP connected');
     }
     _closeExtensionConnection(reason) {
-        this._extensionConnection?.close(reason);
+        var _a;
+        (_a = this._extensionConnection) === null || _a === void 0 ? void 0 : _a.close(reason);
         this._extensionConnectionPromise.reject(new Error(reason));
         this._resetExtensionConnection();
     }
     _resetExtensionConnection() {
         this._connectedTabInfo = undefined;
         this._extensionConnection = null;
-        this._extensionConnectionPromise = new ManualPromise();
-        void this._extensionConnectionPromise.catch(logUnhandledError);
+        this._extensionConnectionPromise = new manualPromise_1.ManualPromise();
+        void this._extensionConnectionPromise.catch(log_1.logUnhandledError);
     }
     _closePlaywrightConnection(reason) {
-        if (this._playwrightConnection?.readyState === WebSocket.OPEN)
+        var _a;
+        if (((_a = this._playwrightConnection) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.WebSocket.OPEN)
             this._playwrightConnection.close(1000, reason);
         this._playwrightConnection = null;
     }
@@ -193,9 +226,10 @@ export class CDPRelayServer {
         this._extensionConnectionPromise.resolve();
     }
     _handleExtensionMessage(method, params) {
+        var _a;
         switch (method) {
             case 'forwardCDPEvent':
-                const sessionId = params.sessionId || this._connectedTabInfo?.sessionId;
+                const sessionId = params.sessionId || ((_a = this._connectedTabInfo) === null || _a === void 0 ? void 0 : _a.sessionId);
                 this._sendToPlaywright({
                     sessionId,
                     method: params.method,
@@ -221,6 +255,7 @@ export class CDPRelayServer {
         }
     }
     async _handleCDPCommand(method, params, sessionId) {
+        var _a;
         switch (method) {
             case 'Browser.getVersion': {
                 return {
@@ -257,38 +292,38 @@ export class CDPRelayServer {
                 return {};
             }
             case 'Target.getTargetInfo': {
-                return this._connectedTabInfo?.targetInfo;
+                return (_a = this._connectedTabInfo) === null || _a === void 0 ? void 0 : _a.targetInfo;
             }
         }
         return await this._forwardToExtension(method, params, sessionId);
     }
     async _forwardToExtension(method, params, sessionId) {
+        var _a;
         if (!this._extensionConnection)
             throw new Error('Extension not connected');
         // Top level sessionId is only passed between the relay and the client.
-        if (this._connectedTabInfo?.sessionId === sessionId)
+        if (((_a = this._connectedTabInfo) === null || _a === void 0 ? void 0 : _a.sessionId) === sessionId)
             sessionId = undefined;
         return await this._extensionConnection.send('forwardCDPCommand', { sessionId, method, params });
     }
     _sendToPlaywright(message) {
-        debugLogger('→ Playwright:', `${message.method ?? `response(id=${message.id})`}`);
-        this._playwrightConnection?.send(JSON.stringify(message));
+        var _a, _b;
+        debugLogger('→ Playwright:', `${(_a = message.method) !== null && _a !== void 0 ? _a : `response(id=${message.id})`}`);
+        (_b = this._playwrightConnection) === null || _b === void 0 ? void 0 : _b.send(JSON.stringify(message));
     }
 }
+exports.CDPRelayServer = CDPRelayServer;
 class ExtensionConnection {
-    _ws;
-    _callbacks = new Map();
-    _lastId = 0;
-    onmessage;
-    onclose;
     constructor(ws) {
+        this._callbacks = new Map();
+        this._lastId = 0;
         this._ws = ws;
         this._ws.on('message', this._onMessage.bind(this));
         this._ws.on('close', this._onClose.bind(this));
         this._ws.on('error', this._onError.bind(this));
     }
     async send(method, params) {
-        if (this._ws.readyState !== WebSocket.OPEN)
+        if (this._ws.readyState !== ws_1.WebSocket.OPEN)
             throw new Error(`Unexpected WebSocket state: ${this._ws.readyState}`);
         const id = ++this._lastId;
         this._ws.send(JSON.stringify({ id, method, params }));
@@ -299,7 +334,7 @@ class ExtensionConnection {
     }
     close(message) {
         debugLogger('closing extension connection:', message);
-        if (this._ws.readyState === WebSocket.OPEN)
+        if (this._ws.readyState === ws_1.WebSocket.OPEN)
             this._ws.close(1000, message);
     }
     _onMessage(event) {
@@ -309,7 +344,7 @@ class ExtensionConnection {
             parsedJson = JSON.parse(eventData);
         }
         catch (e) {
-            debugLogger(`<closing ws> Closing websocket due to malformed JSON. eventData=${eventData} e=${e?.message}`);
+            debugLogger(`<closing ws> Closing websocket due to malformed JSON. eventData=${eventData} e=${e === null || e === void 0 ? void 0 : e.message}`);
             this._ws.close();
             return;
         }
@@ -317,11 +352,12 @@ class ExtensionConnection {
             this._handleParsedMessage(parsedJson);
         }
         catch (e) {
-            debugLogger(`<closing ws> Closing websocket due to failed onmessage callback. eventData=${eventData} e=${e?.message}`);
+            debugLogger(`<closing ws> Closing websocket due to failed onmessage callback. eventData=${eventData} e=${e === null || e === void 0 ? void 0 : e.message}`);
             this._ws.close();
         }
     }
     _handleParsedMessage(object) {
+        var _a;
         if (object.id && this._callbacks.has(object.id)) {
             const callback = this._callbacks.get(object.id);
             this._callbacks.delete(object.id);
@@ -338,13 +374,14 @@ class ExtensionConnection {
             debugLogger('← Extension: unexpected response', object);
         }
         else {
-            this.onmessage?.(object.method, object.params);
+            (_a = this.onmessage) === null || _a === void 0 ? void 0 : _a.call(this, object.method, object.params);
         }
     }
     _onClose(event) {
+        var _a;
         debugLogger(`<ws closed> code=${event.code} reason=${event.reason}`);
         this._dispose();
-        this.onclose?.(this, event.reason);
+        (_a = this.onclose) === null || _a === void 0 ? void 0 : _a.call(this, this, event.reason);
     }
     _onError(event) {
         debugLogger(`<ws error> message=${event.message} type=${event.type} target=${event.target}`);

package/lib/extension/extensionContextFactory.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,15 +14,50 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import debug from 'debug';
-import * as playwright from 'playwright';
-import { startHttpServer } from '../mcp/http.js';
-import { CDPRelayServer } from './cdpRelay.js';
-const debugLogger = debug('pw:mcp:relay');
-export class ExtensionContextFactory {
-    _browserChannel;
-    _userDataDir;
-    _executablePath;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionContextFactory = void 0;
+const debug_1 = __importDefault(require("debug"));
+const playwright = __importStar(require("playwright"));
+const http_1 = require("../sdk/http");
+const cdpRelay_1 = require("./cdpRelay");
+const debugLogger = (0, debug_1.default)('pw:mcp:relay');
+class ExtensionContextFactory {
     constructor(browserChannel, userDataDir, executablePath) {
         this._browserChannel = browserChannel;
         this._userDataDir = userDataDir;
@@ -43,14 +79,15 @@ export class ExtensionContextFactory {
         return await playwright.chromium.connectOverCDP(relay.cdpEndpoint());
     }
     async _startRelay(abortSignal) {
-        const httpServer = await startHttpServer({});
+        const httpServer = await (0, http_1.startHttpServer)({});
         if (abortSignal.aborted) {
             httpServer.close();
             throw new Error(abortSignal.reason);
         }
-        const cdpRelayServer = new CDPRelayServer(httpServer, this._browserChannel, this._userDataDir, this._executablePath);
+        const cdpRelayServer = new cdpRelay_1.CDPRelayServer(httpServer, this._browserChannel, this._userDataDir, this._executablePath);
         abortSignal.addEventListener('abort', () => cdpRelayServer.stop());
         debugLogger(`CDP relay server started, extension endpoint: ${cdpRelayServer.extensionEndpoint()}.`);
         return cdpRelayServer;
     }
 }
+exports.ExtensionContextFactory = ExtensionContextFactory;

package/lib/extension/protocol.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,6 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
 // Whenever the commands/events change, the version must be updated. The latest
 // extension version should be compatible with the old MCP clients.
-export const VERSION = 1;
+exports.VERSION = 1;

package/lib/index.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,21 +14,55 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { BrowserServerBackend } from './browserServerBackend.js';
-import { resolveConfig } from './config.js';
-import { contextFactory } from './browserContextFactory.js';
-import * as mcpServer from './mcp/server.js';
-import { packageJSON } from './utils/package.js';
-export async function createConnection(userConfig = {}, contextGetter) {
-    const config = await resolveConfig(userConfig);
-    const factory = contextGetter ? new SimpleBrowserContextFactory(contextGetter) : contextFactory(config);
-    return mcpServer.createServer('Playwright', packageJSON.version, new BrowserServerBackend(config, factory), false);
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConnection = createConnection;
+const browserServerBackend_1 = require("./browser/browserServerBackend");
+const config_1 = require("./browser/config");
+const browserContextFactory_1 = require("./browser/browserContextFactory");
+const mcpServer = __importStar(require("./sdk/server"));
+const package_1 = require("./package");
+async function createConnection(userConfig = {}, contextGetter) {
+    const config = await (0, config_1.resolveConfig)(userConfig);
+    const factory = contextGetter ? new SimpleBrowserContextFactory(contextGetter) : (0, browserContextFactory_1.contextFactory)(config);
+    return mcpServer.createServer('Playwright', package_1.packageJSON.version, new browserServerBackend_1.BrowserServerBackend(config, factory), false);
 }
 class SimpleBrowserContextFactory {
-    name = 'custom';
-    description = 'Connect to a browser using a custom context getter';
-    _contextGetter;
     constructor(contextGetter) {
+        this.name = 'custom';
+        this.description = 'Connect to a browser using a custom context getter';
         this._contextGetter = contextGetter;
     }
     async createContext() {

package/lib/{utils/log.js → log.js}

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,9 +14,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import debug from 'debug';
-const errorsDebug = debug('pw:mcp:errors');
-export function logUnhandledError(error) {
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testDebug = void 0;
+exports.logUnhandledError = logUnhandledError;
+const debug_1 = __importDefault(require("debug"));
+const errorsDebug = (0, debug_1.default)('pw:mcp:errors');
+function logUnhandledError(error) {
     errorsDebug(error);
 }
-export const testDebug = debug('pw:mcp:test');
+exports.testDebug = (0, debug_1.default)('pw:mcp:test');

package/lib/{utils/package.js → package.js}

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,8 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import fs from 'fs';
-import path from 'path';
-import url from 'url';
-const __filename = url.fileURLToPath(import.meta.url);
-export const packageJSON = JSON.parse(fs.readFileSync(path.join(path.dirname(__filename), '..', '..', 'package.json'), 'utf8'));
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageJSON = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+exports.packageJSON = JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '..', 'package.json'), 'utf8'));