brave-real-launcher 1.2.31 → 1.2.33

package/.github/workflows/chrome-launcher-sync.yml

@@ -3,8 +3,8 @@ name: Chrome Launcher Sync & Publish
 on:
   # Automatic triggers
   schedule:
-    # Weekly trigger - Every Monday at 6 AM UTC (11:30 AM IST)
-    - cron: '0 6 * * 1'
+    # Daily trigger - Every day at 6 AM UTC (11:30 AM IST)
+    - cron: '0 6 * * *'
   
   # Manual trigger
   workflow_dispatch:

package/README.md

@@ -2,14 +2,17 @@
 
 Launch Brave Browser with ease from Node.js. Based on [chrome-launcher](https://github.com/GoogleChrome/chrome-launcher) but specifically adapted for Brave Browser with additional features.
 
-## Features
+## ✨ Features
 
 - 🦁 **Brave Browser Detection**: Automatically detects Brave Browser installations across all platforms
 - 🖥️ **Multi-Platform Support**: Linux (x64/ARM64), macOS (Intel/Apple Silicon), Windows (x64/ARM64)
 - 🐧 **Xvfb Support**: Built-in Xvfb support for headless operation on Linux
 - 🎯 **Launch Modes**: Headless mode, GUI mode, or automatic detection
 - 🔄 **Auto-Sync**: Automatically syncs with chrome-launcher updates while preserving Brave-specific features
-- 🛠️ **Full API Compatibility**: Drop-in replacement for chrome-launcher but for Brave
+- 📦 **uBlock Origin**: Automatic download and loading of uBlock Origin ad blocker
+- 🛡️ **Stealth Mode**: Anti-bot-detection capabilities for automation
+- ⬇️ **Auto-Install**: Automatically install Brave if not present (Windows/Linux/macOS)
+- 🔇 **P3A Disabled**: Private analytics notifications disabled by default
 
 ## Installation
 
@@ -22,18 +25,49 @@ npm install brave-real-launcher
 ```javascript
 const { launch } = require('brave-real-launcher');
 
-// Launch Brave in headless mode
+// Basic launch
 const brave = await launch({
-  braveFlags: ['--headless', '--disable-gpu'],
+  startingUrl: 'https://example.com',
   logLevel: 'info'
 });
 
 console.log('Brave is running on port', brave.port);
-
-// Kill Brave
 brave.kill();
 ```
 
+### With uBlock Origin Ad Blocker
+
+```javascript
+const brave = await launch({
+  startingUrl: 'https://example.com',
+  autoLoadUBlock: true,  // Auto-downloads and loads uBlock Origin
+  logLevel: 'info'
+});
+
+console.log('Extensions loaded:', brave.extensions);
+```
+
+### With Stealth Mode (Anti-Bot Detection)
+
+```javascript
+const brave = await launch({
+  startingUrl: 'https://example.com',
+  enableStealth: true,  // Enables stealth mode
+  autoLoadUBlock: true,
+  logLevel: 'info'
+});
+```
+
+### Auto-Install Brave (if not present)
+
+```javascript
+const brave = await launch({
+  startingUrl: 'https://example.com',
+  autoInstall: true,  // Auto-installs Brave if not found
+  logLevel: 'info'
+});
+```
+
 ## API
 
 ### `launch(options)`
@@ -41,115 +75,131 @@ brave.kill();
 Launches Brave Browser with the specified options.
 
 **Options:**
-- `bravePath?: string` - Path to Brave executable (auto-detected if not provided)
-- `braveFlags?: string[]` - Array of Brave flags to pass
-- `launchMode?: 'auto' | 'headless' | 'gui'` - Launch mode (default: 'auto')
-- `enableXvfb?: boolean` - Enable Xvfb on Linux (default: false)
-- `xvfbOptions?: XvfbOptions` - Xvfb configuration options
-- `port?: number` - Debug port (default: random)
-- `userDataDir?: string | boolean` - User data directory
-- `startingUrl?: string` - URL to navigate to on start
-- And more options compatible with chrome-launcher
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `bravePath` | `string` | auto-detected | Path to Brave executable |
+| `braveFlags` | `string[]` | `[]` | Array of Brave flags to pass |
+| `startingUrl` | `string` | `about:blank` | URL to navigate to on start |
+| `port` | `number` | random | Debug port |
+| `userDataDir` | `string\|boolean` | temp dir | User data directory |
+| `launchMode` | `'auto'\|'headless'\|'gui'` | `'auto'` | Launch mode |
+| `enableXvfb` | `boolean` | `false` | Enable Xvfb on Linux |
+| `autoLoadUBlock` | `boolean` | `false` | Auto-load uBlock Origin |
+| `enableStealth` | `boolean` | `false` | Enable stealth mode |
+| `autoInstall` | `boolean` | `false` | Auto-install Brave if not found |
+| `userAgent` | `string` | default | Custom user agent |
+| `logLevel` | `'verbose'\|'info'\|'error'\|'silent'` | `'silent'` | Log level |
+
+**Returns:** `LaunchedBrave` object with:
+- `pid`: Process ID
+- `port`: Debug port
+- `process`: Child process
+- `extensions`: Loaded extensions info
+- `kill()`: Function to kill browser
 
 ### `getBravePath()`
 
 Returns the path to the Brave Browser executable.
 
-### `XvfbManager`
+### `BraveInstaller`
 
-Manages Xvfb virtual display for headless environments.
+Programmatic Brave installation:
 
 ```javascript
-const { XvfbManager } = require('brave-real-launcher');
+const { BraveInstaller } = require('brave-real-launcher');
 
-const xvfb = new XvfbManager({
-  display: ':99',
-  width: 1920,
-  height: 1080
-});
+const installer = new BraveInstaller();
+const result = await installer.install();
+
+if (result.success) {
+  console.log('Installed at:', result.bravePath);
+}
+```
+
+### `ExtensionManager`
 
-await xvfb.start();
-// ... use Brave
-await xvfb.stop();
+Manage extensions:
+
+```javascript
+const { ExtensionManager } = require('brave-real-launcher');
+
+const manager = new ExtensionManager();
+const ublock = await manager.getUBlockOrigin();
+console.log('uBlock version:', ublock.version);
 ```
 
 ## Platform Support
 
-### Linux
-- x64 and ARM64 architectures
-- Detects installations in standard paths: `/opt/brave.com/brave/`, `/usr/bin/brave-browser`, etc.
-- Supports Flatpak and Snap installations
-- Built-in Xvfb support for headless environments
+### Auto-Install Behavior
 
-### macOS  
-- Intel and Apple Silicon (M1/M2) support
-- Detects Brave Browser, Brave Browser Beta, Nightly, and Dev versions
-- Standard installation paths in `/Applications/`
+| Platform | Method | Skip if Installed |
+|----------|--------|-------------------|
+| **Windows** | Downloads installer, runs silently | ✅ Yes |
+| **Linux** | apt/dnf/yum/pacman | ✅ Yes |
+| **macOS** | Downloads DMG, mounts & copies | ✅ Yes |
 
-### Windows
-- x64 and ARM64 support  
-- Registry-based detection
-- Standard installation paths in Program Files and Local AppData
+### Path Detection
 
-## Environment Variables
+| Platform | Detection Paths |
+|----------|-----------------|
+| **Windows** | `%LOCALAPPDATA%\BraveSoftware\...`, `%PROGRAMFILES%\...` |
+| **Linux** | `/usr/bin/brave-browser`, `/opt/brave.com/brave/...`, Flatpak, Snap |
+| **macOS** | `/Applications/Brave Browser.app/...` |
 
-- `BRAVE_PATH`: Path to Brave executable
-- `HEADLESS`: Force headless mode when set
-- `DISPLAY`: X11 display (Linux)
+## Testing
 
-## Examples
+```bash
+# Install dependencies
+npm install
 
-### Headless Mode with Xvfb
-```javascript
-const brave = await launch({
-  launchMode: 'headless',
-  enableXvfb: true,
-  xvfbOptions: { width: 1920, height: 1080 }
-});
-```
+# Build project
+npm run build
 
-### Custom Flags
-```javascript  
-const brave = await launch({
-  braveFlags: [
-    '--no-sandbox',
-    '--disable-dev-shm-usage',
-    '--disable-gpu'
-  ]
-});
-```
+# Run tests
+npm test
 
-### Auto-Detection
-```javascript
-const brave = await launch({
-  launchMode: 'auto', // Automatically detects headless vs GUI environment
-  logLevel: 'verbose'
-});
+# Test Brave detection
+npm run test:detection
+
+# Test with uBlock Origin
+node -e "const {launch} = require('./dist'); launch({autoLoadUBlock:true, startingUrl:'https://example.com', logLevel:'info'}).then(b => setTimeout(() => b.kill(), 5000))"
 ```
 
-## Development
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `BRAVE_PATH` | Path to Brave executable |
+| `HEADLESS` | Force headless mode when set |
+| `DISPLAY` | X11 display (Linux) |
 
-### Building
+## Development
 
 ```bash
-npm run build
-```
+# Clone repository
+git clone https://github.com/user/brave-real-launcher.git
+cd brave-real-launcher
 
-### Testing
+# Install dependencies
+npm install
 
-```bash
-npm test
+# Build
+npm run build
+
+# Run CI tests
+npm run test:ci
 ```
 
 ## Auto-Sync with chrome-launcher
 
-This project automatically syncs with chrome-launcher updates while preserving Brave-specific functionality. The GitHub Action workflow:
+This project automatically syncs with chrome-launcher updates while preserving Brave-specific functionality:
 
-- Checks for chrome-launcher updates daily
-- Automatically integrates compatible changes
-- Preserves Brave-specific browser detection and features
-- Runs comprehensive tests across all supported platforms
-- Publishes updated versions to npm
+- ✅ Checks for chrome-launcher updates **daily**
+- ✅ Automatically integrates compatible changes
+- ✅ Preserves Brave-specific browser detection
+- ✅ Runs comprehensive tests
+- ✅ Publishes to npm automatically
 
 ## License
 

package/dist/brave-installer.d.ts

@@ -0,0 +1,57 @@
+export interface InstallerOptions {
+    silent?: boolean;
+    downloadDir?: string;
+    channel?: 'release' | 'beta' | 'nightly';
+}
+export interface InstallResult {
+    success: boolean;
+    bravePath?: string;
+    error?: string;
+}
+export declare class BraveInstaller {
+    private silent;
+    private downloadDir;
+    private channel;
+    constructor(options?: InstallerOptions);
+    /**
+     * Install Brave browser on the current platform
+     */
+    install(): Promise<InstallResult>;
+    /**
+     * Install Brave on Windows
+     */
+    private installWindows;
+    /**
+     * Install Brave on Linux
+     */
+    private installLinux;
+    /**
+     * Install Brave on macOS
+     */
+    private installMacOS;
+    /**
+     * Download file from URL
+     */
+    private downloadFile;
+    /**
+     * Detect Linux package manager
+     */
+    private detectLinuxPackageManager;
+    /**
+     * Find Brave on Windows
+     */
+    private findBraveWindows;
+    /**
+     * Find Brave on Linux
+     */
+    private findBraveLinux;
+    /**
+     * Delay helper
+     */
+    private delay;
+    /**
+     * Check if Brave is installed
+     */
+    static isInstalled(): boolean;
+}
+export default BraveInstaller;