@pedropaulovc/playwright 1.59.0-alpha-1769214875000

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

@@ -0,0 +1,94 @@
+"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 utils_exports = {};
+__export(utils_exports, {
+  callOnPageNoTrace: () => callOnPageNoTrace,
+  dateAsFileName: () => dateAsFileName,
+  eventWaiter: () => eventWaiter,
+  waitForCompletion: () => waitForCompletion
+});
+module.exports = __toCommonJS(utils_exports);
+async function waitForCompletion(tab, callback) {
+  const requests = [];
+  const requestListener = (request) => requests.push(request);
+  const disposeListeners = () => {
+    tab.page.off("request", requestListener);
+  };
+  tab.page.on("request", requestListener);
+  let result;
+  try {
+    result = await callback();
+    await tab.waitForTimeout(500);
+  } finally {
+    disposeListeners();
+  }
+  const requestedNavigation = requests.some((request) => request.isNavigationRequest());
+  if (requestedNavigation) {
+    await tab.page.mainFrame().waitForLoadState("load", { timeout: 1e4 }).catch(() => {
+    });
+    return result;
+  }
+  const promises = [];
+  for (const request of requests) {
+    if (["document", "stylesheet", "script", "xhr", "fetch"].includes(request.resourceType()))
+      promises.push(request.response().then((r) => r?.finished()).catch(() => {
+      }));
+    else
+      promises.push(request.response().catch(() => {
+      }));
+  }
+  const timeout = new Promise((resolve) => setTimeout(resolve, 5e3));
+  await Promise.race([Promise.all(promises), timeout]);
+  if (requests.length)
+    await tab.waitForTimeout(500);
+  return result;
+}
+async function callOnPageNoTrace(page, callback) {
+  return await page._wrapApiCall(() => callback(page), { internal: true });
+}
+function dateAsFileName(prefix, extension) {
+  const date = /* @__PURE__ */ new Date();
+  return `${prefix}-${date.toISOString().replace(/[:.]/g, "-")}.${extension}`;
+}
+function eventWaiter(page, event, timeout) {
+  const disposables = [];
+  const eventPromise = new Promise((resolve, reject) => {
+    page.on(event, resolve);
+    disposables.push(() => page.off(event, resolve));
+  });
+  let abort;
+  const abortPromise = new Promise((resolve, reject) => {
+    abort = () => resolve(void 0);
+  });
+  const timeoutPromise = new Promise((f) => {
+    const timeoutId = setTimeout(() => f(void 0), timeout);
+    disposables.push(() => clearTimeout(timeoutId));
+  });
+  return {
+    promise: Promise.race([eventPromise, abortPromise, timeoutPromise]).finally(() => disposables.forEach((dispose) => dispose())),
+    abort
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  callOnPageNoTrace,
+  dateAsFileName,
+  eventWaiter,
+  waitForCompletion
+});

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

