@pedropaulovc/playwright 1.59.0-alpha-1769214875000

package/lib/mcp/terminal/command.js

@@ -0,0 +1,56 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var command_exports = {};
+__export(command_exports, {
+  declareCommand: () => declareCommand,
+  parseCommand: () => parseCommand
+});
+module.exports = __toCommonJS(command_exports);
+function declareCommand(command) {
+  return command;
+}
+function parseCommand(command, args) {
+  const shape = command.args ? command.args.shape : {};
+  const argv = args["_"];
+  const options = command.options?.parse({ ...args, _: void 0 }) ?? {};
+  const argsObject = {};
+  let i = 0;
+  for (const name of Object.keys(shape))
+    argsObject[name] = argv[++i];
+  let parsedArgsObject = {};
+  try {
+    parsedArgsObject = command.args?.parse(argsObject) ?? {};
+  } catch (e) {
+    throw new Error(formatZodError(e));
+  }
+  const toolName = typeof command.toolName === "function" ? command.toolName({ ...parsedArgsObject, ...options }) : command.toolName;
+  const toolParams = command.toolParams({ ...parsedArgsObject, ...options });
+  return { toolName, toolParams };
+}
+function formatZodError(error) {
+  const issue = error.issues[0];
+  if (issue.code === "invalid_type")
+    return `${issue.message} in <${issue.path.join(".")}>`;
+  return error.issues.map((i) => i.message).join("\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  declareCommand,
+  parseCommand
+});

package/lib/mcp/terminal/commands.js

