patchright-bun 1.58.0 → 1.58.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/README.md +225 -225
  2. package/ThirdPartyNotices.txt +5041 -5041
  3. package/cli.js +19 -19
  4. package/index.d.ts +17 -17
  5. package/index.js +17 -17
  6. package/index.mjs +18 -18
  7. package/jsx-runtime.js +42 -42
  8. package/jsx-runtime.mjs +21 -21
  9. package/lib/agents/agentParser.js +89 -89
  10. package/lib/agents/copilot-setup-steps.yml +34 -34
  11. package/lib/agents/generateAgents.js +348 -348
  12. package/lib/agents/playwright-test-coverage.prompt.md +31 -31
  13. package/lib/agents/playwright-test-generate.prompt.md +8 -8
  14. package/lib/agents/playwright-test-generator.agent.md +88 -88
  15. package/lib/agents/playwright-test-heal.prompt.md +6 -6
  16. package/lib/agents/playwright-test-healer.agent.md +55 -55
  17. package/lib/agents/playwright-test-plan.prompt.md +9 -9
  18. package/lib/agents/playwright-test-planner.agent.md +73 -73
  19. package/lib/common/config.js +282 -282
  20. package/lib/common/configLoader.js +344 -344
  21. package/lib/common/esmLoaderHost.js +104 -104
  22. package/lib/common/expectBundle.js +28 -28
  23. package/lib/common/expectBundleImpl.js +407 -407
  24. package/lib/common/fixtures.js +302 -302
  25. package/lib/common/globals.js +58 -58
  26. package/lib/common/ipc.js +60 -60
  27. package/lib/common/poolBuilder.js +85 -85
  28. package/lib/common/process.js +132 -132
  29. package/lib/common/suiteUtils.js +140 -140
  30. package/lib/common/test.js +321 -321
  31. package/lib/common/testLoader.js +101 -101
  32. package/lib/common/testType.js +298 -298
  33. package/lib/common/validators.js +68 -68
  34. package/lib/fsWatcher.js +67 -67
  35. package/lib/index.js +726 -726
  36. package/lib/internalsForTest.js +42 -42
  37. package/lib/isomorphic/events.js +77 -77
  38. package/lib/isomorphic/folders.js +30 -30
  39. package/lib/isomorphic/stringInternPool.js +69 -69
  40. package/lib/isomorphic/teleReceiver.js +521 -521
  41. package/lib/isomorphic/teleSuiteUpdater.js +157 -157
  42. package/lib/isomorphic/testServerConnection.js +225 -225
  43. package/lib/isomorphic/testServerInterface.js +16 -16
  44. package/lib/isomorphic/testTree.js +329 -329
  45. package/lib/isomorphic/types.d.js +16 -16
  46. package/lib/loader/loaderMain.js +59 -59
  47. package/lib/matchers/expect.js +311 -311
  48. package/lib/matchers/matcherHint.js +44 -44
  49. package/lib/matchers/matchers.js +383 -383
  50. package/lib/matchers/toBeTruthy.js +75 -75
  51. package/lib/matchers/toEqual.js +100 -100
  52. package/lib/matchers/toHaveURL.js +101 -101
  53. package/lib/matchers/toMatchAriaSnapshot.js +159 -159
  54. package/lib/matchers/toMatchSnapshot.js +342 -342
  55. package/lib/matchers/toMatchText.js +99 -99
  56. package/lib/mcp/browser/browserContextFactory.js +329 -329
  57. package/lib/mcp/browser/browserServerBackend.js +84 -84
  58. package/lib/mcp/browser/config.js +421 -421
  59. package/lib/mcp/browser/context.js +244 -244
  60. package/lib/mcp/browser/response.js +278 -278
  61. package/lib/mcp/browser/sessionLog.js +75 -75
  62. package/lib/mcp/browser/tab.js +343 -343
  63. package/lib/mcp/browser/tools/common.js +65 -65
  64. package/lib/mcp/browser/tools/console.js +46 -46
  65. package/lib/mcp/browser/tools/dialogs.js +60 -60
  66. package/lib/mcp/browser/tools/evaluate.js +61 -61
  67. package/lib/mcp/browser/tools/files.js +58 -58
  68. package/lib/mcp/browser/tools/form.js +63 -63
  69. package/lib/mcp/browser/tools/install.js +72 -72
  70. package/lib/mcp/browser/tools/keyboard.js +107 -107
  71. package/lib/mcp/browser/tools/mouse.js +107 -107
  72. package/lib/mcp/browser/tools/navigate.js +71 -71
  73. package/lib/mcp/browser/tools/network.js +63 -63
  74. package/lib/mcp/browser/tools/open.js +57 -57
  75. package/lib/mcp/browser/tools/pdf.js +49 -49
  76. package/lib/mcp/browser/tools/runCode.js +78 -78
  77. package/lib/mcp/browser/tools/screenshot.js +93 -93
  78. package/lib/mcp/browser/tools/snapshot.js +173 -173
  79. package/lib/mcp/browser/tools/tabs.js +67 -67
  80. package/lib/mcp/browser/tools/tool.js +47 -47
  81. package/lib/mcp/browser/tools/tracing.js +74 -74
  82. package/lib/mcp/browser/tools/utils.js +94 -94
  83. package/lib/mcp/browser/tools/verify.js +143 -143
  84. package/lib/mcp/browser/tools/wait.js +63 -63
  85. package/lib/mcp/browser/tools.js +84 -84
  86. package/lib/mcp/browser/watchdog.js +44 -44
  87. package/lib/mcp/config.d.js +16 -16
  88. package/lib/mcp/extension/cdpRelay.js +351 -351
  89. package/lib/mcp/extension/extensionContextFactory.js +76 -76
  90. package/lib/mcp/extension/protocol.js +28 -28
  91. package/lib/mcp/index.js +61 -61
  92. package/lib/mcp/log.js +35 -35
  93. package/lib/mcp/program.js +111 -111
  94. package/lib/mcp/sdk/exports.js +28 -28
  95. package/lib/mcp/sdk/http.js +152 -152
  96. package/lib/mcp/sdk/inProcessTransport.js +71 -71
  97. package/lib/mcp/sdk/server.js +223 -223
  98. package/lib/mcp/sdk/tool.js +47 -47
  99. package/lib/mcp/terminal/cli.js +296 -296
  100. package/lib/mcp/terminal/command.js +56 -56
  101. package/lib/mcp/terminal/commands.js +333 -333
  102. package/lib/mcp/terminal/daemon.js +129 -129
  103. package/lib/mcp/terminal/help.json +31 -31
  104. package/lib/mcp/terminal/helpGenerator.js +88 -88
  105. package/lib/mcp/terminal/socketConnection.js +80 -80
  106. package/lib/mcp/test/browserBackend.js +98 -98
  107. package/lib/mcp/test/generatorTools.js +122 -122
  108. package/lib/mcp/test/plannerTools.js +145 -145
  109. package/lib/mcp/test/seed.js +82 -82
  110. package/lib/mcp/test/streams.js +44 -44
  111. package/lib/mcp/test/testBackend.js +99 -99
  112. package/lib/mcp/test/testContext.js +285 -285
  113. package/lib/mcp/test/testTool.js +30 -30
  114. package/lib/mcp/test/testTools.js +108 -108
  115. package/lib/plugins/gitCommitInfoPlugin.js +198 -198
  116. package/lib/plugins/index.js +28 -28
  117. package/lib/plugins/webServerPlugin.js +237 -237
  118. package/lib/program.js +417 -417
  119. package/lib/reporters/base.js +634 -634
  120. package/lib/reporters/blob.js +138 -138
  121. package/lib/reporters/dot.js +99 -99
  122. package/lib/reporters/empty.js +32 -32
  123. package/lib/reporters/github.js +128 -128
  124. package/lib/reporters/html.js +633 -633
  125. package/lib/reporters/internalReporter.js +138 -138
  126. package/lib/reporters/json.js +254 -254
  127. package/lib/reporters/junit.js +232 -232
  128. package/lib/reporters/line.js +131 -131
  129. package/lib/reporters/list.js +253 -253
  130. package/lib/reporters/listModeReporter.js +69 -69
  131. package/lib/reporters/markdown.js +144 -144
  132. package/lib/reporters/merge.js +558 -558
  133. package/lib/reporters/multiplexer.js +112 -112
  134. package/lib/reporters/reporterV2.js +102 -102
  135. package/lib/reporters/teleEmitter.js +317 -317
  136. package/lib/reporters/versions/blobV1.js +16 -16
  137. package/lib/runner/dispatcher.js +530 -530
  138. package/lib/runner/failureTracker.js +72 -72
  139. package/lib/runner/lastRun.js +77 -77
  140. package/lib/runner/loadUtils.js +334 -334
  141. package/lib/runner/loaderHost.js +89 -89
  142. package/lib/runner/processHost.js +180 -180
  143. package/lib/runner/projectUtils.js +241 -241
  144. package/lib/runner/rebase.js +189 -189
  145. package/lib/runner/reporters.js +138 -138
  146. package/lib/runner/sigIntWatcher.js +96 -96
  147. package/lib/runner/storage.js +91 -91
  148. package/lib/runner/taskRunner.js +127 -127
  149. package/lib/runner/tasks.js +410 -410
  150. package/lib/runner/testGroups.js +125 -125
  151. package/lib/runner/testRunner.js +398 -398
  152. package/lib/runner/testServer.js +269 -269
  153. package/lib/runner/uiModeReporter.js +30 -30
  154. package/lib/runner/vcs.js +72 -72
  155. package/lib/runner/watchMode.js +396 -396
  156. package/lib/runner/workerHost.js +104 -104
  157. package/lib/third_party/pirates.js +62 -62
  158. package/lib/third_party/tsconfig-loader.js +103 -103
  159. package/lib/transform/babelBundle.js +46 -46
  160. package/lib/transform/babelBundleImpl.js +461 -461
  161. package/lib/transform/compilationCache.js +274 -274
  162. package/lib/transform/esmLoader.js +103 -103
  163. package/lib/transform/md.js +221 -221
  164. package/lib/transform/portTransport.js +67 -67
  165. package/lib/transform/transform.js +303 -303
  166. package/lib/util.js +400 -400
  167. package/lib/utilsBundle.js +50 -50
  168. package/lib/utilsBundleImpl.js +103 -103
  169. package/lib/worker/fixtureRunner.js +262 -262
  170. package/lib/worker/testInfo.js +536 -536
  171. package/lib/worker/testTracing.js +345 -345
  172. package/lib/worker/timeoutManager.js +174 -174
  173. package/lib/worker/util.js +31 -31
  174. package/lib/worker/workerMain.js +530 -530
  175. package/package.json +2 -2
  176. package/test.d.ts +18 -18
  177. package/test.js +24 -24
  178. package/test.mjs +34 -34
  179. package/types/test.d.ts +10251 -10251
  180. package/types/testReporter.d.ts +822 -822
