@pedropaulovc/playwright 1.59.0-next → 1.59.0-next.3

package/lib/common/config.js

@@ -95,8 +95,7 @@ class FullConfigInternal {
         threshold: 3e5
         /* 5 minutes */
       }),
-      // @ts-expect-error runAgents is hidden
-      runAgents: takeFirst(configCLIOverrides.runAgents, "none"),
+      runAgents: takeFirst(configCLIOverrides.runAgents, userConfig.runAgents, "none"),
       shard: takeFirst(configCLIOverrides.shard, userConfig.shard, null),
       tags: globalTags,
       updateSnapshots: takeFirst(configCLIOverrides.updateSnapshots, userConfig.updateSnapshots, "missing"),
@@ -162,7 +161,7 @@ class FullProjectInternal {
       testDir,
       snapshotDir: takeFirst(pathResolve(configDir, projectConfig.snapshotDir), pathResolve(configDir, config.snapshotDir), testDir),
       testIgnore: takeFirst(projectConfig.testIgnore, config.testIgnore, []),
-      testMatch: takeFirst(projectConfig.testMatch, config.testMatch, "**/*.@(spec|test).?(c|m)[jt]s?(x)"),
+      testMatch: takeFirst(projectConfig.testMatch, config.testMatch, "**/*.@(spec|test).{md,?(c|m)[jt]s?(x)}"),
       timeout: takeFirst(configCLIOverrides.debug ? 0 : void 0, configCLIOverrides.timeout, projectConfig.timeout, config.timeout, defaultTimeout),
       use: (0, import_util.mergeObjects)(config.use, projectConfig.use, configCLIOverrides.use),
       dependencies: projectConfig.dependencies || [],

package/lib/index.js

@@ -138,7 +138,7 @@ const playwrightFixtures = {
   }, { option: true, box: true }],
   serviceWorkers: [({ contextOptions }, use) => use(contextOptions.serviceWorkers ?? "allow"), { option: true, box: true }],
   contextOptions: [{}, { option: true, box: true }],
-  agentOptions: [void 0, { option: true, box: true }],
+  agentOptions: [({}, use) => use(void 0), { option: true, box: true }],
   _combinedContextOptions: [async ({
     acceptDownloads,
     bypassCSP,

package/lib/isomorphic/teleReceiver.js

@@ -459,7 +459,6 @@ const baseFullConfig = {
   tags: [],
   updateSnapshots: "missing",
   updateSourceMethod: "patch",
-  // @ts-expect-error runAgents is hidden
   runAgents: "none",
   version: "",
   workers: 0,

package/lib/mcp/browser/response.js

@@ -60,20 +60,19 @@ class Response {
     return new Response(++Response._ordinal, context, toolName, toolArgs);
   }
   addTextResult(result) {
-    this._results.push({ text: result });
+    this._results.push({ title: "", data: result });
   }
-  async addResult(result) {
-    if (result.data && !result.suggestedFilename)
-      result.suggestedFilename = (0, import_utils.dateAsFileName)(result.ext ?? "bin");
-    if (this._context.config.outputMode === "file") {
-      if (!result.suggestedFilename)
-        result.suggestedFilename = (0, import_utils.dateAsFileName)(result.ext ?? (result.text ? "txt" : "bin"));
+  async addResult(title, data, file) {
+    let filename;
+    if (!file.suggestedFilename) {
+      if (typeof data !== "string")
+        filename = (0, import_utils.dateAsFileName)(file.prefix, file.ext);
+      if (this._context.config.outputMode === "file")
+        filename = (0, import_utils.dateAsFileName)(file.prefix, file.ext);
+    } else {
+      filename = await this._context.outputFile(file.suggestedFilename, { origin: "llm", title });
     }
-    const entry = { text: result.text, data: result.data, title: result.title };
-    if (result.suggestedFilename)
-      entry.filename = await this._context.outputFile(result.suggestedFilename, { origin: "llm", title: result.title ?? "Saved result" });
-    this._results.push(entry);
-    return { fileName: entry.filename };
+    this._results.push({ data, title, filename });
   }
   addError(error) {
     this._errors.push(error);
@@ -109,12 +108,12 @@ class Response {
       for (const result of this._results) {
         if (result.filename) {
           text.push(`- [${result.title}](${rootPath ? import_path.default.relative(rootPath, result.filename) : result.filename})`);
-          if (result.data)
+          if (typeof result.data === "string")
+            await import_fs.default.promises.writeFile(result.filename, this._redactText(result.data), "utf-8");
+          else
             await import_fs.default.promises.writeFile(result.filename, result.data);
-          else if (result.text)
-            await import_fs.default.promises.writeFile(result.filename, this._redactText(result.text));
-        } else if (result.text) {
-          text.push(result.text);
+        } else if (typeof result.data === "string" && result.data.trim()) {
+          text.push(result.data);
         }
       }
     }
@@ -134,16 +133,16 @@ class Response {
     }
     if (tabSnapshot?.modalStates.length) {
       const text = addSection("Modal state");
-      text.push(...(0, import_tab.renderModalStates)(tabSnapshot.modalStates));
+      text.push(...(0, import_tab.renderModalStates)(this._context.config, tabSnapshot.modalStates));
     }
     if (tabSnapshot && this._includeSnapshot === "full") {
       let fileName;
       if (this._includeSnapshotFileName)
         fileName = await this._context.outputFile(this._includeSnapshotFileName, { origin: "llm", title: "Saved snapshot" });
       else if (this._context.config.outputMode === "file")
-        fileName = await this._context.outputFile(`snapshot-${this._ordinal}.yml`, { origin: "code", title: "Saved snapshot" });
+        fileName = await this._context.outputFile((0, import_utils.dateAsFileName)("snapshot", "yml"), { origin: "code", title: "Saved snapshot" });
       if (fileName) {
-        await import_fs.default.promises.writeFile(fileName, tabSnapshot.ariaSnapshot);
+        await import_fs.default.promises.writeFile(fileName, tabSnapshot.ariaSnapshot, "utf-8");
         const text = addSection("Snapshot");
         text.push(`- File: ${rootPath ? import_path.default.relative(rootPath, fileName) : fileName}`);
       } else {
@@ -211,7 +210,7 @@ function renderTabMarkdown(tab) {
 }
 function renderTabsMarkdown(tabs) {
   if (!tabs.length)
-    return ['No open tabs. Use the "browser_navigate" tool to navigate to a page first.'];
+    return ["No open tabs. Navigate to a URL to create one."];
   const lines = [];
   for (let i = 0; i < tabs.length; i++) {
     const tab = tabs[i];

package/lib/mcp/browser/tab.js

@@ -57,7 +57,7 @@ class Tab extends import_events.EventEmitter {
         type: "fileChooser",
         description: "File chooser",
         fileChooser: chooser,
-        clearedBy: import_files.uploadFile.schema.name
+        clearedBy: { tool: import_files.uploadFile.schema.name, skill: "upload" }
       });
     });
     page.on("dialog", (dialog) => this._dialogShown(dialog));
@@ -112,7 +112,7 @@ class Tab extends import_events.EventEmitter {
       type: "dialog",
       description: `"${dialog.type()}" dialog with message "${dialog.message()}"`,
       dialog,
-      clearedBy: import_dialogs.handleDialog.schema.name
+      clearedBy: { tool: import_dialogs.handleDialog.schema.name, skill: "dialog-accept or dialog-dismiss" }
     });
   }
   async _downloadStarted(download) {
@@ -299,12 +299,12 @@ function pageErrorToConsoleMessage(errorOrValue) {
     toString: () => String(errorOrValue)
   };
 }
-function renderModalStates(modalStates) {
+function renderModalStates(config, modalStates) {
   const result = [];
   if (modalStates.length === 0)
     result.push("- There is no modal state present");
   for (const state of modalStates)
-    result.push(`- [${state.description}]: can be handled by the "${state.clearedBy}" tool`);
+    result.push(`- [${state.description}]: can be handled by ${config.skillMode ? state.clearedBy.skill : state.clearedBy.tool}`);
   return result;
 }
 const consoleMessageLevels = ["error", "warning", "info", "debug"];

package/lib/mcp/browser/tools/common.js

@@ -54,9 +54,7 @@ const resize = (0, import_tool.defineTabTool)({
   },
   handle: async (tab, params, response) => {
     response.addCode(`await page.setViewportSize({ width: ${params.width}, height: ${params.height} });`);
-    await tab.waitForCompletion(async () => {
-      await tab.page.setViewportSize({ width: params.width, height: params.height });
-    });
+    await tab.page.setViewportSize({ width: params.width, height: params.height });
   }
 });
 var common_default = [

package/lib/mcp/browser/tools/console.js

@@ -38,7 +38,7 @@ const console = (0, import_tool.defineTabTool)({
   handle: async (tab, params, response) => {
     const messages = await tab.consoleMessages(params.level);
     const text = messages.map((message) => message.toString()).join("\n");
-    await response.addResult({ text, suggestedFilename: params.filename });
+    await response.addResult("Console", text, { prefix: "console", ext: "log", suggestedFilename: params.filename });
   }
 });
 const consoleClear = (0, import_tool.defineTabTool)({

package/lib/mcp/browser/tools/dialogs.js

@@ -37,7 +37,6 @@ const handleDialog = (0, import_tool.defineTabTool)({
     type: "action"
   },
   handle: async (tab, params, response) => {
-    response.setIncludeSnapshot();
     const dialogState = tab.modalStates().find((state) => state.type === "dialog");
     if (!dialogState)
       throw new Error("No dialog visible");

package/lib/mcp/browser/tools/evaluate.js

@@ -27,8 +27,7 @@ var import_tool = require("./tool");
 const evaluateSchema = import_mcpBundle.z.object({
   function: import_mcpBundle.z.string().describe("() => { /* code */ } or (element) => { /* code */ } when element is provided"),
   element: import_mcpBundle.z.string().optional().describe("Human-readable element description used to obtain permission to interact with the element"),
-  ref: import_mcpBundle.z.string().optional().describe("Exact target element reference from the page snapshot"),
-  filename: import_mcpBundle.z.string().optional().describe("Filename to save the result to. If not provided, result is returned as JSON string.")
+  ref: import_mcpBundle.z.string().optional().describe("Exact target element reference from the page snapshot")
 });
 const evaluate = (0, import_tool.defineTabTool)({
   capability: "core",
@@ -40,10 +39,11 @@ const evaluate = (0, import_tool.defineTabTool)({
     type: "action"
   },
   handle: async (tab, params, response) => {
-    response.setIncludeSnapshot();
     let locator;
-    if (params.ref && params.element) {
-      locator = await tab.refLocator({ ref: params.ref, element: params.element });
+    if (!params.function.includes("=>"))
+      params.function = `() => (${params.function})`;
+    if (params.ref) {
+      locator = await tab.refLocator({ ref: params.ref, element: params.element || "element" });
       response.addCode(`await page.${locator.resolved}.evaluate(${(0, import_utils.escapeWithQuotes)(params.function)});`);
     } else {
       response.addCode(`await page.evaluate(${(0, import_utils.escapeWithQuotes)(params.function)});`);
@@ -52,7 +52,7 @@ const evaluate = (0, import_tool.defineTabTool)({
       const receiver = locator?.locator ?? tab.page;
       const result = await receiver._evaluateFunction(params.function);
       const text = JSON.stringify(result, null, 2) || "undefined";
-      await response.addResult({ text, suggestedFilename: params.filename });
+      response.addTextResult(text);
     });
   }
 });

package/lib/mcp/browser/tools/keyboard.js

@@ -38,7 +38,14 @@ const press = (0, import_tool.defineTabTool)({
   handle: async (tab, params, response) => {
     response.addCode(`// Press ${params.key}`);
     response.addCode(`await page.keyboard.press('${params.key}');`);
-    await tab.page.keyboard.press(params.key);
+    if (params.key === "Enter") {
+      response.setIncludeSnapshot();
+      await tab.waitForCompletion(async () => {
+        await tab.page.keyboard.press("Enter");
+      });
+    } else {
+      await tab.page.keyboard.press(params.key);
+    }
   }
 });
 const pressSequentially = (0, import_tool.defineTabTool)({

package/lib/mcp/browser/tools/network.js

@@ -43,7 +43,7 @@ const requests = (0, import_tool.defineTabTool)({
       if (rendered)
         text.push(rendered);
     }
-    await response.addResult({ text: text.join("\n"), suggestedFilename: params.filename });
+    await response.addResult("Network", text.join("\n"), { prefix: "network", ext: "log", suggestedFilename: params.filename });
   }
 });
 const networkClear = (0, import_tool.defineTabTool)({

package/lib/mcp/browser/tools/pdf.js

@@ -39,8 +39,8 @@ const pdf = (0, import_tool.defineTabTool)({
   },
   handle: async (tab, params, response) => {
     const data = await tab.page.pdf();
-    const suggestedFilename = params.filename ?? (0, import_utils2.dateAsFileName)("pdf");
-    await response.addResult({ data, title: "Page as pdf", suggestedFilename });
+    const suggestedFilename = params.filename ?? (0, import_utils2.dateAsFileName)("page", "pdf");
+    await response.addResult("Page as pdf", data, { prefix: "page", ext: "pdf", suggestedFilename });
     response.addCode(`await page.pdf(${(0, import_utils.formatObject)({ path: suggestedFilename })});`);
   }
 });

package/lib/mcp/browser/tools/runCode.js

@@ -36,8 +36,7 @@ var import_utils = require("playwright-core/lib/utils");
 var import_mcpBundle = require("playwright-core/lib/mcpBundle");
 var import_tool = require("./tool");
 const codeSchema = import_mcpBundle.z.object({
-  code: import_mcpBundle.z.string().describe(`A JavaScript function containing Playwright code to execute. It will be invoked with a single argument, page, which you can use for any page interaction. For example: \`async (page) => { await page.getByRole('button', { name: 'Submit' }).click(); return await page.title(); }\``),
-  filename: import_mcpBundle.z.string().optional().describe("Filename to save the result to. If not provided, result is returned as JSON string.")
+  code: import_mcpBundle.z.string().describe(`A JavaScript function containing Playwright code to execute. It will be invoked with a single argument, page, which you can use for any page interaction. For example: \`async (page) => { await page.getByRole('button', { name: 'Submit' }).click(); return await page.title(); }\``)
 });
 const runCode = (0, import_tool.defineTabTool)({
   capability: "core",
@@ -49,7 +48,6 @@ const runCode = (0, import_tool.defineTabTool)({
     type: "action"
   },
   handle: async (tab, params, response) => {
-    response.setIncludeSnapshot();
     response.addCode(`await (${params.code})(page);`);
     const __end__ = new import_utils.ManualPromise();
     const context = {
@@ -69,7 +67,7 @@ const runCode = (0, import_tool.defineTabTool)({
       await import_vm.default.runInContext(snippet, context);
       const result = await __end__;
       if (typeof result === "string")
-        await response.addResult({ text: result, suggestedFilename: params.filename });
+        response.addTextResult(result);
     });
   }
 });

package/lib/mcp/browser/tools/screenshot.js

@@ -45,8 +45,6 @@ const screenshot = (0, import_tool.defineTabTool)({
     type: "readOnly"
   },
   handle: async (tab, params, response) => {
-    if (!!params.element !== !!params.ref)
-      throw new Error("Both element and ref must be provided or neither.");
     if (params.fullPage && params.ref)
       throw new Error("fullPage cannot be used with element screenshots.");
     const fileType = params.type || "png";
@@ -56,17 +54,16 @@ const screenshot = (0, import_tool.defineTabTool)({
       scale: "css",
       ...params.fullPage !== void 0 && { fullPage: params.fullPage }
     };
-    const isElementScreenshot = params.element && params.ref;
-    const screenshotTarget = isElementScreenshot ? params.element : params.fullPage ? "full page" : "viewport";
+    const screenshotTarget = params.ref ? params.element || "element" : params.fullPage ? "full page" : "viewport";
     const ref = params.ref ? await tab.refLocator({ element: params.element || "", ref: params.ref }) : null;
     const data = ref ? await ref.locator.screenshot(options) : await tab.page.screenshot(options);
-    const fileName = params.filename || (0, import_utils3.dateAsFileName)(fileType);
-    response.addCode(`// Screenshot ${screenshotTarget} and save it as ${fileName}`);
+    const suggestedFilename = params.filename || (0, import_utils3.dateAsFileName)(ref ? "element" : "page", fileType);
+    response.addCode(`// Screenshot ${screenshotTarget} and save it as ${suggestedFilename}`);
     if (ref)
-      response.addCode(`await page.${ref.resolved}.screenshot(${(0, import_utils2.formatObject)({ ...options, path: fileName })});`);
+      response.addCode(`await page.${ref.resolved}.screenshot(${(0, import_utils2.formatObject)({ ...options, path: suggestedFilename })});`);
     else
-      response.addCode(`await page.screenshot(${(0, import_utils2.formatObject)({ ...options, path: fileName })});`);
-    await response.addResult({ data, title: `Screenshot of ${screenshotTarget}`, suggestedFilename: fileName });
+      response.addCode(`await page.screenshot(${(0, import_utils2.formatObject)({ ...options, path: suggestedFilename })});`);
+    await response.addResult(`Screenshot of ${screenshotTarget}`, data, { prefix: ref ? "element" : "page", ext: fileType, suggestedFilename });
     response.addImage({
       contentType: fileType === "png" ? "image/png" : "image/jpeg",
       data: scaleImageToFitMessage(data, fileType)

package/lib/mcp/browser/tools/snapshot.js

@@ -170,8 +170,9 @@ const check = (0, import_tool.defineTabTool)({
     type: "input"
   },
   handle: async (tab, params, response) => {
-    const { resolved } = await tab.refLocator(params);
+    const { locator, resolved } = await tab.refLocator(params);
     response.addCode(`await page.${resolved}.check();`);
+    await locator.check();
   }
 });
 const uncheck = (0, import_tool.defineTabTool)({
@@ -185,8 +186,9 @@ const uncheck = (0, import_tool.defineTabTool)({
     type: "input"
   },
   handle: async (tab, params, response) => {
-    const { resolved } = await tab.refLocator(params);
+    const { locator, resolved } = await tab.refLocator(params);
     response.addCode(`await page.${resolved}.uncheck();`);
+    await locator.uncheck();
   }
 });
 var snapshot_default = [

package/lib/mcp/browser/tools/utils.js

@@ -62,9 +62,9 @@ async function waitForCompletion(tab, callback) {
 async function callOnPageNoTrace(page, callback) {
   return await page._wrapApiCall(() => callback(page), { internal: true });
 }
-function dateAsFileName(extension) {
+function dateAsFileName(prefix, extension) {
   const date = /* @__PURE__ */ new Date();
-  return `page-${date.toISOString().replace(/[:.]/g, "-")}.${extension}`;
+  return `${prefix}-${date.toISOString().replace(/[:.]/g, "-")}.${extension}`;
 }
 function eventWaiter(page, event, timeout) {
   const disposables = [];

package/lib/mcp/program.js

@@ -73,6 +73,7 @@ Please run the command below. It will install a local copy of ffmpeg and will no
       return;
     }
     if (options.daemon) {
+      config.skillMode = true;
       config.outputDir = import_path.default.join(process.cwd(), ".playwright-cli");
       config.outputMode = "file";
       config.codegen = "none";

package/lib/mcp/terminal/SKILL.md

@@ -0,0 +1,158 @@
+---
+name: playwright-cli
+description: Automates browser interactions for web testing, form filling, screenshots, and data extraction. Use when the user needs to navigate websites, interact with web pages, fill forms, take screenshots, test web applications, or extract information from web pages.
+allowed-tools: Bash(playwright-cli:*)
+---
+
+# Browser Automation with playwright-cli
+
+## Quick start
+
+```bash
+playwright-cli open https://playwright.dev
+playwright-cli click e15
+playwright-cli type "page.click"
+playwright-cli press Enter
+```
+
+## Core workflow
+
+1. Navigate: `playwright-cli open https://example.com`
+2. Interact using refs from the snapshot
+3. Re-snapshot after significant changes
+
+## Commands
+
+### Core
+
+```bash
+playwright-cli open https://example.com/
+playwright-cli close
+playwright-cli type "search query"
+playwright-cli click e3
+playwright-cli dblclick e7
+playwright-cli fill e5 "user@example.com"
+playwright-cli drag e2 e8
+playwright-cli hover e4
+playwright-cli select e9 "option-value"
+playwright-cli upload ./document.pdf
+playwright-cli check e12
+playwright-cli uncheck e12
+playwright-cli snapshot
+playwright-cli eval "document.title"
+playwright-cli eval "el => el.textContent" e5
+playwright-cli dialog-accept
+playwright-cli dialog-accept "confirmation text"
+playwright-cli dialog-dismiss
+playwright-cli resize 1920 1080
+```
+
+### Navigation
+
+```bash
+playwright-cli go-back
+playwright-cli go-forward
+playwright-cli reload
+```
+
+### Keyboard
+
+```bash
+playwright-cli press Enter
+playwright-cli press ArrowDown
+playwright-cli keydown Shift
+playwright-cli keyup Shift
+```
+
+### Mouse
+
+```bash
+playwright-cli mousemove 150 300
+playwright-cli mousedown
+playwright-cli mousedown right
+playwright-cli mouseup
+playwright-cli mouseup right
+playwright-cli mousewheel 0 100
+```
+
+### Save as
+
+```bash
+playwright-cli screenshot
+playwright-cli screenshot e5
+playwright-cli pdf
+```
+
+### Tabs
+
+```bash
+playwright-cli tab-list
+playwright-cli tab-new
+playwright-cli tab-new https://example.com/page
+playwright-cli tab-close
+playwright-cli tab-close 2
+playwright-cli tab-select 0
+```
+
+### DevTools
+
+```bash
+playwright-cli console
+playwright-cli console warning
+playwright-cli network
+playwright-cli run-code "await page.waitForTimeout(1000)"
+playwright-cli tracing-start
+playwright-cli tracing-stop
+```
+
+### Sessions
+
+```bash
+playwright-cli --session=mysession open example.com
+playwright-cli --session=mysession click e6
+playwright-cli session-list
+playwright-cli session-stop mysession
+playwright-cli session-stop-all
+playwright-cli session-delete
+playwright-cli session-delete mysession
+```
+
+## Example: Form submission
+
+```bash
+playwright-cli open https://example.com/form
+playwright-cli snapshot
+
+playwright-cli fill e1 "user@example.com"
+playwright-cli fill e2 "password123"
+playwright-cli click e3
+playwright-cli snapshot
+```
+
+## Example: Multi-tab workflow
+
+```bash
+playwright-cli open https://example.com
+playwright-cli tab-new https://example.com/other
+playwright-cli tab-list
+playwright-cli tab-select 0
+playwright-cli snapshot
+```
+
+## Example: Debugging with DevTools
+
+```bash
+playwright-cli open https://example.com
+playwright-cli click e4
+playwright-cli fill e7 "test"
+playwright-cli console
+playwright-cli network
+```
+
+```bash
+playwright-cli open https://example.com
+playwright-cli tracing-start
+playwright-cli click e4
+playwright-cli fill e7 "test"
+playwright-cli tracing-stop
+```