		{
		"name": "@browserbasehq/sdk",
		"version": "1.5.0",
		"description": "Browserbase JS SDK",
		"main": "dist/index.js",
		"types": "dist/index.d.ts",
		"version": "2.0.0-alpha.1",
		"description": "The official Node.js library for the Browserbase API",
		"author": "Browserbase <support@browserbase.com>",
		"types": "./index.d.ts",
		"main": "./index.js",
		"type": "commonjs",
		"repository": "github:browserbase/sdk-node",
		"packageManager": "yarn@1.22.22",
		"files": [
		"*/"
		],
		"private": false,
		"scripts": {
		"build": "tsc -p tsconfig.json",
		"build:browser": "tsc -p tsconfig.browser.json",
		"test": "tsx --test test/*"
		"test": "./scripts/test",
		"build": "./scripts/build",
		"format": "prettier --write --cache --cache-strategy metadata . !dist",
		"tsn": "ts-node -r tsconfig-paths/register",
		"lint": "./scripts/lint",
		"fix": "./scripts/format"
		},
		"repository": {
		"type": "git",
		"url": "git+https://github.com/browserbase/js-sdk.git"
		"dependencies": {
		"@types/node": "^18.11.18",
		"@types/node-fetch": "^2.6.4",
		"abort-controller": "^3.0.0",
		"agentkeepalive": "^4.2.1",
		"form-data-encoder": "1.7.2",
		"formdata-node": "^4.3.2",
		"node-fetch": "^2.6.7"
		},
		"keywords": [
		"automation",
		"testing",
		"playwright"
		"sideEffects": [
		"./_shims/index.js",
		"./_shims/index.mjs",
		"./shims/node.js",
		"./shims/node.mjs",
		"./shims/web.js",
		"./shims/web.mjs"
		],
		"author": "Browserbase <info@browserbase.com>",
		"license": "MIT",
		"bugs": {
		"url": "https://github.com/browserbase/js-sdk/issues"
		"imports": {
		"@browserbasehq/sdk": ".",
		"@browserbasehq/sdk/": "./src/"
		},
		"homepage": "https://github.com/browserbase/js-sdk#readme",
		"dependencies": {
		"playwright-core": "^1.45.1",
		"puppeteer-core": "^22.10.0",
		"zod": "^3.22.5"
		},
		"devDependencies": {
		"@changesets/cli": "^2.27.9",
		"@types/node": "^20.14.10",
		"browserify": "^17.0.0",
		"chai": "^5.1.0",
		"tsx": "^4.7.2",
		"typescript": "^5.5.2"
		"exports": {
		"./_shims/auto/*": {
		"deno": {
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*.js",
		"default": "./_shims/auto/*.mjs"
		},
		"bun": {
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*-bun.js",
		"default": "./_shims/auto/*-bun.mjs"
		},
		"browser": {
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*.js",
		"default": "./_shims/auto/*.mjs"
		},
		"worker": {
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*.js",
		"default": "./_shims/auto/*.mjs"
		},
		"workerd": {
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*.js",
		"default": "./_shims/auto/*.mjs"
		},
		"node": {
		"types": "./_shims/auto/*-node.d.ts",
		"require": "./_shims/auto/*-node.js",
		"default": "./_shims/auto/*-node.mjs"
		},
		"types": "./_shims/auto/*.d.ts",
		"require": "./_shims/auto/*.js",
		"default": "./_shims/auto/*.mjs"
		},
		".": {
		"require": {
		"types": "./index.d.ts",
		"default": "./index.js"
		},
		"types": "./index.d.mts",
		"default": "./index.mjs"
		},
		"./*.mjs": {
		"types": "./*.d.ts",
		"default": "./*.mjs"
		},
		"./*.js": {
		"types": "./*.d.ts",
		"default": "./*.js"
		},
		"./*": {
		"types": "./*.d.ts",
		"require": "./*.js",
		"default": "./*.mjs"
		}
		}
		}

334

README.md

		@@ -1,106 +0,296 @@
		<p align="center">
		<picture>
		<source media="(prefers-color-scheme: dark)" srcset="logo/dark.svg"/>
		<img alt="Browserbase logo" src="logo/light.svg" width="300" />
		</picture>
		</p>
		# Browserbase Node API Library

		<p align="center">
		<a href="https://docs.browserbase.com">Documentation</a>
		<span> · </span>
		<a href="https://www.browserbase.com/playground">Playground</a>
		</p>
		<br/>
		[![NPM version](https://img.shields.io/npm/v/@browserbasehq/sdk.svg)](https://npmjs.org/package/@browserbasehq/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@browserbasehq/sdk)

		## Browserbase JS SDK
		This library provides convenient access to the Browserbase REST API from server-side TypeScript or JavaScript.

		Browserbase is the best developer platform to reliably run, manage, and monitor headless browsers.
		Leverage Browserbase to power your automation, test suites, and LLM data retrievals.
		The REST API documentation can be found on [docs.browserbase.com](https://docs.browserbase.com). The full API of this library can be found in [api.md](api.md).

		## Installation and setup
		It is generated with [Stainless](https://www.stainlessapi.com/).

		### 1. Install the SDK:
		## Installation

		```bash
		```sh
		npm install @browserbasehq/sdk
		```

		### 2. Get your Browserbase API Key and Project ID:
		## Usage

		- [Create an account](https://www.browserbase.com/sign-up) or [log in to Browserbase](https://www.browserbase.com/sign-in)
		- Copy your API Key and Project ID [from your Settings page](https://www.browserbase.com/settings)
		The full API of this library can be found in [api.md](api.md).

		## Usage

		<!-- prettier-ignore -->
		```js
		import { Browserbase } from '@browserbasehq/sdk'
		import Browserbase from '@browserbasehq/sdk';

		// Init the SDK
		const browserbase = new Browserbase()
		const client = new Browserbase({
		apiKey: process.env['BROWSERBASE_API_KEY'], // This is the default and can be omitted
		});

		// Load a webpage
		const rawHtml = await browserbase.load('https://www.browserbase.com')
		async function main() {
		const session = await client.sessions.create({ projectId: 'your_project_id', proxies: true });

		// Load multiple webpages (returns iterator)
		const rawHtmls = browserbase.loadURLs([
		'https://www.browserbase.com',
		'https://docs.browserbase.com',
		])
		console.log(session.id);
		}

		for await (let rawHtml of rawHtmls) {
		// ...
		main();
		```

		### Request & Response types

		This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

		<!-- prettier-ignore -->
		```ts
		import Browserbase from '@browserbasehq/sdk';

		const client = new Browserbase({
		apiKey: process.env['BROWSERBASE_API_KEY'], // This is the default and can be omitted
		});

		async function main() {
		const params: Browserbase.SessionCreateParams = { projectId: 'your_project_id', proxies: true };
		const session: Browserbase.SessionCreateResponse = await client.sessions.create(params);
		}

		// Text-only mode
		const text = await browserbase.load('https://www.browserbase.com', {
		textContent: true,
		})
		main();
		```

		// Screenshot (returns bytes)
		const result = await browserbase.screenshot('https://www.browserbase.com', {
		textContent: true,
		})
		Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

		## Handling errors

		When the library is unable to connect to the API,
		or if the API returns a non-success status code (i.e., 4xx or 5xx response),
		a subclass of `APIError` will be thrown:

		<!-- prettier-ignore -->
		```ts
		async function main() {
		const session = await client.sessions
		.create({ projectId: 'your_project_id', proxies: true })
		.catch(async (err) => {
		if (err instanceof Browserbase.APIError) {
		console.log(err.status); // 400
		console.log(err.name); // BadRequestError
		console.log(err.headers); // {server: 'nginx', ...}
		} else {
		throw err;
		}
		});
		}

		main();
		```

		### Vercel AI SDK Integration
		Error codes are as followed:

		Install the additional dependencies:
		\| Status Code \| Error Type \|
		\| ----------- \| -------------------------- \|
		\| 400 \| `BadRequestError` \|
		\| 401 \| `AuthenticationError` \|
		\| 403 \| `PermissionDeniedError` \|
		\| 404 \| `NotFoundError` \|
		\| 422 \| `UnprocessableEntityError` \|
		\| 429 \| `RateLimitError` \|
		\| >=500 \| `InternalServerError` \|
		\| N/A \| `APIConnectionError` \|

		### Retries

		Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
		Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
		429 Rate Limit, and >=500 Internal errors will all be retried by default.

		You can use the `maxRetries` option to configure or disable this:

		<!-- prettier-ignore -->
		```js
		// Configure the default for all requests:
		const client = new Browserbase({
		maxRetries: 0, // default is 2
		});

		// Or, configure per-request:
		await client.sessions.create({ projectId: 'your_project_id', proxies: true }, {
		maxRetries: 5,
		});
		```
		npm install ai openai zod

		### Timeouts

		Requests time out after 1 minute by default. You can configure this with a `timeout` option:

		<!-- prettier-ignore -->
		```ts
		// Configure the default for all requests:
		const client = new Browserbase({
		timeout: 20 * 1000, // 20 seconds (default is 1 minute)
		});

		// Override per-request:
		await client.sessions.create({ projectId: 'your_project_id', proxies: true }, {
		timeout: 5 * 1000,
		});
		```

		```js
		import OpenAI from 'openai'
		import { Browserbase, BrowserbaseAISDK } from '@browserbasehq/sdk'
		import {
		OpenAIStream,
		StreamingTextResponse,
		generateText,
		} from 'ai'
		On timeout, an `APIConnectionTimeoutError` is thrown.

		// Create new OpenAI client
		const openai = new OpenAI({
		apiKey: process.env.OPENAI_API_KEY,
		})
		Note that requests which time out will be [retried twice by default](#retries).

		// Init the Browserbase SDK
		const browserbase = new Browserbase()
		## Advanced Usage

		// Init the tool
		const browserTool = BrowserbaseAISDK(browserbase, { textContent: true })
		### Accessing raw Response data (e.g., headers)

		// Load completions
		const result = await generateText({
		model: openai.chat('gpt-3.5-turbo'),
		tools: {
		browserTool,
		The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.

		You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.

		<!-- prettier-ignore -->
		```ts
		const client = new Browserbase();

		const response = await client.sessions.create({ projectId: 'your_project_id', proxies: true }).asResponse();
		console.log(response.headers.get('X-My-Header'));
		console.log(response.statusText); // access the underlying Response object

		const { data: session, response: raw } = await client.sessions
		.create({ projectId: 'your_project_id', proxies: true })
		.withResponse();
		console.log(raw.headers.get('X-My-Header'));
		console.log(session.id);
		```

		### Making custom/undocumented requests

		This library is typed for convenient access to the documented API. If you need to access undocumented
		endpoints, params, or response properties, the library can still be used.

		#### Undocumented endpoints

		To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
		Options on the client, such as retries, will be respected when making these requests.

		```ts
		await client.post('/some/path', {
		body: { some_prop: 'foo' },
		query: { some_query_arg: 'bar' },
		});
		```

		#### Undocumented request params

		To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
		parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
		send will be sent as-is.

		```ts
		client.foo.create({
		foo: 'my_param',
		bar: 12,
		// @ts-expect-error baz is not yet public
		baz: 'undocumented option',
		});
		```

		For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
		extra param in the body.

		If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
		options.

		#### Undocumented response properties

		To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
		the response object, or cast the response object to the requisite type. Like the request params, we do not
		validate or strip extra properties from the response from the API.

		### Customizing the fetch client

		By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.

		If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
		(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
		add the following import before your first import `from "Browserbase"`:

		```ts
		// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
		// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
		import '@browserbasehq/sdk/shims/web';
		import Browserbase from '@browserbasehq/sdk';
		```

		To do the inverse, add `import "@browserbasehq/sdk/shims/node"` (which does import polyfills).
		This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/browserbase/sdk-node/tree/main/src/_shims#readme)).

		### Logging and middleware

		You may also provide a custom `fetch` function when instantiating the client,
		which can be used to inspect or alter the `Request` or `Response` before/after each request:

		```ts
		import { fetch } from 'undici'; // as one example
		import Browserbase from '@browserbasehq/sdk';

		const client = new Browserbase({
		fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
		console.log('About to make a request', url, init);
		const response = await fetch(url, init);
		console.log('Got response', response);
		return response;
		},
		prompt: 'What is the weather in San Francisco?',
		})
		});
		```

		## Further reading
		Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
		This is intended for debugging purposes only and may change in the future without notice.

		- [See how to leverage the Session Live View for faster development](https://docs.browserbase.com/features/session-live-view)
		- [Sessions API Reference](https://docs.browserbase.com/reference/api/create-a-session)
		### Configuring an HTTP(S) Agent (e.g., for proxies)

		By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.

		If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:

		<!-- prettier-ignore -->
		```ts
		import http from 'http';
		import { HttpsProxyAgent } from 'https-proxy-agent';

		// Configure the default for all requests:
		const client = new Browserbase({
		httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
		});

		// Override per-request:
		await client.sessions.create(
		{ projectId: 'your_project_id', proxies: true },
		{
		httpAgent: new http.Agent({ keepAlive: false }),
		},
		);
		```

		## Semantic versioning

		This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

		1. Changes that only affect static types, without breaking runtime behavior.
		2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
		3. Changes that we do not expect to impact the vast majority of users in practice.

		We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

		We are keen for your feedback; please open an [issue](https://www.github.com/browserbase/sdk-node/issues) with questions, bugs, or suggestions.

		## Requirements

		TypeScript >= 4.5 is supported.

		The following runtimes are supported:

		Note that React Native is not supported at this time.

		If you are interested in other runtime environments, please open or upvote an issue on GitHub.

		## Contributing

		See [the contributing documentation](./CONTRIBUTING.md).

dist/index.d.ts

dist/index.js

dist/integrations/ai-sdk.d.ts

dist/integrations/ai-sdk.js

dist/recorder/call-metadata.d.ts

dist/recorder/call-metadata.js

dist/recorder/crypto.d.ts

dist/recorder/crypto.js

dist/recorder/css-utils.d.ts

dist/recorder/css-utils.js

dist/recorder/generator.d.ts

dist/recorder/generator.js

dist/recorder/javascript-generator.d.ts

dist/recorder/javascript-generator.js

dist/recorder/language.d.ts

dist/recorder/language.js

dist/recorder/recorder-types.d.ts

dist/recorder/recorder-types.js

dist/recorder/recorder.d.ts

dist/recorder/recorder.js

dist/recorder/time.d.ts

dist/recorder/time.js

dist/recorder/timeout-runner.d.ts

dist/recorder/timeout-runner.js

dist/recorder/utils.d.ts

dist/recorder/utils.js

dist/recorder/utils/isomorphic/css-parser.d.ts

dist/recorder/utils/isomorphic/css-parser.js

dist/recorder/utils/isomorphic/css-tokenizer.d.ts

dist/recorder/utils/isomorphic/css-tokenizer.js

dist/recorder/utils/isomorphic/locator-generators.d.ts

dist/recorder/utils/isomorphic/locator-generators.js

dist/recorder/utils/isomorphic/locator-parser.d.ts

dist/recorder/utils/isomorphic/locator-parser.js

dist/recorder/utils/isomorphic/locator-utils.d.ts

dist/recorder/utils/isomorphic/locator-utils.js

dist/recorder/utils/isomorphic/selector-parser.d.ts

dist/recorder/utils/isomorphic/selector-parser.js

dist/recorder/utils/isomorphic/string-utils.d.ts

dist/recorder/utils/isomorphic/string-utils.js

LICENSE

Sorry, the diff of this file is not supported yet

@browserbasehq/sdk - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes