statelydb 0.25.0 → 0.28.0

data/rbi/statelydb.rbi

@@ -14,7 +14,7 @@ module StatelyDB
     sig { returns(String) }
     def to_s; end
 
-    # to_str returns the UUID as a base16 string (eg: "f4a8a24a-129d-411f-91d2-6d19d0eaa096")
+    # to_str returns the UUID as a base16 string (eg: "f4a8a24a-129d-411f-91d2-6d19d0eaa096").
     # 
     # Note: to_str is a type coercion method that is called by Ruby when an object is coerced to a string.
     sig { returns(String) }
@@ -529,9 +529,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 +696,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 +720,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 +752,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 }

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
@@ -11,7 +13,7 @@ module StatelyDB
     # to_s returns the UUID as a base16 string (eg: "f4a8a24a-129d-411f-91d2-6d19d0eaa096")
     def to_s: () -> String
 
-    # to_str returns the UUID as a base16 string (eg: "f4a8a24a-129d-411f-91d2-6d19d0eaa096")
+    # to_str returns the UUID as a base16 string (eg: "f4a8a24a-129d-411f-91d2-6d19d0eaa096").
     # 
     # Note: to_str is a type coercion method that is called by Ruby when an object is coerced to a string.
     def to_str: () -> String
@@ -463,8 +465,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 +612,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 +633,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 +660,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
@@ -978,8 +988,9 @@ module Stately
     ListResponse: untyped
     ListPartialResult: untyped
     ListFinished: untyped
+    KeyCondition: untyped
     SortDirection: untyped
-    FilterCondition: untyped
+    Operator: untyped
     BeginScanRequest: untyped
     SegmentationParams: untyped
     DeleteRequest: untyped
@@ -1005,13 +1016,11 @@ module Stately
     TransactionPutAck: untyped
     TransactionListResponse: untyped
     TransactionFinished: untyped
+    FilterCondition: untyped
     ContinueListRequest: untyped
     ContinueListDirection: untyped
     ContinueScanRequest: untyped
     SortableProperty: untyped
-    ScanRootPathsRequest: untyped
-    ScanRootPathsResponse: untyped
-    ScanRootPathResult: untyped
 
     module DatabaseService
       Stub: untyped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-06-24 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,11 +85,11 @@ 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
 - lib/api/db/scan_pb.rb
-- lib/api/db/scan_root_paths_pb.rb
 - lib/api/db/service_pb.rb
 - lib/api/db/service_services_pb.rb
 - lib/api/db/sync_list_pb.rb
@@ -107,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
@@ -116,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
@@ -141,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.5.22
 signing_key:
 specification_version: 4
 summary: A library for interacting with StatelyDB

data/lib/api/db/scan_root_paths_pb.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: db/scan_root_paths.proto
-
-require 'google/protobuf'
-
-
-descriptor_data = "\n\x18\x64\x62/scan_root_paths.proto\x12\nstately.db\"\xbb\x01\n\x14ScanRootPathsRequest\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12\x14\n\x05limit\x18\x02 \x01(\rR\x05limit\x12)\n\x10pagination_token\x18\x03 \x01(\x0cR\x0fpaginationToken\x12*\n\x11schema_version_id\x18\x04 \x01(\rR\x0fschemaVersionId\x12\x1b\n\tschema_id\x18\x05 \x01(\x04R\x08schemaId\"|\n\x15ScanRootPathsResponse\x12\x38\n\x07results\x18\x01 \x03(\x0b\x32\x1e.stately.db.ScanRootPathResultR\x07results\x12)\n\x10pagination_token\x18\x02 \x01(\x0cR\x0fpaginationToken\"/\n\x12ScanRootPathResult\x12\x19\n\x08key_path\x18\x01 \x01(\tR\x07keyPathBm\n\x0e\x63om.stately.dbB\x12ScanRootPathsProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
-
-pool = Google::Protobuf::DescriptorPool.generated_pool
-pool.add_serialized_file(descriptor_data)
-
-module Stately
-  module Db
-    ScanRootPathsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsRequest").msgclass
-    ScanRootPathsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsResponse").msgclass
-    ScanRootPathResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathResult").msgclass
-  end
-end