stagehand 0.0.4 → 3.5.2

data/rbi/stagehand/models/session_start_response.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class SessionStartResponse < Stagehand::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Stagehand::Models::SessionStartResponse,
+            Stagehand::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Stagehand::Models::SessionStartResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Stagehand::Models::SessionStartResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # Indicates whether the request was successful
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig do
+        params(
+          data: Stagehand::Models::SessionStartResponse::Data::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Indicates whether the request was successful
+        success:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Stagehand::Models::SessionStartResponse::Data,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Stagehand::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Stagehand::Models::SessionStartResponse::Data,
+              Stagehand::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :available
+
+        # Unique Browserbase session identifier
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # CDP WebSocket URL for connecting to the Browserbase cloud browser (present when
+        # available)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cdp_url
+
+        sig do
+          params(
+            available: T::Boolean,
+            session_id: String,
+            cdp_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          available:,
+          # Unique Browserbase session identifier
+          session_id:,
+          # CDP WebSocket URL for connecting to the Browserbase cloud browser (present when
+          # available)
+          cdp_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              available: T::Boolean,
+              session_id: String,
+              cdp_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/stagehand/models/stream_event.rbi

@@ -0,0 +1,237 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class StreamEvent < Stagehand::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Stagehand::StreamEvent, Stagehand::Internal::AnyHash)
+        end
+
+      # Unique identifier for this event
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Stagehand::StreamEvent::Data::Variants) }
+      attr_accessor :data
+
+      # Type of stream event - system events or log messages
+      sig { returns(Stagehand::StreamEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Server-Sent Event emitted during streaming responses. Events are sent as
+      # `data: <JSON>\n\n`. Key order: data (with status first), type, id.
+      sig do
+        params(
+          id: String,
+          data:
+            T.any(
+              Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::OrHash,
+              Stagehand::StreamEvent::Data::StreamEventLogDataOutput::OrHash
+            ),
+          type: Stagehand::StreamEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this event
+        id:,
+        data:,
+        # Type of stream event - system events or log messages
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            data: Stagehand::StreamEvent::Data::Variants,
+            type: Stagehand::StreamEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Data
+        extend Stagehand::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Stagehand::StreamEvent::Data::StreamEventSystemDataOutput,
+              Stagehand::StreamEvent::Data::StreamEventLogDataOutput
+            )
+          end
+
+        class StreamEventSystemDataOutput < Stagehand::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput,
+                Stagehand::Internal::AnyHash
+              )
+            end
+
+          # Current status of the streaming operation
+          sig do
+            returns(
+              Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # Error message (present when status is 'error')
+          sig { returns(T.nilable(String)) }
+          attr_reader :error
+
+          sig { params(error: String).void }
+          attr_writer :error
+
+          # Operation result (present when status is 'finished')
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :result
+
+          sig { params(result: T.anything).void }
+          attr_writer :result
+
+          sig do
+            params(
+              status:
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::OrSymbol,
+              error: String,
+              result: T.anything
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Current status of the streaming operation
+            status:,
+            # Error message (present when status is 'error')
+            error: nil,
+            # Operation result (present when status is 'finished')
+            result: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                status:
+                  Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol,
+                error: String,
+                result: T.anything
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Current status of the streaming operation
+          module Status
+            extend Stagehand::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            STARTING =
+              T.let(
+                :starting,
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+              )
+            CONNECTED =
+              T.let(
+                :connected,
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+              )
+            RUNNING =
+              T.let(
+                :running,
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+              )
+            FINISHED =
+              T.let(
+                :finished,
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+              )
+            ERROR =
+              T.let(
+                :error,
+                Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class StreamEventLogDataOutput < Stagehand::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Stagehand::StreamEvent::Data::StreamEventLogDataOutput,
+                Stagehand::Internal::AnyHash
+              )
+            end
+
+          # Log message from the operation
+          sig { returns(String) }
+          attr_accessor :message
+
+          sig { returns(Symbol) }
+          attr_accessor :status
+
+          sig do
+            params(message: String, status: Symbol).returns(T.attached_class)
+          end
+          def self.new(
+            # Log message from the operation
+            message:,
+            status: :running
+          )
+          end
+
+          sig { override.returns({ message: String, status: Symbol }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(T::Array[Stagehand::StreamEvent::Data::Variants])
+        end
+        def self.variants
+        end
+      end
+
+      # Type of stream event - system events or log messages
+      module Type
+        extend Stagehand::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Stagehand::StreamEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SYSTEM = T.let(:system, Stagehand::StreamEvent::Type::TaggedSymbol)
+        LOG = T.let(:log, Stagehand::StreamEvent::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Stagehand::StreamEvent::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/stagehand/models.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Stagehand
+  Action = Stagehand::Models::Action
+
+  ModelConfig = Stagehand::Models::ModelConfig
+
+  SessionActParams = Stagehand::Models::SessionActParams
+
+  SessionEndParams = Stagehand::Models::SessionEndParams
+
+  SessionExecuteParams = Stagehand::Models::SessionExecuteParams
+
+  SessionExtractParams = Stagehand::Models::SessionExtractParams
+
+  SessionNavigateParams = Stagehand::Models::SessionNavigateParams
+
+  SessionObserveParams = Stagehand::Models::SessionObserveParams
+
+  SessionReplayParams = Stagehand::Models::SessionReplayParams
+
+  SessionStartParams = Stagehand::Models::SessionStartParams
+
+  StreamEvent = Stagehand::Models::StreamEvent
+end

data/rbi/stagehand/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Stagehand
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Stagehand::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(Stagehand::RequestOptions, Stagehand::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: Stagehand::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: Stagehand::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end