playwright 1.56.0-alpha-2025-09-03 → 1.56.0-alpha-1756945786000

package/lib/mcp/browser/sessionLog.js

@@ -0,0 +1,160 @@
+"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 sessionLog_exports = {};
+__export(sessionLog_exports, {
+  SessionLog: () => SessionLog
+});
+module.exports = __toCommonJS(sessionLog_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_log = require("../log");
+var import_config = require("./config");
+class SessionLog {
+  constructor(sessionFolder) {
+    this._ordinal = 0;
+    this._pendingEntries = [];
+    this._sessionFileQueue = Promise.resolve();
+    this._folder = sessionFolder;
+    this._file = import_path.default.join(this._folder, "session.md");
+  }
+  static async create(config, rootPath) {
+    const sessionFolder = await (0, import_config.outputFile)(config, rootPath, `session-${Date.now()}`);
+    await import_fs.default.promises.mkdir(sessionFolder, { recursive: true });
+    console.error(`Session: ${sessionFolder}`);
+    return new SessionLog(sessionFolder);
+  }
+  logResponse(response) {
+    const entry = {
+      timestamp: performance.now(),
+      toolCall: {
+        toolName: response.toolName,
+        toolArgs: response.toolArgs,
+        result: response.result(),
+        isError: response.isError()
+      },
+      code: response.code(),
+      tabSnapshot: response.tabSnapshot()
+    };
+    this._appendEntry(entry);
+  }
+  logUserAction(action, tab, code, isUpdate) {
+    code = code.trim();
+    if (isUpdate) {
+      const lastEntry = this._pendingEntries[this._pendingEntries.length - 1];
+      if (lastEntry.userAction?.name === action.name) {
+        lastEntry.userAction = action;
+        lastEntry.code = code;
+        return;
+      }
+    }
+    if (action.name === "navigate") {
+      const lastEntry = this._pendingEntries[this._pendingEntries.length - 1];
+      if (lastEntry?.tabSnapshot?.url === action.url)
+        return;
+    }
+    const entry = {
+      timestamp: performance.now(),
+      userAction: action,
+      code,
+      tabSnapshot: {
+        url: tab.page.url(),
+        title: "",
+        ariaSnapshot: action.ariaSnapshot || "",
+        modalStates: [],
+        consoleMessages: [],
+        downloads: []
+      }
+    };
+    this._appendEntry(entry);
+  }
+  _appendEntry(entry) {
+    this._pendingEntries.push(entry);
+    if (this._flushEntriesTimeout)
+      clearTimeout(this._flushEntriesTimeout);
+    this._flushEntriesTimeout = setTimeout(() => this._flushEntries(), 1e3);
+  }
+  async _flushEntries() {
+    clearTimeout(this._flushEntriesTimeout);
+    const entries = this._pendingEntries;
+    this._pendingEntries = [];
+    const lines = [""];
+    for (const entry of entries) {
+      const ordinal = (++this._ordinal).toString().padStart(3, "0");
+      if (entry.toolCall) {
+        lines.push(
+          `### Tool call: ${entry.toolCall.toolName}`,
+          `- Args`,
+          "```json",
+          JSON.stringify(entry.toolCall.toolArgs, null, 2),
+          "```"
+        );
+        if (entry.toolCall.result) {
+          lines.push(
+            entry.toolCall.isError ? `- Error` : `- Result`,
+            "```",
+            entry.toolCall.result,
+            "```"
+          );
+        }
+      }
+      if (entry.userAction) {
+        const actionData = { ...entry.userAction };
+        delete actionData.ariaSnapshot;
+        delete actionData.selector;
+        delete actionData.signals;
+        lines.push(
+          `### User action: ${entry.userAction.name}`,
+          `- Args`,
+          "```json",
+          JSON.stringify(actionData, null, 2),
+          "```"
+        );
+      }
+      if (entry.code) {
+        lines.push(
+          `- Code`,
+          "```js",
+          entry.code,
+          "```"
+        );
+      }
+      if (entry.tabSnapshot) {
+        const fileName = `${ordinal}.snapshot.yml`;
+        import_fs.default.promises.writeFile(import_path.default.join(this._folder, fileName), entry.tabSnapshot.ariaSnapshot).catch(import_log.logUnhandledError);
+        lines.push(`- Snapshot: ${fileName}`);
+      }
+      lines.push("", "");
+    }
+    this._sessionFileQueue = this._sessionFileQueue.then(() => import_fs.default.promises.appendFile(this._file, lines.join("\n")));
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SessionLog
+});

package/lib/mcp/browser/tab.js

@@ -0,0 +1,256 @@
+"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 tab_exports = {};
+__export(tab_exports, {
+  Tab: () => Tab,
+  TabEvents: () => TabEvents,
+  renderModalStates: () => renderModalStates
+});
+module.exports = __toCommonJS(tab_exports);
+var import_events = require("events");
+var import_utils = require("playwright-core/lib/utils");
+var import_utils2 = require("./tools/utils");
+var import_log = require("../log");
+const TabEvents = {
+  modalState: "modalState"
+};
+class Tab extends import_events.EventEmitter {
+  constructor(context, page, onPageClose) {
+    super();
+    this._lastTitle = "about:blank";
+    this._consoleMessages = [];
+    this._recentConsoleMessages = [];
+    this._requests = /* @__PURE__ */ new Map();
+    this._modalStates = [];
+    this._downloads = [];
+    this.context = context;
+    this.page = page;
+    this._onPageClose = onPageClose;
+    page.on("console", (event) => this._handleConsoleMessage(messageToConsoleMessage(event)));
+    page.on("pageerror", (error) => this._handleConsoleMessage(pageErrorToConsoleMessage(error)));
+    page.on("request", (request) => this._requests.set(request, null));
+    page.on("response", (response) => this._requests.set(response.request(), response));
+    page.on("close", () => this._onClose());
+    page.on("filechooser", (chooser) => {
+      this.setModalState({
+        type: "fileChooser",
+        description: "File chooser",
+        fileChooser: chooser
+      });
+    });
+    page.on("dialog", (dialog) => this._dialogShown(dialog));
+    page.on("download", (download) => {
+      void this._downloadStarted(download);
+    });
+    page.setDefaultNavigationTimeout(6e4);
+    page.setDefaultTimeout(5e3);
+    page[tabSymbol] = this;
+  }
+  static forPage(page) {
+    return page[tabSymbol];
+  }
+  modalStates() {
+    return this._modalStates;
+  }
+  setModalState(modalState) {
+    this._modalStates.push(modalState);
+    this.emit(TabEvents.modalState, modalState);
+  }
+  clearModalState(modalState) {
+    this._modalStates = this._modalStates.filter((state) => state !== modalState);
+  }
+  modalStatesMarkdown() {
+    return renderModalStates(this.context, this.modalStates());
+  }
+  _dialogShown(dialog) {
+    this.setModalState({
+      type: "dialog",
+      description: `"${dialog.type()}" dialog with message "${dialog.message()}"`,
+      dialog
+    });
+  }
+  async _downloadStarted(download) {
+    const entry = {
+      download,
+      finished: false,
+      outputFile: await this.context.outputFile(download.suggestedFilename())
+    };
+    this._downloads.push(entry);
+    await download.saveAs(entry.outputFile);
+    entry.finished = true;
+  }
+  _clearCollectedArtifacts() {
+    this._consoleMessages.length = 0;
+    this._recentConsoleMessages.length = 0;
+    this._requests.clear();
+  }
+  _handleConsoleMessage(message) {
+    this._consoleMessages.push(message);
+    this._recentConsoleMessages.push(message);
+  }
+  _onClose() {
+    this._clearCollectedArtifacts();
+    this._onPageClose(this);
+  }
+  async updateTitle() {
+    await this._raceAgainstModalStates(async () => {
+      this._lastTitle = await (0, import_utils2.callOnPageNoTrace)(this.page, (page) => page.title());
+    });
+  }
+  lastTitle() {
+    return this._lastTitle;
+  }
+  isCurrentTab() {
+    return this === this.context.currentTab();
+  }
+  async waitForLoadState(state, options) {
+    await (0, import_utils2.callOnPageNoTrace)(this.page, (page) => page.waitForLoadState(state, options).catch(import_log.logUnhandledError));
+  }
+  async navigate(url) {
+    this._clearCollectedArtifacts();
+    const downloadEvent = (0, import_utils2.callOnPageNoTrace)(this.page, (page) => page.waitForEvent("download").catch(import_log.logUnhandledError));
+    try {
+      await this.page.goto(url, { waitUntil: "domcontentloaded" });
+    } catch (_e) {
+      const e = _e;
+      const mightBeDownload = e.message.includes("net::ERR_ABORTED") || e.message.includes("Download is starting");
+      if (!mightBeDownload)
+        throw e;
+      const download = await Promise.race([
+        downloadEvent,
+        new Promise((resolve) => setTimeout(resolve, 3e3))
+      ]);
+      if (!download)
+        throw e;
+      await new Promise((resolve) => setTimeout(resolve, 500));
+      return;
+    }
+    await this.waitForLoadState("load", { timeout: 5e3 });
+  }
+  consoleMessages() {
+    return this._consoleMessages;
+  }
+  requests() {
+    return this._requests;
+  }
+  async captureSnapshot() {
+    let tabSnapshot;
+    const modalStates = await this._raceAgainstModalStates(async () => {
+      const snapshot = await this.page._snapshotForAI();
+      tabSnapshot = {
+        url: this.page.url(),
+        title: await this.page.title(),
+        ariaSnapshot: snapshot,
+        modalStates: [],
+        consoleMessages: [],
+        downloads: this._downloads
+      };
+    });
+    if (tabSnapshot) {
+      tabSnapshot.consoleMessages = this._recentConsoleMessages;
+      this._recentConsoleMessages = [];
+    }
+    return tabSnapshot ?? {
+      url: this.page.url(),
+      title: "",
+      ariaSnapshot: "",
+      modalStates,
+      consoleMessages: [],
+      downloads: []
+    };
+  }
+  _javaScriptBlocked() {
+    return this._modalStates.some((state) => state.type === "dialog");
+  }
+  async _raceAgainstModalStates(action) {
+    if (this.modalStates().length)
+      return this.modalStates();
+    const promise = new import_utils.ManualPromise();
+    const listener = (modalState) => promise.resolve([modalState]);
+    this.once(TabEvents.modalState, listener);
+    return await Promise.race([
+      action().then(() => {
+        this.off(TabEvents.modalState, listener);
+        return [];
+      }),
+      promise
+    ]);
+  }
+  async waitForCompletion(callback) {
+    await this._raceAgainstModalStates(() => (0, import_utils2.waitForCompletion)(this, callback));
+  }
+  async refLocator(params) {
+    return (await this.refLocators([params]))[0];
+  }
+  async refLocators(params) {
+    const snapshot = await this.page._snapshotForAI();
+    return params.map((param) => {
+      if (!snapshot.includes(`[ref=${param.ref}]`))
+        throw new Error(`Ref ${param.ref} not found in the current page snapshot. Try capturing new snapshot.`);
+      return this.page.locator(`aria-ref=${param.ref}`).describe(param.element);
+    });
+  }
+  async waitForTimeout(time) {
+    if (this._javaScriptBlocked()) {
+      await new Promise((f) => setTimeout(f, time));
+      return;
+    }
+    await (0, import_utils2.callOnPageNoTrace)(this.page, (page) => {
+      return page.evaluate(() => new Promise((f) => setTimeout(f, 1e3)));
+    });
+  }
+}
+function messageToConsoleMessage(message) {
+  return {
+    type: message.type(),
+    text: message.text(),
+    toString: () => `[${message.type().toUpperCase()}] ${message.text()} @ ${message.location().url}:${message.location().lineNumber}`
+  };
+}
+function pageErrorToConsoleMessage(errorOrValue) {
+  if (errorOrValue instanceof Error) {
+    return {
+      type: void 0,
+      text: errorOrValue.message,
+      toString: () => errorOrValue.stack || errorOrValue.message
+    };
+  }
+  return {
+    type: void 0,
+    text: String(errorOrValue),
+    toString: () => String(errorOrValue)
+  };
+}
+function renderModalStates(context, modalStates) {
+  const result = ["### Modal state"];
+  if (modalStates.length === 0)
+    result.push("- There is no modal state present");
+  for (const state of modalStates) {
+    const tool = context.tools.filter((tool2) => "clearsModalState" in tool2).find((tool2) => tool2.clearsModalState === state.type);
+    result.push(`- [${state.description}]: can be handled by the "${tool?.schema.name}" tool`);
+  }
+  return result;
+}
+const tabSymbol = Symbol("tabSymbol");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Tab,
+  TabEvents,
+  renderModalStates
+});

