statelydb 0.25.1 → 0.29.0

data/rbi/statelydb.rbi

@@ -182,7 +182,8 @@ module StatelyDB
     sig { params(namespace: String, identifier: T.nilable(T.any(String, StatelyDB::UUID, T.untyped))).returns(StatelyDB::KeyPath) }
     def self.with(namespace, identifier = nil); end
 
-    # If the value is a binary string, encode it as a url-safe base64 string with padding removed.
+    # If the value is a binary string, encode it as a url-safe
+    # base64 string with padding removed.
     # 
     # _@param_ `value` — The value to convert to a key id.
     sig { params(value: T.any(String, StatelyDB::UUID, T.untyped)).returns(String) }
@@ -259,16 +260,6 @@ module StatelyDB
     sig { params(key_paths: T.any(String, T::Array[String])).returns(T.any(T::Array[StatelyDB::Item], NilClass)) }
     def get_batch(*key_paths); end
 
-    # Begin listing Items from a StatelyDB Store at the given prefix.
-    # 
-    # _@param_ `prefix` — the prefix to list
-    # 
-    # _@param_ `limit` — the maximum number of items to return
-    # 
-    # _@param_ `sort_property` — the property to sort by
-    # 
-    # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-    # 
     # _@return_ — the list of Items and the token
     # 
     # ```ruby
@@ -276,13 +267,18 @@ module StatelyDB
     # ```
     sig do
       params(
-        prefix: String,
-        limit: Integer,
-        sort_property: T.nilable(String),
-        sort_direction: Symbol
+        prefix: T.untyped,
+        limit: T.untyped,
+        sort_property: T.untyped,
+        sort_direction: T.untyped,
+        item_types: T.untyped,
+        gt: T.untyped,
+        gte: T.untyped,
+        lt: T.untyped,
+        lte: T.untyped
       ).returns(T.any(T::Array[StatelyDB::Item], StatelyDB::Token))
     end
-    def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending); end
+    def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending, item_types: [], gt: nil, gte: nil, lt: nil, lte: nil); end
 
     # Continue listing Items from a StatelyDB Store using a token.
     # 
@@ -529,9 +525,11 @@ module StatelyDB
     module Auth
       # GRPC interceptor to authenticate against Stately and append bearer tokens to outgoing requests
       class Interceptor < GRPC::ClientInterceptor
-        # _@param_ `token_provider` — The token provider to use for authentication
+        # This must have been started already.
+        # 
+        # _@param_ `token_provider` — The token provider to use for authentication.
         sig { params(token_provider: StatelyDB::Common::Auth::TokenProvider).void }
-        def initialize(token_provider: AuthTokenProvider.new); end
+        def initialize(token_provider:); end
 
         # gRPC client unary interceptor
         # 
@@ -694,6 +692,12 @@ module StatelyDB
       # TokenProvider is an abstract base class that should be extended
       # for individual token provider implementations
       class TokenProvider
+        # Start the token provider. Starting multiple times should be a no-op.
+        # 
+        # _@param_ `endpoint` — The endpoint to connect to
+        sig { params(endpoint: String).void }
+        def start(endpoint: "https://api.stately.cloud"); end
+
         # Get the current access token
         # 
         # _@param_ `force` — Whether to force a refresh of the token
@@ -712,13 +716,15 @@ module StatelyDB
       # It will default to using the value of `STATELY_ACCESS_KEY` if
       # no credentials are explicitly passed and will throw an error if no credentials are found.
       class AuthTokenProvider < StatelyDB::Common::Auth::TokenProvider
-        # _@param_ `endpoint` — The endpoint of the auth server
-        # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-        sig { params(endpoint: String, access_key: String, base_retry_backoff_secs: Float).void }
-        def initialize(endpoint: "https://api.stately.cloud", access_key: ENV.fetch("STATELY_ACCESS_KEY", nil), base_retry_backoff_secs: 1); end
+        sig { params(access_key: String, base_retry_backoff_secs: Float).void }
+        def initialize(access_key: ENV.fetch("STATELY_ACCESS_KEY", nil), base_retry_backoff_secs: 1); end
+
+        # Start the token provider. Starting multiple times is a no-op.
+        sig { params(endpoint: String).void }
+        def start(endpoint: "https://api.stately.cloud"); end
 
         # Close the token provider and kill any background operations
         # This just invokes the close method on the actor which should do the cleanup
@@ -742,10 +748,10 @@ module StatelyDB
           sig { params(endpoint: String, access_key: String, base_retry_backoff_secs: Float).void }
           def initialize(endpoint:, access_key:, base_retry_backoff_secs:); end
 
-          # Initialize the actor. This runs on the actor thread which means
+          # Start the actor. This runs on the actor thread which means
           # we can dispatch async operations here.
           sig { void }
-          def init; end
+          def start; end
 
           # Close the token provider and kill any background operations
           sig { void }
