stagehand 3.20.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d63d07d6d72284d6745a7f938ec12a7153c43a8cc9baba9e6bbf2559fd77b1e3
-  data.tar.gz: 8aa6950f119f872fddbb4d047e3ddb17253363c016c4be81bd573cd6a53b7bb0
+  metadata.gz: 6323bad966eabb92ea6461cf51513992a9a5ab53a20c2c59a3c926a09db69f58
+  data.tar.gz: 93e96e355f774540da45305016f480d525d8efd500fa7f72d997591db6460d92
 SHA512:
-  metadata.gz: f8281b0509afbe153829b60b77e259c98339f348654ed58e216a8d43003cf99aadba760de930518c62e1350ae37cb31fcab4a2e5fe6b5dbbfad07e94fc29ce62
-  data.tar.gz: 295b43fd779e909fd5c8b78e42b6a5b6b1f45686a47392136a08e4860c16e7382a203caaa9b8806e341a96dc4ca2789ee5a92e1c3606169516848ac577e2d31d
+  metadata.gz: 2f7d789b0cb10ef1cec433e586e00612c8c2597ee9061369214d116277ad0cac52ff35e0cebb13b96e91398e2e6380354c713479f07384ad64cdd581b8a4e8c2
+  data.tar.gz: ccb32a0e15484d6ccdd7142cd711734d386a42ee68eaa02f69225f5541df166fcb7e79682dd4c47933de4407588e9688027adb2ce3644daa599305a89ed4146b

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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)

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/models/model_config.rb

@@ -2,63 +2,333 @@
 
 module Stagehand
   module Models
