browserbase · stainless-app · May 16, 2025 · May 22, 2025 · May 28, 2025 · Jun 3, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,12 +7,17 @@ on:
       - 'integrated/**'
       - 'stl-preview-head/**'
       - 'stl-preview-base/**'
+  pull_request:
+    branches-ignore:
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/browserbase-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 
@@ -31,6 +36,7 @@ jobs:
     timeout-minutes: 5
     name: build
     runs-on: ${{ github.repository == 'stainless-sdks/browserbase-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     permissions:
       contents: read
       id-token: write
@@ -66,6 +72,7 @@ jobs:
     timeout-minutes: 10
     name: test
     runs-on: ${{ github.repository == 'stainless-sdks/browserbase-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 

diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "2.6.0"
+  ".": "2.7.0"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 18
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-e2ed1b5267eeff92982918505349017b9155da2c7ab948787ab11cf9068af1b8.yml
-openapi_spec_hash: 6639c21dccb52ca610cae833227a9791
-config_hash: 74882e23a455dece33e43a27e67f0fbb
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-be7a4aeebb1605262935b4b3ab446a95b1fad8a7d18098943dd548c8a486ef13.yml
+openapi_spec_hash: 1c950a109f80140711e7ae2cf87fddad
+config_hash: b3ca4ec5b02e5333af51ebc2e9fdef1b
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,63 @@
 # Changelog
 
+## 2.7.0 (2025-09-26)
+
+Full Changelog: [v2.6.0...v2.7.0](https://github.com/browserbase/sdk-node/compare/v2.6.0...v2.7.0)
+
+### Features
+
+* **api:** api update ([3348e1a](https://github.com/browserbase/sdk-node/commit/3348e1a8e2cd6093142953283cedeaab44dfba81))
+* **api:** api update ([d80e4ac](https://github.com/browserbase/sdk-node/commit/d80e4acd14c12d8eed735ae11ed41cc07077dbde))
+* **api:** api update ([d661869](https://github.com/browserbase/sdk-node/commit/d661869a4b91bdc914195961b63ec5080060b178))
+* **api:** api update ([d57f23e](https://github.com/browserbase/sdk-node/commit/d57f23ea6d04a61dd523fd9cfea3bba138914483))
+* **api:** api update ([90c9185](https://github.com/browserbase/sdk-node/commit/90c9185c9de52ad0297062906d58ec7bb99ea004))
+* **api:** api update ([0ec3383](https://github.com/browserbase/sdk-node/commit/0ec33838237efd4424249482aac57294f17bdeda))
+* **api:** api update ([ef5f62b](https://github.com/browserbase/sdk-node/commit/ef5f62b267edcfa58fb677db40ae24a9a742ffa0))
+* **api:** manual updates ([b2ac95c](https://github.com/browserbase/sdk-node/commit/b2ac95c9014672c812f352f5c9ca8a4c325c9a2f))
+* **api:** manual updates ([59bb2a5](https://github.com/browserbase/sdk-node/commit/59bb2a5665c3bebf073c7084d8dbfbef40148e38))
+* **client:** add support for endpoint-specific base URLs ([0c69436](https://github.com/browserbase/sdk-node/commit/0c69436d731785b207af5f979e9eb5ae1b975957))
+* **mcp:** support filtering tool results by a jq expression ([0efabac](https://github.com/browserbase/sdk-node/commit/0efabac130794ebc44c4054a19e77bb6fc455749))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([8e59beb](https://github.com/browserbase/sdk-node/commit/8e59beb314e8c07bd14b471121e28ec941168190))
+* **client:** don't send `Content-Type` for bodyless methods ([bfe46e8](https://github.com/browserbase/sdk-node/commit/bfe46e8c3af3377953857072ee39babdaec25820))
+* coerce nullable values to undefined ([6108dc5](https://github.com/browserbase/sdk-node/commit/6108dc5e49ed0623e8d91159e65c8a2a6399c811))
+* publish script — handle NPM errors correctly ([87c245e](https://github.com/browserbase/sdk-node/commit/87c245e2048dad1586d97fae8c4622c6e2780365))
+
+
+### Performance Improvements
+
+* faster formatting ([44cd7a6](https://github.com/browserbase/sdk-node/commit/44cd7a6321dc1dc6f0ebffef9f39db191efd4576))
+
+
+### Chores
+
+* ci build action ([4fe59cd](https://github.com/browserbase/sdk-node/commit/4fe59cd495df620609a05b8556d04d1968ef004b))
+* **ci:** enable for pull requests ([132825d](https://github.com/browserbase/sdk-node/commit/132825d5c65ba9aa1c47afe9b8a7b14885129598))
+* **ci:** only run for pushes and fork pull requests ([a166050](https://github.com/browserbase/sdk-node/commit/a166050ab35ddff365ca60f23ed1243690b7eda2))
+* **deps:** update dependency node-fetch to v2.6.13 ([b657cbe](https://github.com/browserbase/sdk-node/commit/b657cbec9e3603f4fe186141f0e38aa8a3a66bb7))
+* do not install brew dependencies in ./scripts/bootstrap by default ([ea703c8](https://github.com/browserbase/sdk-node/commit/ea703c8de75098582591496bdb0b3d81c9f1605a))
+* **docs:** grammar improvements ([985f2fe](https://github.com/browserbase/sdk-node/commit/985f2fe1bf866f1dc48c8d5f1827dda2e99b6f11))
+* **docs:** use top-level-await in example snippets ([24c7006](https://github.com/browserbase/sdk-node/commit/24c7006ca4c4dc7c03a48796b2677bdc47728934))
+* improve publish-npm script --latest tag logic ([88ce3e3](https://github.com/browserbase/sdk-node/commit/88ce3e3a96e34bfeb08d2ac254440b283818d7ef))
+* **internal:** formatting change ([29b57d4](https://github.com/browserbase/sdk-node/commit/29b57d4294400969bccde8cacc2b27a5dd90f7fa))
+* **internal:** make base APIResource abstract ([6ec9d38](https://github.com/browserbase/sdk-node/commit/6ec9d38a92775cb8e46468b05f539f53a01b54c9))
+* **internal:** move publish config ([2fb47ce](https://github.com/browserbase/sdk-node/commit/2fb47cec73a9d518866c84f927fbe16327dc9ab9))
+* **internal:** remove redundant imports config ([ddf4087](https://github.com/browserbase/sdk-node/commit/ddf408750a968e8bfcab59a1b86d58be796074de))
+* **internal:** update comment in script ([a549d56](https://github.com/browserbase/sdk-node/commit/a549d56d306c23019fc9cd99f4af5d48345664a5))
+* **internal:** version bump ([690777f](https://github.com/browserbase/sdk-node/commit/690777f5b88d363db563aba093363ed84c7c9ec4))
+* make some internal functions async ([f8111cb](https://github.com/browserbase/sdk-node/commit/f8111cb415bd62ff7d30f6ec7912878042d94eed))
+* mention unit type in timeout docs ([8d864d1](https://github.com/browserbase/sdk-node/commit/8d864d1f6858a655840ec824434e045c886216eb))
+* update @stainless-api/prism-cli to v5.15.0 ([d4ac1f1](https://github.com/browserbase/sdk-node/commit/d4ac1f19f066dc8386a2d7a48123d031763bef46))
+* update CI script ([2cd3501](https://github.com/browserbase/sdk-node/commit/2cd3501a6fa3368e8ad48dcd97f8cafd03b92dca))
+
+
+### Refactors
+
+* **types:** replace Record with mapped types ([3e0bfd3](https://github.com/browserbase/sdk-node/commit/3e0bfd327332edd2969106d189e650286d13e441))
+
 ## 2.6.0 (2025-05-16)
 
 Full Changelog: [v2.5.0...v2.6.0](https://github.com/browserbase/sdk-node/compare/v2.5.0...v2.6.0)

diff --git a/README.md b/README.md
@@ -26,13 +26,9 @@ 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' });
+const session = await client.sessions.create({ projectId: 'your_project_id' });
 
-  console.log(session.id);
-}
-
-main();
+console.log(session.id);
 ```
 
 ### Request & Response types
@@ -47,12 +43,8 @@ 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' };
-  const session: Browserbase.SessionCreateResponse = await client.sessions.create(params);
-}
-
-main();
+const params: Browserbase.SessionCreateParams = { projectId: 'your_project_id' };
+const session: Browserbase.SessionCreateResponse = await client.sessions.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -95,19 +87,15 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  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();
+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;
+  }
+});
 ```
 
 Error codes are as follows:

diff --git a/SECURITY.md b/SECURITY.md
@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Browserbase please follow the respective company's security reporting guidelines.
+or products provided by Browserbase, please follow the respective company's security reporting guidelines.
 
 ### Browserbase Terms and Policies
 
-Please contact [email protected] for any questions or concerns regarding security of our services.
+Please contact [email protected] for any questions or concerns regarding the security of our services.
 
 ---
 

diff --git a/api.md b/api.md
@@ -2,59 +2,60 @@
 
 Types:
 
-- <code><a href="./src/resources/contexts.ts">Context</a></code>
 - <code><a href="./src/resources/contexts.ts">ContextCreateResponse</a></code>
+- <code><a href="./src/resources/contexts.ts">ContextRetrieveResponse</a></code>
 - <code><a href="./src/resources/contexts.ts">ContextUpdateResponse</a></code>
 
 Methods:
 
 - <code title="post /v1/contexts">client.contexts.<a href="./src/resources/contexts.ts">create</a>({ ...params }) -> ContextCreateResponse</code>
-- <code title="get /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">retrieve</a>(id) -> Context</code>
+- <code title="get /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">retrieve</a>(id) -> ContextRetrieveResponse</code>
 - <code title="put /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">update</a>(id) -> ContextUpdateResponse</code>
 
 # Extensions
 
 Types:
 
-- <code><a href="./src/resources/extensions.ts">Extension</a></code>
+- <code><a href="./src/resources/extensions.ts">ExtensionCreateResponse</a></code>
+- <code><a href="./src/resources/extensions.ts">ExtensionRetrieveResponse</a></code>
 
 Methods:
 
-- <code title="post /v1/extensions">client.extensions.<a href="./src/resources/extensions.ts">create</a>({ ...params }) -> Extension</code>
-- <code title="get /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">retrieve</a>(id) -> Extension</code>
+- <code title="post /v1/extensions">client.extensions.<a href="./src/resources/extensions.ts">create</a>({ ...params }) -> ExtensionCreateResponse</code>
+- <code title="get /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">retrieve</a>(id) -> ExtensionRetrieveResponse</code>
 - <code title="delete /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">delete</a>(id) -> void</code>
 
 # Projects
 
 Types:
 
-- <code><a href="./src/resources/projects.ts">Project</a></code>
-- <code><a href="./src/resources/projects.ts">ProjectUsage</a></code>
+- <code><a href="./src/resources/projects.ts">ProjectRetrieveResponse</a></code>
 - <code><a href="./src/resources/projects.ts">ProjectListResponse</a></code>
+- <code><a href="./src/resources/projects.ts">ProjectUsageResponse</a></code>
 
 Methods:
 
-- <code title="get /v1/projects/{id}">client.projects.<a href="./src/resources/projects.ts">retrieve</a>(id) -> Project</code>
+- <code title="get /v1/projects/{id}">client.projects.<a href="./src/resources/projects.ts">retrieve</a>(id) -> ProjectRetrieveResponse</code>
 - <code title="get /v1/projects">client.projects.<a href="./src/resources/projects.ts">list</a>() -> ProjectListResponse</code>
-- <code title="get /v1/projects/{id}/usage">client.projects.<a href="./src/resources/projects.ts">usage</a>(id) -> ProjectUsage</code>
+- <code title="get /v1/projects/{id}/usage">client.projects.<a href="./src/resources/projects.ts">usage</a>(id) -> ProjectUsageResponse</code>
 
 # Sessions
 
 Types:
 
-- <code><a href="./src/resources/sessions/sessions.ts">Session</a></code>
-- <code><a href="./src/resources/sessions/sessions.ts">SessionLiveURLs</a></code>
 - <code><a href="./src/resources/sessions/sessions.ts">SessionCreateResponse</a></code>
 - <code><a href="./src/resources/sessions/sessions.ts">SessionRetrieveResponse</a></code>
+- <code><a href="./src/resources/sessions/sessions.ts">SessionUpdateResponse</a></code>
 - <code><a href="./src/resources/sessions/sessions.ts">SessionListResponse</a></code>
+- <code><a href="./src/resources/sessions/sessions.ts">SessionDebugResponse</a></code>
 
 Methods:
 
 - <code title="post /v1/sessions">client.sessions.<a href="./src/resources/sessions/sessions.ts">create</a>({ ...params }) -> SessionCreateResponse</code>
 - <code title="get /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">retrieve</a>(id) -> SessionRetrieveResponse</code>
-- <code title="post /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">update</a>(id, { ...params }) -> Session</code>
+- <code title="post /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">update</a>(id, { ...params }) -> SessionUpdateResponse</code>
 - <code title="get /v1/sessions">client.sessions.<a href="./src/resources/sessions/sessions.ts">list</a>({ ...params }) -> SessionListResponse</code>
-- <code title="get /v1/sessions/{id}/debug">client.sessions.<a href="./src/resources/sessions/sessions.ts">debug</a>(id) -> SessionLiveURLs</code>
+- <code title="get /v1/sessions/{id}/debug">client.sessions.<a href="./src/resources/sessions/sessions.ts">debug</a>(id) -> SessionDebugResponse</code>
 
 ## Downloads
 
@@ -66,7 +67,6 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/sessions/logs.ts">SessionLog</a></code>
 - <code><a href="./src/resources/sessions/logs.ts">LogListResponse</a></code>
 
 Methods:
@@ -77,7 +77,6 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/sessions/recording.ts">SessionRecording</a></code>
 - <code><a href="./src/resources/sessions/recording.ts">RecordingRetrieveResponse</a></code>
 
 Methods:

diff --git a/bin/check-release-environment b/bin/check-release-environment
@@ -3,7 +3,7 @@
 errors=()
 
 if [ -z "${NPM_TOKEN}" ]; then
-  errors+=("The BROWSERBASE_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi
 
 lenErrors=${#errors[@]}

diff --git a/bin/publish-npm b/bin/publish-npm
@@ -4,22 +4,58 @@ set -eux
 
 npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
 
-# Build the project
 yarn build
-
-# Navigate to the dist directory
 cd dist
 
-# Get the version from package.json
-VERSION="$(node -p "require('./package.json').version")"
+# Get package name and version from package.json
+PACKAGE_NAME="$(jq -r -e '.name' ./package.json)"
+VERSION="$(jq -r -e '.version' ./package.json)"
+
+# Get latest version from npm
+#
+# If the package doesn't exist, npm will return:
+# {
+#   "error": {
+#     "code": "E404",
+#     "summary": "Unpublished on 2025-06-05T09:54:53.528Z",
+#     "detail": "'the_package' is not in this registry..."
+#   }
+# }
+NPM_INFO="$(npm view "$PACKAGE_NAME" version --json 2>/dev/null || true)"
+
+# Check if we got an E404 error
+if echo "$NPM_INFO" | jq -e '.error.code == "E404"' > /dev/null 2>&1; then
+  # Package doesn't exist yet, no last version
+  LAST_VERSION=""
+elif echo "$NPM_INFO" | jq -e '.error' > /dev/null 2>&1; then
+  # Report other errors
+  echo "ERROR: npm returned unexpected data:"
+  echo "$NPM_INFO"
+  exit 1
+else
+  # Success - get the version
+  LAST_VERSION=$(echo "$NPM_INFO" | jq -r '.') # strip quotes
+fi
 
-# Extract the pre-release tag if it exists
+# Check if current version is pre-release (e.g. alpha / beta / rc)
+CURRENT_IS_PRERELEASE=false
 if [[ "$VERSION" =~ -([a-zA-Z]+) ]]; then
-  # Extract the part before any dot in the pre-release identifier
-  TAG="${BASH_REMATCH[1]}"
+  CURRENT_IS_PRERELEASE=true
+  CURRENT_TAG="${BASH_REMATCH[1]}"
+fi
+
+# Check if last version is a stable release
+LAST_IS_STABLE_RELEASE=true
+if [[ -z "$LAST_VERSION" || "$LAST_VERSION" =~ -([a-zA-Z]+) ]]; then
+  LAST_IS_STABLE_RELEASE=false
+fi
+
+# Use a corresponding alpha/beta tag if there already is a stable release and we're publishing a prerelease.
+if $CURRENT_IS_PRERELEASE && $LAST_IS_STABLE_RELEASE; then
+  TAG="$CURRENT_TAG"
 else
   TAG="latest"
 fi
 
 # Publish with the appropriate tag
-yarn publish --access public --tag "$TAG"
+yarn publish --tag "$TAG"
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@browserbasehq/sdk",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "The official Node.js library for the Browserbase API",
   "author": "Browserbase <[email protected]>",
   "types": "dist/index.d.ts",
@@ -12,6 +12,9 @@
     "**/*"
   ],
   "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",
@@ -64,10 +67,6 @@
     "./shims/web.js",
     "./shims/web.mjs"
   ],
-  "imports": {
-    "@browserbasehq/sdk": ".",
-    "@browserbasehq/sdk/*": "./src/*"
-  },
   "exports": {
     "./_shims/auto/*": {
       "deno": {