@@ -1000,32 +1006,27 @@ module StatelyDB
       sig { params(key_paths: T.any(String, T::Array[String])).void }
       def delete(*key_paths); end
 
-      # Begin listing Items from a StatelyDB Store at the given prefix.
-      # 
       # Example:
       #   client.data.transaction do |txn|
       #     (items, token) = txn.begin_list("/ItemType-identifier")
       #     (items, token) = txn.continue_list(token)
       #   end
       # 
-      # _@param_ `prefix` — the prefix to list
-      # 
-      # _@param_ `limit` — the maximum number of items to return
-      # 
-      # _@param_ `sort_property` — the property to sort by
-      # 
-      # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-      # 
       # _@return_ — the list of Items and the token
       sig do
         params(
-          prefix: String,
-          limit: Integer,
-          sort_property: T.nilable(String),
-          sort_direction: Symbol
+          prefix: T.untyped,
+          limit: T.untyped,
+          sort_property: T.untyped,
+          sort_direction: T.untyped,
+          item_types: T.untyped,
+          gt: T.untyped,
+          gte: T.untyped,
+          lt: T.untyped,
+          lte: T.untyped
         ).returns([T::Array[StatelyDB::Item], ::Stately::Db::ListToken])
       end
-      def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending); end
+      def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending, item_types: [], gt: nil, gte: nil, lt: nil, lte: nil); end
 
       # Continue listing Items from a StatelyDB Store using a token.
       # 

data/sig/statelydb.rbs

@@ -1,5 +1,7 @@
 # A module for Stately Cloud auth code
 module StatelyDB
+  VERSION: untyped
+
   # UUID is a helper class for working with UUIDs in StatelyDB. The ruby version of a StatelyDB is a binary string,
   # and this class provides convenience methods for converting to the base16 representation specified in RFC 9562.
   # Internally this class uses the byte_string attribute to store the UUID as a string with the Encoding::ASCII_8BIT
@@ -149,7 +151,8 @@ module StatelyDB
     # ```
     def self.with: (String namespace, ?(String | StatelyDB::UUID | _ToS)? identifier) -> StatelyDB::KeyPath
 
-    # If the value is a binary string, encode it as a url-safe base64 string with padding removed.
+    # If the value is a binary string, encode it as a url-safe
+    # base64 string with padding removed.
     # 
     # _@param_ `value` — The value to convert to a key id.
     def self.to_key_id: ((String | StatelyDB::UUID | _ToS) value) -> String
@@ -218,26 +221,21 @@ module StatelyDB
     # ```
     def get_batch: (*(String | ::Array[String]) key_paths) -> (::Array[StatelyDB::Item] | NilClass)
 
-    # Begin listing Items from a StatelyDB Store at the given prefix.
-    # 
-    # _@param_ `prefix` — the prefix to list
-    # 
-    # _@param_ `limit` — the maximum number of items to return
-    # 
-    # _@param_ `sort_property` — the property to sort by
-    # 
-    # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-    # 
     # _@return_ — the list of Items and the token
     # 
     # ```ruby
     # client.data.begin_list("/ItemType-identifier", limit: 10, sort_direction: :ascending)
     # ```
     def begin_list: (
-                      String prefix,
-                      ?limit: Integer,
-                      ?sort_property: String?,
-                      ?sort_direction: Symbol
+                      untyped prefix,
+                      ?limit: untyped,
+                      ?sort_property: untyped,
+                      ?sort_direction: untyped,
+                      ?item_types: untyped,
+                      ?gt: untyped,
+                      ?gte: untyped,
+                      ?lt: untyped,
+                      ?lte: untyped
                     ) -> (::Array[StatelyDB::Item] | StatelyDB::Token)
 
     # Continue listing Items from a StatelyDB Store using a token.
@@ -463,8 +461,10 @@ module StatelyDB
     module Auth
       # GRPC interceptor to authenticate against Stately and append bearer tokens to outgoing requests
       class Interceptor < GRPC::ClientInterceptor
-        # _@param_ `token_provider` — The token provider to use for authentication
-        def initialize: (?token_provider: StatelyDB::Common::Auth::TokenProvider) -> void
+        # This must have been started already.
+        # 
+        # _@param_ `token_provider` — The token provider to use for authentication.
+        def initialize: (token_provider: StatelyDB::Common::Auth::TokenProvider) -> void
 
         # gRPC client unary interceptor
         # 
@@ -608,6 +608,11 @@ module StatelyDB
       # TokenProvider is an abstract base class that should be extended
       # for individual token provider implementations
       class TokenProvider
+        # Start the token provider. Starting multiple times should be a no-op.
+        # 
+        # _@param_ `endpoint` — The endpoint to connect to
+        def start: (?endpoint: String) -> void
+
         # Get the current access token
         # 
         # _@param_ `force` — Whether to force a refresh of the token
