brave-real-playwright-core 1.0.1

package/lib/server/codegen/language.js

@@ -0,0 +1,132 @@
+"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 language_exports = {};
+__export(language_exports, {
+  fromKeyboardModifiers: () => fromKeyboardModifiers,
+  generateCode: () => generateCode,
+  sanitizeDeviceOptions: () => sanitizeDeviceOptions,
+  toClickOptionsForSourceCode: () => toClickOptionsForSourceCode,
+  toKeyboardModifiers: () => toKeyboardModifiers,
+  toSignalMap: () => toSignalMap
+});
+module.exports = __toCommonJS(language_exports);
+function generateCode(actions, languageGenerator, options) {
+  const header = languageGenerator.generateHeader(options);
+  const footer = languageGenerator.generateFooter(options.saveStorage);
+  const actionTexts = actions.map((a) => generateActionText(languageGenerator, a, !!options.generateAutoExpect)).filter(Boolean);
+  const text = [header, ...actionTexts, footer].join("\n");
+  return { header, footer, actionTexts, text };
+}
+function generateActionText(generator, action, generateAutoExpect) {
+  let text = generator.generateAction(action);
+  if (!text)
+    return;
+  if (generateAutoExpect && action.action.preconditionSelector) {
+    const expectAction = {
+      frame: action.frame,
+      startTime: action.startTime,
+      endTime: action.startTime,
+      action: {
+        name: "assertVisible",
+        selector: action.action.preconditionSelector,
+        signals: []
+      }
+    };
+    const expectText = generator.generateAction(expectAction);
+    if (expectText)
+      text = expectText + "\n\n" + text;
+  }
+  return text;
+}
+function sanitizeDeviceOptions(device, options) {
+  const cleanedOptions = {};
+  for (const property in options) {
+    if (JSON.stringify(device[property]) !== JSON.stringify(options[property]))
+      cleanedOptions[property] = options[property];
+  }
+  return cleanedOptions;
+}
+function toSignalMap(action) {
+  let popup;
+  let download;
+  let dialog;
+  for (const signal of action.signals) {
+    if (signal.name === "popup")
+      popup = signal;
+    else if (signal.name === "download")
+      download = signal;
+    else if (signal.name === "dialog")
+      dialog = signal;
+  }
+  return {
+    popup,
+    download,
+    dialog
+  };
+}
+function toKeyboardModifiers(modifiers) {
+  const result = [];
+  if (modifiers & 1)
+    result.push("Alt");
+  if (modifiers & 2)
+    result.push("ControlOrMeta");
+  if (modifiers & 4)
+    result.push("ControlOrMeta");
+  if (modifiers & 8)
+    result.push("Shift");
+  return result;
+}
+function fromKeyboardModifiers(modifiers) {
+  let result = 0;
+  if (!modifiers)
+    return result;
+  if (modifiers.includes("Alt"))
+    result |= 1;
+  if (modifiers.includes("Control"))
+    result |= 2;
+  if (modifiers.includes("ControlOrMeta"))
+    result |= 2;
+  if (modifiers.includes("Meta"))
+    result |= 4;
+  if (modifiers.includes("Shift"))
+    result |= 8;
+  return result;
+}
+function toClickOptionsForSourceCode(action) {
+  const modifiers = toKeyboardModifiers(action.modifiers);
+  const options = {};
+  if (action.button !== "left")
+    options.button = action.button;
+  if (modifiers.length)
+    options.modifiers = modifiers;
+  if (action.clickCount > 2)
+    options.clickCount = action.clickCount;
+  if (action.position)
+    options.position = action.position;
+  return options;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  fromKeyboardModifiers,
+  generateCode,
+  sanitizeDeviceOptions,
+  toClickOptionsForSourceCode,
+  toKeyboardModifiers,
+  toSignalMap
+});

package/lib/server/codegen/languages.js