-    class ModelConfig < Stagehand::Internal::Type::BaseModel
-      # @!attribute model_name
-      #   Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
-      #
-      #   @return [String]
-      required :model_name, String, api_name: :modelName
-
-      # @!attribute api_key
-      #   API key for the model provider
-      #
-      #   @return [String, nil]
-      optional :api_key, String, api_name: :apiKey
-
-      # @!attribute base_url
-      #   Base URL for the model provider
-      #
-      #   @return [String, nil]
-      optional :base_url, String, api_name: :baseURL
-
-      # @!attribute headers
-      #   Custom headers sent with every request to the model provider
-      #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :headers, Stagehand::Internal::Type::HashOf[String]
-
-      # @!attribute provider
-      #   AI provider for the model (or provide a baseURL endpoint instead)
-      #
-      #   @return [Symbol, Stagehand::Models::ModelConfig::Provider, nil]
-      optional :provider, enum: -> { Stagehand::ModelConfig::Provider }
-
-      # @!method initialize(model_name:, api_key: nil, base_url: nil, headers: nil, provider: nil)
-      #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
-      #
-      #   @param api_key [String] API key for the model provider
-      #
-      #   @param base_url [String] Base URL for the model provider
-      #
-      #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
-      #
-      #   @param provider [Symbol, Stagehand::Models::ModelConfig::Provider] AI provider for the model (or provide a baseURL endpoint instead)
-
-      # AI provider for the model (or provide a baseURL endpoint instead)
-      #
-      # @see Stagehand::Models::ModelConfig#provider
-      module Provider
-        extend Stagehand::Internal::Type::Enum
-
-        OPENAI = :openai
-        ANTHROPIC = :anthropic
-        GOOGLE = :google
-        MICROSOFT = :microsoft
-        BEDROCK = :bedrock
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
+    module ModelConfig
+      extend Stagehand::Internal::Type::Union
+
+      variant -> { Stagehand::ModelConfig::VertexModelConfigObject }
+
+      variant -> { Stagehand::ModelConfig::GenericModelConfigObject }
+
+      class VertexModelConfigObject < Stagehand::Internal::Type::BaseModel
+        # @!attribute auth
+        #   Vertex provider authentication configuration
+        #
+        #   @return [Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth]
+        required :auth, -> { Stagehand::ModelConfig::VertexModelConfigObject::Auth }
+
+        # @!attribute model_name
+        #   Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+        #
+        #   @return [String]
+        required :model_name, String, api_name: :modelName
+
+        # @!attribute provider
+        #   Vertex AI model provider
+        #
+        #   @return [Symbol, :vertex]
+        required :provider, const: :vertex
+
+        # @!attribute provider_options
+        #   Vertex provider-specific model configuration
+        #
+        #   @return [Stagehand::Models::ModelConfig::VertexModelConfigObject::ProviderOptions]
+        required :provider_options,
+                 -> { Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions },
+                 api_name: :providerOptions
+
+        # @!attribute api_key
+        #   API key for the model provider
+        #
+        #   @return [String, nil]
+        optional :api_key, String, api_name: :apiKey
+
+        # @!attribute base_url
+        #   Base URL for the model provider
+        #
+        #   @return [String, nil]
+        optional :base_url, String, api_name: :baseURL
+
+        # @!attribute headers
+        #   Custom headers sent with every request to the model provider
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+        # @!method initialize(auth:, model_name:, provider_options:, api_key: nil, base_url: nil, headers: nil, provider: :vertex)
+        #   @param auth [Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth] Vertex provider authentication configuration
+        #
+        #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+        #
+        #   @param provider_options [Stagehand::Models::ModelConfig::VertexModelConfigObject::ProviderOptions] Vertex provider-specific model configuration
+        #
+        #   @param api_key [String] API key for the model provider
+        #
+        #   @param base_url [String] Base URL for the model provider
+        #
+        #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
+        #
+        #   @param provider [Symbol, :vertex] Vertex AI model provider
+
+        # @see Stagehand::Models::ModelConfig::VertexModelConfigObject#auth
+        class Auth < Stagehand::Internal::Type::BaseModel
+          # @!attribute credentials
+          #   Google Cloud service account credentials
+          #
+          #   @return [Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials]
+          required :credentials, -> { Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials }
+
+          # @!attribute type
+          #   Use inline Google Cloud service account credentials for provider authentication
+          #
+          #   @return [Symbol, :googleServiceAccount]
+          required :type, const: :googleServiceAccount
+
+          # @!attribute project_id
+          #   Google Cloud project ID used by google-auth-library
+          #
+          #   @return [String, nil]
+          optional :project_id, String, api_name: :projectId
+
+          # @!attribute scopes
+          #   Google auth scopes for the desired API request
+          #
+          #   @return [String, Array<String>, nil]
+          optional :scopes, union: -> { Stagehand::ModelConfig::VertexModelConfigObject::Auth::Scopes }
+
+          # @!attribute universe_domain
+          #   Google Cloud universe domain
+          #
+          #   @return [String, nil]
+          optional :universe_domain, String, api_name: :universeDomain
+
+          # @!method initialize(credentials:, project_id: nil, scopes: nil, universe_domain: nil, type: :googleServiceAccount)
+          #   Vertex provider authentication configuration
+          #
+          #   @param credentials [Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials] Google Cloud service account credentials
+          #
+          #   @param project_id [String] Google Cloud project ID used by google-auth-library
+          #
+          #   @param scopes [String, Array<String>] Google auth scopes for the desired API request
+          #
+          #   @param universe_domain [String] Google Cloud universe domain
+          #
+          #   @param type [Symbol, :googleServiceAccount] Use inline Google Cloud service account credentials for provider authentication
+
+          # @see Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth#credentials
+          class Credentials < Stagehand::Internal::Type::BaseModel
+            # @!attribute client_email
+            #
+            #   @return [String]
+            required :client_email, String
+
+            # @!attribute private_key
+            #
+            #   @return [String]
+            required :private_key, String
+
+            # @!attribute auth_provider_x509_cert_url
+            #
+            #   @return [String, nil]
+            optional :auth_provider_x509_cert_url, String
+
+            # @!attribute auth_uri
+            #
+            #   @return [String, nil]
+            optional :auth_uri, String
+
+            # @!attribute client_id
+            #
+            #   @return [String, nil]
+            optional :client_id, String
+
+            # @!attribute client_x509_cert_url
+            #
+            #   @return [String, nil]
+            optional :client_x509_cert_url, String
+
+            # @!attribute private_key_id
+            #
+            #   @return [String, nil]
+            optional :private_key_id, String
+
+            # @!attribute project_id
+            #
+            #   @return [String, nil]
+            optional :project_id, String
+
+            # @!attribute token_uri
+            #
+            #   @return [String, nil]
+            optional :token_uri, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::Type, nil]
+            optional :type, enum: -> { Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials::Type }
+
+            # @!attribute universe_domain
+            #
+            #   @return [String, nil]
+            optional :universe_domain, String
+
+            # @!method initialize(client_email:, private_key:, auth_provider_x509_cert_url: nil, auth_uri: nil, client_id: nil, client_x509_cert_url: nil, private_key_id: nil, project_id: nil, token_uri: nil, type: nil, universe_domain: nil)
+            #   Google Cloud service account credentials
+            #
+            #   @param client_email [String]
+            #   @param private_key [String]
+            #   @param auth_provider_x509_cert_url [String]
+            #   @param auth_uri [String]
+            #   @param client_id [String]
+            #   @param client_x509_cert_url [String]
+            #   @param private_key_id [String]
+            #   @param project_id [String]
+            #   @param token_uri [String]
+            #   @param type [Symbol, Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::Type]
+            #   @param universe_domain [String]
+
+            # @see Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials#type
+            module Type
+              extend Stagehand::Internal::Type::Enum
+
+              SERVICE_ACCOUNT = :service_account
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # Google auth scopes for the desired API request
+          #
+          # @see Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth#scopes
+          module Scopes
+            extend Stagehand::Internal::Type::Union
+
+            variant String
+
+            variant -> { Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Scopes::StringArray }
+
+            # @!method self.variants
+            #   @return [Array(String, Array<String>)]
+
+            # @type [Stagehand::Internal::Type::Converter]
+            StringArray = Stagehand::Internal::Type::ArrayOf[String]
+          end
+        end
+
+        # @see Stagehand::Models::ModelConfig::VertexModelConfigObject#provider_options
+        class ProviderOptions < Stagehand::Internal::Type::BaseModel
+          # @!attribute vertex
+          #   Vertex AI provider-specific settings
+          #
+          #   @return [Stagehand::Models::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex]
+          required :vertex, -> { Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex }
+
+          # @!method initialize(vertex:)
+          #   Vertex provider-specific model configuration
+          #
+          #   @param vertex [Stagehand::Models::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex] Vertex AI provider-specific settings
+
+          # @see Stagehand::Models::ModelConfig::VertexModelConfigObject::ProviderOptions#vertex
+          class Vertex < Stagehand::Internal::Type::BaseModel
+            # @!attribute location
+            #   Google Cloud location for Vertex AI models
+            #
+            #   @return [String]
+            required :location, String
+
+            # @!attribute project
+            #   Google Cloud project ID for Vertex AI models
+            #
+            #   @return [String]
+            required :project, String
+
+            # @!attribute base_url
+            #   Base URL for the Vertex AI provider
+            #
+            #   @return [String, nil]
+            optional :base_url, String, api_name: :baseURL
+
+            # @!attribute headers
+            #   Custom headers sent with every request to the Vertex AI provider
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+            # @!method initialize(location:, project:, base_url: nil, headers: nil)
+            #   Vertex AI provider-specific settings
+            #
+            #   @param location [String] Google Cloud location for Vertex AI models
+            #
+            #   @param project [String] Google Cloud project ID for Vertex AI models
+            #
+            #   @param base_url [String] Base URL for the Vertex AI provider
+            #
+            #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the Vertex AI provider
+          end
+        end
       end
