@playwright/mcp 0.0.14 → 0.0.16

package/lib/tab.js

@@ -0,0 +1,81 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tab = void 0;
+const pageSnapshot_1 = require("./pageSnapshot");
+class Tab {
+    context;
+    page;
+    _console = [];
+    _requests = new Map();
+    _snapshot;
+    _onPageClose;
+    constructor(context, page, onPageClose) {
+        this.context = context;
+        this.page = page;
+        this._onPageClose = onPageClose;
+        page.on('console', event => this._console.push(event));
+        page.on('request', request => this._requests.set(request, null));
+        page.on('response', response => this._requests.set(response.request(), response));
+        page.on('framenavigated', frame => {
+            if (!frame.parentFrame())
+                this._clearCollectedArtifacts();
+        });
+        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.setDefaultNavigationTimeout(60000);
+        page.setDefaultTimeout(5000);
+    }
+    _clearCollectedArtifacts() {
+        this._console.length = 0;
+        this._requests.clear();
+    }
+    _onClose() {
+        this._clearCollectedArtifacts();
+        this._onPageClose(this);
+    }
+    async navigate(url) {
+        await this.page.goto(url, { waitUntil: 'domcontentloaded' });
+        // Cap load event to 5 seconds, the page is operational at this point.
+        await this.page.waitForLoadState('load', { timeout: 5000 }).catch(() => { });
+    }
+    hasSnapshot() {
+        return !!this._snapshot;
+    }
+    snapshotOrDie() {
+        if (!this._snapshot)
+            throw new Error('No snapshot available');
+        return this._snapshot;
+    }
+    console() {
+        return this._console;
+    }
+    requests() {
+        return this._requests;
+    }
+    async captureSnapshot() {
+        this._snapshot = await pageSnapshot_1.PageSnapshot.create(this.page);
+    }
+}
+exports.Tab = Tab;

package/lib/tools/common.js

