@hasna/connectors 0.8.2 → 0.9.1

package/connectors/connect-browseruse/CLAUDE.md

@@ -0,0 +1,190 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+connect-browseruse is a TypeScript connector for Browser Use Cloud API (browser-use.com) with multi-profile configuration support. It provides CLI and programmatic access to AI-powered browser automation tasks, sessions, and skills.
+
+## Build & Run Commands
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+
+# Run specific commands
+bun run dev --help
+bun run dev tasks list
+bun run dev run "Navigate to google.com and search for AI"
+```
+
+## Code Style
+
+- TypeScript with strict mode
+- ESM modules (type: module)
+- Use async/await for all async operations
+- Minimal dependencies: commander, chalk only
+- Type annotations required everywhere
+- Use interfaces for all API types
+
+## Project Structure
+
+```
+src/
+├── api/
+│   ├── client.ts     # HTTP client with Bearer token auth
+│   ├── tasks.ts      # Tasks API module
+│   ├── sessions.ts   # Sessions API module
+│   ├── profiles.ts   # Browser Profiles API module
+│   ├── browsers.ts   # Browser Sessions API module
+│   ├── skills.ts     # Skills & Marketplace API modules
+│   ├── files.ts      # Files API module
+│   ├── billing.ts    # Billing API module
+│   └── index.ts      # Main BrowserUse connector class
+├── cli/
+│   └── index.ts      # CLI commands
+├── types/
+│   └── index.ts      # Type definitions
+├── utils/
+│   ├── config.ts     # Multi-profile configuration
+│   └── output.ts     # CLI output formatting
+└── index.ts          # Library exports
+```
+
+## Key Patterns
+
+### Multi-Profile Configuration
+
+Profiles stored in `~/.connect/connect-browseruse/profiles/`:
+- Each profile is a separate JSON file
+- `current_profile` file tracks active profile
+- `--profile` flag overrides for single command
+- Environment variables override profile config
+
+### Authentication
+
+Uses Bearer token authentication for all requests. API key can be set via:
+- Environment variable: `BROWSER_USE_API_KEY`
+- Profile configuration: `connect-browseruse config set api-key <key>`
+
+### Service APIs
+
+Each API endpoint has its own module:
+- **TasksApi**: Create, list, get, stop, pause, resume tasks
+- **SessionsApi**: Manage agent sessions with public sharing
+- **ProfilesApi**: Browser profiles for persistent state
+- **BrowsersApi**: Direct CDP browser sessions
+- **SkillsApi**: User-created skills
+- **MarketplaceApi**: Browse and discover marketplace skills
+- **FilesApi**: Upload/download files via presigned URLs
+- **BillingApi**: Account credits and plan info
+
+## CLI Commands
+
+### Tasks
+```bash
+connect-browseruse tasks list                    # List all tasks
+connect-browseruse tasks create "Search for AI"  # Create new task
+connect-browseruse tasks get <id>                # Get task details
+connect-browseruse tasks stop <id>               # Stop running task
+connect-browseruse tasks pause <id>              # Pause task
+connect-browseruse tasks resume <id>             # Resume paused task
+connect-browseruse tasks logs <id>               # View task logs
+```
+
+### Sessions
+```bash
+connect-browseruse sessions list                 # List sessions
+connect-browseruse sessions get <id>             # Get session details
+connect-browseruse sessions create               # Create new session
+connect-browseruse sessions delete <id>          # Delete session
+connect-browseruse sessions share <id>           # Create public share
+connect-browseruse sessions unshare <id>         # Remove public share
+```
+
+### Browser Profiles
+```bash
+connect-browseruse profiles list                 # List browser profiles
+connect-browseruse profiles get <id>             # Get profile details
+connect-browseruse profiles create --name "My Profile" # Create profile
+connect-browseruse profiles delete <id>          # Delete profile
+```
+
+### Skills & Marketplace
+```bash
+connect-browseruse skills list                   # List user skills
+connect-browseruse skills get <id>               # Get skill details
+connect-browseruse skills create --name "Login" --parameter "url:string" # Create skill
+connect-browseruse skills delete <id>            # Delete skill
+connect-browseruse skills run <id> -p '{"url":"example.com"}' # Run skill
+
+connect-browseruse marketplace list              # List marketplace skills
+connect-browseruse marketplace get <id>          # Get marketplace skill
+```
+
+### Billing
+```bash
+connect-browseruse billing show                  # Show billing info
+connect-browseruse billing credits               # Show credit balance
+connect-browseruse billing plan                  # Show current plan
+```
+
+### Quick Run
+```bash
+connect-browseruse run "Navigate to google.com"  # Quick task execution
+connect-browseruse run "Search for news" --timeout 120000
+```
+
+### Profile & Config
+```bash
+connect-browseruse profile list                  # List profiles
+connect-browseruse profile use <name>            # Switch profile
+connect-browseruse profile create <name>         # Create profile
+connect-browseruse profile delete <name>         # Delete profile
+connect-browseruse config set api-key <key>      # Set API key
+connect-browseruse config set base-url <url>     # Set base URL
+connect-browseruse config show                   # Show current config
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `BROWSER_USE_API_KEY` | Browser Use API key (overrides profile) |
+| `BROWSER_USE_BASE_URL` | Base URL (default: https://api.browser-use.com) |
+
+## Data Storage
+
+```
+~/.connect/connect-browseruse/
+├── current_profile   # Active profile name
+└── profiles/
+    ├── default.json  # Default profile
+    └── {name}.json   # Named profiles
+```
+
+Profile JSON structure:
+```json
+{
+  "apiKey": "bu_...",
+  "baseUrl": "https://api.browser-use.com"
+}
+```
+
+## Dependencies
+
+- commander: CLI framework
+- chalk: Terminal styling
+
+## API Reference
+
+Browser Use Cloud API: https://docs.browser-use.com/cloud/api

package/connectors/connect-browseruse/README.md

@@ -0,0 +1,216 @@
+# connect-browseruse
+
+TypeScript connector for Browser Use Cloud API (browser-use.com) - AI-powered browser automation tasks, sessions, and skills.
+
+## Features
+
+- Full Browser Use Cloud API support
+- Multi-profile configuration (switch between different API keys/accounts)
+- Bearer token authentication
+- Clean CLI structure with Commander.js
+- Pretty and JSON output formats
+- TypeScript with strict mode
+
+## Installation
+
+```bash
+npm install -g @hasna/connect-browseruse
+# or
+bun add -g @hasna/connect-browseruse
+```
+
+## Quick Start
+
+### Configure API Key
+
+```bash
+# Set API key
+connect-browseruse config set api-key bu_your_api_key
+
+# Or use environment variable
+export BROWSER_USE_API_KEY=bu_your_api_key
+```
+
+### Run a Task
+
+```bash
+# Quick task execution
+connect-browseruse run "Navigate to google.com and search for AI news"
+
+# Create a task with options
+connect-browseruse tasks create "Fill out the contact form on example.com" --save-browser
+```
+
+## CLI Commands
+
+### Tasks
+
+```bash
+connect-browseruse tasks list                    # List all tasks
+connect-browseruse tasks create "Search for AI"  # Create new task
+connect-browseruse tasks get <id>                # Get task details
+connect-browseruse tasks stop <id>               # Stop running task
+connect-browseruse tasks pause <id>              # Pause task
+connect-browseruse tasks resume <id>             # Resume paused task
+connect-browseruse tasks logs <id>               # View task logs
+```
+
+### Sessions
+
+```bash
+connect-browseruse sessions list                 # List sessions
+connect-browseruse sessions get <id>             # Get session details
+connect-browseruse sessions create               # Create new session
+connect-browseruse sessions delete <id>          # Delete session
+connect-browseruse sessions share <id>           # Create public share
+connect-browseruse sessions unshare <id>         # Remove public share
+```
+
+### Browser Profiles
+
+```bash
+connect-browseruse profiles list                 # List browser profiles
+connect-browseruse profiles get <id>             # Get profile details
+connect-browseruse profiles create --name "Work" # Create profile
+connect-browseruse profiles delete <id>          # Delete profile
+```
+
+### Skills
+
+```bash
+connect-browseruse skills list                   # List user skills
+connect-browseruse skills get <id>               # Get skill details
+connect-browseruse skills create --name "Login"  # Create skill
+connect-browseruse skills delete <id>            # Delete skill
+connect-browseruse skills run <id> -p '{"url":"example.com"}' # Run skill
+```
+
+### Marketplace
+
+```bash
+connect-browseruse marketplace list              # List marketplace skills
+connect-browseruse marketplace get <id>          # Get marketplace skill
+```
+
+### Billing
+
+```bash
+connect-browseruse billing show                  # Show billing info
+connect-browseruse billing credits               # Show credit balance
+connect-browseruse billing plan                  # Show current plan
+```
+
+### Quick Run
+
+```bash
+connect-browseruse run "Navigate to google.com"  # Quick task execution
+connect-browseruse run "Search for news" --timeout 120000
+```
+
+### Profile & Config
+
+```bash
+connect-browseruse profile list                  # List profiles
+connect-browseruse profile use <name>            # Switch profile
+connect-browseruse profile create <name>         # Create profile
+connect-browseruse profile delete <name>         # Delete profile
+connect-browseruse config set api-key <key>      # Set API key
+connect-browseruse config set base-url <url>     # Set base URL
+connect-browseruse config show                   # Show current config
+```
+
+## Programmatic Usage
+
+```typescript
+import { BrowserUse } from '@hasna/connect-browseruse';
+
+// Create client
+const browserUse = new BrowserUse({
+  apiKey: process.env.BROWSER_USE_API_KEY!,
+});
+
+// Or create from environment
+const browserUse = BrowserUse.fromEnv();
+
+// Run a quick task
+const result = await browserUse.run('Navigate to google.com and get the page title');
+console.log(result);
+
+// Create a task with more control
+const task = await browserUse.tasks.create({
+  task: 'Fill out the contact form',
+  saveBrowserSession: true,
+});
+
+// Wait for completion
+const completed = await browserUse.tasks.waitForCompletion(task.id);
+console.log(completed.output);
+
+// List sessions
+const sessions = await browserUse.sessions.list();
+
+// Get billing info
+const billing = await browserUse.billing.getAccount();
+console.log(`Credits: ${billing.credits}`);
+```
+
+## Multi-Profile Configuration
+
+Profiles are stored in `~/.connect/connect-browseruse/profiles/`:
+
+```
+~/.connect/connect-browseruse/
+├── current_profile   # Name of active profile
+└── profiles/
+    ├── default.json  # Default profile
+    ├── work.json     # Named profile
+    └── personal.json # Named profile
+```
+
+### Profile Commands
+
+```bash
+# Create profiles
+connect-browseruse profile create work
+connect-browseruse config set api-key bu_work_key
+
+# Switch profiles
+connect-browseruse profile use work
+
+# Use profile for single command
+connect-browseruse -p personal tasks list
+
+# List profiles
+connect-browseruse profile list
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `BROWSER_USE_API_KEY` | Browser Use API key (overrides profile config) |
+| `BROWSER_USE_BASE_URL` | Base URL (default: https://api.browser-use.com) |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI in development
+bun run dev
+
+# Build for distribution
+bun run build
+
+# Type check
+bun run typecheck
+```
+
+## API Reference
+
+See the full API documentation at: https://docs.browser-use.com/cloud/api
+
+## License
+
+MIT

package/connectors/connect-browseruse/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hasna/connect-browseruse",
+  "version": "0.0.2",
+  "description": "Browser Use Cloud API connector CLI - AI-powered browser automation tasks, sessions, and skills",
+  "type": "module",
+  "bin": {
+    "connect-browseruse": "./bin/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
+    "dev": "bun run ./src/cli/index.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "browser-use",
+    "browser",
+    "automation",
+    "ai-agent",
+    "web-scraping",
+    "connector",
+    "cli",
+    "typescript",
+    "bun"
+  ],
+  "author": "Hasna",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "chalk": "^5.3.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hasnaxyz/connect-browseruse.git"
+  }
+}

