real-browser-mcp-server 1.3.3 → 1.4.0

package/.github/ISSUE_TEMPLATE/general_issue.yaml

@@ -1,58 +0,0 @@
-name: Report Issue
-description: Please use this to report any issue
-labels: [triage]
-assignees:
-  - zfcsoftware
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Please take care to fill in all fields. Recreating the issue will speed up its resolution. Thank you for contributing to the betterment of the library by reporting issues.
-  - type: textarea
-    id: issue-detail
-    attributes:
-      label: Description
-      description: Please describe the problem you are experiencing. You only need to provide information about the problem in this field.
-    validations:
-      required: true
-  - type: textarea
-    id: issue-recreate
-    attributes:
-      label: Full steps to reproduce the issue
-      description: Please provide a full working code to reproduce the issue. Make sure that the code you provide is directly executable. This step is very important to resolve the issue.
-    validations:
-      required: true
-  - type: dropdown
-    id: issue-type
-    attributes:
-      label: Issue Type
-      description: What type of issue would you like to report?
-      multiple: true
-      options:
-        - Bug
-        - Build/Install
-        - Performance
-        - Support
-        - Feature Request
-        - Documentation Request
-        - Others
-  - type: dropdown
-    id: Operating-System
-    attributes:
-      label: Operating System
-      description: What OS are you seeing the issue in? If you don't see your OS listed, please provide more details in the "Description" section above.
-      multiple: true
-      options:
-        - Windows 10
-        - Linux
-        - Mac OS
-        - Other
-  - type: dropdown
-    id: use-type
-    attributes:
-      label: Do you use Docker?
-      description: Are you running it with Docker or on your local computer?
-      multiple: false
-      options:
-        - Docker
-        - I don't use Docker

package/.github/SETUP.md

