Merge pull request #4 from browserbase/release-please--branches--main--changes--next

release: 0.3.0

Author: pirate

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.0"
+  ".": "0.3.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 7
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fstagehand-705638ac8966569986bd9ebb7c9761bf0016909e9f2753e77ceabb12c8049511.yml
-openapi_spec_hash: a8fbbcaa38e91c7f97313620b42d8d62
-config_hash: a35b56eb05306a0f02e83c11d57f975f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fstagehand-e96507dd78e76fccc77ba7fb09704da127ead6f4d73ea854e9b2150e90787ff4.yml
+openapi_spec_hash: 0c2548b8fdd6de6789b19123e69609c1
+config_hash: c3abb41dbe698d59b3bf12f393013d54

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.3.0 (2025-12-17)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/browserbase/stagehand-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** manual updates ([7dcf75c](https://github.com/browserbase/stagehand-ruby/commit/7dcf75cc0c580743b8bb0bbdb41077a6a7aa6dfb))
+* **api:** manual updates ([3162ca0](https://github.com/browserbase/stagehand-ruby/commit/3162ca00c75b37ccb869d7a082f25b263e15d93d))
+* **api:** manual updates ([a972ef7](https://github.com/browserbase/stagehand-ruby/commit/a972ef7dc9040af201ee8e87db013fc077a7ab3f))
+* **api:** manual updates ([be169eb](https://github.com/browserbase/stagehand-ruby/commit/be169ebb8a61b86f4d1caee63aeded39139f10aa))
+* **api:** manual updates ([2a98da9](https://github.com/browserbase/stagehand-ruby/commit/2a98da9563a1ab4e33d6bf3398083d772b61e07f))
+* **api:** manual updates ([05879da](https://github.com/browserbase/stagehand-ruby/commit/05879da16a92ae6199ca2c4e323a6602fbc5d841))
+* **api:** manual updates ([69e4183](https://github.com/browserbase/stagehand-ruby/commit/69e418398b943df8b7454b50ab02d17ba3feb212))
+* **api:** manual updates ([9176bca](https://github.com/browserbase/stagehand-ruby/commit/9176bcaf88f115335199a44a52c8e1d697920822))
+* **api:** manual updates ([36f0681](https://github.com/browserbase/stagehand-ruby/commit/36f0681452a11e25da7126e0270855bbdd3fe8df))
+
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([369b9d0](https://github.com/browserbase/stagehand-ruby/commit/369b9d0d37390d96fa673d08e64594cefc6a04fa))
+
 ## 0.2.0 (2025-12-16)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/browserbase/stagehand-ruby/compare/v0.1.0...v0.2.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    stagehand (0.2.0)
+    stagehand (0.3.0)
       connection_pool
 
 GEM

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "stagehand", "~> 0.2.0"
+gem "stagehand", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -36,7 +36,7 @@ stagehand = Stagehand::Client.new(
 
 response = stagehand.sessions.act("00000000-your-session-id-000000000000", input: "click the first link on the page")
 
-puts(response.actions)
+puts(response.data)
 ```
 
 ### Handling errors
@@ -45,10 +45,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  session = stagehand.sessions.start(
-    browserbase_api_key: "your Browserbase API key",
-    browserbase_project_id: "your Browserbase Project ID"
-  )
+  session = stagehand.sessions.start(model_name: "openai/gpt-5-nano")
 rescue Stagehand::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -91,11 +88,7 @@ stagehand = Stagehand::Client.new(
 )
 
 # Or, configure per-request:
-stagehand.sessions.start(
-  browserbase_api_key: "your Browserbase API key",
-  browserbase_project_id: "your Browserbase Project ID",
-  request_options: {max_retries: 5}
-)
+stagehand.sessions.start(model_name: "openai/gpt-5-nano", request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -109,11 +102,7 @@ stagehand = Stagehand::Client.new(
 )
 
 # Or, configure per-request:
-stagehand.sessions.start(
-  browserbase_api_key: "your Browserbase API key",
-  browserbase_project_id: "your Browserbase Project ID",
-  request_options: {timeout: 5}
-)
+stagehand.sessions.start(model_name: "openai/gpt-5-nano", request_options: {timeout: 5})
 ```
 
 On timeout, `Stagehand::Errors::APITimeoutError` is raised.
@@ -145,8 +134,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 ```ruby
 response =
   stagehand.sessions.start(
-    browserbase_api_key: "your Browserbase API key",
-    browserbase_project_id: "your Browserbase Project ID",
+    model_name: "openai/gpt-5-nano",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -211,25 +199,25 @@ stagehand.sessions.act("00000000-your-session-id-000000000000", **params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :true
-puts(Stagehand::SessionActParams::XStreamResponse::TRUE)
+# :typescript
+puts(Stagehand::SessionActParams::XLanguage::TYPESCRIPT)
 
-# Revealed type: `T.all(Stagehand::SessionActParams::XStreamResponse, Symbol)`
-T.reveal_type(Stagehand::SessionActParams::XStreamResponse::TRUE)
+# Revealed type: `T.all(Stagehand::SessionActParams::XLanguage, Symbol)`
+T.reveal_type(Stagehand::SessionActParams::XLanguage::TYPESCRIPT)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
 stagehand.sessions.act(
-  x_stream_response: Stagehand::SessionActParams::XStreamResponse::TRUE,
+  x_language: Stagehand::SessionActParams::XLanguage::TYPESCRIPT,
   # …
 )
 
 # Literal values are also permissible:
 stagehand.sessions.act(
-  x_stream_response: :true,
+  x_language: :typescript,
   # …
 )
 ```

lib/stagehand.rb

@@ -58,8 +58,8 @@
 require_relative "stagehand/models/session_act_response"
 require_relative "stagehand/models/session_end_params"
 require_relative "stagehand/models/session_end_response"
-require_relative "stagehand/models/session_execute_agent_params"
-require_relative "stagehand/models/session_execute_agent_response"
+require_relative "stagehand/models/session_execute_params"
+require_relative "stagehand/models/session_execute_response"
 require_relative "stagehand/models/session_extract_params"
 require_relative "stagehand/models/session_extract_response"
 require_relative "stagehand/models/session_navigate_params"

lib/stagehand/internal/transport/pooled_net_requester.rb

@@ -153,17 +153,19 @@ def execute(request)
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

lib/stagehand/internal/type/base_model.rb

@@ -440,9 +440,9 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false)
         # @example
         #   # `action` is a `Stagehand::Action`
         #   action => {
-        #     arguments: arguments,
         #     description: description,
-        #     method_: method_
+        #     selector: selector,
+        #     arguments: arguments
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

lib/stagehand/internal/type/union.rb

@@ -6,14 +6,14 @@ module Type
       # @api private
       #
       # @example
-      #   # `session_extract_response` is a `Stagehand::Models::SessionExtractResponse`
-      #   case session_extract_response
-      #   when Stagehand::Models::SessionExtractResponse::Extraction
-      #     puts(session_extract_response.extraction)
-      #   when Stagehand::Models::SessionExtractResponse::CustomMap
+      #   # `model_config` is a `Stagehand::ModelConfig`
+      #   case model_config
+      #   when String
       #     # ...
+      #   when Stagehand::ModelConfig::ModelConfigObject
+      #     puts(model_config.model_name)
       #   else
-      #     puts(session_extract_response)
+      #     puts(model_config)
       #   end
       module Union
         include Stagehand::Internal::Type::Converter

lib/stagehand/models.rb

@@ -47,7 +47,7 @@ module Stagehand
 
   SessionEndParams = Stagehand::Models::SessionEndParams
 
-  SessionExecuteAgentParams = Stagehand::Models::SessionExecuteAgentParams
+  SessionExecuteParams = Stagehand::Models::SessionExecuteParams
 
   SessionExtractParams = Stagehand::Models::SessionExtractParams