@@ -624,12 +629,13 @@ module StatelyDB
       # It will default to using the value of `STATELY_ACCESS_KEY` if
       # no credentials are explicitly passed and will throw an error if no credentials are found.
       class AuthTokenProvider < StatelyDB::Common::Auth::TokenProvider
-        # _@param_ `endpoint` — The endpoint of the auth server
-        # 
         # _@param_ `access_key` — The StatelyDB access key credential
         # 
         # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
-        def initialize: (?endpoint: String, ?access_key: String, ?base_retry_backoff_secs: Float) -> void
+        def initialize: (?access_key: String, ?base_retry_backoff_secs: Float) -> void
+
+        # Start the token provider. Starting multiple times is a no-op.
+        def start: (?endpoint: String) -> void
 
         # Close the token provider and kill any background operations
         # This just invokes the close method on the actor which should do the cleanup
@@ -650,9 +656,9 @@ module StatelyDB
           # _@param_ `base_retry_backoff_secs` — The base retry backoff in seconds
           def initialize: (endpoint: String, access_key: String, base_retry_backoff_secs: Float) -> void
 
-          # Initialize the actor. This runs on the actor thread which means
+          # Start the actor. This runs on the actor thread which means
           # we can dispatch async operations here.
-          def init: () -> void
+          def start: () -> void
 
           # Close the token provider and kill any background operations
           def close: () -> void
@@ -881,28 +887,23 @@ module StatelyDB
       # _@return_ — nil
       def delete: (*(String | ::Array[String]) key_paths) -> void
 
-      # Begin listing Items from a StatelyDB Store at the given prefix.
-      # 
       # Example:
       #   client.data.transaction do |txn|
       #     (items, token) = txn.begin_list("/ItemType-identifier")
       #     (items, token) = txn.continue_list(token)
       #   end
       # 
-      # _@param_ `prefix` — the prefix to list
-      # 
-      # _@param_ `limit` — the maximum number of items to return
-      # 
-      # _@param_ `sort_property` — the property to sort by
-      # 
-      # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-      # 
       # _@return_ — the list of Items and the token
       def begin_list: (
-                        String prefix,
-                        ?limit: Integer,
-                        ?sort_property: String?,
-                        ?sort_direction: Symbol
+                        untyped prefix,
+                        ?limit: untyped,
+                        ?sort_property: untyped,
+                        ?sort_direction: untyped,
+                        ?item_types: untyped,
+                        ?gt: untyped,
+                        ?gte: untyped,
+                        ?lt: untyped,
+                        ?lte: untyped
                       ) -> [::Array[StatelyDB::Item], ::Stately::Db::ListToken]
 
       # Continue listing Items from a StatelyDB Store using a token.
@@ -978,8 +979,9 @@ module Stately
     ListResponse: untyped
     ListPartialResult: untyped
     ListFinished: untyped
+    KeyCondition: untyped
     SortDirection: untyped
-    FilterCondition: untyped
+    Operator: untyped
     BeginScanRequest: untyped
     SegmentationParams: untyped
     DeleteRequest: untyped
@@ -1005,6 +1007,7 @@ module Stately
     TransactionPutAck: untyped
     TransactionListResponse: untyped
     TransactionFinished: untyped
+    FilterCondition: untyped
     ContinueListRequest: untyped
     ContinueListDirection: untyped
     ContinueScanRequest: untyped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.29.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-02 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -66,7 +66,9 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.64.3
-description: ''
+description: Client for StatelyDB, a document database built on top of DynamoDB with
+  Elastic Schema that allows you to change your data model any time with automatic
+  backwards compatibility.
 email: support@stately.cloud
 executables: []
 extensions: []
@@ -83,6 +85,7 @@ files:
 - lib/api/db/get_pb.rb
 - lib/api/db/item_pb.rb
 - lib/api/db/item_property_pb.rb
+- lib/api/db/list_filters_pb.rb
 - lib/api/db/list_pb.rb
 - lib/api/db/list_token_pb.rb
 - lib/api/db/put_pb.rb
@@ -106,6 +109,7 @@ files:
 - lib/transaction/queue.rb
 - lib/transaction/transaction.rb
 - lib/uuid.rb
+- lib/version.rb
 - rbi/auth/get_auth_token_pb.rbi
 - rbi/auth/service_pb.rbi
 - rbi/auth/service_services_pb.rbi
@@ -115,6 +119,7 @@ files:
 - rbi/db/get_pb.rbi
 - rbi/db/item_pb.rbi
 - rbi/db/item_property_pb.rbi
+- rbi/db/list_filters_pb.rbi
 - rbi/db/list_pb.rbi
 - rbi/db/list_token_pb.rbi
 - rbi/db/put_pb.rbi
@@ -140,14 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A library for interacting with StatelyDB