antibotbrowser 1.0.9 → 3.0.0

package/README.md

@@ -1,74 +1,99 @@
-# Usage
-## 1 - First let's start by installing the module
-```
-npm install antibotbrowser
-
-```
-
-## 2 - Let's include our module in our project
-```js
-const antibotbrowser = require("antibotbrowser");
-```
-
-## 3 - And let's run our browser
-```js
-  var antibrowser = await antibotbrowser.startbrowser(9222);
-  //OR HİDE MOD (headless / no-sandbox) Mode Open browser
-  var antibrowser = await antibotbrowser.startbrowser_hide(9222);
-```
-
-## END - Connect the browser to puppeteer with websocket
-```js
-const antibotbrowser = require("antibotbrowser");
-const puppeteer = require('puppeteer');
-
-(async () => { 
-
-   const antibrowser = await antibotbrowser.startbrowser(9222);  
-
-    const browser = await puppeteer.connect({browserWSEndpoint: antibrowser.websokcet});
-
-   // Normal use from now on
-    const page = await browser.newPage();    
-
-    await page.setViewport({width:0, height:0});
-
-    page.goto("https://google.com")
-
-})();
-
-```
-
-## Example uses
-1-
-```js
-const antibotbrowser = require("antibotbrowser");
-const puppeteer = require('puppeteer');
-(async () => { 
-
-   const antibrowser = await antibotbrowser.startbrowser();  // We start the browser with default settings. Port: 9222 Url: google.com
-
-    const browser = await puppeteer.connect({browserWSEndpoint: antibrowser.websokcet}); // We connect the launched browser to puppeteer. With the variable we created above, it gives the web socket url to puppetter with antibotbrowser.websocket  .
-
-   // Normal use from now on
-    const page = await browser.newPage();    
-
-    await page.setViewport({width:0, height:0});
-
-    page.goto("https://google.com")
-
-})();
-```
-
-## Arguments
-```js
-    antibotbrowser.startbrowser(port, url);  
-    // port: The debugging port is the debugging port of the chromium browser. There can be 1 browser on the same port number, so you can add it as an argument. By default, if you enter nothing, the port is 9222. 
-
-    // url: The first page address on browser startup. If you leave it blank, it defaults to google.com.
-    
-    // Examples
-    antibotbrowser.startbrowser(9223, "https://github.com");  
-    antibotbrowser.startbrowser(9222, "https://google.com");  
-    // note do not start 2 scanners on the same port!!!
-```
+# Usage
+> This library is designed to behave like a real browser, allowing you to bypass **Cloudflare Challenges** and other bot verification systems that often block traditional automated tools.
+> This is for educational purposes only. Bypassing systems like bot verification may be illegal. User responsibility lies with the user.
+> **Note:** This package is compatible with **Puppeteer**, **Playwright**, and any other automation framework that supports the Chrome DevTools Protocol (CDP).
+## 1 - First let's start by installing the module
+```
+npm install antibotbrowser
+```
+
+## 2 - Let's include our module in our project
+```js
+const antibotbrowser = require("antibotbrowser");
+```
+
+## 3 - And let's run our browser
+```js
+  // Default use (Port: 9222)
+  var antibrowser = await antibotbrowser.startbrowser(9222);
+
+  // Advanced use with options
+  var antibrowser = await antibotbrowser.startbrowser({
+    port: 9222, // Default: 9222 (Optional)
+    userdata: true, // persistent profile (Default: true) (Optional)
+    headless: true, // headless mode (Default: false) (Optional)
+    nosandbox: true // no-sandbox mode (Default: false) (Optional)
+  });
+```
+
+> If `userdata` is `true`, the browser will use a persistent profile to save your session (cookies, history, etc.). If `false`, it will use a temporary profile that is deleted when the browser is closed.
+
+## END - Connect the browser to puppeteer with websocket
+```js
+const antibotbrowser = require("antibotbrowser");
+const puppeteer = require('puppeteer');
+
+(async () => { 
+
+   const antibrowser = await antibotbrowser.startbrowser({
+       port: 9222,
+       headless: false
+   });  
+
+    const browser = await puppeteer.connect({browserWSEndpoint: antibrowser.websokcet});
+
+   // Normal use from now on
+    const page = await browser.newPage();    
+
+    await page.setViewport({width:0, height:0});
+
+    await page.goto("https://www.nokersoft.com")
+
+})();
+```
+
+## Example uses
+```js
+const antibotbrowser = require("antibotbrowser");
+const puppeteer = require('puppeteer');
+(async () => { 
+
+   const antibrowser = await antibotbrowser.startbrowser(9222);  // We start the browser with settings Port: 9222
+
+    const browser = await puppeteer.connect({browserWSEndpoint: antibrowser.websokcet}); // We connect the launched browser to puppeteer.
+
+   // Normal use from now on
+    const page = await browser.newPage();    
+
+    await page.setViewport({width:0, height:0});
+
+    await page.goto("https://www.nokersoft.com")
+
+})();
+```
+
+## Troubleshooting and General Information
+- **Linux / Server Usage:** If you are running on a Linux server without a GUI (e.g., Ubuntu Server), you must use the `headless: true` option.
+- **Root User:** If you are running the script as a `root` user, Chromium may fail to start due to security restrictions. In this case, use the `nosandbox: true` option.
+- **Port Conflicts:** If the default port `9222` is already in use by another application, you can specify a different port using the `port` option (e.g., `9333`).
+- **Dependencies:** Ensure that your system has the necessary dependencies installed for Chromium to run (especially on minimal Linux distributions).
+
+### Usage with Playwright
+```js
+const { chromium } = require('playwright');
+const antibotbrowser = require("antibotbrowser");
+
+(async () => {
+   const antibrowser = await antibotbrowser.startbrowser(9222);
+   
+   // Connect Playwright to the launched browser via CDP
+   const browser = await chromium.connectOverCDP(`http://localhost:9222`);
+   
+   const context = browser.contexts()[0];
+   const page = context.pages()[0] || await context.newPage();
+   
+   await page.goto("https://www.nokersoft.com");
+   
+   console.log("Page title:", await page.title());
+})();
+```

package/index.js

@@ -1,72 +1,68 @@
-const chromium = require('chromium');
-const {execFile} = require('child_process');
-var request = require('sync-request');
-const fs = require('fs');
-const { start } = require('repl');
-
-// github.com/reloxe
-// nokersoft.com
-
-versioncehck();
-async function versioncehck() {
-    var versioncheck = await request('GET', `https://registry.npmjs.org/antibotbrowser/latest`);
-    if (JSON.parse(versioncheck.getBody())['version'] != JSON.parse(fs.readFileSync(__dirname + '/package.json'))['version']) {
-        console.log("[Notification] AntiBotBrowser New Version Available !");
-    }
-}
-
-
-const delay = ms => new Promise(resolve => setTimeout(resolve, ms))
-
-async function startbrowser_hide(port) {
-   return new Promise(async(resolve, reject) => {
-    
-        try {
-      
-      execFile(chromium.path, ['--remote-debugging-port=' + port, '--headless', '--no-sandbox'], (err) => {
-        if (err) { }
-    });
-        await delay(4000);
-        var res = await request('GET', `http://127.0.0.1:${port}/json/version`);
-        veri = await JSON.parse(res.getBody())
-        useragent = await veri["User-Agent"];
-        websokcet = await veri["webSocketDebuggerUrl"];
-
-        resolve( { useragent, websokcet } )
-
-        } catch (error) {
-           startbrowser_hide(port);
-        }
-
-})
-}
-
-
-async function startbrowser(port) {
-    return new Promise(async(resolve, reject) => {
-     
-         try {
- 
-       execFile(chromium.path, ['--remote-debugging-port=' + port], (err) => {
-         if (err) { }
-     });
-         await delay(4000);
-         var res = await request('GET', `http://127.0.0.1:${port}/json/version`);
-         veri = await JSON.parse(res.getBody())
-         useragent = await veri["User-Agent"];
-         websokcet = await veri["webSocketDebuggerUrl"];
-         
-         resolve( { useragent, websokcet } )
-
-         
-         } catch (error) {
-            startbrowser(port);
-         }
- 
- })
- }
-
-module.exports = {
-    startbrowser_hide,
-    startbrowser
+const chromium = require('chromium');
+const { execFile } = require('child_process');
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+// github.com/reloxe
+// nokersoft.com
+
+versioncehck();
+async function versioncehck() {
+    try {
+        var versioncheck = await fetch(`https://registry.npmjs.org/antibotbrowser/latest`);
+        var versionBody = await versioncheck.text();
+        if (JSON.parse(versionBody)['version'] != JSON.parse(fs.readFileSync(__dirname + '/package.json'))['version']) {
+            console.log("[Notification] AntiBotBrowser New Version Available !");
+        }
+    } catch (e) { }
+}
+
+const delay = ms => new Promise(resolve => setTimeout(resolve, ms))
+
+async function startbrowser(options) {
+    const port = (typeof options === 'object' ? options.port : options) || 9222;
+    const userdata = (typeof options === 'object' ? options.userdata : false) || false;
+    const headless = (typeof options === 'object' ? options.headless : false) || false;
+    const nosandbox = (typeof options === 'object' ? options.nosandbox : false) || false;
+
+    const profileName = userdata ? `antibot_profile_persistent` : `antibot_profile_${Date.now()}`;
+    const baseDir = path.join(__dirname, 'antibot_profiles');
+    if (!fs.existsSync(baseDir)) {
+        fs.mkdirSync(baseDir, { recursive: true });
+    }
+    const tempProfile = path.join(baseDir, profileName);
+
+    var args = [
+        '--remote-debugging-port=' + port,
+        '--user-data-dir=' + tempProfile
+    ];
+
+    if (headless) { args.push('--headless'); }
+    if (nosandbox) { args.push('--no-sandbox'); }
+
+    try {
+        execFile(chromium.path, args, (err) => {
+            if (err) { }
+        });
+    } catch (e) { }
+
+    while (true) {
+        try {
+            var res = await fetch(`http://127.0.0.1:${port}/json/version`);
+            if (res.status === 200) {
+                var resBody = await res.text();
+                var veri = JSON.parse(resBody);
+                var useragent = veri["User-Agent"];
+                var websokcet = veri["webSocketDebuggerUrl"];
+                return { useragent, websokcet };
+            }
+        } catch (error) { }
+        await delay(300);
+    }
+}
+
+module.exports = {
+    startbrowser
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "antibotbrowser",
-  "version": "1.0.9",
+  "version": "3.0.0",
   "readme": "README.md",
   "description": "Opening Chromium opens a real browser without bot validations in automated systems like Puppetter. To avoid problems in places like Cloudflare",
   "main": "index.js",
@@ -10,7 +10,6 @@
   "author": "By Nokersoftware | nokersoft.com",
   "license": "ISC",
   "dependencies": {
-    "chromium": "^3.0.3",
-    "sync-request": "^6.1.0"
+    "chromium": "3.0.3"
   }
-}
+}