patchright-core 1.58.2 → 1.59.1

package/lib/tools/backend/tracing.js

@@ -0,0 +1,78 @@
+"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 tracing_exports = {};
+__export(tracing_exports, {
+  default: () => tracing_default
+});
+module.exports = __toCommonJS(tracing_exports);
+var import_zodBundle = require("../../zodBundle");
+var import_tool = require("./tool");
+const tracingStart = (0, import_tool.defineTool)({
+  capability: "devtools",
+  schema: {
+    name: "browser_start_tracing",
+    title: "Start tracing",
+    description: "Start trace recording",
+    inputSchema: import_zodBundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    const browserContext = await context.ensureBrowserContext();
+    const tracesDir = await context.outputFile({ prefix: "", suggestedFilename: `traces`, ext: "" }, { origin: "code" });
+    const name = "trace-" + Date.now();
+    await browserContext.tracing.start({
+      name,
+      screenshots: true,
+      snapshots: true,
+      live: true
+    });
+    response.addTextResult(`Trace recording started`);
+    response.addFileLink("Action log", `${tracesDir}/${name}.trace`);
+    response.addFileLink("Network log", `${tracesDir}/${name}.network`);
+    response.addFileLink("Resources", `${tracesDir}/resources`);
+    browserContext.tracing[traceLegendSymbol] = { tracesDir, name };
+  }
+});
+const tracingStop = (0, import_tool.defineTool)({
+  capability: "devtools",
+  schema: {
+    name: "browser_stop_tracing",
+    title: "Stop tracing",
+    description: "Stop trace recording",
+    inputSchema: import_zodBundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    const browserContext = await context.ensureBrowserContext();
+    await browserContext.tracing.stop();
+    const traceLegend = browserContext.tracing[traceLegendSymbol];
+    if (!traceLegend)
+      throw new Error("Tracing is not started");
+    delete browserContext.tracing[traceLegendSymbol];
+    response.addTextResult(`Trace recording stopped.`);
+    response.addFileLink("Trace", `${traceLegend.tracesDir}/${traceLegend.name}.trace`);
+    response.addFileLink("Network log", `${traceLegend.tracesDir}/${traceLegend.name}.network`);
+    response.addFileLink("Resources", `${traceLegend.tracesDir}/resources`);
+  }
+});
+var tracing_default = [
+  tracingStart,
+  tracingStop
+];
+const traceLegendSymbol = Symbol("tracesDir");

package/lib/tools/backend/utils.js

@@ -0,0 +1,83 @@
+"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, {
+  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;
+}
+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 = {
+  eventWaiter,
+  waitForCompletion
+});

package/lib/tools/backend/verify.js

