terminal-shop 1.7.0 → 2.0.0

data/rbi/lib/terminal-shop/base_client.rbi

@@ -1,59 +1,66 @@
 # typed: strong
 
 module TerminalShop
+  # @api private
   class BaseClient
     abstract!
 
-    RequestComponentsShape = T.type_alias do
-      {
-        method: Symbol,
-        path: T.any(String, T::Array[String]),
-        query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
-        headers: T.nilable(
-          T::Hash[String,
-                  T.nilable(
-                    T.any(
-                      String,
-                      Integer,
-                      T::Array[T.nilable(T.any(String, Integer))]
-                    )
-                  )]
-        ),
-        body: T.nilable(T.anything),
-        unwrap: T.nilable(Symbol),
-        page: T.nilable(T::Class[TerminalShop::BasePage[TerminalShop::BaseModel]]),
-        stream: T.nilable(T::Class[T.anything]),
-        model: T.nilable(TerminalShop::Converter::Input),
-        options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
-      }
-    end
+    RequestComponentsShape =
+      T.type_alias do
+        {
+          method: Symbol,
+          path: T.any(String, T::Array[String]),
+          query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+          headers: T.nilable(
+            T::Hash[String,
+                    T.nilable(
+                      T.any(
+                        String,
+                        Integer,
+                        T::Array[T.nilable(T.any(String, Integer))]
+                      )
+                    )]
+          ),
+          body: T.nilable(T.anything),
+          unwrap: T.nilable(Symbol),
+          page: T.nilable(T::Class[TerminalShop::BasePage[TerminalShop::BaseModel]]),
+          stream: T.nilable(T::Class[T.anything]),
+          model: T.nilable(TerminalShop::Converter::Input),
+          options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
+        }
+      end
 
-    RequestInputShape = T.type_alias do
-      {
-        method: Symbol,
-        url: URI::Generic,
-        headers: T::Hash[String, String],
-        body: T.anything,
-        max_retries: Integer,
-        timeout: Float
-      }
-    end
+    RequestInputShape =
+      T.type_alias do
+        {
+          method: Symbol,
+          url: URI::Generic,
+          headers: T::Hash[String, String],
+          body: T.anything,
+          max_retries: Integer,
+          timeout: Float
+        }
+      end
 
+    # from whatwg fetch spec
     MAX_REDIRECTS = 20
 
     PLATFORM_HEADERS = T::Hash[String, String]
 
     class << self
+      # @api private
       sig { params(req: TerminalShop::BaseClient::RequestComponentsShape).void }
       def validate!(req)
       end
 
+      # @api private
       sig do
         params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
       end
       def should_retry?(status, headers:)
       end
 
+      # @api private
       sig do
         params(
           request: TerminalShop::BaseClient::RequestInputShape,
@@ -64,16 +71,24 @@ module TerminalShop
       end
       def follow_redirect(request, status:, response_headers:)
       end
-    end
 
-    sig { returns(T.anything) }
-    def requester
+      # @api private
+      sig do
+        params(
+          status: T.any(Integer, TerminalShop::APIConnectionError),
+          stream: T.nilable(T::Enumerable[String])
+        )
+          .void
+      end
+      def reap_connection!(status, stream:)
+      end
     end
 
-    sig { params(_: T.anything).returns(T.anything) }
-    def requester=(_)
-    end
+    # @api private
+    sig { returns(T.anything) }
+    attr_accessor :requester
 
+    # @api private
     sig do
       params(
         base_url: String,
@@ -98,26 +113,31 @@ module TerminalShop
     )
     end
 
+    # @api private
     sig { overridable.returns(T::Hash[String, String]) }
     private def auth_headers
     end
 
+    # @api private
     sig { returns(String) }
     private def generate_idempotency_key
     end
 
+    # @api private
     sig do
       overridable
-        .params(req: TerminalShop::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything])
+        .params(req: TerminalShop::BaseClient::RequestComponentsShape, opts: TerminalShop::Util::AnyHash)
         .returns(TerminalShop::BaseClient::RequestInputShape)
     end
     private def build_request(req, opts)
     end
 
+    # @api private
     sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
     private def retry_delay(headers, retry_count:)
     end
 
+    # @api private
     sig do
       params(
         request: TerminalShop::BaseClient::RequestInputShape,
@@ -130,6 +150,8 @@ module TerminalShop
     private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
     end
 
+    # Execute the request specified by `req`. This is the method that all resource
+    #   methods call into.
     sig do
       params(
         method: Symbol,
@@ -150,7 +172,7 @@ module TerminalShop
         page: T.nilable(T::Class[TerminalShop::BasePage[TerminalShop::BaseModel]]),
         stream: T.nilable(T::Class[T.anything]),
         model: T.nilable(TerminalShop::Converter::Input),
-        options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
+        options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
       )
         .returns(T.anything)
     end