+
+      class GenericModelConfigObject < Stagehand::Internal::Type::BaseModel
+        # @!attribute model_name
+        #   Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+        #
+        #   @return [String]
+        required :model_name, String, api_name: :modelName
+
+        # @!attribute api_key
+        #   API key for the model provider
+        #
+        #   @return [String, nil]
+        optional :api_key, String, api_name: :apiKey
+
+        # @!attribute base_url
+        #   Base URL for the model provider
+        #
+        #   @return [String, nil]
+        optional :base_url, String, api_name: :baseURL
+
+        # @!attribute headers
+        #   Custom headers sent with every request to the model provider
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+        # @!attribute provider
+        #   AI provider for the model (or provide a baseURL endpoint instead)
+        #
+        #   @return [Symbol, Stagehand::Models::ModelConfig::GenericModelConfigObject::Provider, nil]
+        optional :provider, enum: -> { Stagehand::ModelConfig::GenericModelConfigObject::Provider }
+
+        # @!method initialize(model_name:, api_key: nil, base_url: nil, headers: nil, provider: nil)
+        #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+        #
+        #   @param api_key [String] API key for the model provider
+        #
+        #   @param base_url [String] Base URL for the model provider
+        #
+        #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
+        #
+        #   @param provider [Symbol, Stagehand::Models::ModelConfig::GenericModelConfigObject::Provider] AI provider for the model (or provide a baseURL endpoint instead)
+
+        # AI provider for the model (or provide a baseURL endpoint instead)
+        #
+        # @see Stagehand::Models::ModelConfig::GenericModelConfigObject#provider
+        module Provider
+          extend Stagehand::Internal::Type::Enum
+
+          OPENAI = :openai
+          ANTHROPIC = :anthropic
+          GOOGLE = :google
+          MICROSOFT = :microsoft
+          BEDROCK = :bedrock
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(Stagehand::Models::ModelConfig::VertexModelConfigObject, Stagehand::Models::ModelConfig::GenericModelConfigObject)]
     end
   end
 end