@@ -16,34 +16,31 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const waitSchema = zod_1.z.object({
-    time: zod_1.z.number().describe('The time to wait in seconds'),
-});
-const wait = captureSnapshot => ({
+const tool_1 = require("./tool");
+const wait = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'wait',
     schema: {
         name: 'browser_wait',
         description: 'Wait for a specified time in seconds',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(waitSchema),
+        inputSchema: zod_1.z.object({
+            time: zod_1.z.number().describe('The time to wait in seconds'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = waitSchema.parse(params);
-        await new Promise(f => setTimeout(f, Math.min(10000, validatedParams.time * 1000)));
+        await new Promise(f => setTimeout(f, Math.min(10000, params.time * 1000)));
         return {
-            code: [`// Waited for ${validatedParams.time} seconds`],
+            code: [`// Waited for ${params.time} seconds`],
             captureSnapshot,
             waitForNetwork: false,
         };
     },
 });
-const closeSchema = zod_1.z.object({});
-const close = {
+const close = (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_close',
         description: 'Close the page',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(closeSchema),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
         await context.close();
@@ -53,27 +50,25 @@ const close = {
             waitForNetwork: false,
         };
     },
-};
-const resizeSchema = zod_1.z.object({
-    width: zod_1.z.number().describe('Width of the browser window'),
-    height: zod_1.z.number().describe('Height of the browser window'),
 });
-const resize = captureSnapshot => ({
+const resize = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_resize',
         description: 'Resize the browser window',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(resizeSchema),
+        inputSchema: zod_1.z.object({
+            width: zod_1.z.number().describe('Width of the browser window'),
+            height: zod_1.z.number().describe('Height of the browser window'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = resizeSchema.parse(params);
         const tab = context.currentTabOrDie();
         const code = [
-            `// Resize browser window to ${validatedParams.width}x${validatedParams.height}`,
-            `await page.setViewportSize({ width: ${validatedParams.width}, height: ${validatedParams.height} });`
+            `// 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: validatedParams.width, height: validatedParams.height });
+            await tab.page.setViewportSize({ width: params.width, height: params.height });
         };
         return {
             code,

package/lib/tools/console.js

@@ -16,17 +16,16 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const consoleSchema = zod_1.z.object({});
-const console = {
+const tool_1 = require("./tool");
+const console = (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_console_messages',
         description: 'Returns all console messages',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(consoleSchema),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
-        const messages = await context.currentTabOrDie().console();
+        const messages = context.currentTabOrDie().console();
         const log = messages.map(message => `[${message.type().toUpperCase()}] ${message.text()}`).join('\n');
         return {
             code: [`// <internal code to get console messages>`],
@@ -39,7 +38,7 @@ const console = {
             waitForNetwork: false,
         };
     },
-};
+});
 exports.default = [
     console,
 ];

package/lib/tools/dialogs.js

@@ -16,25 +16,23 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const handleDialogSchema = zod_1.z.object({
-    accept: zod_1.z.boolean().describe('Whether to accept the dialog.'),
-    promptText: zod_1.z.string().optional().describe('The text of the prompt in case of a prompt dialog.'),
-});
-const handleDialog = captureSnapshot => ({
+const tool_1 = require("./tool");
+const handleDialog = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_handle_dialog',
         description: 'Handle a dialog',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(handleDialogSchema),
+        inputSchema: zod_1.z.object({
+            accept: zod_1.z.boolean().describe('Whether to accept the dialog.'),
+            promptText: zod_1.z.string().optional().describe('The text of the prompt in case of a prompt dialog.'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = handleDialogSchema.parse(params);
         const dialogState = context.modalStates().find(state => state.type === 'dialog');
         if (!dialogState)
             throw new Error('No dialog visible');
-        if (validatedParams.accept)
-            await dialogState.dialog.accept(validatedParams.promptText);
+        if (params.accept)
+            await dialogState.dialog.accept(params.promptText);
         else
             await dialogState.dialog.dismiss();
         context.clearModalState(dialogState);

package/lib/tools/files.js

@@ -16,27 +16,25 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const uploadFileSchema = zod_1.z.object({
-    paths: zod_1.z.array(zod_1.z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
-});
-const uploadFile = captureSnapshot => ({
+const tool_1 = require("./tool");
+const uploadFile = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'files',
     schema: {
         name: 'browser_file_upload',
         description: 'Upload one or multiple files',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(uploadFileSchema),
+        inputSchema: zod_1.z.object({
+            paths: zod_1.z.array(zod_1.z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = uploadFileSchema.parse(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 ${validatedParams.paths.join(', ')}`,
+            `// <internal code to chose files ${params.paths.join(', ')}`,
         ];
         const action = async () => {
-            await modalState.fileChooser.setFiles(validatedParams.paths);
+            await modalState.fileChooser.setFiles(params.paths);
             context.clearModalState(modalState);
         };
         return {

package/lib/tools/install.js

@@ -21,16 +21,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const path_1 = __importDefault(require("path"));
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const install = {
+const tool_1 = require("./tool");
+const install = (0, tool_1.defineTool)({
     capability: 'install',
     schema: {
         name: 'browser_install',
         description: 'Install the browser specified in the config. Call this if you get an error about the browser not being installed.',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(zod_1.z.object({})),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
-        const channel = context.options.launchOptions?.channel ?? context.options.browserName ?? 'chrome';
+        const channel = context.config.browser?.launchOptions?.channel ?? context.config.browser?.launchOptions.browserName ?? 'chrome';
         const cli = path_1.default.join(require.resolve('playwright/package.json'), '..', 'cli.js');
         const child = (0, child_process_1.fork)(cli, ['install', channel], {
             stdio: 'pipe',
@@ -52,7 +52,7 @@ const install = {
             waitForNetwork: false,
         };
     },
-};
+});
 exports.default = [
     install,
 ];

package/lib/tools/keyboard.js

@@ -14,30 +14,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = __importDefault(require("zod-to-json-schema"));
-const pressKeySchema = zod_1.z.object({
-    key: zod_1.z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
-});
-const pressKey = captureSnapshot => ({
+const tool_1 = require("./tool");
+const pressKey = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_press_key',
         description: 'Press a key on the keyboard',
-        inputSchema: (0, zod_to_json_schema_1.default)(pressKeySchema),
+        inputSchema: zod_1.z.object({
+            key: zod_1.z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = pressKeySchema.parse(params);
         const tab = context.currentTabOrDie();
         const code = [
-            `// Press ${validatedParams.key}`,
-            `await page.keyboard.press('${validatedParams.key}');`,
+            `// Press ${params.key}`,
+            `await page.keyboard.press('${params.key}');`,
         ];
-        const action = () => tab.page.keyboard.press(validatedParams.key);
+        const action = () => tab.page.keyboard.press(params.key);
         return {
             code,
             action,

package/lib/tools/navigate.js

@@ -16,24 +16,22 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const navigateSchema = zod_1.z.object({
-    url: zod_1.z.string().describe('The URL to navigate to'),
-});
-const navigate = captureSnapshot => ({
+const tool_1 = require("./tool");
+const navigate = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_navigate',
         description: 'Navigate to a URL',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(navigateSchema),
+        inputSchema: zod_1.z.object({
+            url: zod_1.z.string().describe('The URL to navigate to'),
+        }),
     },
     handle: async (context, params) => {
-        const validatedParams = navigateSchema.parse(params);
         const tab = await context.ensureTab();
-        await tab.navigate(validatedParams.url);
+        await tab.navigate(params.url);
         const code = [
-            `// Navigate to ${validatedParams.url}`,
-            `await page.goto('${validatedParams.url}');`,
+            `// Navigate to ${params.url}`,
+            `await page.goto('${params.url}');`,
         ];
         return {
             code,
@@ -42,13 +40,12 @@ const navigate = captureSnapshot => ({
         };
     },
 });
-const goBackSchema = zod_1.z.object({});
-const goBack = captureSnapshot => ({
+const goBack = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'history',
     schema: {
         name: 'browser_navigate_back',
         description: 'Go back to the previous page',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goBackSchema),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
         const tab = await context.ensureTab();
@@ -64,13 +61,12 @@ const goBack = captureSnapshot => ({
         };
     },
 });
-const goForwardSchema = zod_1.z.object({});
-const goForward = captureSnapshot => ({
+const goForward = captureSnapshot => (0, tool_1.defineTool)({
     capability: 'history',
     schema: {
         name: 'browser_navigate_forward',
         description: 'Go forward to the next page',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goForwardSchema),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
         const tab = context.currentTabOrDie();

package/lib/tools/network.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+const tool_1 = require("./tool");
+const requests = (0, tool_1.defineTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_network_requests',
+        description: 'Returns all network requests since loading the page',
+        inputSchema: zod_1.z.object({}),
+    },
+    handle: async (context) => {
+        const requests = context.currentTabOrDie().requests();
+        const log = [...requests.entries()].map(([request, response]) => renderRequest(request, response)).join('\n');
+        return {
+            code: [`// <internal code to list network requests>`],
+            action: async () => {
+                return {
+                    content: [{ type: 'text', text: log }]
+                };
+            },
+            captureSnapshot: false,
+            waitForNetwork: false,
+        };
+    },
+});
+function renderRequest(request, response) {
+    const result = [];
+    result.push(`[${request.method().toUpperCase()}] ${request.url()}`);
+    if (response)
+        result.push(`=> [${response.status()}] ${response.statusText()}`);
+    return result.join(' ');
+}
+exports.default = [
+    requests,
+];

package/lib/tools/pdf.js

@@ -47,27 +47,21 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
 const zod_1 = require("zod");
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const utils_1 = require("./utils");
+const tool_1 = require("./tool");
 const javascript = __importStar(require("../javascript"));
-const pdfSchema = zod_1.z.object({});
-const pdf = {
+const config_1 = require("../config");
+const pdf = (0, tool_1.defineTool)({
     capability: 'pdf',
     schema: {
         name: 'browser_pdf_save',
         description: 'Save page as PDF',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(pdfSchema),
+        inputSchema: zod_1.z.object({}),
     },
     handle: async (context) => {
         const tab = context.currentTabOrDie();
-        const fileName = path_1.default.join(os_1.default.tmpdir(), (0, utils_1.sanitizeForFilePath)(`page-${new Date().toISOString()}`)) + '.pdf';
+        const fileName = await (0, config_1.outputFile)(context.config, `page-${new Date().toISOString()}'.pdf'`);
         const code = [
             `// Save page as ${fileName}`,
             `await page.pdf(${javascript.formatObject({ path: fileName })});`,
@@ -79,7 +73,7 @@ const pdf = {
             waitForNetwork: false,
         };
     },
-};
+});
 exports.default = [
     pdf,
 ];