@hasna/connectors 0.8.1 → 0.9.0

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;
+  }
+}

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

@@ -0,0 +1,70 @@
+import type { BrowserUseClient } from './client';
+import type { PresignedUrl, UploadFileParams } from '../types';
+
+/**
+ * Files API
+ */
+export class FilesApi {
+  constructor(private client: BrowserUseClient) {}
+
+  /**
+   * Get presigned URL for uploading a file to an agent session
+   */
+  async getAgentSessionUploadUrl(sessionId: string, params: UploadFileParams): Promise<PresignedUrl> {
+    return this.client.post<PresignedUrl>(`/v2/sessions/${sessionId}/files/upload`, {
+      file_name: params.fileName,
+      content_type: params.contentType,
+    });
+  }
+
+  /**
+   * Get presigned URL for uploading a file to a browser session
+   */
+  async getBrowserSessionUploadUrl(browserId: string, params: UploadFileParams): Promise<PresignedUrl> {
+    return this.client.post<PresignedUrl>(`/v2/browsers/${browserId}/files/upload`, {
+      file_name: params.fileName,
+      content_type: params.contentType,
+    });
+  }
+
+  /**
+   * Get presigned URL for downloading a task output file
+   */
+  async getTaskOutputUrl(taskId: string, fileId: string): Promise<PresignedUrl> {
+    return this.client.get<PresignedUrl>(`/v2/tasks/${taskId}/files/${fileId}`);
+  }
+
+  /**
+   * Upload a file using a presigned URL
+   */
+  async uploadFile(presignedUrl: string, data: Uint8Array | Buffer | string, contentType?: string): Promise<void> {
+    const headers: Record<string, string> = {};
+    if (contentType) {
+      headers['Content-Type'] = contentType;
+    }
+
+    const response = await fetch(presignedUrl, {
+      method: 'PUT',
+      headers,
+      body: data,
+    });
+
+    if (!response.ok) {
+      throw new Error(`Failed to upload file: ${response.status} ${response.statusText}`);
+    }
+  }
+
+  /**
+   * Download a file from a presigned URL
+   */
+  async downloadFile(presignedUrl: string): Promise<Uint8Array> {
+    const response = await fetch(presignedUrl);
+
+    if (!response.ok) {
+      throw new Error(`Failed to download file: ${response.status} ${response.statusText}`);
+    }
+
+    const arrayBuffer = await response.arrayBuffer();
+    return new Uint8Array(arrayBuffer);
+  }
+}

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

@@ -0,0 +1,95 @@
+import { BrowserUseClient, type BrowserUseClientConfig } from './client';
+import { TasksApi } from './tasks';
+import { SessionsApi } from './sessions';
+import { ProfilesApi } from './profiles';
+import { BrowsersApi } from './browsers';
+import { SkillsApi, MarketplaceApi } from './skills';
+import { FilesApi } from './files';
+import { BillingApi } from './billing';
+
+/**
+ * Main Browser Use Connector class
+ * Provides access to all Browser Use Cloud API endpoints
+ */
+export class BrowserUse {
+  private readonly client: BrowserUseClient;
+
+  // API modules
+  public readonly tasks: TasksApi;
+  public readonly sessions: SessionsApi;
+  public readonly profiles: ProfilesApi;
+  public readonly browsers: BrowsersApi;
+  public readonly skills: SkillsApi;
+  public readonly marketplace: MarketplaceApi;
+  public readonly files: FilesApi;
+  public readonly billing: BillingApi;
+
+  constructor(config: BrowserUseClientConfig) {
+    this.client = new BrowserUseClient(config);
+    this.tasks = new TasksApi(this.client);
+    this.sessions = new SessionsApi(this.client);
+    this.profiles = new ProfilesApi(this.client);
+    this.browsers = new BrowsersApi(this.client);
+    this.skills = new SkillsApi(this.client);
+    this.marketplace = new MarketplaceApi(this.client);
+    this.files = new FilesApi(this.client);
+    this.billing = new BillingApi(this.client);
+  }
+
+  /**
+   * Create a client from environment variables
+   * Looks for BROWSER_USE_API_KEY and optionally BROWSER_USE_BASE_URL
+   */
+  static fromEnv(): BrowserUse {
+    const apiKey = process.env.BROWSER_USE_API_KEY;
+    const baseUrl = process.env.BROWSER_USE_BASE_URL;
+
+    if (!apiKey) {
+      throw new Error('BROWSER_USE_API_KEY environment variable is required');
+    }
+
+    return new BrowserUse({ apiKey, baseUrl });
+  }
+
+  /**
+   * Run a task with a simple interface
+   */
+  async run(task: string, options?: { schema?: Record<string, unknown>; timeout?: number }): Promise<unknown> {
+    const result = await this.tasks.run(
+      { task, schema: options?.schema },
+      2000,
+      options?.timeout || 300000
+    );
+    return result.output;
+  }
+
+  /**
+   * Get API key preview (for debugging)
+   */
+  getApiKeyPreview(): string {
+    return this.client.getApiKeyPreview();
+  }
+
+  /**
+   * Get base URL
+   */
+  getBaseUrl(): string {
+    return this.client.getBaseUrl();
+  }
+
+  /**
+   * Get the underlying client for direct API access
+   */
+  getClient(): BrowserUseClient {
+    return this.client;
+  }
+}
+
+export { BrowserUseClient } from './client';
+export { TasksApi } from './tasks';
+export { SessionsApi } from './sessions';
+export { ProfilesApi } from './profiles';
+export { BrowsersApi } from './browsers';
+export { SkillsApi, MarketplaceApi } from './skills';
+export { FilesApi } from './files';
+export { BillingApi } from './billing';

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

