chore: more accurate generic params for stream classes (#8)

Author: stainless-app[bot]

lib/openai/base_stream.rb

@@ -16,7 +16,7 @@ module OpenAI
   #
   # messages => Array
   # ```
-  class BaseStream
+  module BaseStream
     # @return [void]
     #
     def close = OpenAI::Util.close_fused!(@iterator)

lib/openai/stream.rb

@@ -16,7 +16,9 @@ module OpenAI
   #
   # messages => Array
   # ```
-  class Stream < OpenAI::BaseStream
+  class Stream
+    include OpenAI::BaseStream
+
     # @private
     #
     # @return [Enumerable]

rbi/lib/openai/base_client.rbi

@@ -22,7 +22,7 @@ module OpenAI
         body: T.nilable(T.anything),
         unwrap: T.nilable(Symbol),
         page: T.nilable(T::Class[OpenAI::BasePage[OpenAI::BaseModel]]),
-        stream: T.nilable(T::Class[OpenAI::BaseStream[OpenAI::BaseModel]]),
+        stream: T.nilable(T::Class[OpenAI::BaseStream[T.anything, OpenAI::BaseModel]]),
         model: T.nilable(OpenAI::Converter::Input),
         options: T.nilable(T.any(OpenAI::RequestOptions, T::Hash[Symbol, T.anything]))
       }
@@ -148,7 +148,7 @@ module OpenAI
         body: T.nilable(T.anything),
         unwrap: T.nilable(Symbol),
         page: T.nilable(T::Class[OpenAI::BasePage[OpenAI::BaseModel]]),
-        stream: T.nilable(T::Class[OpenAI::BaseStream[OpenAI::BaseModel]]),
+        stream: T.nilable(T::Class[OpenAI::BaseStream[T.anything, OpenAI::BaseModel]]),
         model: T.nilable(OpenAI::Converter::Input),
         options: T.nilable(T.any(OpenAI::RequestOptions, T::Hash[Symbol, T.anything]))
       )

rbi/lib/openai/base_stream.rbi

@@ -1,7 +1,8 @@
 # typed: strong
 
 module OpenAI
-  class BaseStream
+  module BaseStream
+    Message = type_member(:in)
     Elem = type_member(:out)
 
     sig { void }
@@ -28,11 +29,11 @@ module OpenAI
         url: URI::Generic,
         status: Integer,
         response: Net::HTTPResponse,
-        messages: T::Enumerable[OpenAI::Util::SSEMessage]
+        messages: T::Enumerable[Message]
       )
-        .returns(T.attached_class)
+        .void
     end
-    def self.new(model:, url:, status:, response:, messages:)
+    def initialize(model:, url:, status:, response:, messages:)
     end
   end
 end

rbi/lib/openai/stream.rbi

@@ -1,11 +1,27 @@
 # typed: strong
 
 module OpenAI
-  class Stream < OpenAI::BaseStream
+  class Stream
+    include OpenAI::BaseStream
+
+    Message = type_member(:in) { {fixed: OpenAI::Util::SSEMessage} }
     Elem = type_member(:out)
 
     sig { override.returns(T::Enumerable[Elem]) }
     private def iterator
     end
+
+    sig do
+      params(
+        model: T.any(T::Class[T.anything], OpenAI::Converter),
+        url: URI::Generic,
+        status: Integer,
+        response: Net::HTTPResponse,
+        messages: T::Enumerable[OpenAI::Util::SSEMessage]
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(model:, url:, status:, response:, messages:)
+    end
   end
 end

sig/openai/base_stream.rbs

@@ -1,5 +1,5 @@
 module OpenAI
-  class BaseStream[Elem]
+  module BaseStream[Message, Elem]
     def close: -> void
 
     private def iterator: -> Enumerable[Elem]
@@ -15,7 +15,7 @@ module OpenAI
       url: URI::Generic,
       status: Integer,
       response: top,
-      messages: Enumerable[OpenAI::Util::sse_message]
+      messages: Enumerable[Message]
     ) -> void
   end
 end

sig/openai/stream.rbs

@@ -1,5 +1,15 @@
 module OpenAI
-  class Stream[Elem] < OpenAI::BaseStream[Elem]
+  class Stream[Elem]
+    include OpenAI::BaseStream[OpenAI::Util::sse_message, Elem]
+
     private def iterator: -> Enumerable[Elem]
+
+    def initialize: (
+      model: Class | OpenAI::Converter,
+      url: URI::Generic,
+      status: Integer,
+      response: top,
+      messages: Enumerable[OpenAI::Util::sse_message]
+    ) -> void
   end
 end