@@ -0,0 +1,68 @@
+"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 languages_exports = {};
+__export(languages_exports, {
+  languageSet: () => languageSet
+});
+module.exports = __toCommonJS(languages_exports);
+var import_csharp = require("./csharp");
+var import_java = require("./java");
+var import_javascript = require("./javascript");
+var import_jsonl = require("./jsonl");
+var import_python = require("./python");
+function languageSet() {
+  return /* @__PURE__ */ new Set([
+    new import_javascript.JavaScriptLanguageGenerator(
+      /* isPlaywrightTest */
+      true
+    ),
+    new import_javascript.JavaScriptLanguageGenerator(
+      /* isPlaywrightTest */
+      false
+    ),
+    new import_python.PythonLanguageGenerator(
+      /* isAsync */
+      false,
+      /* isPytest */
+      true
+    ),
+    new import_python.PythonLanguageGenerator(
+      /* isAsync */
+      false,
+      /* isPytest */
+      false
+    ),
+    new import_python.PythonLanguageGenerator(
+      /* isAsync */
+      true,
+      /* isPytest */
+      false
+    ),
+    new import_csharp.CSharpLanguageGenerator("mstest"),
+    new import_csharp.CSharpLanguageGenerator("nunit"),
+    new import_csharp.CSharpLanguageGenerator("library"),
+    new import_java.JavaLanguageGenerator("junit"),
+    new import_java.JavaLanguageGenerator("library"),
+    new import_jsonl.JsonlLanguageGenerator()
+  ]);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  languageSet
+});

package/lib/server/codegen/python.js