package/connectors/connect-browseruse/src/api/billing.ts

@@ -0,0 +1,32 @@
+import type { BrowserUseClient } from './client';
+import type { AccountBilling } from '../types';
+
+/**
+ * Billing API
+ */
+export class BillingApi {
+  constructor(private client: BrowserUseClient) {}
+
+  /**
+   * Get account billing information
+   */
+  async getAccount(): Promise<AccountBilling> {
+    return this.client.get<AccountBilling>('/v2/billing');
+  }
+
+  /**
+   * Get current credit balance
+   */
+  async getCredits(): Promise<number> {
+    const account = await this.getAccount();
+    return account.credits;
+  }
+
+  /**
+   * Get current plan
+   */
+  async getPlan(): Promise<string> {
+    const account = await this.getAccount();
+    return account.plan;
+  }
+}

package/connectors/connect-browseruse/src/api/browsers.ts

@@ -0,0 +1,50 @@
+import type { BrowserUseClient } from './client';
+import type {
+  BrowserSession,
+  CreateBrowserSessionParams,
+  ListBrowserSessionsParams,
+  PaginatedResponse,
+} from '../types';
+
+/**
+ * Browsers API (Direct CDP browser sessions)
+ */
+export class BrowsersApi {
+  constructor(private client: BrowserUseClient) {}
+
+  /**
+   * List all browser sessions
+   */
+  async list(params?: ListBrowserSessionsParams): Promise<PaginatedResponse<BrowserSession>> {
+    return this.client.get<PaginatedResponse<BrowserSession>>('/v2/browsers', {
+      limit: params?.limit,
+      cursor: params?.cursor,
+    });
+  }
+
+  /**
+   * Create a new browser session
+   */
+  async create(params?: CreateBrowserSessionParams): Promise<BrowserSession> {
+    return this.client.post<BrowserSession>('/v2/browsers', {
+      profile_id: params?.profileId,
+      proxy_url: params?.proxyUrl,
+    });
+  }
+
+  /**
+   * Get a browser session by ID
+   */
+  async get(browserId: string): Promise<BrowserSession> {
+    return this.client.get<BrowserSession>(`/v2/browsers/${browserId}`);
+  }
+
+  /**
+   * Stop a browser session
+   */
+  async stop(browserId: string): Promise<BrowserSession> {
+    return this.client.patch<BrowserSession>(`/v2/browsers/${browserId}`, {
+      action: 'stop',
+    });
+  }
+}