@@ -1,111 +0,0 @@
-# 🔧 GitHub Actions Setup Guide
-
-यह गाइड बताएगी कि GitHub Actions workflow को कैसे setup करना है।
-
-## 🔐 Required Secrets
-
-आपको अपनी GitHub repository में निम्नलिखित secrets को add करना होगा:
-
-### 1. GH_TOKEN
-- **Purpose**: Repository access और GitHub releases के लिए
-- **कैसे बनाएं**:
-  1. GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
-  2. "Generate new token (classic)" पर click करें
-  3. निम्नलिखित permissions select करें:
-     - `repo` (Full control of private repositories)
-     - `write:packages` (Write packages to GitHub Package Registry)
-     - `workflow` (Update GitHub Action workflows)
-  4. Token generate करें और copy करें
-
-### 2. NPM_TOKEN
-- **Purpose**: NPM पर package publish करने के लिए
-- **कैसे बनाएं**:
-  1. NPM website पर login करें (https://www.npmjs.com/)
-  2. Profile → Access Tokens → Generate New Token
-  3. "Automation" type select करें (recommended for CI/CD)
-  4. Token generate करें और copy करें
-
-## 🛠️ Secrets को Repository में Add करना
-
-1. GitHub repository पर जाएं
-2. Settings → Secrets and variables → Actions
-3. "New repository secret" पर click करें
-4. निम्नलिखित secrets add करें:
-
-| Secret Name | Value |
-|-------------|-------|
-| `GH_TOKEN` | आपका GitHub Personal Access Token |
-| `NPM_TOKEN` | आपका NPM Automation Token |
-
-## 🚀 Workflow Usage
-
-इस project में **2 workflows** हैं:
-
-### 1. 🤖 Auto Increment & Publish (Recommended)
-**Simple Auto-Increment**: हमेशा patch version increment करता है
-
-#### Automatic Publishing:
-```bash
-# कोई भी change push करें, automatic version increment होगा:
-git commit -m "any change"
-git push origin main  # 1.5.0 → 1.5.1 → 1.5.2 → 1.5.3...
-```
-
-#### Manual Publishing:
-1. GitHub repository → Actions → "🤖 Auto Increment & Publish"
-2. "Run workflow" click करें
-3. "Publish to NPM?" = `true` रखें
-4. "Run workflow" पर click करें
-
-### 2. 🚀 Publish to NPM (Tag-based)
-Traditional tag-based publishing:
-
-```bash
-# Manual tag push के लिए
-git tag v1.5.1
-git push origin v1.5.1
-```
-
-## 🔢 Simple Auto-Increment System
-
-**Current Version**: `1.5.0`
-
-हर workflow run पर automatic patch increment:
-- `1.5.0` → `1.5.1`
-- `1.5.1` → `1.5.2` 
-- `1.5.2` → `1.5.3`
-- `1.5.3` → `1.5.4`
-- ... and so on
-
-**बिल्कुल simple!** 🚀 कोई complex commit message analysis नहीं चाहिए।
-
-## 📋 Workflow Features
-
-✅ **Automatic Triggers**: Version tags पर auto-publish  
-✅ **Manual Triggers**: GitHub UI से manual control  
-✅ **Security**: Secrets का safe उपयोग  
-✅ **Testing**: Publish से पहले automated tests  
-✅ **Version Management**: Automatic version bumping  
-✅ **GitHub Releases**: Auto-generated releases  
-✅ **Error Handling**: Comprehensive error reporting  
-✅ **Summary Reports**: Detailed workflow summaries  
-
-## 🔍 Troubleshooting
-
-### Common Issues:
-
-1. **Token Permissions**: 
-   - GH_TOKEN में सही permissions हों
-   - NPM_TOKEN "Automation" type का हो
-
-2. **Repository Access**:
-   - Repository में Actions enabled हों
-   - Secrets properly configured हों
-
-3. **Publishing Errors**:
-   - Package name conflicts check करें
-   - NPM account verified हो
-
-## 📞 Support
-
-अगर कोई issue आए तो GitHub Issues में report करें।

package/.github/workflows/publish.yml

@@ -1,135 +0,0 @@
-name: 🚀 Build, Version & Publish to NPM
-
-on:
-  push:
-    branches: [main, master]
-    paths-ignore:
-      - 'README.md'
-      - 'docs/**'
-      - '*.md'
-      - 'LICENSE.md'
-      - '.gitignore'
-
-  workflow_dispatch:
-    inputs:
-      increment_type:
-        description: '📈 Version increment type'
-        required: true
-        default: 'patch'
-        type: choice
-        options:
-          - patch
-          - minor
-          - major
-      dry_run:
-        description: '🧪 Dry run (check build/test without publishing to NPM)'
-        required: false
-        default: false
-        type: boolean
-
-jobs:
-  publish:
-    name: 🚀 Publish to NPM
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-
-    steps:
-      - name: 📥 Checkout Repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.GH_TOKEN || github.token }}
-
-      - name: 🟢 Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: ⚙️ Configure Git
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-
-      - name: 📦 Install Dependencies
-        run: npm ci || npm install
-
-      - name: 🧪 Pre-Publish Verification
-        run: |
-          echo "💡 Running basic syntax and file checks..."
-          node -c lib/cjs/index.js
-          node -c lib/esm/index.mjs
-          echo "✅ Code syntax is valid."
-
-      - name: 📈 Increment Version
-        id: versioning
-        run: |
-          # Determine the increment type (major, minor, or patch)
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            INCREMENT_TYPE="${{ github.event.inputs.increment_type }}"
-          else
-            COMMIT_MSG=$(git log -1 --pretty=%B)
-            if echo "$COMMIT_MSG" | grep -qE "\[major\]|BREAKING CHANGE"; then
-              INCREMENT_TYPE="major"
-            elif echo "$COMMIT_MSG" | grep -qE "\[minor\]|feat:"; then
-              INCREMENT_TYPE="minor"
-            else
-              INCREMENT_TYPE="patch"
-            fi
-          fi
-
-          echo "📈 Selected increment type: $INCREMENT_TYPE"
-          
-          # Bump version, commit changes and create tag
-          npm version $INCREMENT_TYPE -m "🔖 Release: v%s [skip ci]"
-          
-          # Capture new version for subsequent steps
-          NEW_VERSION=$(node -p "require('./package.json').version")
-          echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
-          echo "version=v$NEW_VERSION" >> $GITHUB_OUTPUT
-
-      - name: 🚀 Push Version Bump & Tag
-        if: github.event.inputs.dry_run != 'true'
-        run: |
-          git push origin HEAD --follow-tags
-
-      - name: 📦 Publish Package to NPM
-        if: github.event.inputs.dry_run != 'true'
-        run: |
-          npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: 📋 Create GitHub Release
-        if: github.event.inputs.dry_run != 'true'
-        run: |
-          TAG="v${{ env.NEW_VERSION }}"
-          
-          cat > release_body.md << EOF
-          ## 🚀 Real Browser MCP Server v${{ env.NEW_VERSION }}
-          
-          ### 📦 Published Packages
-          - **NPM Package**: [real-browser-mcp-server](https://www.npmjs.com/package/real-browser-mcp-server)
-          - **Stealth automation**: Powered by Patchright (undetected Playwright fork).
-          
-          ### 🛠️ Key Capabilities
-          * **Turnstile Bypass**: Solves Cloudflare Turnstile automatically.
-          * **Ad Blocker**: Integrated `@ghostery/adblocker-playwright` with binary caching.
-          * **Stealth Evasion**: Passes advanced bot checkers like CreepJS, Datadome, Pixelscan, and FingerprintJS.
-          
-          ### 📥 Installation
-          \`\`\`bash
-          npm install real-browser-mcp-server@${{ env.NEW_VERSION }}
-          \`\`\`
-          
-          ---
-          *Auto-generated with ❤️ by GitHub Actions*
-          EOF
-          
-          gh release create "$TAG" \
-            --title "Release $TAG" \
-            --notes-file release_body.md
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN || github.token }}

package/Dockerfile

@@ -1,79 +0,0 @@
-# Stage 1: Build
-FROM node:20-slim AS builder
-
-WORKDIR /app
-
-# Copy package files first for better caching
-COPY package*.json ./
-
-# Install all dependencies (including devDependencies for build)
-RUN npm ci
-
-# Copy source files
-COPY . .
-
-# Stage 2: Production
-FROM node:20-slim AS production
-
-# Install Chromium and required dependencies
-RUN apt-get update && apt-get install -y \
-    wget \
-    gnupg \
-    ca-certificates \
-    apt-transport-https \
-    chromium \
-    fonts-liberation \
-    libasound2 \
-    libatk-bridge2.0-0 \
-    libatk1.0-0 \
-    libcups2 \
-    libdbus-1-3 \
-    libdrm2 \
-    libgbm1 \
-    libgtk-3-0 \
-    libnspr4 \
-    libnss3 \
-    libxcomposite1 \
-    libxdamage1 \
-    libxfixes3 \
-    libxkbcommon0 \
-    libxrandr2 \
-    xdg-utils \
-    xvfb \
-    && rm -rf /var/lib/apt/lists/* \
-    && apt-get clean
-
-# Set Chrome binary path
-ENV CHROME_BIN=/usr/bin/chromium
-
-# Create non-root user for security
-RUN groupadd -r pptruser && useradd -r -g pptruser -G audio,video pptruser \
-    && mkdir -p /home/pptruser/Downloads \
-    && chown -R pptruser:pptruser /home/pptruser
-
-WORKDIR /app
-
-# Copy from builder stage
-COPY --from=builder /app/node_modules ./node_modules
-COPY --from=builder /app/package*.json ./
-COPY --from=builder /app/lib ./lib
-COPY --from=builder /app/test ./test
-COPY --from=builder /app/packages ./packages
-COPY --from=builder /app/typings.d.ts ./
-
-# Set ownership to non-root user
-RUN chown -R pptruser:pptruser /app
-
-# Switch to non-root user
-USER pptruser
-
-# Set headless mode for container
-ENV HEADLESS=true
-ENV NODE_ENV=production
-
-# Health check
-HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
-    CMD node -e "console.log('OK')" || exit 1
-
-# Default command: run CJS tests
-CMD ["npm", "run", "cjs_test"]

package/lib/cjs/index.js

@@ -1,321 +0,0 @@
-const { PlaywrightBlocker } = require("@ghostery/adblocker-playwright");
-const { pageController } = require("./module/pageController.js");
-
-const { chromium } = require("patchright");
-const { createCursor } = require("ghost-cursor-patchright");
-const fs = require('fs');
-const path = require('path');
-
-let adBlockerInstance = null;
-let adBlockerPromise = null;
-function getAdBlocker() {
-  if (!adBlockerPromise) {
-    const cachePath = path.join(__dirname, 'adblocker.bin');
-    adBlockerPromise = PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch, {
-      path: cachePath,
-      read: fs.promises.readFile,
-      write: fs.promises.writeFile,
-    }).then(blocker => {
-      adBlockerInstance = blocker;
-      return blocker;
-    }).catch(err => {
-      console.error('[adblocker] Failed to initialize adblocker:', err.message);
-      return null;
-    });
-  }
-  return adBlockerPromise;
-}
-
-function loadEnvFile() {
-  const envPaths = [
-    path.join(process.cwd(), '.env'),
-  ];
-
-  let currentDir = process.cwd();
-  for (let i = 0; i < 5; i++) {
-    const envPath = path.join(currentDir, '.env');
-    if (fs.existsSync(envPath) && !envPaths.includes(envPath)) {
-      envPaths.push(envPath);
-    }
-    const parentDir = path.dirname(currentDir);
-    if (parentDir === currentDir) break;
-    currentDir = parentDir;
-  }
-
-  for (const envPath of envPaths) {
-    try {
-      if (fs.existsSync(envPath)) {
-        const envContent = fs.readFileSync(envPath, 'utf-8');
-        envContent.split('\n').forEach(line => {
-          const trimmed = line.trim();
-          if (trimmed && !trimmed.startsWith('#')) {
-            const [key, ...valueParts] = trimmed.split('=');
-            const value = valueParts.join('=').replace(/^["']|["']$/g, '');
-            if (key && !process.env[key]) {
-              process.env[key] = value;
-            }
-          }
-        });
-        break;
-      }
-    } catch (error) {
-      // Silently ignore .env loading errors
-    }
-  }
-}
-
-loadEnvFile();
-
-function getDefaultHeadless() {
-  const envHeadless = (process.env.HEADLESS || '').toLowerCase();
-  return envHeadless === 'true';
-}
-
-function applyBrowserShims(browser, page) {
-  if (page._shimsApplied) return page;
-  page._shimsApplied = true;
-
-  // Enable ad blocker
-  if (adBlockerInstance) {
-    adBlockerInstance.enableBlockingInPage(page).catch(() => {});
-  } else {
-    getAdBlocker().then(blocker => {
-      if (blocker) {
-        blocker.enableBlockingInPage(page).catch(() => {});
-      }
-    });
-  }
-
-  // Cookie shims (Compatibility adapter for Playwright context)
-  if (!page.cookies) {
-    page.cookies = async (urls) => {
-      return await page.context().cookies(urls ? (Array.isArray(urls) ? urls : [urls]) : []);
-    };
-  }
-
-  if (!page.setCookie) {
-    page.setCookie = async (...cookies) => {
-      const formatted = cookies.map(c => ({
-        name: c.name,
-        value: c.value,
-        domain: c.domain || new URL(page.url()).hostname,
-        path: c.path || '/',
-        expires: c.expires || undefined,
-        httpOnly: c.httpOnly,
-        secure: c.secure,
-        sameSite: c.sameSite
-      }));
-      await page.context().addCookies(formatted);
-    };
-  }
-
-  if (!page.deleteCookie) {
-    page.deleteCookie = async (...cookies) => {
-      await page.context().clearCookies();
-    };
-  }
-
-  // Navigation shims
-  if (!page.waitForNetworkIdle) {
-    page.waitForNetworkIdle = async (options = {}) => {
-      try {
-        await page.waitForLoadState('networkidle', { timeout: options.timeout });
-      } catch (e) {
-        // Ignore networkidle timeouts if they are non-fatal
-      }
-    };
-  }
-
-  if (!page.evaluateOnNewDocument) {
-    page.evaluateOnNewDocument = async (fn, ...args) => {
-      return await page.addInitScript(fn, ...args);
-    };
-  }
-
-  // Ghost Cursor integration via ghost-cursor-patchright
-  const cursorPromise = createCursor(page).catch(err => {
-    console.error("Failed to create cursor:", err);
-    return null;
-  });
-
-  page.realCursor = {
-    move: async (selector, options = {}) => {
-      try {
-        const cursor = await cursorPromise;
-        if (cursor) {
-          await cursor.move(selector, options);
-        } else {
-          await page.hover(selector, options);
-        }
-      } catch (e) {
-        // Silently fallback if element is not found
-        try {
-          await page.hover(selector, options);
-        } catch (err) {}
-      }
-    }
-  };
-  page.realClick = async (selector, options = {}) => {
-    try {
-      const cursor = await cursorPromise;
-      if (cursor) {
-        await cursor.click(selector, options);
-      } else {
-        await page.click(selector, options);
-      }
-    } catch (e) {
-      await page.click(selector, options);
-    }
-  };
-
-  // Mouse wheel shim (Adapter for Playwright positional args)
-  if (page.mouse && page.mouse.wheel) {
-    const originalWheel = page.mouse.wheel.bind(page.mouse);
-    page.mouse.wheel = async (x, y) => {
-      if (typeof x === 'object' && x !== null) {
-        const deltaX = x.deltaX || 0;
-        const deltaY = x.deltaY || 0;
-        return await originalWheel(deltaX, deltaY);
-      }
-      return await originalWheel(x, y);
-    };
-  }
-
-  // Browser shims
-  if (!browser.process) {
-    browser.process = () => ({
-      pid: browser._childProcess?.pid || 1337
-    });
-  }
-
-  if (!browser.pages) {
-    browser.pages = async () => {
-      return browser.contexts().flatMap(c => c.pages());
-    };
-  }
-
-  return page;
-}
-
-async function connect({
-  args = [],
-  headless = getDefaultHeadless(),
-  proxy = {},
-  turnstile = false,
-  disableXvfb = false,
-} = {}) {
-  let xvfbInstance = null;
-  if (process.platform === 'linux' && !process.env.DISPLAY && !disableXvfb) {
-    try {
-      const Xvfb = require('xvfb');
-      xvfbInstance = new Xvfb({
-        silent: true,
-        xvfb_args: ['-screen', '0', '1280x1024x24', '-ac']
-      });
-      xvfbInstance.startSync();
-    } catch (err) {
-      console.error('[xvfb] Failed to start Xvfb server automatically:', err.message);
-    }
-  }
-
-  let playwrightProxy = undefined;
-  if (proxy && proxy.host && proxy.port) {
-    playwrightProxy = {
-      server: `${proxy.host}:${proxy.port}`
-    };
-    if (proxy.username && proxy.password) {
-      playwrightProxy.username = proxy.username;
-      playwrightProxy.password = proxy.password;
-    }
-  }
-
-  const chromiumArgs = [
-    '--disable-blink-features=AutomationControlled',
-    '--no-sandbox',
-    '--disable-setuid-sandbox',
-    '--window-size=1920,1080',
-    ...args
-  ];
-
-  if (headless) {
-    chromiumArgs.push(
-      '--disable-gpu',
-      '--hide-scrollbars',
-      '--mute-audio'
-    );
-  }
-
-  let browser;
-  try {
-    // Try launching using the system's real installed Google Chrome first for maximum stealth/fingerprint integrity
-    browser = await chromium.launch({
-      headless,
-      args: chromiumArgs,
-      proxy: playwrightProxy,
-      channel: 'chrome'
-    });
-    console.error('[Launch] Successfully launched using system Google Chrome channel');
-  } catch (e) {
-    // Fallback to pre-packaged Chromium if Chrome is not installed
-    browser = await chromium.launch({
-      headless,
-      args: chromiumArgs,
-      proxy: playwrightProxy
-    });
-    console.error('[Launch] Google Chrome channel not available, falling back to pre-packaged Chromium');
-  }
-
-  if (xvfbInstance) {
-    browser.on('disconnected', () => {
-      try {
-        xvfbInstance.stopSync();
-      } catch (e) {
-        console.error('[xvfb] Failed to stop Xvfb server:', e.message);
-      }
-    });
-    const originalClose = browser.close.bind(browser);
-    browser.close = async () => {
-      await originalClose();
-      try {
-        xvfbInstance.stopSync();
-      } catch (e) {
-        console.error('[xvfb] Failed to stop Xvfb server during close:', e.message);
-      }
-    };
-  }
-
-  // Ensure ad blocker is ready
-  await getAdBlocker();
-
-  const context = await browser.newContext({
-    viewport: null,
-  });
-
-  let page = await context.newPage();
-
-  applyBrowserShims(browser, page);
-
-  page = await pageController({
-    browser,
-    page,
-    proxy,
-    turnstile,
-  });
-
-  context.on('page', async (newPage) => {
-    applyBrowserShims(browser, newPage);
-    await pageController({
-      browser,
-      page: newPage,
-      proxy,
-      turnstile,
-    });
-  });
-
-  return {
-    browser,
-    page,
-  };
-}
-
-module.exports = { connect };