testdriverai 7.2.56 → 7.2.58

package/.github/workflows/testdriver.yml

@@ -2,168 +2,169 @@ name: TestDriver.ai Tests
 
 on:
   push:
-    branches: [ main, master ]
+    branches: [main, master]
   pull_request:
-    branches: [ main, master ]
+    branches: [main, master]
 
 jobs:
   test:
     runs-on: ubuntu-latest
-    
+
     permissions:
       contents: read
-      pull-requests: write  # Required to post comments on PRs
+      pull-requests: write # Required to post comments on PRs
 
     steps:
-    - uses: actions/checkout@v4
-
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20'
-        cache: 'npm'
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Run TestDriver.ai tests
-      env:
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
-      run: npx vitest run
-
-    - name: Upload test results
-      if: always()
-      uses: actions/upload-artifact@v4
-      with:
-        name: test-results
-        path: test-results/
-        retention-days: 30
-
-    # Init command test - only runs on PRs, not on main/master
-    - name: Create test directory for init
-      if: github.event_name == 'pull_request'
-      run: |
-        mkdir -p /tmp/test-init-project
-        cd /tmp/test-init-project
-
-    - name: Run init command (skip prompts)
-      if: github.event_name == 'pull_request'
-      working-directory: /tmp/test-init-project
-      run: |
-        # Create .env with API key first to skip the prompt
-        echo "TD_API_KEY=${{ secrets.TD_API_KEY }}" > .env
-        
-        # Run init command using the CLI from the repo
-        node ${{ github.workspace }}/bin/testdriverai.js init
-      env:
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-
-    - name: Verify project structure
-      if: github.event_name == 'pull_request'
-      working-directory: /tmp/test-init-project
-      run: |
-        echo "Checking generated files..."
-        
-        # Check for package.json
-        if [ ! -f "package.json" ]; then
-          echo "❌ package.json not found"
-          exit 1
-        fi
-        echo "✓ package.json exists"
-        
-        # Check for vitest config
-        if [ ! -f "vitest.config.js" ]; then
-          echo "❌ vitest.config.js not found"
-          exit 1
-        fi
-        echo "✓ vitest.config.js exists"
-        
-        # Check for test file
-        if [ ! -f "tests/example.test.js" ]; then
-          echo "❌ tests/example.test.js not found"
-          exit 1
-        fi
-        echo "✓ tests/example.test.js exists"
-        
-        # Check for .env file
-        if [ ! -f ".env" ]; then
-          echo "❌ .env not found"
-          exit 1
-        fi
-        echo "✓ .env exists"
-        
-        # Check for .gitignore
-        if [ ! -f ".gitignore" ]; then
-          echo "❌ .gitignore not found"
-          exit 1
-        fi
-        echo "✓ .gitignore exists"
-        
-        # Check for GitHub workflow
-        if [ ! -f ".github/workflows/testdriver.yml" ]; then
-          echo "❌ .github/workflows/testdriver.yml not found"
-          exit 1
-        fi
-        echo "✓ .github/workflows/testdriver.yml exists"
-
-    - name: Verify vitest config contents
-      if: github.event_name == 'pull_request'
-      working-directory: /tmp/test-init-project
-      run: |
-        echo "Checking vitest.config.js contents..."
-        
-        # Check for TestDriver reporter
-        if ! grep -q "TestDriver()" vitest.config.js; then
-          echo "❌ TestDriver reporter not found in vitest.config.js"
-          cat vitest.config.js
-          exit 1
-        fi
-        echo "✓ TestDriver reporter is configured"
-        
-        # Check for setupFiles
-        if ! grep -q "setupFiles.*testdriverai/vitest/setup" vitest.config.js; then
-          echo "❌ setupFiles not configured correctly"
-          cat vitest.config.js
-          exit 1
-        fi
-        echo "✓ setupFiles is configured"
-
-    - name: Verify test file contents
-      if: github.event_name == 'pull_request'
-      working-directory: /tmp/test-init-project
-      run: |
-        echo "Checking test file contents..."
-        
-        # Check for .provision usage
-        if ! grep -q "\.provision\.chrome" tests/example.test.js; then
-          echo "❌ Test does not use .provision.chrome"
-          cat tests/example.test.js
-          exit 1
-        fi
-        echo "✓ Test uses .provision.chrome"
-        
-        # Check for TestDriver import
-        if ! grep -q "from 'testdriverai/vitest/hooks'" tests/example.test.js; then
-          echo "❌ Test does not import from testdriverai/vitest/hooks"
-          cat tests/example.test.js
-          exit 1
-        fi
-        echo "✓ Test imports TestDriver from vitest/hooks"
-
-    - name: Run the generated test
-      if: github.event_name == 'pull_request'
-      working-directory: /tmp/test-init-project
-      run: npm test
-      env:
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-
-    - name: Upload init test results
-      if: always() && github.event_name == 'pull_request'
-      uses: actions/upload-artifact@v4
-      with:
-        name: test-init-results
-        path: /tmp/test-init-project/test-results/
-        retention-days: 7
-        if-no-files-found: warn
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run TestDriver.ai tests
+        env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+          TWOCAPTCHA_API_KEY: ${{ secrets.TWOCAPTCHA_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: npx vitest run
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: test-results/
+          retention-days: 30
+
+      # Init command test - only runs on PRs, not on main/master
+      - name: Create test directory for init
+        if: github.event_name == 'pull_request'
+        run: |
+          mkdir -p /tmp/test-init-project
+          cd /tmp/test-init-project
+
+      - name: Run init command (skip prompts)
+        if: github.event_name == 'pull_request'
+        working-directory: /tmp/test-init-project
+        run: |
+          # Create .env with API key first to skip the prompt
+          echo "TD_API_KEY=${{ secrets.TD_API_KEY }}" > .env
+
+          # Run init command using the CLI from the repo
+          node ${{ github.workspace }}/bin/testdriverai.js init
+        env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+
+      - name: Verify project structure
+        if: github.event_name == 'pull_request'
+        working-directory: /tmp/test-init-project
+        run: |
+          echo "Checking generated files..."
+
+          # Check for package.json
+          if [ ! -f "package.json" ]; then
+            echo "❌ package.json not found"
+            exit 1
+          fi
+          echo "✓ package.json exists"
+
+          # Check for vitest config
+          if [ ! -f "vitest.config.js" ]; then
+            echo "❌ vitest.config.js not found"
+            exit 1
+          fi
+          echo "✓ vitest.config.js exists"
+
+          # Check for test file
+          if [ ! -f "tests/example.test.js" ]; then
+            echo "❌ tests/example.test.js not found"
+            exit 1
+          fi
+          echo "✓ tests/example.test.js exists"
+
+          # Check for .env file
+          if [ ! -f ".env" ]; then
+            echo "❌ .env not found"
+            exit 1
+          fi
+          echo "✓ .env exists"
+
+          # Check for .gitignore
+          if [ ! -f ".gitignore" ]; then
+            echo "❌ .gitignore not found"
+            exit 1
+          fi
+          echo "✓ .gitignore exists"
+
+          # Check for GitHub workflow
+          if [ ! -f ".github/workflows/testdriver.yml" ]; then
+            echo "❌ .github/workflows/testdriver.yml not found"
+            exit 1
+          fi
+          echo "✓ .github/workflows/testdriver.yml exists"
+
+      - name: Verify vitest config contents
+        if: github.event_name == 'pull_request'
+        working-directory: /tmp/test-init-project
+        run: |
+          echo "Checking vitest.config.js contents..."
+
+          # Check for TestDriver reporter
+          if ! grep -q "TestDriver()" vitest.config.js; then
+            echo "❌ TestDriver reporter not found in vitest.config.js"
+            cat vitest.config.js
+            exit 1
+          fi
+          echo "✓ TestDriver reporter is configured"
+
+          # Check for setupFiles
+          if ! grep -q "setupFiles.*testdriverai/vitest/setup" vitest.config.js; then
+            echo "❌ setupFiles not configured correctly"
+            cat vitest.config.js
+            exit 1
+          fi
+          echo "✓ setupFiles is configured"
+
+      - name: Verify test file contents
+        if: github.event_name == 'pull_request'
+        working-directory: /tmp/test-init-project
+        run: |
+          echo "Checking test file contents..."
+
+          # Check for .provision usage
+          if ! grep -q "\.provision\.chrome" tests/example.test.js; then
+            echo "❌ Test does not use .provision.chrome"
+            cat tests/example.test.js
+            exit 1
+          fi
+          echo "✓ Test uses .provision.chrome"
+
+          # Check for TestDriver import
+          if ! grep -q "from 'testdriverai/vitest/hooks'" tests/example.test.js; then
+            echo "❌ Test does not import from testdriverai/vitest/hooks"
+            cat tests/example.test.js
+            exit 1
+          fi
+          echo "✓ Test imports TestDriver from vitest/hooks"
+
+      - name: Run the generated test
+        if: github.event_name == 'pull_request'
+        working-directory: /tmp/test-init-project
+        run: npm test
+        env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+
+      - name: Upload init test results
+        if: always() && github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-init-results
+          path: /tmp/test-init-project/test-results/
+          retention-days: 7
+          if-no-files-found: warn

package/.github/workflows/windows-self-hosted.yaml

@@ -4,13 +4,15 @@ on:
   workflow_call:
     inputs:
       test_pattern:
-        description: 'Test file pattern to run'
+        description: "Test file pattern to run"
         required: false
         type: string
-        default: 'examples/*.test.mjs'
+        default: "examples/*.test.mjs"
     secrets:
       TD_API_KEY:
         required: true
+      TWOCAPTCHA_API_KEY:
+        required: true
       TD_WEBSITE:
         required: false
       AWS_ACCESS_KEY_ID:
@@ -21,48 +23,60 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    
+
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    
-    - name: Set up Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20'
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Run Windows tests with self-hosted instances
-      run: npx vitest run ${{ inputs.test_pattern }}
-      env:
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-        TD_WEBSITE: ${{ secrets.TD_WEBSITE }}
-        TD_OS: windows
-        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        AWS_REGION: us-east-2
-        AWS_LAUNCH_TEMPLATE_ID: lt-0ef9bf26a945fb442
-        AMI_ID: ami-0dd5fa241273a7d50
-        RESOLUTION: 1920x1080
-    
-    - name: Upload test results
-      if: always()
-      uses: actions/upload-artifact@v4
-      with:
-        name: test-results-windows
-        path: test-report.junit.xml
-        retention-days: 30
-    
-    - name: Upload TestDriver AI CLI logs
-      if: always()
-      uses: actions/upload-artifact@v4
-      with:
-        name: testdriverai-cli-logs-windows
-        path: /tmp/testdriverai-cli-*.log
-        if-no-files-found: warn
-        retention-days: 30
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Debug Environment
+        run: |
+          echo "Checking environment variables..."
+          if [ -n "${{ secrets.TWOCAPTCHA_API_KEY }}" ]; then
+            echo "TWOCAPTCHA_API_KEY is set (length: ${#TWOCAPTCHA_API_KEY})"
+          else
+            echo "TWOCAPTCHA_API_KEY is NOT set"
+          fi
+        env:
+          TWOCAPTCHA_API_KEY: ${{ secrets.TWOCAPTCHA_API_KEY }}
+
+      - name: Run Windows tests with self-hosted instances
+        run: npx vitest run ${{ inputs.test_pattern }}
+        env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+          TWOCAPTCHA_API_KEY: ${{ secrets.TWOCAPTCHA_API_KEY }}
+          TD_WEBSITE: ${{ secrets.TD_WEBSITE }}
+          TD_OS: windows
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: us-east-2
+          AWS_LAUNCH_TEMPLATE_ID: lt-0ef9bf26a945fb442
+          AMI_ID: ami-0dd5fa241273a7d50
+          RESOLUTION: 1920x1080
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-windows
+          path: test-report.junit.xml
+          retention-days: 30
+
+      - name: Upload TestDriver AI CLI logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: testdriverai-cli-logs-windows
+          path: /tmp/testdriverai-cli-*.log
+          if-no-files-found: warn
+          retention-days: 30

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [7.2.58](https://github.com/testdriverai/testdriverai/compare/v6.1.8...v7.2.58) (2026-01-27)
+
+
+### Reverts
+
+* Revert "list dashcam version g" ([5037571](https://github.com/testdriverai/testdriverai/commit/5037571440c33f8966104874c542c6c57a809510))
+* Revert "update discord invite" ([b5a9b99](https://github.com/testdriverai/testdriverai/commit/b5a9b9955cf2b0b07fd0ebeb6abf65f89cd3d5a8))
+
+
+

package/docs/docs.json

@@ -72,6 +72,7 @@
                 "pages": [
                   "/v7/ai",
                   "/v7/assert",
+                  "/v7/captcha",
                   "/v7/click",
                   "/v7/double-click",
                   "/v7/exec",

package/docs/v7/captcha.mdx

@@ -0,0 +1,160 @@
+---
+title: "captcha()"
+sidebarTitle: "captcha"
+description: "Solve captchas using 2captcha service"
+icon: "shield-check"
+---
+
+# Captcha Solving
+
+TestDriver can automatically solve captchas during your tests using the 2captcha service. This feature works on both **Linux** and **Windows** sandboxes.
+
+## Quick Start
+
+
+```javascript
+const result = await testdriver.captcha({
+  apiKey: process.env.TWOCAPTCHA_API_KEY,
+});
+
+console.log(result.success); // true
+console.log(result.token);   // The solved captcha token
+```
+
+That's it! TestDriver will automatically:
+- Detect the captcha type on the page
+- Extract the sitekey
+- Solve the captcha via 2captcha
+- Inject the token into the page
+- Trigger any callbacks
+
+## Supported Captcha Types
+
+| Type | Auto-Detected | Notes |
+|------|---------------|-------|
+| reCAPTCHA v2 | ✅ | Including invisible |
+| reCAPTCHA v3 | ✅ | Action is auto-detected |
+| hCaptcha | ✅ | |
+| Cloudflare Turnstile | ✅ | |
+
+## Getting a 2captcha API Key
+
+1. Sign up at [2captcha.com](https://2captcha.com)
+2. Add funds to your account
+3. Copy your API key from the dashboard
+
+## Configuration Options
+
+```javascript
+const result = await testdriver.captcha({
+  // Required
+  apiKey: '2CAPTCHA_API_KEY',
+
+  // Optional - usually auto-detected
+  sitekey: '6Le...',           // Override auto-detected sitekey
+  type: 'recaptcha_v3',        // Override auto-detected type
+  action: 'submit',            // reCAPTCHA v3 action
+
+  // Timing
+  timeout: 120000,             // Max wait time (default: 120s)
+  pollInterval: 5000,          // Poll interval (default: 5s)
+});
+```
+
+## Full Example
+
+```javascript
+import { describe, expect, it } from "vitest";
+import { TestDriver } from "testdriver";
+
+describe("Checkout flow", () => {
+  it("should complete checkout with captcha", async (context) => {
+    const testdriver = TestDriver(context);
+
+    // Navigate to checkout page
+    await testdriver.provision.chrome({
+      url: 'https://example.com/checkout',
+    });
+
+    // Fill out form
+    await testdriver.type({ text: 'John Doe', selector: '#name' });
+    await testdriver.type({ text: 'john@example.com', selector: '#email' });
+
+    // Solve the captcha
+    const result = await testdriver.captcha({
+      apiKey: process.env.TWOCAPTCHA_API_KEY,
+    });
+
+    expect(result.success).toBe(true);
+
+    // Submit the form
+    await testdriver.click({ selector: '#submit' });
+
+    // Verify success
+    await testdriver.find({ text: 'Order confirmed' });
+  }, 180000);
+});
+```
+
+## Environment Variables
+
+You can set your API key as an environment variable:
+
+```bash
+export TWOCAPTCHA_API_KEY=your_api_key_here
+```
+
+Then use it in your tests:
+
+```javascript
+```javascript
+const result = await testdriver.captcha({
+  apiKey: process.env.TWOCAPTCHA_API_KEY,
+});
+```
+
+### GitHub Actions
+
+Add the key to your repository secrets and expose it in your workflow:
+
+```yaml
+- name: Run Tests
+  run: npm test
+  env:
+    TWOCAPTCHA_API_KEY: ${{ secrets.TWOCAPTCHA_API_KEY }}
+```
+
+## How It Works
+
+1. **Detection**: Scans the page for captcha elements (`data-sitekey`, script tags, etc.)
+2. **Submit**: Sends the captcha challenge to 2captcha's solving service
+3. **Poll**: Waits for human solvers to complete the captcha
+4. **Inject**: Injects the solved token into the page's hidden fields
+5. **Callback**: Triggers any JavaScript callbacks the page expects
+
+## Troubleshooting
+
+### "Could not auto-detect captcha"
+
+The captcha element wasn't found on the page. Try:
+- Waiting for the page to fully load before calling `captcha()`
+- Providing the `sitekey` and `type` manually
+
+### Timeout errors
+
+Captcha solving typically takes 10-30 seconds. If you're getting timeouts:
+- Increase the `timeout` option
+- Check your 2captcha balance
+- Verify the captcha type is correct
+
+### Token not working
+
+Some sites validate tokens immediately. Make sure:
+- The token is injected before form submission
+- The captcha type matches what the site expects
+- For reCAPTCHA v3, the `action` parameter matches the site's expected action
+
+## Requirements
+
+- Chrome must be launched with remote debugging enabled (automatic on all sandboxes)
+- A valid 2captcha API key with sufficient balance