package/connectors/connect-browseruse/src/api/client.ts

@@ -0,0 +1,168 @@
+import { BrowserUseApiError } from '../types';
+
+const DEFAULT_BASE_URL = 'https://api.browser-use.com/api/v2';
+
+export interface BrowserUseClientConfig {
+  apiKey: string;
+  baseUrl?: string;
+}
+
+export interface RequestOptions {
+  method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+  params?: Record<string, string | number | boolean | undefined>;
+  body?: unknown;
+  headers?: Record<string, string>;
+}
+
+/**
+ * Browser Use API Client
+ */
+export class BrowserUseClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+
+  constructor(config: BrowserUseClientConfig) {
+    if (!config.apiKey) {
+      throw new Error('Browser Use API key is required');
+    }
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl || DEFAULT_BASE_URL;
+  }
+
+  /**
+   * Build URL with query parameters
+   */
+  private buildUrl(path: string, params?: Record<string, string | number | boolean | undefined>): string {
+    const url = new URL(`${this.baseUrl}${path}`);
+
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+
+    return url.toString();
+  }
+
+  /**
+   * Make an authenticated request to the Browser Use API
+   */
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {} } = options;
+
+    const url = this.buildUrl(path, params);
+
+    const requestHeaders: Record<string, string> = {
+      'X-Browser-Use-API-Key': this.apiKey,
+      'Accept': 'application/json',
+      ...headers,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      requestHeaders['Content-Type'] = 'application/json';
+    }
+
+    const fetchOptions: RequestInit = {
+      method,
+      headers: requestHeaders,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      fetchOptions.body = JSON.stringify(body);
+    }
+
+    const response = await fetch(url, fetchOptions);
+
+    // Handle 204 No Content
+    if (response.status === 204) {
+      return {} as T;
+    }
+
+    // Parse response
+    let data: unknown;
+    const contentType = response.headers.get('content-type') || '';
+
+    if (contentType.includes('application/json')) {
+      const text = await response.text();
+      if (text) {
+        try {
+          data = JSON.parse(text);
+        } catch {
+          data = text;
+        }
+      }
+    } else {
+      data = await response.text();
+    }
+
+    // Handle errors
+    if (!response.ok) {
+      let errorMessage = `Browser Use API Error: ${response.status} ${response.statusText}`;
+
+      if (typeof data === 'object' && data !== null) {
+        const errData = data as Record<string, unknown>;
+        errorMessage = (errData.message || errData.error || errData.detail || errorMessage) as string;
+      } else if (typeof data === 'string' && data) {
+        errorMessage = data;
+      }
+
+      throw new BrowserUseApiError(errorMessage, response.status, data);
+    }
+
+    return data as T;
+  }
+
+  /**
+   * GET request
+   */
+  async get<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'GET', params });
+  }
+
+  /**
+   * POST request
+   */
+  async post<T>(path: string, body?: unknown, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'POST', body, params });
+  }
+
+  /**
+   * PUT request
+   */
+  async put<T>(path: string, body?: unknown): Promise<T> {
+    return this.request<T>(path, { method: 'PUT', body });
+  }
+
+  /**
+   * PATCH request
+   */
+  async patch<T>(path: string, body?: unknown): Promise<T> {
+    return this.request<T>(path, { method: 'PATCH', body });
+  }
+
+  /**
+   * DELETE request
+   */
+  async delete<T>(path: string): Promise<T> {
+    return this.request<T>(path, { method: 'DELETE' });
+  }
+
+  /**
+   * Get API key preview (for display/debugging)
+   */
+  getApiKeyPreview(): string {
+    if (this.apiKey.length > 12) {
+      return `${this.apiKey.substring(0, 6)}...${this.apiKey.substring(this.apiKey.length - 4)}`;
+    }
+    return '***';
+  }
+
+  /**
+   * Get base URL
+   */
+  getBaseUrl(): string {
+    return this.baseUrl;
+  }
+}