package/README.md CHANGED
@@ -1,225 +1,225 @@
1
- <h1 align="center">
2
- 🎭 Patchright NodeJS
3
- </h1>
4
-
5
-
6
- <p align="center">
7
- <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/blob/main/LICENSE">
8
- <img src="https://img.shields.io/badge/License-Apache%202.0-green">
9
- </a>
10
- <a>
11
- <img src="https://img.shields.io/badge/Based%20on-Playwright-goldenrod">
12
- </a>
13
- <a>
14
- <img src="https://img.shields.io/badge/Driver-Patched-blue">
15
- </a>
16
- <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml">
17
- <img src="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml/badge.svg">
18
- </a>
19
- <br/>
20
- <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases/latest">
21
- <img alt="Patchright Version" src="https://img.shields.io/github/v/release/microsoft/playwright?display_name=release&label=Version">
22
- </a>
23
- <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs">
24
- <img src="https://img.shields.io/badge/Package-NodeJS-seagreen">
25
- </a>
26
- <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases">
27
- <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/npm/d18m/patchright?color=red">
28
- </a>
29
- </p>
30
-
31
- #### 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.
32
-
33
- > [!NOTE]
34
- > This repository serves the Patchright-NodeJS Package. To use Patchright with Python, check out the [Python Package](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python).
35
- > Also check out the main [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright)
36
-
37
- ---
38
-
39
- <details open>
40
- <summary><h3>Sponsors</h1></summary>
41
-
42
- </details>
43
-
44
- ---
45
-
46
- ## Install it from NPM
47
-
48
- ```bash
49
- # Install Patchright from NPM
50
- npm i patchright
51
- ```
52
-
53
- ```bash
54
- # Install Chromium-Driver for Patchright
55
- npx patchright install chromium
56
- ```
57
-
58
- ---
59
-
60
- ## Usage
61
- #### Just change the import and use it like playwright. Patchright is a drop-in-replacement for Playwright!
62
-
63
- > [!IMPORTANT]
64
- > Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.
65
-
66
- ```js
67
- // patchright here!
68
- const { chromium } = require('patchright');
69
-
70
- (async () => {
71
- const browser = await chromium.launch();
72
- const page = await browser.newPage();
73
- await page.goto('http://example.com');
74
- // other actions...
75
- await browser.close();
76
- })();
77
- ```
78
-
79
- ### Best Practice - use Chrome without Fingerprint Injection
80
-
81
- To be completely undetected, use the following configuration:
82
- ```js
83
- chromium.launchPersistentContext("...", {
84
- channel: "chrome",
85
- headless: false,
86
- viewport: null,
87
- // do NOT add custom browser headers or userAgent
88
- });
89
- ```
90
-
91
- > [!NOTE]
92
- > We recommend using Google Chrome instead of Chromium.
93
- > You can install it via `npx patchright install chrome` (or via any other installation method) and use it with `channel: "chrome"`.
94
-
95
-
96
- ---
97
-
98
- ## Patches
99
-
100
- ### [Runtime.enable](https://vanilla.aslushnikov.com/?Runtime.enable) Leak
101
- 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.
102
-
103
- ### [Console.enable](https://vanilla.aslushnikov.com/?Console.enable) Leak
104
- 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.
105
-
106
- ### Command Flags Leaks
107
- Patchright tweaks the Playwright Default Args to avoid detection by Command Flag Leaks. This (most importantly) affects:
108
- - `--disable-blink-features=AutomationControlled` (added) to avoid navigator.webdriver detection.
109
- - `--enable-automation` (removed) to avoid navigator.webdriver detection.
110
- - `--disable-popup-blocking` (removed) to avoid popup crashing.
111
- - `--disable-component-update` (removed) to avoid detection as a Stealth Driver.
112
- - `--disable-default-apps` (removed) to enable default apps.
113
- - `--disable-extensions` (removed) to enable extensions
114
-
115
- ### General Leaks
116
- Patchright patches some general leaks in the Playwright codebase. This mainly includes poor setups and obvious detection points.
117
-
118
- ### Closed Shadow Roots
119
- Patchright is able to interact with elements in Closed Shadow Roots. Just use normal locators and Patchright will do the rest.
120
- <br/>
121
- Patchright is now also able to use XPaths in Closed Shadow Roots.
122
-
123
- ---
124
-
125
- ## Stealth
126
-
127
- With the right setup, Patchright currently is considered undetectable.
128
- Patchright passes:
129
- - [Brotector](https://kaliiiiiiiiii.github.io/brotector/) ✅ (with [CDP-Patches](https://github.com/Kaliiiiiiiiii-Vinyzu/CDP-Patches/))
130
- - [Cloudflare](https://cloudflare.com/) ✅
131
- - [Kasada](https://www.kasada.io/) ✅
132
- - [Akamai](https://www.akamai.com/products/bot-manager/) ✅
133
- - [Shape/F5](https://www.f5.com/) ✅
134
- - [Bet365](https://bet365.com/) ✅
135
- - [Datadome](https://datadome.co/products/bot-protection/) ✅
136
- - [Fingerprint.com](https://fingerprint.com/products/bot-detection/) ✅
137
- - [CreepJS](https://abrahamjuliot.github.io/creepjs/) ✅
138
- - [Sannysoft](https://bot.sannysoft.com/) ✅
139
- - [Incolumitas](https://bot.incolumitas.com/) ✅
140
- - [IPHey](https://iphey.com/) ✅
141
- - [Browserscan](https://browserscan.net/) ✅
142
- - [Pixelscan](https://pixelscan.net/) ✅
143
-
144
- ---
145
-
146
- ## Documentation and API Reference
147
- See the original [Playwright Documentation](https://playwright.dev/docs/intro) and [API Reference](https://playwright.dev/docs/api/class-playwright)
148
-
149
- ## Extended Patchright API
150
- #### **`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>
151
- - Added `isolatedContext` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
152
- ```diff
153
- object.evaluate(
154
- pageFunction: Function | string,
155
- arg?: Arg,
156
- ...,
157
- + isolatedContext: boolean = true
158
- )
159
- ```
160
-
161
- #### **`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>
162
- - Added `isolatedContext` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
163
- ```diff
164
- object.evaluateHandle(
165
- pageFunction: Function | string,
166
- arg?: Arg,
167
- ...,
168
- + isolatedContext: boolean = true
169
- )
170
- ```
171
-
172
- #### **`evaluateAll`** Method <sub>([`Locator.evaluateAll`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all))</sub>
173
- - Added `isolated_context` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `True`)
174
- ```diff
175
- Locator.evaluateAll(
176
- pageFunction: Function | string,
177
- arg?: Arg,
178
- ...,
179
- + isolatedContext: boolean = true
180
- )
181
- ```
182
-
183
- ---
184
-
185
- ## Bugs
186
- #### The bugs are documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#bugs).
187
-
188
- ---
189
-
190
- ### TODO
191
- #### The TODO is documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#todo).
192
-
193
-
194
- ---
195
-
196
- ## Development
197
-
198
- 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.
199
-
200
- ---
201
-
202
- ## Support our work
203
-
204
- 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.
205
-
206
- ---
207
-
208
- ## Copyright and License
209
- © [Vinyzu](https://github.com/Vinyzu/)
210
-
211
- Patchright is licensed [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)
212
-
213
- ---
214
-
215
- ## Disclaimer
216
-
217
- This repository is provided for **educational purposes only**. \
218
- 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.\
219
- **Any misuse or legal violations are the sole responsibility of the user**.
220
-
221
- ---
222
-
223
- ## Authors
224
-
225
- #### Active Maintainer: [Vinyzu](https://github.com/Vinyzu/) </br> Co-Maintainer: [Kaliiiiiiiiii](https://github.com/kaliiiiiiiiii/)
1
+ <h1 align="center">
2
+ 🎭 Patchright NodeJS
3
+ </h1>
4
+
5
+
6
+ <p align="center">
7
+ <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/blob/main/LICENSE">
8
+ <img src="https://img.shields.io/badge/License-Apache%202.0-green">
9
+ </a>
10
+ <a>
11
+ <img src="https://img.shields.io/badge/Based%20on-Playwright-goldenrod">
12
+ </a>
13
+ <a>
14
+ <img src="https://img.shields.io/badge/Driver-Patched-blue">
15
+ </a>
16
+ <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml">
17
+ <img src="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python/actions/workflows/patchright_tests.yml/badge.svg">
18
+ </a>
19
+ <br/>
20
+ <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases/latest">
21
+ <img alt="Patchright Version" src="https://img.shields.io/github/v/release/microsoft/playwright?display_name=release&label=Version">
22
+ </a>
23
+ <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs">
24
+ <img src="https://img.shields.io/badge/Package-NodeJS-seagreen">
25
+ </a>
26
+ <a href="https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-nodejs/releases">
27
+ <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/npm/d18m/patchright?color=red">
28
+ </a>
29
+ </p>
30
+
31
+ #### 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.
32
+
33
+ > [!NOTE]
34
+ > This repository serves the Patchright-NodeJS Package. To use Patchright with Python, check out the [Python Package](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright-python).
35
+ > Also check out the main [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright)
36
+
37
+ ---
38
+
39
+ <details open>
40
+ <summary><h3>Sponsors</h1></summary>
41
+
42
+ </details>
43
+
44
+ ---
45
+
46
+ ## Install it from NPM
47
+
48
+ ```bash
49
+ # Install Patchright from NPM
50
+ npm i patchright
51
+ ```
52
+
53
+ ```bash
54
+ # Install Chromium-Driver for Patchright
55
+ npx patchright install chromium
56
+ ```
57
+
58
+ ---
59
+
60
+ ## Usage
61
+ #### Just change the import and use it like playwright. Patchright is a drop-in-replacement for Playwright!
62
+
63
+ > [!IMPORTANT]
64
+ > Patchright only patches CHROMIUM based browsers. Firefox and Webkit are not supported.
65
+
66
+ ```js
67
+ // patchright here!
68
+ const { chromium } = require('patchright');
69
+
70
+ (async () => {
71
+ const browser = await chromium.launch();
72
+ const page = await browser.newPage();
73
+ await page.goto('http://example.com');
74
+ // other actions...
75
+ await browser.close();
76
+ })();
77
+ ```
78
+
79
+ ### Best Practice - use Chrome without Fingerprint Injection
80
+
81
+ To be completely undetected, use the following configuration:
82
+ ```js
83
+ chromium.launchPersistentContext("...", {
84
+ channel: "chrome",
85
+ headless: false,
86
+ viewport: null,
87
+ // do NOT add custom browser headers or userAgent
88
+ });
89
+ ```
90
+
91
+ > [!NOTE]
92
+ > We recommend using Google Chrome instead of Chromium.
93
+ > You can install it via `npx patchright install chrome` (or via any other installation method) and use it with `channel: "chrome"`.
94
+
95
+
96
+ ---
97
+
98
+ ## Patches
99
+
100
+ ### [Runtime.enable](https://vanilla.aslushnikov.com/?Runtime.enable) Leak
101
+ 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.
102
+
103
+ ### [Console.enable](https://vanilla.aslushnikov.com/?Console.enable) Leak
104
+ 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.
105
+
106
+ ### Command Flags Leaks
107
+ Patchright tweaks the Playwright Default Args to avoid detection by Command Flag Leaks. This (most importantly) affects:
108
+ - `--disable-blink-features=AutomationControlled` (added) to avoid navigator.webdriver detection.
109
+ - `--enable-automation` (removed) to avoid navigator.webdriver detection.
110
+ - `--disable-popup-blocking` (removed) to avoid popup crashing.
111
+ - `--disable-component-update` (removed) to avoid detection as a Stealth Driver.
112
+ - `--disable-default-apps` (removed) to enable default apps.
113
+ - `--disable-extensions` (removed) to enable extensions
114
+
115
+ ### General Leaks
116
+ Patchright patches some general leaks in the Playwright codebase. This mainly includes poor setups and obvious detection points.
117
+
118
+ ### Closed Shadow Roots
119
+ Patchright is able to interact with elements in Closed Shadow Roots. Just use normal locators and Patchright will do the rest.
120
+ <br/>
121
+ Patchright is now also able to use XPaths in Closed Shadow Roots.
122
+
123
+ ---
124
+
125
+ ## Stealth
126
+
127
+ With the right setup, Patchright currently is considered undetectable.
128
+ Patchright passes:
129
+ - [Brotector](https://kaliiiiiiiiii.github.io/brotector/) ✅ (with [CDP-Patches](https://github.com/Kaliiiiiiiiii-Vinyzu/CDP-Patches/))
130
+ - [Cloudflare](https://cloudflare.com/) ✅
131
+ - [Kasada](https://www.kasada.io/) ✅
132
+ - [Akamai](https://www.akamai.com/products/bot-manager/) ✅
133
+ - [Shape/F5](https://www.f5.com/) ✅
134
+ - [Bet365](https://bet365.com/) ✅
135
+ - [Datadome](https://datadome.co/products/bot-protection/) ✅
136
+ - [Fingerprint.com](https://fingerprint.com/products/bot-detection/) ✅
137
+ - [CreepJS](https://abrahamjuliot.github.io/creepjs/) ✅
138
+ - [Sannysoft](https://bot.sannysoft.com/) ✅
139
+ - [Incolumitas](https://bot.incolumitas.com/) ✅
140
+ - [IPHey](https://iphey.com/) ✅
141
+ - [Browserscan](https://browserscan.net/) ✅
142
+ - [Pixelscan](https://pixelscan.net/) ✅
143
+
144
+ ---
145
+
146
+ ## Documentation and API Reference
147
+ See the original [Playwright Documentation](https://playwright.dev/docs/intro) and [API Reference](https://playwright.dev/docs/api/class-playwright)
148
+
149
+ ## Extended Patchright API
150
+ #### **`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>
151
+ - Added `isolatedContext` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
152
+ ```diff
153
+ object.evaluate(
154
+ pageFunction: Function | string,
155
+ arg?: Arg,
156
+ ...,
157
+ + isolatedContext: boolean = true
158
+ )
159
+ ```
160
+
161
+ #### **`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>
162
+ - Added `isolatedContext` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `true`)
163
+ ```diff
164
+ object.evaluateHandle(
165
+ pageFunction: Function | string,
166
+ arg?: Arg,
167
+ ...,
168
+ + isolatedContext: boolean = true
169
+ )
170
+ ```
171
+
172
+ #### **`evaluateAll`** Method <sub>([`Locator.evaluateAll`](https://playwright.dev/docs/api/class-locator#locator-evaluate-all))</sub>
173
+ - Added `isolated_context` to choose Execution Context (Main/Isolated). `Bool` (*optional*, Defaults to `True`)
174
+ ```diff
175
+ Locator.evaluateAll(
176
+ pageFunction: Function | string,
177
+ arg?: Arg,
178
+ ...,
179
+ + isolatedContext: boolean = true
180
+ )
181
+ ```
182
+
183
+ ---
184
+
185
+ ## Bugs
186
+ #### The bugs are documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#bugs).
187
+
188
+ ---
189
+
190
+ ### TODO
191
+ #### The TODO is documented in the [Patchright Driver Repository](https://github.com/Kaliiiiiiiiii-Vinyzu/patchright#todo).
192
+
193
+
194
+ ---
195
+
196
+ ## Development
197
+
198
+ 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.
199
+
200
+ ---
201
+
202
+ ## Support our work
203
+
204
+ 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.
205
+
206
+ ---
207
+
208
+ ## Copyright and License
209
+ © [Vinyzu](https://github.com/Vinyzu/)
210
+
211
+ Patchright is licensed [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)
212
+
213
+ ---
214
+
215
+ ## Disclaimer
216
+
217
+ This repository is provided for **educational purposes only**. \
218
+ 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.\
219
+ **Any misuse or legal violations are the sole responsibility of the user**.
220
+
221
+ ---
222
+
223
+ ## Authors
224
+
225
+ #### Active Maintainer: [Vinyzu](https://github.com/Vinyzu/) </br> Co-Maintainer: [Kaliiiiiiiiii](https://github.com/kaliiiiiiiiii/)