@@ -0,0 +1,59 @@
+import type { BrowserUseClient } from './client';
+import type {
+  Profile,
+  CreateProfileParams,
+  UpdateProfileParams,
+  ListProfilesParams,
+  PaginatedResponse,
+} from '../types';
+
+/**
+ * Profiles API (Browser Profiles for persistent state)
+ */
+export class ProfilesApi {
+  constructor(private client: BrowserUseClient) {}
+
+  /**
+   * List all profiles
+   */
+  async list(params?: ListProfilesParams): Promise<PaginatedResponse<Profile>> {
+    return this.client.get<PaginatedResponse<Profile>>('/v2/profiles', {
+      limit: params?.limit,
+      cursor: params?.cursor,
+    });
+  }
+
+  /**
+   * Create a new profile
+   */
+  async create(params: CreateProfileParams): Promise<Profile> {
+    return this.client.post<Profile>('/v2/profiles', {
+      name: params.name,
+      description: params.description,
+    });
+  }
+
+  /**
+   * Get a profile by ID
+   */
+  async get(profileId: string): Promise<Profile> {
+    return this.client.get<Profile>(`/v2/profiles/${profileId}`);
+  }
+
+  /**
+   * Update a profile
+   */
+  async update(profileId: string, params: UpdateProfileParams): Promise<Profile> {
+    return this.client.patch<Profile>(`/v2/profiles/${profileId}`, {
+      name: params.name,
+      description: params.description,
+    });
+  }
+
+  /**
+   * Delete a profile
+   */
+  async delete(profileId: string): Promise<void> {
+    await this.client.delete(`/v2/profiles/${profileId}`);
+  }
+}

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

@@ -0,0 +1,88 @@
+import type { BrowserUseClient } from './client';
+import type {
+  Session,
+  CreateSessionParams,
+  ListSessionsParams,
+  SessionPublicShare,
+  PaginatedResponse,
+} from '../types';
+
+/**
+ * Sessions API
+ */
+export class SessionsApi {
+  constructor(private client: BrowserUseClient) {}
+
+  /**
+   * List all sessions
+   */
+  async list(params?: ListSessionsParams): Promise<PaginatedResponse<Session>> {
+    return this.client.get<PaginatedResponse<Session>>('/v2/sessions', {
+      limit: params?.limit,
+      cursor: params?.cursor,
+      status: params?.status,
+    });
+  }
+
+  /**
+   * Create a new session
+   */
+  async create(params?: CreateSessionParams): Promise<Session> {
+    return this.client.post<Session>('/v2/sessions', {
+      task: params?.task,
+      profile_id: params?.profileId,
+      proxy_url: params?.proxyUrl,
+      keep_alive: params?.keepAlive,
+      save_browser_data: params?.save_browser_data,
+    });
+  }
+
+  /**
+   * Get a session by ID
+   */
+  async get(sessionId: string): Promise<Session> {
+    return this.client.get<Session>(`/v2/sessions/${sessionId}`);
+  }
+
+  /**
+   * Update a session (stop)
+   */
+  async update(sessionId: string, action: 'stop'): Promise<Session> {
+    return this.client.patch<Session>(`/v2/sessions/${sessionId}`, { action });
+  }
+
+  /**
+   * Stop a session
+   */
+  async stop(sessionId: string): Promise<Session> {
+    return this.update(sessionId, 'stop');
+  }
+
+  /**
+   * Delete a session
+   */
+  async delete(sessionId: string): Promise<void> {
+    await this.client.delete(`/v2/sessions/${sessionId}`);
+  }
+
+  /**
+   * Get public share for a session
+   */
+  async getPublicShare(sessionId: string): Promise<SessionPublicShare> {
+    return this.client.get<SessionPublicShare>(`/v2/sessions/${sessionId}/public-share`);
+  }
+
+  /**
+   * Create public share for a session
+   */
+  async createPublicShare(sessionId: string): Promise<SessionPublicShare> {
+    return this.client.post<SessionPublicShare>(`/v2/sessions/${sessionId}/public-share`);
+  }
+
+  /**
+   * Delete public share for a session
+   */
+  async deletePublicShare(sessionId: string): Promise<void> {
+    await this.client.delete(`/v2/sessions/${sessionId}/public-share`);
+  }
+}