@@ -0,0 +1,143 @@
+"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 verify_exports = {};
+__export(verify_exports, {
+  default: () => verify_default
+});
+module.exports = __toCommonJS(verify_exports);
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_utils = require("playwright-core/lib/utils");
+var import_tool = require("./tool");
+const verifyElement = (0, import_tool.defineTabTool)({
+  capability: "testing",
+  schema: {
+    name: "browser_verify_element_visible",
+    title: "Verify element visible",
+    description: "Verify element is visible on the page",
+    inputSchema: import_mcpBundle.z.object({
+      role: import_mcpBundle.z.string().describe('ROLE of the element. Can be found in the snapshot like this: `- {ROLE} "Accessible Name":`'),
+      accessibleName: import_mcpBundle.z.string().describe('ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: `- role "{ACCESSIBLE_NAME}"`')
+    }),
+    type: "assertion"
+  },
+  handle: async (tab, params, response) => {
+    const locator = tab.page.getByRole(params.role, { name: params.accessibleName });
+    if (await locator.count() === 0) {
+      response.addError(`Element with role "${params.role}" and accessible name "${params.accessibleName}" not found`);
+      return;
+    }
+    response.addCode(`await expect(page.getByRole(${(0, import_utils.escapeWithQuotes)(params.role)}, { name: ${(0, import_utils.escapeWithQuotes)(params.accessibleName)} })).toBeVisible();`);
+    response.addTextResult("Done");
+  }
+});
+const verifyText = (0, import_tool.defineTabTool)({
+  capability: "testing",
+  schema: {
+    name: "browser_verify_text_visible",
+    title: "Verify text visible",
+    description: `Verify text is visible on the page. Prefer ${verifyElement.schema.name} if possible.`,
+    inputSchema: import_mcpBundle.z.object({
+      text: import_mcpBundle.z.string().describe('TEXT to verify. Can be found in the snapshot like this: `- role "Accessible Name": {TEXT}` or like this: `- text: {TEXT}`')
+    }),
+    type: "assertion"
+  },
+  handle: async (tab, params, response) => {
+    const locator = tab.page.getByText(params.text).filter({ visible: true });
+    if (await locator.count() === 0) {
+      response.addError("Text not found");
+      return;
+    }
+    response.addCode(`await expect(page.getByText(${(0, import_utils.escapeWithQuotes)(params.text)})).toBeVisible();`);
+    response.addTextResult("Done");
+  }
+});
+const verifyList = (0, import_tool.defineTabTool)({
+  capability: "testing",
+  schema: {
+    name: "browser_verify_list_visible",
+    title: "Verify list visible",
+    description: "Verify list is visible on the page",
+    inputSchema: import_mcpBundle.z.object({
+      element: import_mcpBundle.z.string().describe("Human-readable list description"),
+      ref: import_mcpBundle.z.string().describe("Exact target element reference that points to the list"),
+      items: import_mcpBundle.z.array(import_mcpBundle.z.string()).describe("Items to verify")
+    }),
+    type: "assertion"
+  },
+  handle: async (tab, params, response) => {
+    const { locator } = await tab.refLocator({ ref: params.ref, element: params.element });
+    const itemTexts = [];
+    for (const item of params.items) {
+      const itemLocator = locator.getByText(item);
+      if (await itemLocator.count() === 0) {
+        response.addError(`Item "${item}" not found`);
+        return;
+      }
+      itemTexts.push(await itemLocator.textContent());
+    }
+    const ariaSnapshot = `\`
+- list:
+${itemTexts.map((t) => `  - listitem: ${(0, import_utils.escapeWithQuotes)(t, '"')}`).join("\n")}
+\``;
+    response.addCode(`await expect(page.locator('body')).toMatchAriaSnapshot(${ariaSnapshot});`);
+    response.addTextResult("Done");
+  }
+});
+const verifyValue = (0, import_tool.defineTabTool)({
+  capability: "testing",
+  schema: {
+    name: "browser_verify_value",
+    title: "Verify value",
+    description: "Verify element value",
+    inputSchema: import_mcpBundle.z.object({
+      type: import_mcpBundle.z.enum(["textbox", "checkbox", "radio", "combobox", "slider"]).describe("Type of the element"),
+      element: import_mcpBundle.z.string().describe("Human-readable element description"),
+      ref: import_mcpBundle.z.string().describe("Exact target element reference that points to the element"),
+      value: import_mcpBundle.z.string().describe('Value to verify. For checkbox, use "true" or "false".')
+    }),
+    type: "assertion"
+  },
+  handle: async (tab, params, response) => {
+    const { locator, resolved } = await tab.refLocator({ ref: params.ref, element: params.element });
+    const locatorSource = `page.${resolved}`;
+    if (params.type === "textbox" || params.type === "slider" || params.type === "combobox") {
+      const value = await locator.inputValue();
+      if (value !== params.value) {
+        response.addError(`Expected value "${params.value}", but got "${value}"`);
+        return;
+      }
+      response.addCode(`await expect(${locatorSource}).toHaveValue(${(0, import_utils.escapeWithQuotes)(params.value)});`);
+    } else if (params.type === "checkbox" || params.type === "radio") {
+      const value = await locator.isChecked();
+      if (value !== (params.value === "true")) {
+        response.addError(`Expected value "${params.value}", but got "${value}"`);
+        return;
+      }
+      const matcher = value ? "toBeChecked" : "not.toBeChecked";
+      response.addCode(`await expect(${locatorSource}).${matcher}();`);
+    }
+    response.addTextResult("Done");
+  }
+});
+var verify_default = [
+  verifyElement,
+  verifyText,
+  verifyList,
+  verifyValue
+];

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

@@ -0,0 +1,63 @@
+"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 wait_exports = {};
+__export(wait_exports, {
+  default: () => wait_default
+});
+module.exports = __toCommonJS(wait_exports);
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_tool = require("./tool");
+const wait = (0, import_tool.defineTool)({
+  capability: "core",
+  schema: {
+    name: "browser_wait_for",
+    title: "Wait for",
+    description: "Wait for text to appear or disappear or a specified time to pass",
+    inputSchema: import_mcpBundle.z.object({
+      time: import_mcpBundle.z.number().optional().describe("The time to wait in seconds"),
+      text: import_mcpBundle.z.string().optional().describe("The text to wait for"),
+      textGone: import_mcpBundle.z.string().optional().describe("The text to wait for to disappear")
+    }),
+    type: "assertion"
+  },
+  handle: async (context, params, response) => {
+    if (!params.text && !params.textGone && !params.time)
+      throw new Error("Either time, text or textGone must be provided");
+    if (params.time) {
+      response.addCode(`await new Promise(f => setTimeout(f, ${params.time} * 1000));`);
+      await new Promise((f) => setTimeout(f, Math.min(3e4, params.time * 1e3)));
+    }
+    const tab = context.currentTabOrDie();
+    const locator = params.text ? tab.page.getByText(params.text).first() : void 0;
+    const goneLocator = params.textGone ? tab.page.getByText(params.textGone).first() : void 0;
+    if (goneLocator) {
+      response.addCode(`await page.getByText(${JSON.stringify(params.textGone)}).first().waitFor({ state: 'hidden' });`);
+      await goneLocator.waitFor({ state: "hidden" });
+    }
+    if (locator) {
+      response.addCode(`await page.getByText(${JSON.stringify(params.text)}).first().waitFor({ state: 'visible' });`);
+      await locator.waitFor({ state: "visible" });
+    }
+    response.addTextResult(`Waited for ${params.text || params.textGone || params.time}`);
+    response.setIncludeSnapshot();
+  }
+});
+var wait_default = [
+  wait
+];

package/lib/mcp/browser/tools.js

@@ -0,0 +1,82 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tools_exports = {};
+__export(tools_exports, {
+  browserTools: () => browserTools,
+  filteredTools: () => filteredTools
+});
+module.exports = __toCommonJS(tools_exports);
+var import_common = __toESM(require("./tools/common"));
+var import_console = __toESM(require("./tools/console"));
+var import_dialogs = __toESM(require("./tools/dialogs"));
+var import_evaluate = __toESM(require("./tools/evaluate"));
+var import_files = __toESM(require("./tools/files"));
+var import_form = __toESM(require("./tools/form"));
+var import_install = __toESM(require("./tools/install"));
+var import_keyboard = __toESM(require("./tools/keyboard"));
+var import_mouse = __toESM(require("./tools/mouse"));
+var import_navigate = __toESM(require("./tools/navigate"));
+var import_network = __toESM(require("./tools/network"));
+var import_pdf = __toESM(require("./tools/pdf"));
+var import_runCode = __toESM(require("./tools/runCode"));
+var import_snapshot = __toESM(require("./tools/snapshot"));
+var import_screenshot = __toESM(require("./tools/screenshot"));
+var import_tabs = __toESM(require("./tools/tabs"));
+var import_tracing = __toESM(require("./tools/tracing"));
+var import_wait = __toESM(require("./tools/wait"));
+var import_verify = __toESM(require("./tools/verify"));
+const browserTools = [
+  ...import_common.default,
+  ...import_console.default,
+  ...import_dialogs.default,
+  ...import_evaluate.default,
+  ...import_files.default,
+  ...import_form.default,
+  ...import_install.default,
+  ...import_keyboard.default,
+  ...import_mouse.default,
+  ...import_navigate.default,
+  ...import_network.default,
+  ...import_pdf.default,
+  ...import_runCode.default,
+  ...import_screenshot.default,
+  ...import_snapshot.default,
+  ...import_tabs.default,
+  ...import_tracing.default,
+  ...import_wait.default,
+  ...import_verify.default
+];
+function filteredTools(config) {
+  return browserTools.filter((tool) => tool.capability.startsWith("core") || config.capabilities?.includes(tool.capability)).filter((tool) => !tool.skillOnly);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  browserTools,
+  filteredTools
+});

package/lib/mcp/browser/watchdog.js

@@ -0,0 +1,44 @@
+"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 watchdog_exports = {};
+__export(watchdog_exports, {
+  setupExitWatchdog: () => setupExitWatchdog
+});
+module.exports = __toCommonJS(watchdog_exports);
+var import_browserContextFactory = require("./browserContextFactory");
+var import_context = require("./context");
+function setupExitWatchdog() {
+  let isExiting = false;
+  const handleExit = async () => {
+    if (isExiting)
+      return;
+    isExiting = true;
+    setTimeout(() => process.exit(0), 15e3);
+    await import_context.Context.disposeAll();
+    await import_browserContextFactory.SharedContextFactory.dispose();
+    process.exit(0);
+  };
+  process.stdin.on("close", handleExit);
+  process.on("SIGINT", handleExit);
+  process.on("SIGTERM", handleExit);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setupExitWatchdog
+});

package/lib/mcp/config.d.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 config_d_exports = {};
+module.exports = __toCommonJS(config_d_exports);