Merge pull request #2 from browser-use/release-please--branches--main--changes--next--components--browser-use-sdk

release: 0.1.0

Author: maticzav

.github/workflows/publish-npm.yml

@@ -0,0 +1,32 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/browser-use/browser-use-node/actions/workflows/publish-npm.yml
+name: Publish NPM
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.BROWSER_USE_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,21 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'browser-use/browser-use-node' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.BROWSER_USE_NPM_TOKEN || secrets.NPM_TOKEN }}

.release-please-manifest.json

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

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 22
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browser-use%2Fbrowser-use-86040fd18419e7b4e0947660d9c0ff1abe21550528d2d2a549736cd16f85a92d.yml
 openapi_spec_hash: 7c5de9d0f633db35fd9e250fcc834d1f
-config_hash: fdda11f4272828e3d5d13f933105a0d7
+config_hash: 9ae623b132cbaa42505f45bb1db418ea

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.1.0 (2025-08-09)
+
+Full Changelog: [v0.0.1...v0.1.0](https://github.com/browser-use/browser-use-node/compare/v0.0.1...v0.1.0)
+
+### Features
+
+* **api:** update via SDK Studio ([c56303c](https://github.com/browser-use/browser-use-node/commit/c56303c06357c1b24d6e797dd9a1fb7ca4e4249b))
+
+
+### Chores
+
+* update SDK settings ([e47a3c0](https://github.com/browser-use/browser-use-node/commit/e47a3c0111c16d7c1e7096a8b69f5e77c85f82fe))
+* update SDK settings ([c39de14](https://github.com/browser-use/browser-use-node/commit/c39de1490a0d59e65b376efa94ec959b87b43d47))

CONTRIBUTING.md

@@ -42,25 +42,25 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ npm install git+ssh://[email protected]:stainless-sdks/browser-use-typescript.git
+$ npm install git+ssh://[email protected]:browser-use/browser-use-node.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
 ```sh
 # Clone
-$ git clone https://www.github.com/stainless-sdks/browser-use-typescript
-$ cd browser-use-typescript
+$ git clone https://www.github.com/browser-use/browser-use-node
+$ cd browser-use-node
 
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link browser-use-node
+$ yarn link browser-use-sdk
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global browser-use-node
+$ pnpm link -—global browser-use-sdk
 ```
 
 ## Running tests
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ yarn fix
 ```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/browser-use/browser-use-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

README.md

@@ -1,6 +1,6 @@
 # Browser Use TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/browser-use-node.svg?label=npm%20(stable)>)](https://npmjs.org/package/browser-use-node) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/browser-use-node)
+[![NPM version](<https://img.shields.io/npm/v/browser-use-sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/browser-use-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/browser-use-sdk)
 
 This library provides convenient access to the Browser Use REST API from server-side TypeScript or JavaScript.
 
@@ -11,19 +11,16 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://[email protected]:stainless-sdks/browser-use-typescript.git
+npm install browser-use-sdk
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install browser-use-node`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 
 const client = new BrowserUse({
   apiKey: process.env['BROWSER_USE_API_KEY'], // This is the default and can be omitted
@@ -40,7 +37,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 
 const client = new BrowserUse({
   apiKey: process.env['BROWSER_USE_API_KEY'], // This is the default and can be omitted
@@ -162,7 +159,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 
 const client = new BrowserUse({
   logLevel: 'debug', // Show all log messages
@@ -190,7 +187,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
 below the configured level will not be sent to your logger.
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 import pino from 'pino';
 
 const logger = pino();
@@ -259,7 +256,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 import fetch from 'my-fetch';
 
 const client = new BrowserUse({ fetch });
@@ -270,7 +267,7 @@ const client = new BrowserUse({ fetch });
 If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 
 const client = new BrowserUse({
   fetchOptions: {
@@ -287,7 +284,7 @@ options to requests:
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -301,7 +298,7 @@ const client = new BrowserUse({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
 ```ts
-import BrowserUse from 'browser-use-node';
+import BrowserUse from 'browser-use-sdk';
 
 const client = new BrowserUse({
   fetchOptions: {
@@ -313,7 +310,7 @@ const client = new BrowserUse({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
 
 ```ts
-import BrowserUse from 'npm:browser-use-node';
+import BrowserUse from 'npm:browser-use-sdk';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new BrowserUse({
@@ -335,7 +332,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 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/stainless-sdks/browser-use-typescript/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/browser-use/browser-use-node/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

bin/check-release-environment

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${NPM_TOKEN}" ]; then
+  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[@]}
+
+if [[ lenErrors -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"
+

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^browser-use-node(/.*)?',
+              regex: '^browser-use-sdk(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],

jest.config.ts

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