BrowserFabric

TypeScript SDK for BrowserFabric — cloud browser automation API with persistent sessions and CDP access.

Install

npm install browserfabric

Quick Start

import { BrowserFabric } from 'browserfabric';

const bf = new BrowserFabric({ apiKey: 'bf_your_key' });

const session = await bf.createSession();
await session.navigate('https://example.com');
await session.click('a');
const screenshot = await session.screenshot();
await session.close();

Authentication

// Via constructor
const bf = new BrowserFabric({ apiKey: 'bf_...' });

// Via environment variable
// export BROWSERFABRIC_API_KEY=bf_...
const bf = new BrowserFabric();

Persistent Sessions

// Save state on close
const session = await bf.createSession({ persist: true });
await session.navigate('https://app.example.com/login');
await session.type('#email', '[email protected]');
await session.click('#submit');
const ctx = await session.saveContext('my-login');
await session.close();

// Restore later
const session2 = await bf.createSession({ contextId: ctx.context_id });
// Already logged in!

Available Methods

BrowserFabric

| Method | Description | |--------|-------------| | createSession(options?) | Create a browser session | | listSessions() | List active sessions | | listContexts() | List saved contexts | | deleteContext(id) | Delete a context | | healthCheck() | Check server health | | isHealthy() | Quick health check |

BrowserSession

| Method | Description | |--------|-------------| | navigate(url, waitUntil?) | Go to a URL | | click(selector) | Click an element | | type(selector, text) | Type into an input | | find(selector) | Find elements | | screenshot(fullPage?) | Take a screenshot | | screenshotElement(selector) | Screenshot a specific element | | waitFor(selector, state?) | Wait for element state | | scroll(direction?, amount?) | Scroll the page | | pressKey(key) | Press a keyboard key | | selectOption(selector, value) | Select from dropdown | | hover(selector) | Hover over element | | evaluateJs(expression) | Execute JavaScript | | goBack() | Browser history back | | goForward() | Browser history forward | | observe() | Get DOM tree | | snapshot() | Get accessibility tree | | pageSummary() | Quick page state summary | | pageInfo() | Get URL and title | | sessionInfo() | Session metadata + CDP URL | | saveContext(name) | Save browser state | | close() | Close the session |

Self-Hosted

const bf = new BrowserFabric({
  baseUrl: 'http://your-server:9000',
  apiKey: 'bf_...',
});

License

MIT