@@ -0,0 +1,151 @@
+"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_zodBundle = require("../../zodBundle");
+var import_stringUtils = require("../../utils/isomorphic/stringUtils");
+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_zodBundle.z.object({
+      role: import_zodBundle.z.string().describe('ROLE of the element. Can be found in the snapshot like this: `- {ROLE} "Accessible Name":`'),
+      accessibleName: import_zodBundle.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) => {
+    for (const frame of tab.page.frames()) {
+      const locator = frame.getByRole(params.role, { name: params.accessibleName });
+      if (await locator.count() > 0) {
+        const resolved = await locator.normalize();
+        response.addCode(`await expect(page.${resolved}).toBeVisible();`);
+        response.addTextResult("Done");
+        return;
+      }
+    }
+    response.addError(`Element with role "${params.role}" and accessible name "${params.accessibleName}" not found`);
+  }
+});
+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_zodBundle.z.object({
+      text: import_zodBundle.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) => {
+    for (const frame of tab.page.frames()) {
+      const locator = frame.getByText(params.text).filter({ visible: true });
+      if (await locator.count() > 0) {
+        const resolved = await locator.normalize();
+        response.addCode(`await expect(page.${resolved}).toBeVisible();`);
+        response.addTextResult("Done");
+        return;
+      }
+    }
+    response.addError("Text not found");
+  }
+});
+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_zodBundle.z.object({
+      element: import_zodBundle.z.string().describe("Human-readable list description"),
+      ref: import_zodBundle.z.string().describe("Exact target element reference that points to the list"),
+      selector: import_zodBundle.z.string().optional().describe('CSS or role selector for the target list, when "ref" is not available.'),
+      items: import_zodBundle.z.array(import_zodBundle.z.string()).describe("Items to verify")
+    }),
+    type: "assertion"
+  },
+  handle: async (tab, params, response) => {
+    const { locator } = await tab.refLocator({ ref: params.ref, selector: params.selector, 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(tab.expectTimeoutOptions));
+    }
+    const ariaSnapshot = `\`
+- list:
+${itemTexts.map((t) => `  - listitem: ${(0, import_stringUtils.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_zodBundle.z.object({
+      type: import_zodBundle.z.enum(["textbox", "checkbox", "radio", "combobox", "slider"]).describe("Type of the element"),
+      element: import_zodBundle.z.string().describe("Human-readable element description"),
+      ref: import_zodBundle.z.string().describe("Exact target element reference from the page snapshot"),
+      selector: import_zodBundle.z.string().optional().describe('CSS or role selector for the target element, when "ref" is not available'),
+      value: import_zodBundle.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, selector: params.selector, element: params.element });
+    const locatorSource = `page.${resolved}`;
+    if (params.type === "textbox" || params.type === "slider" || params.type === "combobox") {
+      const value = await locator.inputValue(tab.expectTimeoutOptions);
+      if (value !== params.value) {
+        response.addError(`Expected value "${params.value}", but got "${value}"`);
+        return;
+      }
+      response.addCode(`await expect(${locatorSource}).toHaveValue(${(0, import_stringUtils.escapeWithQuotes)(params.value)});`);
+    } else if (params.type === "checkbox" || params.type === "radio") {
+      const value = await locator.isChecked(tab.expectTimeoutOptions);
+      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/tools/backend/video.js

@@ -0,0 +1,98 @@
+"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 video_exports = {};
+__export(video_exports, {
+  default: () => video_default
+});
+module.exports = __toCommonJS(video_exports);
+var import_zodBundle = require("../../zodBundle");
+var import_tool = require("./tool");
+const videoStart = (0, import_tool.defineTool)({
+  capability: "devtools",
+  schema: {
+    name: "browser_start_video",
+    title: "Start video",
+    description: "Start video recording",
+    inputSchema: import_zodBundle.z.object({
+      filename: import_zodBundle.z.string().optional().describe("Filename to save the video."),
+      size: import_zodBundle.z.object({
+        width: import_zodBundle.z.number().describe("Video width"),
+        height: import_zodBundle.z.number().describe("Video height")
+      }).optional().describe("Video size")
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    const resolvedFile = await response.resolveClientFile({ prefix: "video", ext: "webm", suggestedFilename: params.filename }, "Video");
+    await context.startVideoRecording(resolvedFile.fileName, { size: params.size });
+    response.addTextResult("Video recording started.");
+  }
+});
+const videoStop = (0, import_tool.defineTool)({
+  capability: "devtools",
+  schema: {
+    name: "browser_stop_video",
+    title: "Stop video",
+    description: "Stop video recording",
+    inputSchema: import_zodBundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    const fileNames = await context.stopVideoRecording();
+    if (!fileNames.length) {
+      response.addTextResult("No videos were recorded.");
+      return;
+    }
+    for (const fileName of fileNames) {
+      const resolvedFile = await response.resolveClientFile({
+        prefix: "video",
+        ext: "webm",
+        suggestedFilename: fileName
+      }, "Video");
+      await response.addFileResult(resolvedFile, null);
+    }
+  }
+});
+const videoChapter = (0, import_tool.defineTool)({
+  capability: "devtools",
+  schema: {
+    name: "browser_video_chapter",
+    title: "Video chapter",
+    description: "Add a chapter marker to the video recording. Shows a full-screen chapter card with blurred backdrop.",
+    inputSchema: import_zodBundle.z.object({
+      title: import_zodBundle.z.string().describe("Chapter title"),
+      description: import_zodBundle.z.string().optional().describe("Chapter description"),
+      duration: import_zodBundle.z.number().optional().describe("Duration in milliseconds to show the chapter card")
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params, response) => {
+    const tab = context.currentTabOrDie();
+    await tab.page.screencast.showChapter(params.title, {
+      description: params.description,
+      duration: params.duration
+    });
+    response.addTextResult(`Chapter '${params.title}' added.`);
+  }
+});
+var video_default = [
+  videoStart,
+  videoStop,
+  videoChapter
+];

package/lib/tools/backend/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_zodBundle = require("../../zodBundle");
+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_zodBundle.z.object({
+      time: import_zodBundle.z.number().optional().describe("The time to wait in seconds"),
+      text: import_zodBundle.z.string().optional().describe("The text to wait for"),
+      textGone: import_zodBundle.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
+];