feat(api): api update (#26)

Author: Stainless Bot

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd sdk-node
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link browserbase
+$ yarn link @browserbasehq/sdk
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global browserbase
+$ pnpm link -—global @browserbasehq/sdk
 ```
 
 ## Running tests

README.md

@@ -1,6 +1,6 @@
 # Browserbase Node API Library
 
-[![NPM version](https://img.shields.io/npm/v/browserbase.svg)](https://npmjs.org/package/browserbase) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/browserbase)
+[![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)
 
 This library provides convenient access to the Browserbase REST API from server-side TypeScript or JavaScript.
 
@@ -15,22 +15,22 @@ npm install git+ssh://[email protected]:browserbase/sdk-node.git
 ```
 
 > [!NOTE]
-> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install browserbase`
+> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install @browserbasehq/sdk`
 
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import Browserbase from 'browserbase';
+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 session = await client.sessions.create({ projectId: 'your_project_id', proxies: true });
+  const session = await client.sessions.create({ projectId: 'your_project_id' });
 
   console.log(session.id);
 }
@@ -44,14 +44,14 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Browserbase from 'browserbase';
+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 params: Browserbase.SessionCreateParams = { projectId: 'your_project_id' };
   const session: Browserbase.SessionCreateResponse = await client.sessions.create(params);
 }
 
@@ -69,17 +69,15 @@ 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;
-      }
-    });
+  const session = await client.sessions.create({ projectId: 'your_project_id' }).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();
@@ -114,7 +112,7 @@ const client = new Browserbase({
 });
 
 // Or, configure per-request:
-await client.sessions.create({ projectId: 'your_project_id', proxies: true }, {
+await client.sessions.create({ projectId: 'your_project_id' }, {
   maxRetries: 5,
 });
 ```
@@ -131,7 +129,7 @@ const client = new Browserbase({
 });
 
 // Override per-request:
-await client.sessions.create({ projectId: 'your_project_id', proxies: true }, {
+await client.sessions.create({ projectId: 'your_project_id' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -152,12 +150,12 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 ```ts
 const client = new Browserbase();
 
-const response = await client.sessions.create({ projectId: 'your_project_id', proxies: true }).asResponse();
+const response = await client.sessions.create({ projectId: 'your_project_id' }).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 })
+  .create({ projectId: 'your_project_id' })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(session.id);
@@ -218,11 +216,11 @@ 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 'browserbase/shims/web';
-import Browserbase from 'browserbase';
+import '@browserbasehq/sdk/shims/web';
+import Browserbase from '@browserbasehq/sdk';
 ```
 
-To do the inverse, add `import "browserbase/shims/node"` (which does import polyfills).
+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
@@ -232,7 +230,7 @@ which can be used to inspect or alter the `Request` or `Response` before/after e
 
 ```ts
 import { fetch } from 'undici'; // as one example