@@ -0,0 +1,519 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var commands_exports = {};
+__export(commands_exports, {
+  commands: () => commands
+});
+module.exports = __toCommonJS(commands_exports);
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_command = require("./command");
+const open = (0, import_command.declareCommand)({
+  name: "open",
+  description: "Open URL",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    url: import_mcpBundle.z.string().describe("The URL to navigate to")
+  }),
+  options: import_mcpBundle.z.object({
+    headed: import_mcpBundle.z.boolean().default(false).describe("Run browser in headed mode")
+  }),
+  toolName: "browser_open",
+  toolParams: ({ url, headed }) => ({ url, headed })
+});
+const close = (0, import_command.declareCommand)({
+  name: "close",
+  description: "Close the page",
+  category: "core",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_close",
+  toolParams: () => ({})
+});
+const goBack = (0, import_command.declareCommand)({
+  name: "go-back",
+  description: "Go back to the previous page",
+  category: "navigation",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_navigate_back",
+  toolParams: () => ({})
+});
+const goForward = (0, import_command.declareCommand)({
+  name: "go-forward",
+  description: "Go forward to the next page",
+  category: "navigation",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_navigate_forward",
+  toolParams: () => ({})
+});
+const reload = (0, import_command.declareCommand)({
+  name: "reload",
+  description: "Reload the current page",
+  category: "navigation",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_reload",
+  toolParams: () => ({})
+});
+const pressKey = (0, import_command.declareCommand)({
+  name: "press",
+  description: "Press a key on the keyboard, `a`, `ArrowLeft`",
+  category: "keyboard",
+  args: import_mcpBundle.z.object({
+    key: import_mcpBundle.z.string().describe("Name of the key to press or a character to generate, such as `ArrowLeft` or `a`")
+  }),
+  toolName: "browser_press_key",
+  toolParams: ({ key }) => ({ key })
+});
+const type = (0, import_command.declareCommand)({
+  name: "type",
+  description: "Type text into editable element",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    text: import_mcpBundle.z.string().describe("Text to type into the element")
+  }),
+  options: import_mcpBundle.z.object({
+    submit: import_mcpBundle.z.boolean().optional().describe("Whether to submit entered text (press Enter after)")
+  }),
+  toolName: "browser_press_sequentially",
+  toolParams: ({ text, submit }) => ({ text, submit })
+});
+const keydown = (0, import_command.declareCommand)({
+  name: "keydown",
+  description: "Press a key down on the keyboard",
+  category: "keyboard",
+  args: import_mcpBundle.z.object({
+    key: import_mcpBundle.z.string().describe("Name of the key to press or a character to generate, such as `ArrowLeft` or `a`")
+  }),
+  toolName: "browser_keydown",
+  toolParams: ({ key }) => ({ key })
+});
+const keyup = (0, import_command.declareCommand)({
+  name: "keyup",
+  description: "Press a key up on the keyboard",
+  category: "keyboard",
+  args: import_mcpBundle.z.object({
+    key: import_mcpBundle.z.string().describe("Name of the key to press or a character to generate, such as `ArrowLeft` or `a`")
+  }),
+  toolName: "browser_keyup",
+  toolParams: ({ key }) => ({ key })
+});
+const mouseMove = (0, import_command.declareCommand)({
+  name: "mousemove",
+  description: "Move mouse to a given position",
+  category: "mouse",
+  args: import_mcpBundle.z.object({
+    x: import_mcpBundle.z.number().describe("X coordinate"),
+    y: import_mcpBundle.z.number().describe("Y coordinate")
+  }),
+  toolName: "browser_mouse_move_xy",
+  toolParams: ({ x, y }) => ({ x, y })
+});
+const mouseDown = (0, import_command.declareCommand)({
+  name: "mousedown",
+  description: "Press mouse down",
+  category: "mouse",
+  args: import_mcpBundle.z.object({
+    button: import_mcpBundle.z.string().optional().describe("Button to press, defaults to left")
+  }),
+  toolName: "browser_mouse_down",
+  toolParams: ({ button }) => ({ button })
+});
+const mouseUp = (0, import_command.declareCommand)({
+  name: "mouseup",
+  description: "Press mouse up",
+  category: "mouse",
+  args: import_mcpBundle.z.object({
+    button: import_mcpBundle.z.string().optional().describe("Button to press, defaults to left")
+  }),
+  toolName: "browser_mouse_up",
+  toolParams: ({ button }) => ({ button })
+});
+const mouseWheel = (0, import_command.declareCommand)({
+  name: "mousewheel",
+  description: "Scroll mouse wheel",
+  category: "mouse",
+  args: import_mcpBundle.z.object({
+    dx: import_mcpBundle.z.number().describe("Y delta"),
+    dy: import_mcpBundle.z.number().describe("X delta")
+  }),
+  toolName: "browser_mouse_wheel",
+  toolParams: ({ dx: deltaY, dy: deltaX }) => ({ deltaY, deltaX })
+});
+const click = (0, import_command.declareCommand)({
+  name: "click",
+  description: "Perform click on a web page",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot"),
+    button: import_mcpBundle.z.string().optional().describe("Button to click, defaults to left")
+  }),
+  options: import_mcpBundle.z.object({
+    modifiers: import_mcpBundle.z.array(import_mcpBundle.z.string()).optional().describe("Modifier keys to press")
+  }),
+  toolName: "browser_click",
+  toolParams: ({ ref, button, modifiers }) => ({ ref, button, modifiers })
+});
+const doubleClick = (0, import_command.declareCommand)({
+  name: "dblclick",
+  description: "Perform double click on a web page",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot"),
+    button: import_mcpBundle.z.string().optional().describe("Button to click, defaults to left")
+  }),
+  options: import_mcpBundle.z.object({
+    modifiers: import_mcpBundle.z.array(import_mcpBundle.z.string()).optional().describe("Modifier keys to press")
+  }),
+  toolName: "browser_click",
+  toolParams: ({ ref, button, modifiers }) => ({ ref, button, modifiers, doubleClick: true })
+});
+const drag = (0, import_command.declareCommand)({
+  name: "drag",
+  description: "Perform drag and drop between two elements",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    startRef: import_mcpBundle.z.string().describe("Exact source element reference from the page snapshot"),
+    endRef: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot")
+  }),
+  options: import_mcpBundle.z.object({
+    headed: import_mcpBundle.z.boolean().default(false).describe("Run browser in headed mode")
+  }),
+  toolName: "browser_drag",
+  toolParams: ({ startRef, endRef }) => ({ startRef, endRef })
+});
+const fill = (0, import_command.declareCommand)({
+  name: "fill",
+  description: "Fill text into editable element",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot"),
+    text: import_mcpBundle.z.string().describe("Text to fill into the element")
+  }),
+  options: import_mcpBundle.z.object({
+    submit: import_mcpBundle.z.boolean().optional().describe("Whether to submit entered text (press Enter after)")
+  }),
+  toolName: "browser_type",
+  toolParams: ({ ref, text, submit }) => ({ ref, text, submit })
+});
+const hover = (0, import_command.declareCommand)({
+  name: "hover",
+  description: "Hover over element on page",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot")
+  }),
+  toolName: "browser_hover",
+  toolParams: ({ ref }) => ({ ref })
+});
+const select = (0, import_command.declareCommand)({
+  name: "select",
+  description: "Select an option in a dropdown",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot"),
+    val: import_mcpBundle.z.string().describe("Value to select in the dropdown")
+  }),
+  toolName: "browser_select_option",
+  toolParams: ({ ref, val: value }) => ({ ref, values: [value] })
+});
+const fileUpload = (0, import_command.declareCommand)({
+  name: "upload",
+  description: "Upload one or multiple files",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    file: import_mcpBundle.z.string().describe("The absolute paths to the files to upload")
+  }),
+  toolName: "browser_file_upload",
+  toolParams: ({ file }) => ({ paths: [file] })
+});
+const check = (0, import_command.declareCommand)({
+  name: "check",
+  description: "Check a checkbox or radio button",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot")
+  }),
+  toolName: "browser_check",
+  toolParams: ({ ref }) => ({ ref })
+});
+const uncheck = (0, import_command.declareCommand)({
+  name: "uncheck",
+  description: "Uncheck a checkbox or radio button",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().describe("Exact target element reference from the page snapshot")
+  }),
+  toolName: "browser_uncheck",
+  toolParams: ({ ref }) => ({ ref })
+});
+const snapshot = (0, import_command.declareCommand)({
+  name: "snapshot",
+  description: "Capture page snapshot to obtain element ref",
+  category: "core",
+  args: import_mcpBundle.z.object({}),
+  options: import_mcpBundle.z.object({
+    filename: import_mcpBundle.z.string().optional().describe("Save snapshot to markdown file instead of returning it in the response.")
+  }),
+  toolName: "browser_snapshot",
+  toolParams: ({ filename }) => ({ filename })
+});
+const evaluate = (0, import_command.declareCommand)({
+  name: "eval",
+  description: "Evaluate JavaScript expression on page or element",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    func: import_mcpBundle.z.string().describe("() => { /* code */ } or (element) => { /* code */ } when element is provided"),
+    ref: import_mcpBundle.z.string().optional().describe("Exact target element reference from the page snapshot")
+  }),
+  toolName: "browser_evaluate",
+  toolParams: ({ func, ref }) => ({ function: func, ref })
+});
+const dialogAccept = (0, import_command.declareCommand)({
+  name: "dialog-accept",
+  description: "Accept a dialog",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    prompt: import_mcpBundle.z.string().optional().describe("The text of the prompt in case of a prompt dialog.")
+  }),
+  toolName: "browser_handle_dialog",
+  toolParams: ({ prompt: promptText }) => ({ accept: true, promptText })
+});
+const dialogDismiss = (0, import_command.declareCommand)({
+  name: "dialog-dismiss",
+  description: "Dismiss a dialog",
+  category: "core",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_handle_dialog",
+  toolParams: () => ({ accept: false })
+});
+const resize = (0, import_command.declareCommand)({
+  name: "resize",
+  description: "Resize the browser window",
+  category: "core",
+  args: import_mcpBundle.z.object({
+    w: import_mcpBundle.z.number().describe("Width of the browser window"),
+    h: import_mcpBundle.z.number().describe("Height of the browser window")
+  }),
+  toolName: "browser_resize",
+  toolParams: ({ w: width, h: height }) => ({ width, height })
+});
+const tabList = (0, import_command.declareCommand)({
+  name: "tab-list",
+  description: "List all tabs",
+  category: "tabs",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_tabs",
+  toolParams: () => ({ action: "list" })
+});
+const tabNew = (0, import_command.declareCommand)({
+  name: "tab-new",
+  description: "Create a new tab",
+  category: "tabs",
+  args: import_mcpBundle.z.object({
+    url: import_mcpBundle.z.string().optional().describe("The URL to navigate to in the new tab. If omitted, the new tab will be blank.")
+  }),
+  toolName: "browser_tabs",
+  toolParams: ({ url }) => ({ action: "new", url })
+});
+const tabClose = (0, import_command.declareCommand)({
+  name: "tab-close",
+  description: "Close a browser tab",
+  category: "tabs",
+  args: import_mcpBundle.z.object({
+    index: import_mcpBundle.z.number().optional().describe("Tab index. If omitted, current tab is closed.")
+  }),
+  toolName: "browser_tabs",
+  toolParams: ({ index }) => ({ action: "close", index })
+});
+const tabSelect = (0, import_command.declareCommand)({
+  name: "tab-select",
+  description: "Select a browser tab",
+  category: "tabs",
+  args: import_mcpBundle.z.object({
+    index: import_mcpBundle.z.number().describe("Tab index")
+  }),
+  toolName: "browser_tabs",
+  toolParams: ({ index }) => ({ action: "select", index })
+});
+const screenshot = (0, import_command.declareCommand)({
+  name: "screenshot",
+  description: "screenshot of the current page or element",
+  category: "export",
+  args: import_mcpBundle.z.object({
+    ref: import_mcpBundle.z.string().optional().describe("Exact target element reference from the page snapshot.")
+  }),
+  options: import_mcpBundle.z.object({
+    filename: import_mcpBundle.z.string().optional().describe("File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified."),
+    ["full-page"]: import_mcpBundle.z.boolean().optional().describe("When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport.")
+  }),
+  toolName: "browser_take_screenshot",
+  toolParams: ({ ref, filename, ["full-page"]: fullPage }) => ({ filename, ref, fullPage })
+});
+const pdfSave = (0, import_command.declareCommand)({
+  name: "pdf",
+  description: "Save page as PDF",
+  category: "export",
+  args: import_mcpBundle.z.object({}),
+  options: import_mcpBundle.z.object({
+    filename: import_mcpBundle.z.string().optional().describe("File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.")
+  }),
+  toolName: "browser_pdf_save",
+  toolParams: ({ filename }) => ({ filename })
+});
+const consoleList = (0, import_command.declareCommand)({
+  name: "console",
+  description: "List console messages",
+  category: "devtools",
+  args: import_mcpBundle.z.object({
+    ["min-level"]: import_mcpBundle.z.string().optional().describe('Level of the console messages to return. Each level includes the messages of more severe levels. Defaults to "info".')
+  }),
+  options: import_mcpBundle.z.object({
+    clear: import_mcpBundle.z.boolean().optional().describe("Whether to clear the console list")
+  }),
+  toolName: ({ clear }) => clear ? "browser_console_clear" : "browser_console_messages",
+  toolParams: ({ ["min-level"]: level, clear }) => clear ? {} : { level }
+});
+const networkRequests = (0, import_command.declareCommand)({
+  name: "network",
+  description: "List all network requests since loading the page",
+  category: "devtools",
+  args: import_mcpBundle.z.object({}),
+  options: import_mcpBundle.z.object({
+    static: import_mcpBundle.z.boolean().optional().describe("Whether to include successful static resources like images, fonts, scripts, etc. Defaults to false."),
+    clear: import_mcpBundle.z.boolean().optional().describe("Whether to clear the network list")
+  }),
+  toolName: ({ clear }) => clear ? "browser_network_clear" : "browser_network_requests",
+  toolParams: ({ static: includeStatic, clear }) => clear ? {} : { includeStatic }
+});
+const runCode = (0, import_command.declareCommand)({
+  name: "run-code",
+  description: "Run Playwright code snippet",
+  category: "devtools",
+  args: 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.")
+  }),
+  toolName: "browser_run_code",
+  toolParams: ({ code }) => ({ code })
+});
+const tracingStart = (0, import_command.declareCommand)({
+  name: "tracing-start",
+  description: "Start trace recording",
+  category: "devtools",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_start_tracing",
+  toolParams: () => ({})
+});
+const tracingStop = (0, import_command.declareCommand)({
+  name: "tracing-stop",
+  description: "Stop trace recording",
+  category: "devtools",
+  args: import_mcpBundle.z.object({}),
+  toolName: "browser_stop_tracing",
+  toolParams: () => ({})
+});
+const sessionList = (0, import_command.declareCommand)({
+  name: "session-list",
+  description: "List all sessions",
+  category: "session",
+  args: import_mcpBundle.z.object({}),
+  toolName: "",
+  toolParams: () => ({})
+});
+const sessionStop = (0, import_command.declareCommand)({
+  name: "session-stop",
+  description: "Stop session",
+  category: "session",
+  args: import_mcpBundle.z.object({
+    name: import_mcpBundle.z.string().optional().describe("Name of the session to stop. If omitted, current session is stopped.")
+  }),
+  toolName: "",
+  toolParams: () => ({})
+});
+const sessionStopAll = (0, import_command.declareCommand)({
+  name: "session-stop-all",
+  description: "Stop all sessions",
+  category: "session",
+  toolName: "",
+  toolParams: () => ({})
+});
+const sessionDelete = (0, import_command.declareCommand)({
+  name: "session-delete",
+  description: "Delete session data",
+  category: "session",
+  args: import_mcpBundle.z.object({
+    name: import_mcpBundle.z.string().optional().describe("Name of the session to delete. If omitted, current session is deleted.")
+  }),
+  toolName: "",
+  toolParams: ({ name }) => ({ name })
+});
+const commandsArray = [
+  // core category
+  open,
+  close,
+  type,
+  click,
+  doubleClick,
+  fill,
+  drag,
+  hover,
+  select,
+  fileUpload,
+  check,
+  uncheck,
+  snapshot,
+  evaluate,
+  consoleList,
+  dialogAccept,
+  dialogDismiss,
+  resize,
+  // navigation category
+  goBack,
+  goForward,
+  reload,
+  // keyboard category
+  pressKey,
+  keydown,
+  keyup,
+  // mouse category
+  mouseMove,
+  mouseDown,
+  mouseUp,
+  mouseWheel,
+  // export category
+  screenshot,
+  pdfSave,
+  // tabs category
+  tabList,
+  tabNew,
+  tabClose,
+  tabSelect,
+  // devtools category
+  networkRequests,
+  runCode,
+  tracingStart,
+  tracingStop,
+  // session category
+  sessionList,
+  sessionStop,
+  sessionStopAll,
+  sessionDelete
+];
+const commands = Object.fromEntries(commandsArray.map((cmd) => [cmd.name, cmd]));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  commands
+});