Merge pull request #23 from browserbase/release-please--branches--main--changes--next--components--sdk

release: 0.1.0-alpha.3

Author: maxbeatty

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.2"
+  ".": "0.1.0-alpha.3"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 18
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-9f93c744538f57747ea1385817e21b40c318b65ebc155dca8950268beb280bc9.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-b341dd9d5bb77c4f217b94b186763e730fd798fbb773a5e90bb4e2a8d4a2c822.yml

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.1.0-alpha.3 (2024-10-29)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/browserbase/sdk-node/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** api update ([#19](https://github.com/browserbase/sdk-node/issues/19)) ([8df9cc8](https://github.com/browserbase/sdk-node/commit/8df9cc8c76e4a615ba63d4568086bd60e88a0dfb))
+
+
+### Chores
+
+* update SDK settings ([#21](https://github.com/browserbase/sdk-node/issues/21)) ([dd2956f](https://github.com/browserbase/sdk-node/commit/dd2956f0b22aac232b6ae3cdd572a4d6b688099d))
+
 ## 0.1.0-alpha.2 (2024-10-28)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/browserbase/sdk-node/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

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.
 
@@ -11,19 +11,16 @@ It is generated with [Stainless](https://www.stainlessapi.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://[email protected]:browserbase/sdk-node.git
+npm install @browserbasehq/sdk
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install browserbase`
-
 ## 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
@@ -44,7 +41,7 @@ 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
@@ -218,11 +215,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 +229,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> => {

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-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "browserbase",
-  "version": "0.1.0-alpha.2",
+  "name": "@browserbasehq/sdk",
+  "version": "0.1.0-alpha.3",
   "description": "The official TypeScript library for the Browserbase API",
   "author": "Browserbase <[email protected]>",
   "types": "dist/index.d.ts",
@@ -67,8 +67,8 @@
     "./shims/web.mjs"
   ],
   "imports": {
-    "browserbase": ".",
-    "browserbase/*": "./src/*"
+    "@browserbasehq/sdk": ".",
+    "@browserbasehq/sdk/*": "./src/*"
   },
   "exports": {
     "./_shims/auto/*": {

package.json

@@ -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/build

@@ -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');