stagehand 3.19.3 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3995180e65110d8a64695b7be8cb095b24e8d6fb3bc2627f13df4c0acaa15f2
-  data.tar.gz: a0b8bcd2648d2429b55c13b50d60fb7ec46da97118390900d1acfe0989e728d4
+  metadata.gz: 6323bad966eabb92ea6461cf51513992a9a5ab53a20c2c59a3c926a09db69f58
+  data.tar.gz: 93e96e355f774540da45305016f480d525d8efd500fa7f72d997591db6460d92
 SHA512:
-  metadata.gz: 83eae8bebac5087cda9551141db3d62bff7a0caa065ff675799610237d3ebf5114b62bb519403a3063e147b9384721d6bc0fdca28ce222c08691326f0a8b5e82
-  data.tar.gz: 7461914b6798606c6f0a672074ed3eaba504a82794e97becf1974de15cf701ce25ceec987d6969bb833d2ef098a5562da41f7faad6b1e871c75bba3ed4b4cda9
+  metadata.gz: 2f7d789b0cb10ef1cec433e586e00612c8c2597ee9061369214d116277ad0cac52ff35e0cebb13b96e91398e2e6380354c713479f07384ad64cdd581b8a4e8c2
+  data.tar.gz: ccb32a0e15484d6ccdd7142cd711734d386a42ee68eaa02f69225f5541df166fcb7e79682dd4c47933de4407588e9688027adb2ce3644daa599305a89ed4146b

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## 3.21.0 (2026-05-27)
+
+Full Changelog: [v3.20.0...v3.21.0](https://github.com/browserbase/stagehand-ruby/compare/v3.20.0...v3.21.0)
+
+### Features
+
+* [feat]: add `ignoreSelectors` to `observe()` ([0acc093](https://github.com/browserbase/stagehand-ruby/commit/0acc093944e72ee488393ec1fb73dc16450cc825))
+* [STG-1756] forward Vertex model config ([f9752bc](https://github.com/browserbase/stagehand-ruby/commit/f9752bc3297bb9feef4d4b46d7faeac2a5e73335))
+* Add `screenshot` option to Extract ([7b65ca7](https://github.com/browserbase/stagehand-ruby/commit/7b65ca776e1e13c489f13991b012fa24aecc60e6))
+* STG-1756 add Vertex auth params to Stagehand spec ([4b65f22](https://github.com/browserbase/stagehand-ruby/commit/4b65f221055c7d0d3d7426845fbd0e49ba13d2df))
+
+
+### Bug Fixes
+
+* **client:** elide content type header on requests without body ([6149c11](https://github.com/browserbase/stagehand-ruby/commit/6149c11d9ab60a0cac69f1e26e3a2f42425ad616))
+
+## 3.20.0 (2026-05-06)
+
+Full Changelog: [v3.19.3...v3.20.0](https://github.com/browserbase/stagehand-ruby/compare/v3.19.3...v3.20.0)
+
+### Features
+
+* [feat]: add `ignoreSelectors` to `extract()` ([db24a9a](https://github.com/browserbase/stagehand-ruby/commit/db24a9ab45dc464d2ad88f9b50d39952c4c76801))
+* [STG-1798] feat: support Browserbase verified sessions ([9647eb3](https://github.com/browserbase/stagehand-ruby/commit/9647eb3a4df86cc9d7aedb2f0a9ddd0babd39565))
+* [STG-1808] Deprecate Browserbase project ID ([7af1c21](https://github.com/browserbase/stagehand-ruby/commit/7af1c21a07e7163ffb0b86f6c199989b750e0365))
+* Bedrock auth passthrough ([5cb6ecb](https://github.com/browserbase/stagehand-ruby/commit/5cb6ecbe621e894dc6c5aec379fdca1183eec4fc))
+* remove experimental requirement on agent variables ([#2079](https://github.com/browserbase/stagehand-ruby/issues/2079)) ([6f106d7](https://github.com/browserbase/stagehand-ruby/commit/6f106d74feb1b3f036433ec67dda5e4c395f434e))
+* Revert "[STG-1573] Add providerOptions for extensible model auth ([#1822](https://github.com/browserbase/stagehand-ruby/issues/1822))" ([0c83a09](https://github.com/browserbase/stagehand-ruby/commit/0c83a0978116f8fc11a4edf78586f3d61b8af5e8))
+* support setting headers via env ([5515959](https://github.com/browserbase/stagehand-ruby/commit/5515959505685e62f9324aebf470a295dd6d8292))
+
+
+### Bug Fixes
+
+* avoid gzip buffering during streaming ([23c3eef](https://github.com/browserbase/stagehand-ruby/commit/23c3eef17497edbf3ec03049d12c548607112c8d))
+* multipart encoding for file arrays ([149b303](https://github.com/browserbase/stagehand-ruby/commit/149b303eb54f4c9af037a5e073a2d6c92d959b44))
+
+
+### Chores
+
+* **internal:** more robust bootstrap script ([69c050a](https://github.com/browserbase/stagehand-ruby/commit/69c050a467b5fcab904331bd30bd18d46cee8cae))
+
 ## 3.19.3 (2026-04-03)
 
 Full Changelog: [v3.18.0...v3.19.3](https://github.com/browserbase/stagehand-ruby/compare/v3.18.0...v3.19.3)

data/README.md

@@ -90,7 +90,6 @@ require "playwright"
 
 client = Stagehand::Client.new(
   browserbase_api_key: ENV["BROWSERBASE_API_KEY"],
-  browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"],
   model_api_key: ENV["MODEL_API_KEY"],
   server: "remote"
 )
@@ -162,10 +161,10 @@ client.sessions.end_(session_id)
 
 Set your environment variables (from `examples/.env.example`):
 
-- `STAGEHAND_API_URL`
 - `MODEL_API_KEY`
 - `BROWSERBASE_API_KEY`
-- `BROWSERBASE_PROJECT_ID`
+
+`STAGEHAND_API_URL` is optional and defaults to the hosted Stagehand API. `STAGEHAND_BASE_URL` remains supported as a deprecated fallback when `STAGEHAND_API_URL` is unset.
 
 ```bash
 cp examples/.env.example examples/.env

data/lib/stagehand/client.rb

@@ -19,7 +19,8 @@ module Stagehand
     # @return [String]
     attr_reader :browserbase_api_key
 
-    # Your [Browserbase Project ID](https://www.browserbase.com/settings)
+    # Deprecated. Browserbase API keys are now project-scoped, so this value is accepted for
+    # backwards compatibility and ignored.
     # @return [String]
     attr_reader :browserbase_project_id
 
@@ -34,7 +35,7 @@ module Stagehand
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      {**bb_api_key_auth, **bb_project_id_auth, **llm_model_api_key_auth}
+      {**bb_api_key_auth, **llm_model_api_key_auth}
     end
 
     # @api private
@@ -48,7 +49,7 @@ module Stagehand
     #
     # @return [Hash{String=>String}]
     private def bb_project_id_auth
-      {"x-bb-project-id" => @browserbase_project_id}
+      {}
     end
 
     # @api private
@@ -63,8 +64,8 @@ module Stagehand
     # @param browserbase_api_key [String, nil] Your [Browserbase API Key](https://www.browserbase.com/settings) Defaults to
     # `ENV["BROWSERBASE_API_KEY"]`
     #
-    # @param browserbase_project_id [String, nil] Your [Browserbase Project ID](https://www.browserbase.com/settings) Defaults to
-    # `ENV["BROWSERBASE_PROJECT_ID"]`
+    # @param browserbase_project_id [String, nil] Deprecated. Browserbase API keys are now project-scoped, so
+    # this value is accepted for backwards compatibility and ignored.
     #
     # @param model_api_key [String, nil] Your LLM provider API key (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)
     # Defaults to `ENV["MODEL_API_KEY"]`
@@ -72,7 +73,8 @@ module Stagehand
     # @param server [String] Server mode to use ("remote" or "local"). Defaults to "remote"
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
-    # `"https://api.example.com/v2/"`. Defaults to `ENV["STAGEHAND_BASE_URL"]`
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["STAGEHAND_API_URL"]`,
+    # then `ENV["STAGEHAND_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -83,10 +85,10 @@ module Stagehand
     # @param max_retry_delay [Float]
     def initialize(
       browserbase_api_key: ENV["BROWSERBASE_API_KEY"],
-      browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"],
+      browserbase_project_id: nil,
       model_api_key: ENV["MODEL_API_KEY"],
       server: "remote",
-      base_url: ENV["STAGEHAND_BASE_URL"],
+      base_url: ENV["STAGEHAND_API_URL"] || ENV["STAGEHAND_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
@@ -99,15 +101,24 @@ module Stagehand
         raise ArgumentError,
               "browserbase_api_key is required, and can be set via environ: \"BROWSERBASE_API_KEY\""
       end
-      if browserbase_project_id.nil?
-        raise ArgumentError,
-              "browserbase_project_id is required, and can be set via environ: \"BROWSERBASE_PROJECT_ID\""
-      end
       if model_api_key.nil?
         raise ArgumentError,
               "model_api_key is required, and can be set via environ: \"MODEL_API_KEY\""
       end
 
+      headers = {}
+      custom_headers_env = ENV["STAGEHAND_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @browserbase_api_key = browserbase_api_key.to_s
       @browserbase_project_id = browserbase_project_id.to_s
       @model_api_key = model_api_key.to_s
@@ -117,7 +128,8 @@ module Stagehand
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @sessions = Stagehand::Resources::Sessions.new(client: self)

data/lib/stagehand/internal/transport/base_client.rb

@@ -306,6 +306,8 @@ module Stagehand
               Stagehand::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          headers.delete("content-type") if body.nil?
+
           url = Stagehand::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/stagehand/internal/type/union.rb

@@ -4,6 +4,17 @@ module Stagehand
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `model_config` is a `Stagehand::ModelConfig`
+      #   case model_config
+      #   when Stagehand::ModelConfig::VertexModelConfigObject
+      #     puts(model_config.auth)
+      #   when Stagehand::ModelConfig::GenericModelConfigObject
+      #     puts(model_config.model_name)
+      #   else
+      #     puts(model_config)
+      #   end
       module Union
         include Stagehand::Internal::Type::Converter
         include Stagehand::Internal::Util::SorbetRuntimeSupport

data/lib/stagehand/internal/util.rb

@@ -610,6 +610,7 @@ module Stagehand
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -619,7 +620,7 @@ module Stagehand
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Stagehand::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -635,6 +636,7 @@ module Stagehand
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/stagehand/local.rb

@@ -50,7 +50,6 @@ module Stagehand
 
       missing = []
       missing << "browserbase_api_key" if client.browserbase_api_key.to_s.empty?
-      missing << "browserbase_project_id" if client.browserbase_project_id.to_s.empty?
       return if missing.empty?
 
       message =
@@ -213,10 +212,9 @@ module Stagehand
     end
 
     class ServerManager
-      def initialize(model_api_key:, browserbase_api_key:, browserbase_project_id:)
+      def initialize(model_api_key:, browserbase_api_key:)
         @model_api_key = model_api_key
         @browserbase_api_key = browserbase_api_key
-        @browserbase_project_id = browserbase_project_id
         @host = DEFAULT_HOST
         @port = 0
         @mutex = Mutex.new
@@ -335,9 +333,6 @@ module Stagehand
         if @browserbase_api_key.to_s != ""
           env["BROWSERBASE_API_KEY"] = @browserbase_api_key
         end
-        if @browserbase_project_id.to_s != ""
-          env["BROWSERBASE_PROJECT_ID"] = @browserbase_project_id
-        end
         env
       end
 
@@ -376,8 +371,6 @@ module Stagehand
           kwargs[:base_url] = base_url.nil? ? "http://#{DEFAULT_HOST}" : base_url
           kwargs[:browserbase_api_key] =
             kwargs[:browserbase_api_key] || ENV["BROWSERBASE_API_KEY"] || ""
-          kwargs[:browserbase_project_id] =
-            kwargs[:browserbase_project_id] || ENV["BROWSERBASE_PROJECT_ID"] || ""
         end
 
         super(**kwargs)
@@ -386,8 +379,7 @@ module Stagehand
 
         @local_server_manager = Stagehand::Local::ServerManager.new(
           model_api_key: @model_api_key,
-          browserbase_api_key: @browserbase_api_key,
-          browserbase_project_id: @browserbase_project_id
+          browserbase_api_key: @browserbase_api_key
         )
       end
 
@@ -421,8 +413,7 @@ module Stagehand
       end
 
       def bb_project_id_auth
-        return {} if @browserbase_project_id.to_s.empty?
-        super
+        {}
       end
     end