terminal-shop 1.7.0 → 1.8.0

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

@@ -1,42 +1,52 @@
 # typed: strong
 
 module TerminalShop
+  # @api private
   module Util
+    # @api private
     sig { returns(Float) }
     def self.monotonic_secs
     end
 
     class << self
+      # @api private
       sig { returns(String) }
       def arch
       end
 
+      # @api private
       sig { returns(String) }
       def os
       end
     end
 
     class << self
-      sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
+      # @api private
+      sig { params(input: T.anything).returns(T::Boolean) }
       def primitive?(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
       def coerce_boolean(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.nilable(T::Boolean)) }
       def coerce_boolean!(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(Integer, T.anything)) }
       def coerce_integer(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(Float, T.anything)) }
       def coerce_float(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
       def coerce_hash(input)
       end
@@ -45,17 +55,29 @@ module TerminalShop
     OMIT = T.let(T.anything, T.anything)
 
     class << self
+      # @api private
       sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
       private def deep_merge_lr(lhs, rhs, concat: false)
       end
 
+      # @api private
+      #
+      # Recursively merge one hash with another. If the values at a given key are not
+      #   both hashes, just take the new value.
       sig do
         params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
           .returns(T.anything)
       end
-      def deep_merge(*values, sentinel: nil, concat: false)
+      def deep_merge(
+        *values,
+        # the value to return if no values are provided.
+        sentinel: nil,
+        # whether to merge sequences by concatenation.
+        concat: false
+      )
       end
 
+      # @api private
       sig do
         params(
           data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything),
@@ -70,20 +92,24 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig { params(uri: URI::Generic).returns(String) }
       def uri_origin(uri)
       end
 
+      # @api private
       sig { params(path: T.any(String, T::Array[String])).returns(String) }
       def interpolate_path(path)
       end
     end
 
     class << self
+      # @api private
       sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
       def decode_query(query)
       end
 
+      # @api private
       sig do
         params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
           .returns(T.nilable(String))
@@ -103,14 +129,17 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig { params(url: T.any(URI::Generic, String)).returns(TerminalShop::Util::ParsedUriShape) }
       def parse_uri(url)
       end
 
+      # @api private
       sig { params(parsed: TerminalShop::Util::ParsedUriShape).returns(URI::Generic) }
       def unparse_uri(parsed)
       end
 
+      # @api private
       sig do
         params(lhs: TerminalShop::Util::ParsedUriShape, rhs: TerminalShop::Util::ParsedUriShape)
           .returns(URI::Generic)
@@ -120,6 +149,7 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig do
         params(
           headers: T::Hash[String,
@@ -131,15 +161,21 @@ module TerminalShop
       end
     end
 
+    # @api private
+    #
+    # An adapter that satisfies the IO interface required by `::IO.copy_stream`
     class ReadIOAdapter
+      # @api private
       sig { params(max_len: T.nilable(Integer)).returns(String) }
       private def read_enum(max_len)
       end
 
+      # @api private
       sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) }
       def read(max_len = nil, out_string = nil)
       end
 
+      # @api private
       sig do
         params(
           stream: T.any(String, IO, StringIO, T::Enumerable[String]),
@@ -158,20 +194,24 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig do
         params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void
       end
       private def encode_multipart_formdata(y, boundary:, key:, val:)
       end
 
+      # @api private
       sig { params(body: T.anything).returns([String, T::Enumerable[String]]) }
       private def encode_multipart_streaming(body)
       end
 
+      # @api private
       sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
       def encode_content(headers, body)
       end
 
+      # @api private
       sig do
         params(
           headers: T.any(T::Hash[String, String], Net::HTTPHeader),
@@ -185,6 +225,9 @@ module TerminalShop
     end
 
     class << self
+      # @api private
+      #
+      # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
       sig do
         params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void)
           .returns(T::Enumerable[T.anything])
@@ -192,30 +235,34 @@ module TerminalShop
       def fused_enum(enum, external: false, &close)
       end
 
+      # @api private
       sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
       def close_fused!(enum)
       end
 
+      # @api private
       sig do
-        params(
-          enum: T.nilable(T::Enumerable[T.anything]),
-          blk: T.proc.params(arg0: Enumerator::Yielder).void
-        ).void
+        params(enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void)
+          .returns(T::Enumerable[T.anything])
       end
       def chain_fused(enum, &blk)
       end
     end
 
-    SSEMessage = T.type_alias do
+    ServerSentEvent = T.type_alias do
       {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)}
     end
 
     class << self
+      # @api private
       sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
       def decode_lines(enum)
       end
 
-      sig { params(lines: T::Enumerable[String]).returns(TerminalShop::Util::SSEMessage) }
+      # @api private
+      #
+      # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+      sig { params(lines: T::Enumerable[String]).returns(TerminalShop::Util::ServerSentEvent) }
       def decode_sse(lines)
       end
     end

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

@@ -1,5 +1,5 @@
 # typed: strong
 
 module TerminalShop
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/sig/terminal-shop/base_client.rbs

@@ -45,7 +45,12 @@ module TerminalShop
       response_headers: ::Hash[String, String]
     ) -> TerminalShop::BaseClient::request_input
 
