phantomwright-driver 1.58.0

package/README.md

@@ -0,0 +1,240 @@
+<h1 align="center">
+    🎭 Patchright NodeJS
+</h1>
+
+
+<p align="center">
+    <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/License-Apache%202.0-green">
+    </a>
+    <a>
+        <img src="https://img.shields.io/badge/Based%20on-Playwright-goldenrod">
+    </a>
+    <a>
+        <img src="https://img.shields.io/badge/Driver-Patched-blue">
+    </a>
+    <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml">
+        <img src="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml/badge.svg">
+    </a>
+    <br/>
+    <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases/latest">
+        <img alt="Patchright Version" src="https://img.shields.io/github/v/release/microsoft/playwright?display_name=release&label=Version">
+    </a>
+    <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs">
+        <img src="https://img.shields.io/badge/Package-NodeJS-seagreen">
+    </a>
+    <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases">
+        <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/npm/d18m/patchright?color=red">
+    </a>
+</p>
+
+#### Patchright is a patched and undetected version of the Playwright Testing and Automation Framework. </br> It can be used as a drop-in replacement for Playwright.
+
+> [!NOTE]  
+> This repository serves the Patchright-NodeJS Package. To use Patchright with Python, check out the [Python Package](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python).
+> Also check out the main [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright)
+
+---
+
+<details open>
+    <summary><h3>Sponsors</h1></summary>
+
+ <a href="https://hyperbrowser.ai/"><img alt="Hyperbrowser Banner Ad" src="https://github.com/user-attachments/assets/7132b07b-8543-4381-9b9d-02f706f5db4b" width="80%"/></a>
+ </br>
+If you’re looking for a high-performance browser automation platform checkout [**Hyperbrowser**](https://hyperbrowser.ai/). It’s ideal for AI Agents, large-scale web scraping and automated testing. </br>
+[**Hyperbrowser**](https://hyperbrowser.ai/) delivers cloud-based browser infrastructure that scales instantly from a few sessions to thousands, with built-in CAPTCHA solving, stealth fingerprinting, and a global proxy network. It integrates seamlessly with Puppeteer, Playwright, and Selenium, so you can be up and running in minutes, no server or proxy management required.
+
+Key Features:
+- **Instant scaling**: Launch 1,000+ concurrent browsers
+- **Captcha Solving**: Handles reCAPTCHA, Cloudflare, AWS, and more
+- **Stealth mode**: Dynamic, human-like fingerprints for undetectable automation
+- **Global proxy network**: 170+ countries with rotation and geo-targeting
+- **Built-in debugging**: Live view and session replay for real-time monitoring
+- **1-line integration**: Works with Puppeteer, Playwright, Selenium in Node.js or Python
+
+👉 Learn more at [**hyperbrowser.ai**](https://hyperbrowser.ai/)
+
+</details>
+
+---
+
+## Install it from NPM
+
+```bash
+# Install Phantomwright-Driver from NPM
+npm i phantomwright-driver
+```
+
+```bash
+# Install Chromium-Driver for Phantomwright-Driver
+npx patchright install chromium
+```
+
+---
+
+## Usage
+#### Just change the import and use it like playwright. Patchright is a drop-in-replacement for Playwright!
+
+> [!IMPORTANT]  
+> Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.
+
+```js
+// phantomwright-driver here!
+const { chromium } = require('phantomwright-driver');
+
+(async () => {
+  const browser = await chromium.launch();
+  const page = await browser.newPage();
+  await page.goto('http://example.com');
+  // other actions...
+  await browser.close();
+})();
+```
+
+### Best Practice  - use Chrome without Fingerprint Injection
+
+To be completely undetected, use the following configuration:
+```js
+chromium.launchPersistentContext("...", {
+    channel: "chrome",
+    headless: false,
+    viewport: null,
+    // do NOT add custom browser headers or userAgent
+});
+```
+
+> [!NOTE]
+> We recommend using Google Chrome instead of Chromium.
+> You can install it via `npx patchright install chrome` (or via any other installation method) and use it with `channel: "chrome"`.
+
+
+---
+
+## Patches
+
+### [Runtime.enable](https://vanilla.aslushnikov.com/?Runtime.enable) Leak
+This is the biggest Patch Patchright uses. To avoid detection by this leak, patchright avoids using [Runtime.enable](https://vanilla.aslushnikov.com/?Runtime.enable) by executing Javascript in (isolated) ExecutionContexts.
+
+### [Console.enable](https://vanilla.aslushnikov.com/?Console.enable) Leak
+Patchright patches this leak by disabling the Console API all together. This means, console functionality will not work in Patchright. If you really need the console, you might be better off using Javascript loggers, although they also can be easily detected.
+
+### Command Flags Leaks
+Patchright tweaks the Playwright Default Args to avoid detection by Command Flag Leaks. This (most importantly) affects:
+- `--disable-blink-features=AutomationControlled` (added) to avoid navigator.webdriver detection.
+- `--enable-automation` (removed) to avoid navigator.webdriver detection.
+- `--disable-popup-blocking` (removed) to avoid popup crashing.
+- `--disable-component-update` (removed) to avoid detection as a Stealth Driver.
+- `--disable-default-apps` (removed) to enable default apps.
+- `--disable-extensions` (removed) to enable extensions
+
+### General Leaks
+Patchright patches some general leaks in the Playwright codebase. This mainly includes poor setups and obvious detection points.
+
+### Closed Shadow Roots
+Patchright is able to interact with elements in Closed Shadow Roots. Just use normal locators and Patchright will do the rest.
+<br/>
+Patchright is now also able to use XPaths in Closed Shadow Roots.
+
+---
+
+## Stealth
+
+With the right setup, Patchright currently is considered undetectable.
+Patchright passes:
+- [Brotector](https://kaliiiiiiiiii.github.io/brotector/) ✅ (with [CDP-Patches](https://github.com/Kaliiiiiiiiii-Vinyzu/CDP-Patches/))
+- [Cloudflare](https://cloudflare.com/) ✅
+- [Kasada](https://www.kasada.io/) ✅
+- [Akamai](https://www.akamai.com/products/bot-manager/) ✅
+- [Shape/F5](https://www.f5.com/) ✅
+- [Bet365](https://bet365.com/) ✅
+- [Datadome](https://datadome.co/products/bot-protection/) ✅
+- [Fingerprint.com](https://fingerprint.com/products/bot-detection/) ✅
+- [CreepJS](https://abrahamjuliot.github.io/creepjs/) ✅
+- [Sannysoft](https://bot.sannysoft.com/) ✅
+- [Incolumitas](https://bot.incolumitas.com/) ✅
+- [IPHey](https://iphey.com/) ✅
+- [Browserscan](https://browserscan.net/) ✅
+- [Pixelscan](https://pixelscan.net/) ✅
+
+---
+
+## Documentation and API Reference
+See the original [Playwright Documentation](https://playwright.dev/docs/intro) and [API Reference](https://playwright.dev/docs/api/class-playwright)
+
+## Extended Patchright API
+#### **`evaluate`** Method <sub>([`Frame.evaluate`](https://playwright.dev/docs/api/class-frame#frame-evaluate), [`Page.evaluate`](https://playwright.dev/docs/api/class-page#page-evaluate),  [`Locator.evaluate`](https://playwright.dev/docs/api/class-locator#locator-evaluate),  [`Worker.evaluate`](https://playwright.dev/docs/api/class-worker#worker-evaluate),  [`JSHandle.evaluate`](https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate))</sub>
+- Added `isolatedContext`  to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
+```diff
+object.evaluate(
+    pageFunction: Function | string,
+    arg?: Arg,
+    ...,
++   isolatedContext: boolean = true
+)
+```
+
+#### **`evaluateHandle`** Method <sub>([`Frame.evaluateHandle`](https://playwright.dev/docs/api/class-frame#frame-evaluate-handle), [`Page.evaluateHandle`](https://playwright.dev/docs/api/class-page#page-evaluate-handle), [`Locator.evaluateHandle`](https://playwright.dev/docs/api/class-locator#locator-evaluate-handle), [`Worker.evaluateHandle`](https://playwright.dev/docs/api/class-worker#worker-evaluate-handle), [`JSHandle.evaluateHandle`](https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate-handle))</sub>
+- Added `isolatedContext`  to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
+```diff
+object.evaluateHandle(
+    pageFunction: Function | string,
+    arg?: Arg,
+    ...,
++   isolatedContext: boolean = true
+)
+```
+
+#### **`evaluateAll`** Method <sub>([`Locator.evaluateAll`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all))</sub>
+- Added `isolated_context`  to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `True`)
+```diff
+Locator.evaluateAll(
+    pageFunction: Function | string,
+    arg?: Arg,
+    ...,
++   isolatedContext: boolean = true
+)
+```
+
+---
+
+## Bugs
+#### The bugs are documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#bugs).
+
+---
+
+### TODO
+#### The TODO is documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#todo).
+
+
+---
+
+## Development
+
+Deployment of new Patchright versions are automatic, but bugs due to Playwright codebase changes may occur. Fixes for these bugs might take a few days to be released. 
+
+---
+
+## Support our work
+
+If you choose to support our work, please contact [@vinyzu](https://discord.com/users/935224495126487150) or [@steve_abcdef](https://discord.com/users/936292409426477066) on Discord.
+
+---
+
+## Copyright and License
+© [Vinyzu](https://github.com/Vinyzu/)
+
+Patchright is licensed [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)
+
+---
+
+## Disclaimer
+
+This repository is provided for **educational purposes only**. \
+No warranties are provided regarding accuracy, completeness, or suitability for any purpose. **Use at your own risk**—the authors and maintainers assume **no liability** for **any damages**, **legal issues**, or **warranty breaches** resulting from use, modification, or distribution of this code.\
+**Any misuse or legal violations are the sole responsibility of the user**. 
+
+---
+
+## Authors
+
+#### Active Maintainer: [Vinyzu](https://github.com/Vinyzu/) </br> Co-Maintainer: [Kaliiiiiiiiii](https://github.com/kaliiiiiiiiii/)