-import Browserbase from 'browserbase';
+import Browserbase from '@browserbasehq/sdk';
 
 const client = new Browserbase({
   fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
@@ -265,7 +263,7 @@ const client = new Browserbase({
 
 // Override per-request:
 await client.sessions.create(
-  { projectId: 'your_project_id', proxies: true },
+  { projectId: 'your_project_id' },
   {
     httpAgent: new http.Agent({ keepAlive: false }),
   },

jest.config.ts

@@ -7,9 +7,9 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^browserbase$': '<rootDir>/src/index.ts',
-    '^browserbase/_shims/auto/(.*)$': '<rootDir>/src/_shims/auto/$1-node',
-    '^browserbase/(.*)$': '<rootDir>/src/$1',
+    '^@browserbasehq/sdk$': '<rootDir>/src/index.ts',
+    '^@browserbasehq/sdk/_shims/auto/(.*)$': '<rootDir>/src/_shims/auto/$1-node',
+    '^@browserbasehq/sdk/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',

package.json

@@ -66,8 +66,8 @@
     "./shims/web.mjs"
   ],
   "imports": {
-    "browserbase": ".",
-    "browserbase/*": "./src/*"
+    "@browserbasehq/sdk": ".",
+    "@browserbasehq/sdk/*": "./src/*"
   },
   "exports": {
     "./_shims/auto/*": {

scripts/build

@@ -8,7 +8,7 @@ node scripts/utils/check-version.cjs
 
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
-# This way importing from `"browserbase/resources/foo"` works
+# This way importing from `"@browserbasehq/sdk/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
 rm -rf dist; mkdir dist
@@ -47,8 +47,8 @@ node scripts/utils/postprocess-files.cjs
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-(cd dist && node -e 'require("browserbase")')
-(cd dist && node -e 'import("browserbase")' --input-type=module)
+(cd dist && node -e 'require("@browserbasehq/sdk")')
+(cd dist && node -e 'import("@browserbasehq/sdk")' --input-type=module)
 
 if command -v deno &> /dev/null && [ -e ./scripts/build-deno ]
 then

scripts/utils/postprocess-files.cjs

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const { parse } = require('@typescript-eslint/parser');
 
-const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? 'browserbase/';
+const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? '@browserbasehq/sdk/';
 
 const distDir =
   process.env['DIST_PATH'] ?
@@ -142,7 +142,7 @@ async function postprocess() {
 
     if (file.endsWith('.d.ts')) {
       // work around bad tsc behavior
-      // if we have `import { type Readable } from 'browserbase/_shims/index'`,
+      // if we have `import { type Readable } from '@browserbasehq/sdk/_shims/index'`,
       // tsc sometimes replaces `Readable` with `import("stream").Readable` inline
       // in the output .d.ts
       transformed = transformed.replace(/import\("stream"\).Readable/g, 'Readable');

src/_shims/README.md

@@ -1,9 +1,9 @@
 # 👋 Wondering what everything in here does?
 
-`browserbase` supports a wide variety of runtime environments like Node.js, Deno, Bun, browsers, and various
+`@browserbasehq/sdk` supports a wide variety of runtime environments like Node.js, Deno, Bun, browsers, and various
 edge runtimes, as well as both CommonJS (CJS) and EcmaScript Modules (ESM).
 
-To do this, `browserbase` provides shims for either using `node-fetch` when in Node (because `fetch` is still experimental there) or the global `fetch` API built into the environment when not in Node.
+To do this, `@browserbasehq/sdk` provides shims for either using `node-fetch` when in Node (because `fetch` is still experimental there) or the global `fetch` API built into the environment when not in Node.
 
 It uses [conditional exports](https://nodejs.org/api/packages.html#conditional-exports) to
 automatically select the correct shims for each environment. However, conditional exports are a fairly new
@@ -15,32 +15,32 @@ getting the wrong raw `Response` type from `.asResponse()`, for example.
 
 The user can work around these issues by manually importing one of:
 
-- `import 'browserbase/shims/node'`
-- `import 'browserbase/shims/web'`
+- `import '@browserbasehq/sdk/shims/node'`
+- `import '@browserbasehq/sdk/shims/web'`
 
 All of the code here in `_shims` handles selecting the automatic default shims or manual overrides.
 
 ### How it works - Runtime
 
-Runtime shims get installed by calling `setShims` exported by `browserbase/_shims/registry`.
+Runtime shims get installed by calling `setShims` exported by `@browserbasehq/sdk/_shims/registry`.
 
-Manually importing `browserbase/shims/node` or `browserbase/shims/web`, calls `setShims` with the respective runtime shims.
+Manually importing `@browserbasehq/sdk/shims/node` or `@browserbasehq/sdk/shims/web`, calls `setShims` with the respective runtime shims.
 
-All client code imports shims from `browserbase/_shims/index`, which:
+All client code imports shims from `@browserbasehq/sdk/_shims/index`, which:
 
 - checks if shims have been set manually
-- if not, calls `setShims` with the shims from `browserbase/_shims/auto/runtime`
-- re-exports the installed shims from `browserbase/_shims/registry`.
+- if not, calls `setShims` with the shims from `@browserbasehq/sdk/_shims/auto/runtime`
+- re-exports the installed shims from `@browserbasehq/sdk/_shims/registry`.
 
-`browserbase/_shims/auto/runtime` exports web runtime shims.
-If the `node` export condition is set, the export map replaces it with `browserbase/_shims/auto/runtime-node`.
+`@browserbasehq/sdk/_shims/auto/runtime` exports web runtime shims.
+If the `node` export condition is set, the export map replaces it with `@browserbasehq/sdk/_shims/auto/runtime-node`.
 
 ### How it works - Type time
 
-All client code imports shim types from `browserbase/_shims/index`, which selects the manual types from `browserbase/_shims/manual-types` if they have been declared, otherwise it exports the auto types from `browserbase/_shims/auto/types`.
+All client code imports shim types from `@browserbasehq/sdk/_shims/index`, which selects the manual types from `@browserbasehq/sdk/_shims/manual-types` if they have been declared, otherwise it exports the auto types from `@browserbasehq/sdk/_shims/auto/types`.
 
-`browserbase/_shims/manual-types` exports an empty namespace.
-Manually importing `browserbase/shims/node` or `browserbase/shims/web` merges declarations into this empty namespace, so they get picked up by `browserbase/_shims/index`.
+`@browserbasehq/sdk/_shims/manual-types` exports an empty namespace.
+Manually importing `@browserbasehq/sdk/shims/node` or `@browserbasehq/sdk/shims/web` merges declarations into this empty namespace, so they get picked up by `@browserbasehq/sdk/_shims/index`.
 
-`browserbase/_shims/auto/types` exports web type definitions.
-If the `node` export condition is set, the export map replaces it with `browserbase/_shims/auto/types-node`, though TS only picks this up if `"moduleResolution": "nodenext"` or `"moduleResolution": "bundler"`.
+`@browserbasehq/sdk/_shims/auto/types` exports web type definitions.
+If the `node` export condition is set, the export map replaces it with `@browserbasehq/sdk/_shims/auto/types-node`, though TS only picks this up if `"moduleResolution": "nodenext"` or `"moduleResolution": "bundler"`.

src/_shims/index.d.ts

@@ -2,7 +2,7 @@
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
 import { manual } from './manual-types';
-import * as auto from 'browserbase/_shims/auto/types';
+import * as auto from '@browserbasehq/sdk/_shims/auto/types';
 import { type RequestOptions } from '../core';
 
 type SelectType<Manual, Auto> = unknown extends Manual ? Auto : Manual;

src/_shims/index.js

@@ -2,7 +2,7 @@
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
 const shims = require('./registry');
-const auto = require('browserbase/_shims/auto/runtime');
+const auto = require('@browserbasehq/sdk/_shims/auto/runtime');
 if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
 for (const property of Object.keys(shims)) {
   Object.defineProperty(exports, property, {

src/_shims/index.mjs

@@ -2,6 +2,6 @@
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
 import * as shims from './registry.mjs';
-import * as auto from 'browserbase/_shims/auto/runtime';
+import * as auto from '@browserbasehq/sdk/_shims/auto/runtime';
 if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
 export * from './registry.mjs';