package/lib/mcp/browser/tools/common.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 common_exports = {};
+__export(common_exports, {
+  default: () => common_default
+});
+module.exports = __toCommonJS(common_exports);
+var import_bundle = require("../../sdk/bundle");
+var import_tool = require("./tool");
+const close = (0, import_tool.defineTool)({
+  capability: "core",
+  schema: {
+    name: "browser_close",
+    title: "Close browser",
+    description: "Close the page",
+    inputSchema: import_bundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    await context.closeBrowserContext();
+    response.setIncludeTabs();
+    response.addCode(`await page.close()`);
+  }
+});
+const resize = (0, import_tool.defineTabTool)({
+  capability: "core",
+  schema: {
+    name: "browser_resize",
+    title: "Resize browser window",
+    description: "Resize the browser window",
+    inputSchema: import_bundle.z.object({
+      width: import_bundle.z.number().describe("Width of the browser window"),
+      height: import_bundle.z.number().describe("Height of the browser window")
+    }),
+    type: "readOnly"
+  },
+  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 });
+    });
+  }
+});
+var common_default = [
+  close,
+  resize
+];

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

@@ -0,0 +1,41 @@
+"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 console_exports = {};
+__export(console_exports, {
+  default: () => console_default
+});
+module.exports = __toCommonJS(console_exports);
+var import_bundle = require("../../sdk/bundle");
+var import_tool = require("./tool");
+const console = (0, import_tool.defineTabTool)({
+  capability: "core",
+  schema: {
+    name: "browser_console_messages",
+    title: "Get console messages",
+    description: "Returns all console messages",
+    inputSchema: import_bundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (tab, params, response) => {
+    tab.consoleMessages().map((message) => response.addResult(message.toString()));
+  }
+});
+var console_default = [
+  console
+];

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

@@ -0,0 +1,55 @@
+"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 dialogs_exports = {};
+__export(dialogs_exports, {
+  default: () => dialogs_default
+});
+module.exports = __toCommonJS(dialogs_exports);
+var import_bundle = require("../../sdk/bundle");
+var import_tool = require("./tool");
+const handleDialog = (0, import_tool.defineTabTool)({
+  capability: "core",
+  schema: {
+    name: "browser_handle_dialog",
+    title: "Handle a dialog",
+    description: "Handle a dialog",
+    inputSchema: import_bundle.z.object({
+      accept: import_bundle.z.boolean().describe("Whether to accept the dialog."),
+      promptText: import_bundle.z.string().optional().describe("The text of the prompt in case of a prompt dialog.")
+    }),
+    type: "destructive"
+  },
+  handle: async (tab, params, response) => {
+    response.setIncludeSnapshot();
+    const dialogState = tab.modalStates().find((state) => state.type === "dialog");
+    if (!dialogState)
+      throw new Error("No dialog visible");
+    tab.clearModalState(dialogState);
+    await tab.waitForCompletion(async () => {
+      if (params.accept)
+        await dialogState.dialog.accept(params.promptText);
+      else
+        await dialogState.dialog.dismiss();
+    });
+  },
+  clearsModalState: "dialog"
+});
+var dialogs_default = [
+  handleDialog
+];

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

@@ -0,0 +1,70 @@
+"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 evaluate_exports = {};
+__export(evaluate_exports, {
+  default: () => evaluate_default
+});
+module.exports = __toCommonJS(evaluate_exports);
+var import_bundle = require("../../sdk/bundle");
+var import_tool = require("./tool");
+var javascript = __toESM(require("../codegen"));
+var import_utils = require("./utils");
+const evaluateSchema = import_bundle.z.object({
+  function: import_bundle.z.string().describe("() => { /* code */ } or (element) => { /* code */ } when element is provided"),
+  element: import_bundle.z.string().optional().describe("Human-readable element description used to obtain permission to interact with the element"),
+  ref: import_bundle.z.string().optional().describe("Exact target element reference from the page snapshot")
+});
+const evaluate = (0, import_tool.defineTabTool)({
+  capability: "core",
+  schema: {
+    name: "browser_evaluate",
+    title: "Evaluate JavaScript",
+    description: "Evaluate JavaScript expression on page or element",
+    inputSchema: evaluateSchema,
+    type: "destructive"
+  },
+  handle: async (tab, params, response) => {
+    response.setIncludeSnapshot();
+    let locator;
+    if (params.ref && params.element) {
+      locator = await tab.refLocator({ ref: params.ref, element: params.element });
+      response.addCode(`await page.${await (0, import_utils.generateLocator)(locator)}.evaluate(${javascript.quote(params.function)});`);
+    } else {
+      response.addCode(`await page.evaluate(${javascript.quote(params.function)});`);
+    }
+    await tab.waitForCompletion(async () => {
+      const receiver = locator ?? tab.page;
+      const result = await receiver._evaluateFunction(params.function);
+      response.addResult(JSON.stringify(result, null, 2) || "undefined");
+    });
+  }
+});
+var evaluate_default = [
+  evaluate
+];