@@ -0,0 +1,277 @@
+"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 python_exports = {};
+__export(python_exports, {
+  PythonLanguageGenerator: () => PythonLanguageGenerator
+});
+module.exports = __toCommonJS(python_exports);
+var import_language = require("./language");
+var import_utils = require("../../utils");
+var import_deviceDescriptors = require("../deviceDescriptors");
+class PythonLanguageGenerator {
+  constructor(isAsync, isPyTest) {
+    this.groupName = "Python";
+    this.highlighter = "python";
+    this.id = isPyTest ? "python-pytest" : isAsync ? "python-async" : "python";
+    this.name = isPyTest ? "Pytest" : isAsync ? "Library Async" : "Library";
+    this._isAsync = isAsync;
+    this._isPyTest = isPyTest;
+    this._awaitPrefix = isAsync ? "await " : "";
+    this._asyncPrefix = isAsync ? "async " : "";
+  }
+  generateAction(actionInContext) {
+    const action = actionInContext.action;
+    if (this._isPyTest && (action.name === "openPage" || action.name === "closePage"))
+      return "";
+    const pageAlias = actionInContext.frame.pageAlias;
+    const formatter = new PythonFormatter(4);
+    if (action.name === "openPage") {
+      formatter.add(`${pageAlias} = ${this._awaitPrefix}context.new_page()`);
+      if (action.url && action.url !== "about:blank" && action.url !== "chrome://newtab/")
+        formatter.add(`${this._awaitPrefix}${pageAlias}.goto(${quote(action.url)})`);
+      return formatter.format();
+    }
+    const locators = actionInContext.frame.framePath.map((selector) => `.${this._asLocator(selector)}.content_frame`);
+    const subject = `${pageAlias}${locators.join("")}`;
+    const signals = (0, import_language.toSignalMap)(action);
+    if (signals.dialog)
+      formatter.add(`  ${pageAlias}.once("dialog", lambda dialog: dialog.dismiss())`);
+    let code = `${this._awaitPrefix}${this._generateActionCall(subject, actionInContext)}`;
+    if (signals.popup) {
+      code = `${this._asyncPrefix}with ${pageAlias}.expect_popup() as ${signals.popup.popupAlias}_info {
+        ${code}
+      }
+      ${signals.popup.popupAlias} = ${this._awaitPrefix}${signals.popup.popupAlias}_info.value`;
+    }
+    if (signals.download) {
+      code = `${this._asyncPrefix}with ${pageAlias}.expect_download() as download${signals.download.downloadAlias}_info {
+        ${code}
+      }
+      download${signals.download.downloadAlias} = ${this._awaitPrefix}download${signals.download.downloadAlias}_info.value`;
+    }
+    formatter.add(code);
+    return formatter.format();
+  }
+  _generateActionCall(subject, actionInContext) {
+    const action = actionInContext.action;
+    switch (action.name) {
+      case "openPage":
+        throw Error("Not reached");
+      case "closePage":
+        return `${subject}.close()`;
+      case "click": {
+        let method = "click";
+        if (action.clickCount === 2)
+          method = "dblclick";
+        const options = (0, import_language.toClickOptionsForSourceCode)(action);
+        const optionsString = formatOptions(options, false);
+        return `${subject}.${this._asLocator(action.selector)}.${method}(${optionsString})`;
+      }
+      case "check":
+        return `${subject}.${this._asLocator(action.selector)}.check()`;
+      case "uncheck":
+        return `${subject}.${this._asLocator(action.selector)}.uncheck()`;
+      case "fill":
+        return `${subject}.${this._asLocator(action.selector)}.fill(${quote(action.text)})`;
+      case "setInputFiles":
+        return `${subject}.${this._asLocator(action.selector)}.set_input_files(${formatValue(action.files.length === 1 ? action.files[0] : action.files)})`;
+      case "press": {
+        const modifiers = (0, import_language.toKeyboardModifiers)(action.modifiers);
+        const shortcut = [...modifiers, action.key].join("+");
+        return `${subject}.${this._asLocator(action.selector)}.press(${quote(shortcut)})`;
+      }
+      case "navigate":
+        return `${subject}.goto(${quote(action.url)})`;
+      case "select":
+        return `${subject}.${this._asLocator(action.selector)}.select_option(${formatValue(action.options.length === 1 ? action.options[0] : action.options)})`;
+      case "assertText":
+        return `expect(${subject}.${this._asLocator(action.selector)}).${action.substring ? "to_contain_text" : "to_have_text"}(${quote(action.text)})`;
+      case "assertChecked":
+        return `expect(${subject}.${this._asLocator(action.selector)}).${action.checked ? "to_be_checked()" : "not_to_be_checked()"}`;
+      case "assertVisible":
+        return `expect(${subject}.${this._asLocator(action.selector)}).to_be_visible()`;
+      case "assertValue": {
+        const assertion = action.value ? `to_have_value(${quote(action.value)})` : `to_be_empty()`;
+        return `expect(${subject}.${this._asLocator(action.selector)}).${assertion};`;
+      }
+      case "assertSnapshot":
+        return `expect(${subject}.${this._asLocator(action.selector)}).to_match_aria_snapshot(${quote(action.ariaSnapshot)})`;
+    }
+  }
+  _asLocator(selector) {
+    return (0, import_utils.asLocator)("python", selector);
+  }
+  generateHeader(options) {
+    const formatter = new PythonFormatter();
+    const recordHar = options.contextOptions.recordHar;
+    if (this._isPyTest) {
+      const contextOptions = formatContextOptions(
+        options.contextOptions,
+        options.deviceName,
+        true
+        /* asDict */
+      );
+      const fixture = contextOptions ? `
+
+@pytest.fixture(scope="session")
+def browser_context_args(browser_context_args, playwright) {
+    return {${contextOptions}}
+}
+` : "";
+      formatter.add(`${options.deviceName || contextOptions ? "import pytest\n" : ""}import re
+from playwright.sync_api import Page, expect
+${fixture}
+
+def test_example(page: Page) -> None {`);
+      if (recordHar)
+        formatter.add(`    page.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === "string" ? `, url=${quote(recordHar.urlFilter)}` : ""})`);
+    } else if (this._isAsync) {
+      formatter.add(`
+import asyncio
+import re
+from playwright.async_api import Playwright, async_playwright, expect
+
+
+async def run(playwright: Playwright) -> None {
+    browser = await playwright.${options.browserName}.launch(${formatOptions(options.launchOptions, false)})
+    context = await browser.new_context(${formatContextOptions(options.contextOptions, options.deviceName)})`);
+      if (recordHar)
+        formatter.add(`    await context.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === "string" ? `, url=${quote(recordHar.urlFilter)}` : ""})`);
+    } else {
+      formatter.add(`
+import re
+from playwright.sync_api import Playwright, sync_playwright, expect
+
+
+def run(playwright: Playwright) -> None {
+    browser = playwright.${options.browserName}.launch(${formatOptions(options.launchOptions, false)})
+    context = browser.new_context(${formatContextOptions(options.contextOptions, options.deviceName)})`);
+      if (recordHar)
+        formatter.add(`    context.route_from_har(${quote(recordHar.path)}${typeof recordHar.urlFilter === "string" ? `, url=${quote(recordHar.urlFilter)}` : ""})`);
+    }
+    return formatter.format();
+  }
+  generateFooter(saveStorage) {
+    if (this._isPyTest) {
+      return "";
+    } else if (this._isAsync) {
+      const storageStateLine = saveStorage ? `
+    await context.storage_state(path=${quote(saveStorage)})` : "";
+      return `
+    # ---------------------${storageStateLine}
+    await context.close()
+    await browser.close()
+
+
+async def main() -> None:
+    async with async_playwright() as playwright:
+        await run(playwright)
+
+
+asyncio.run(main())
+`;
+    } else {
+      const storageStateLine = saveStorage ? `
+    context.storage_state(path=${quote(saveStorage)})` : "";
+      return `
+    # ---------------------${storageStateLine}
+    context.close()
+    browser.close()
+
+
+with sync_playwright() as playwright:
+    run(playwright)
+`;
+    }
+  }
+}
+function formatValue(value) {
+  if (value === false)
+    return "False";
+  if (value === true)
+    return "True";
+  if (value === void 0)
+    return "None";
+  if (Array.isArray(value))
+    return `[${value.map(formatValue).join(", ")}]`;
+  if (typeof value === "string")
+    return quote(value);
+  if (typeof value === "object")
+    return JSON.stringify(value);
+  return String(value);
+}
+function formatOptions(value, hasArguments, asDict) {
+  const keys = Object.keys(value).filter((key) => value[key] !== void 0).sort();
+  if (!keys.length)
+    return "";
+  return (hasArguments ? ", " : "") + keys.map((key) => {
+    if (asDict)
+      return `"${(0, import_utils.toSnakeCase)(key)}": ${formatValue(value[key])}`;
+    return `${(0, import_utils.toSnakeCase)(key)}=${formatValue(value[key])}`;
+  }).join(", ");
+}
+function formatContextOptions(options, deviceName, asDict) {
+  options = { ...options, recordHar: void 0 };
+  const device = deviceName && import_deviceDescriptors.deviceDescriptors[deviceName];
+  if (!device)
+    return formatOptions(options, false, asDict);
+  return `**playwright.devices[${quote(deviceName)}]` + formatOptions((0, import_language.sanitizeDeviceOptions)(device, options), true, asDict);
+}
+class PythonFormatter {
+  constructor(offset = 0) {
+    this._lines = [];
+    this._baseIndent = " ".repeat(4);
+    this._baseOffset = " ".repeat(offset);
+  }
+  prepend(text) {
+    this._lines = text.trim().split("\n").map((line) => line.trim()).concat(this._lines);
+  }
+  add(text) {
+    this._lines.push(...text.trim().split("\n").map((line) => line.trim()));
+  }
+  newLine() {
+    this._lines.push("");
+  }
+  format() {
+    let spaces = "";
+    const lines = [];
+    this._lines.forEach((line) => {
+      if (line === "")
+        return lines.push(line);
+      if (line === "}") {
+        spaces = spaces.substring(this._baseIndent.length);
+        return;
+      }
+      line = spaces + line;
+      if (line.endsWith("{")) {
+        spaces += this._baseIndent;
+        line = line.substring(0, line.length - 1).trimEnd() + ":";
+      }
+      return lines.push(this._baseOffset + line);
+    });
+    return lines.join("\n");
+  }
+}
+function quote(text) {
+  return (0, import_utils.escapeWithQuotes)(text, '"');
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PythonLanguageGenerator
+});

package/lib/server/codegen/types.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 types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/lib/server/console.js

@@ -0,0 +1,53 @@
+"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, {
+  ConsoleMessage: () => ConsoleMessage
+});
+module.exports = __toCommonJS(console_exports);
+class ConsoleMessage {
+  constructor(page, type, text, args, location) {
+    this._page = page;
+    this._type = type;
+    this._text = text;
+    this._args = args;
+    this._location = location || { url: "", lineNumber: 0, columnNumber: 0 };
+  }
+  page() {
+    return this._page;
+  }
+  type() {
+    return this._type;
+  }
+  text() {
+    if (this._text === void 0)
+      this._text = this._args.map((arg) => arg.preview()).join(" ");
+    return this._text;
+  }
+  args() {
+    return this._args;
+  }
+  location() {
+    return this._location;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConsoleMessage
+});