-    # @private
+    def self.reap_connection!: (
+      Integer | TerminalShop::APIConnectionError status,
+      stream: Enumerable[String]?
+    ) -> void
+
+    # @api private
     attr_accessor requester: top
 
     def initialize: (

data/sig/terminal-shop/base_model.rbs

@@ -85,9 +85,11 @@ module TerminalShop
   class Union
     extend TerminalShop::Converter
 
-    private def self.known_variants: -> ::Array[[Symbol?, Proc]]
+    private def self.known_variants: -> ::Array[[Symbol?, (^-> TerminalShop::Converter::input)]]
 
-    def self.variants: -> ::Array[[Symbol?, top]]
+    def self.derefed_variants: -> ::Array[[Symbol?, top]]
+
+    def self.variants: -> ::Array[top]
 
     private def self.discriminator: (Symbol property) -> void
 
@@ -118,7 +120,7 @@ module TerminalShop
     ) -> ([true, top, nil] | [false, bool, Integer])
   end
 
-  class ArrayOf
+  class ArrayOf[Elem]
     include TerminalShop::Converter
 
     def ===: (top other) -> bool
@@ -133,7 +135,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> TerminalShop::Converter::input
+    def item_type: -> Elem
 
     def initialize: (
       ::Hash[Symbol, top]
@@ -143,7 +145,7 @@ module TerminalShop
     ) -> void
   end
 
-  class HashOf
+  class HashOf[Elem]
     include TerminalShop::Converter
 
     def ===: (top other) -> bool
@@ -158,7 +160,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> TerminalShop::Converter::input
+    def item_type: -> Elem
 
     def initialize: (
       ::Hash[Symbol, top]

data/sig/terminal-shop/errors.rbs

@@ -1,17 +1,17 @@
 module TerminalShop
   class Error < StandardError
-    attr_reader cause: StandardError?
+    attr_accessor cause: StandardError?
   end
 
   class ConversionError < TerminalShop::Error
   end
 
   class APIError < TerminalShop::Error
-    attr_reader url: URI::Generic
+    attr_accessor url: URI::Generic
 
-    attr_reader status: Integer?
+    attr_accessor status: Integer?
 
-    attr_reader body: top?
+    attr_accessor body: top?
 
     def initialize: (
       url: URI::Generic,

data/sig/terminal-shop/models/subscription.rbs

@@ -85,7 +85,7 @@ module TerminalShop
           def to_hash: -> TerminalShop::Models::SubscriptionAPI::Schedule::weekly
         end
 
-        private def self.variants: -> [[nil, TerminalShop::Models::SubscriptionAPI::Schedule::Fixed], [nil, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly]]
+        def self.variants: -> [TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly]
       end
     end
   end

data/sig/terminal-shop/pooled_net_requester.rbs

@@ -19,11 +19,16 @@ module TerminalShop
       (String arg0) -> void
     } -> top
 
-    private def with_pool: (URI::Generic url) { (top arg0) -> void } -> void
+    private def with_pool: (
+      URI::Generic url,
+      deadline: Float
+    ) {
+      (top arg0) -> void
+    } -> void
 
     def execute: (
       TerminalShop::PooledNetRequester::request request
-    ) -> [top, Enumerable[String]]
+    ) -> [Integer, top, Enumerable[String]]
 
     def initialize: (size: Integer) -> void
   end

data/sig/terminal-shop/util.rbs

@@ -6,7 +6,7 @@ module TerminalShop
 
     def self?.os: -> String
 
-    def self?.primitive?: (top input) -> (bool | top)
+    def self?.primitive?: (top input) -> bool
 
     def self?.coerce_boolean: (top input) -> (bool | top)
 
@@ -122,15 +122,15 @@ module TerminalShop
       Enumerable[top]? enum
     ) {
       (Enumerator::Yielder arg0) -> void
-    } -> void
+    } -> Enumerable[top]
 
-    type sse_message =
+    type server_sent_event =
       { event: String?, data: String?, id: String?, retry: Integer? }
 
     def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String]
 
     def self?.decode_sse: (
       Enumerable[String] lines
-    ) -> TerminalShop::Util::sse_message
+    ) -> TerminalShop::Util::server_sent_event
   end
 end

data/sig/terminal-shop/version.rbs

@@ -1,3 +1,3 @@
 module TerminalShop
-  VERSION: "1.6.0"
+  VERSION: "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal-shop
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Terminal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -346,10 +346,10 @@ files:
 - sig/terminal-shop/resources/view.rbs
 - sig/terminal-shop/util.rbs
 - sig/terminal-shop/version.rbs
-homepage: https://gemdocs.org/gems/terminal-shop/latest
+homepage: https://gemdocs.org/gems/terminal-shop
 licenses: []
 metadata:
-  homepage_uri: https://gemdocs.org/gems/terminal-shop/latest
+  homepage_uri: https://gemdocs.org/gems/terminal-shop
   source_code_uri: https://github.com/terminaldotshop/terminal-sdk-ruby
   rubygems_mfa_required: 'false'
 post_install_message: