statelydb 0.21.0 → 0.23.0

data/rbi/errors/error_details_pb.rbi

@@ -0,0 +1,146 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: errors/error_details.proto
+# typed: strict
+
+# StatelyErrorDetails is a message containing detailed error information.
+# This is returned from the Stately API via Connect error details:
+#  https://connectrpc.com/docs/go/errors#error-details
+# Note: As a customer, you should not need to handle this message directly unless writing
+# a custom low-level SDK. Instead, language-specific SDKs will provide a more user-friendly
+# error object that wraps this message.
+class Stately::Errors::StatelyErrorDetails
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      stately_code: T.nilable(String),
+      message: T.nilable(String),
+      upstream_cause: T.nilable(String),
+      code: T.nilable(Integer)
+    ).void
+  end
+  def initialize(
+    stately_code: "",
+    message: "",
+    upstream_cause: "",
+    code: 0
+  )
+  end
+
+  # stately_code is the error code that was returned by the Stately API.
+# The full list of codes is available at https://docs.stately.cloud/api/error-codes/
+# and documentation on a specific code can be found at https://docs.stately.cloud/api/error-codes/#{stately_code}
+  sig { returns(String) }
+  def stately_code
+  end
+
+  # stately_code is the error code that was returned by the Stately API.
+# The full list of codes is available at https://docs.stately.cloud/api/error-codes/
+# and documentation on a specific code can be found at https://docs.stately.cloud/api/error-codes/#{stately_code}
+  sig { params(value: String).void }
+  def stately_code=(value)
+  end
+
+  # stately_code is the error code that was returned by the Stately API.
+# The full list of codes is available at https://docs.stately.cloud/api/error-codes/
+# and documentation on a specific code can be found at https://docs.stately.cloud/api/error-codes/#{stately_code}
+  sig { void }
+  def clear_stately_code
+  end
+
+  # message is a human-readable error message that can be displayed to the user that
+# provides more context about the error.
+  sig { returns(String) }
+  def message
+  end
+
+  # message is a human-readable error message that can be displayed to the user that
+# provides more context about the error.
+  sig { params(value: String).void }
+  def message=(value)
+  end
+
+  # message is a human-readable error message that can be displayed to the user that
+# provides more context about the error.
+  sig { void }
+  def clear_message
+  end
+
+  # upstream_cause is additional information about the error that can be used to help debug the error,
+# This field will only optionally be supplied by the Stately API.
+# Note: This may row over as the error is passed through multiple services.
+  sig { returns(String) }
+  def upstream_cause
+  end
+
+  # upstream_cause is additional information about the error that can be used to help debug the error,
+# This field will only optionally be supplied by the Stately API.
+# Note: This may row over as the error is passed through multiple services.
+  sig { params(value: String).void }
+  def upstream_cause=(value)
+  end
+
+  # upstream_cause is additional information about the error that can be used to help debug the error,
+# This field will only optionally be supplied by the Stately API.
+# Note: This may row over as the error is passed through multiple services.
+  sig { void }
+  def clear_upstream_cause
+  end
+
+  # The Connect/gRPC code associated with this error. This generally isn't set,
+# because the overall API response has an error code. But this can be used in
+# the case that we're returning multiple different errors, or communicating
+# errors across non-Connect APIs.
+  sig { returns(Integer) }
+  def code
+  end
+
+  # The Connect/gRPC code associated with this error. This generally isn't set,
+# because the overall API response has an error code. But this can be used in
+# the case that we're returning multiple different errors, or communicating
+# errors across non-Connect APIs.
+  sig { params(value: Integer).void }
+  def code=(value)
+  end
+
+  # The Connect/gRPC code associated with this error. This generally isn't set,
+# because the overall API response has an error code. But this can be used in
+# the case that we're returning multiple different errors, or communicating
+# errors across non-Connect APIs.
+  sig { void }
+  def clear_code
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Stately::Errors::StatelyErrorDetails) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Errors::StatelyErrorDetails).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Errors::StatelyErrorDetails) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Errors::StatelyErrorDetails, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end

data/rbi/statelydb.rbi

@@ -158,7 +158,7 @@ module StatelyDB
     # _@param_ `namespace`
     # 
     # _@param_ `identifier`
-    sig { params(namespace: String, identifier: T.nilable(T.any(String, StatelyDB::UUID, T.untyped))).returns(KeyPath) }
+    sig { params(namespace: String, identifier: T.nilable(T.any(String, StatelyDB::UUID, T.untyped))).returns(StatelyDB::KeyPath) }
     def with(namespace, identifier = nil); end
 
     sig { returns(String) }
@@ -179,7 +179,7 @@ module StatelyDB
     # ```ruby
     # keypath = KeyPath.with("genres", "rock").with("artists", "the-beatles")
     # ```
-    sig { params(namespace: String, identifier: T.nilable(T.any(String, StatelyDB::UUID, T.untyped))).returns(KeyPath) }
+    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.
@@ -210,7 +210,7 @@ module StatelyDB
       params(
         store_id: Integer,
         schema: Module,
-        token_provider: T.nilable(Common::Auth::TokenProvider),
+        token_provider: T.nilable(StatelyDB::Common::Auth::TokenProvider),
         endpoint: T.nilable(String),
         region: T.nilable(String),
         no_auth: T::Boolean
@@ -321,7 +321,7 @@ module StatelyDB
     sig do
       params(
         limit: Integer,
-        item_types: T::Array[T.any(Class, String)],
+        item_types: T::Array[T.any(T::Class[T.anything], String)],
         total_segments: T.nilable(Integer),
         segment_index: T.nilable(Integer)
       ).returns(T.any(T::Array[StatelyDB::Item], StatelyDB::Token))
@@ -450,7 +450,7 @@ module StatelyDB
     # _@param_ `resp` — the response to process
     # 
     # _@return_ — the result of the sync operation
-    sig { params(resp: ::Stately::Db::SyncResponse).returns(StatelyDB::SyncResult) }
+    sig { params(resp: Stately::Db::GetResponse).returns(StatelyDB::SyncResult) }
     def process_sync_response(resp); end
   end
 
@@ -530,7 +530,7 @@ module StatelyDB
       # 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
-        sig { params(token_provider: TokenProvider).void }
+        sig { params(token_provider: StatelyDB::Common::Auth::TokenProvider).void }
         def initialize(token_provider: AuthTokenProvider.new); end
 
         # gRPC client unary interceptor
@@ -654,7 +654,7 @@ module StatelyDB
         # Get the current access token
         # 
         # _@return_ — The fetched TokenResult
-        sig { returns(TokenResult) }
+        sig { returns(StatelyDB::Common::Auth::TokenResult) }
         def fetch; end
 
         # Close the token provider and kill any background operations
@@ -664,15 +664,6 @@ module StatelyDB
 
       # StatelyAccessTokenFetcher is a TokenFetcher that fetches tokens from the StatelyDB API
       class StatelyAccessTokenFetcher < StatelyDB::Common::Auth::TokenFetcher
-        NON_RETRYABLE_ERRORS = T.let([
-  GRPC::Core::StatusCodes::UNAUTHENTICATED,
-  GRPC::Core::StatusCodes::PERMISSION_DENIED,
-  GRPC::Core::StatusCodes::NOT_FOUND,
-  GRPC::Core::StatusCodes::UNIMPLEMENTED,
-  GRPC::Core::StatusCodes::INVALID_ARGUMENT
-].freeze, T.untyped)
-        RETRY_ATTEMPTS = T.let(10, T.untyped)
-
         # _@param_ `endpoint` — The endpoint of the OAuth server
         # 
         # _@param_ `access_key` — The StatelyDB access key credential
@@ -684,7 +675,7 @@ module StatelyDB
         # Fetch a new token from the StatelyDB API
         # 
         # _@return_ — The fetched TokenResult
-        sig { returns(TokenResult) }
+        sig { returns(StatelyDB::Common::Auth::TokenResult) }
         def fetch; end
 
         # Close the token provider and kill any background operations
@@ -862,8 +853,8 @@ module StatelyDB
       # 
       # _@param_ `store_id` — the StatelyDB Store to transact against
       # 
-      # _@param_ `schema` — the schema to use for marshalling and unmarshalling Items
-      sig { params(stub: ::Stately::Db::DatabaseService::Stub, store_id: Integer, schema: ::StatelyDB::Schema).void }
+      # _@param_ `schema` — the generated Schema module to use for mapping StatelyDB Items.
+      sig { params(stub: ::Stately::Db::DatabaseService::Stub, store_id: Integer, schema: Module).void }
       def initialize(stub:, store_id:, schema:); end
 
       # Send a request and wait for a response
@@ -1066,7 +1057,7 @@ module StatelyDB
       # _@param_ `req` — the request
       # 
       # _@return_ — the response type
-      sig { params(req: ::Stately::Db::TransactionRequest).returns(Class) }
+      sig { params(req: ::Stately::Db::TransactionRequest).returns(T::Class[T.anything]) }
       def infer_response_type_from_request(req); end
 
       # We are using a oneof inside the TransactionResponse to determine the type of response. The ruby
@@ -1075,7 +1066,7 @@ module StatelyDB
       # _@param_ `resp` — the response
       # 
       # _@return_ — the response type
-      sig { params(resp: ::Stately::Db::TransactionResponse).returns(Class) }
+      sig { params(resp: ::Stately::Db::TransactionResponse).returns(T::Class[T.anything]) }
       def infer_response_type_from_response(resp); end
 
       # Result represents the results of a transaction
@@ -1105,55 +1096,7 @@ end
 
 module Stately
   module Db
-    GetRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetRequest").msgclass, T.untyped)
-    GetItem = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetItem").msgclass, T.untyped)
-    GetResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GetResponse").msgclass, T.untyped)
-    PutRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutRequest").msgclass, T.untyped)
-    PutItem = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutItem").msgclass, T.untyped)
-    PutResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.PutResponse").msgclass, T.untyped)
-    Item = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.Item").msgclass, T.untyped)
-    BeginListRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.BeginListRequest").msgclass, T.untyped)
-    ListResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListResponse").msgclass, T.untyped)
-    ListPartialResult = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListPartialResult").msgclass, T.untyped)
-    ListFinished = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListFinished").msgclass, T.untyped)
-    SortDirection = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SortDirection").enummodule, T.untyped)
-    FilterCondition = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.FilterCondition").msgclass, T.untyped)
-    BeginScanRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.BeginScanRequest").msgclass, T.untyped)
-    SegmentationParams = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SegmentationParams").msgclass, T.untyped)
-    DeleteRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteRequest").msgclass, T.untyped)
-    DeleteItem = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteItem").msgclass, T.untyped)
-    DeleteResult = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteResult").msgclass, T.untyped)
-    DeleteResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeleteResponse").msgclass, T.untyped)
-    SyncListRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListRequest").msgclass, T.untyped)
-    SyncListResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListResponse").msgclass, T.untyped)
-    SyncListReset = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListReset").msgclass, T.untyped)
-    SyncListPartialResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SyncListPartialResponse").msgclass, T.untyped)
-    DeletedItem = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.DeletedItem").msgclass, T.untyped)
-    ListToken = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ListToken").msgclass, T.untyped)
-    TransactionRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionRequest").msgclass, T.untyped)
-    TransactionResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionResponse").msgclass, T.untyped)
-    TransactionBegin = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionBegin").msgclass, T.untyped)
-    TransactionGet = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionGet").msgclass, T.untyped)
-    TransactionBeginList = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionBeginList").msgclass, T.untyped)
-    TransactionContinueList = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionContinueList").msgclass, T.untyped)
-    TransactionPut = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionPut").msgclass, T.untyped)
-    TransactionDelete = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionDelete").msgclass, T.untyped)
-    TransactionGetResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionGetResponse").msgclass, T.untyped)
-    GeneratedID = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.GeneratedID").msgclass, T.untyped)
-    TransactionPutAck = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionPutAck").msgclass, T.untyped)
-    TransactionListResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionListResponse").msgclass, T.untyped)
-    TransactionFinished = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.TransactionFinished").msgclass, T.untyped)
-    ContinueListRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ContinueListRequest").msgclass, T.untyped)
-    ContinueListDirection = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ContinueListDirection").enummodule, T.untyped)
-    ContinueScanRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ContinueScanRequest").msgclass, T.untyped)
-    SortableProperty = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.SortableProperty").enummodule, T.untyped)
-    ScanRootPathsRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsRequest").msgclass, T.untyped)
-    ScanRootPathsResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathsResponse").msgclass, T.untyped)
-    ScanRootPathResult = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.db.ScanRootPathResult").msgclass, T.untyped)
-
     module DatabaseService
-      Stub = T.let(Service.rpc_stub_class, T.untyped)
-
       # DatabaseService is the service for creating, reading, updating and deleting data
       # in a StatelyDB Store. Creating and modifying Stores is done by
       # stately.dbmanagement.ManagementService.
@@ -1164,12 +1107,7 @@ module Stately
   end
 
   module Auth
-    GetAuthTokenRequest = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.auth.GetAuthTokenRequest").msgclass, T.untyped)
-    GetAuthTokenResponse = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.auth.GetAuthTokenResponse").msgclass, T.untyped)
-
     module AuthService
-      Stub = T.let(Service.rpc_stub_class, T.untyped)
-
       # AuthService is the service for vending access tokens used to connect to
       # StatelyDB. This API is meant to be used from SDKs. Access Keys are created
       # and managed from the stately.dbmanagement.UserService.
@@ -1180,17 +1118,8 @@ module Stately
   end
 
   module Errors
-    StatelyErrorDetails = T.let(::Google::Protobuf::DescriptorPool.generated_pool.lookup("stately.errors.StatelyErrorDetails").msgclass, T.untyped)
   end
 end
 
 module StatelyCode
-  CACHED_SCHEMA_TOO_OLD = T.let("CachedSchemaTooOld", T.untyped)
-  CONCURRENT_MODIFICATION = T.let("ConcurrentModification", T.untyped)
-  CONDITIONAL_CHECK_FAILED = T.let("ConditionalCheckFailed", T.untyped)
-  ITEM_REUSED_WITH_DIFFERENT_KEY_PATH = T.let("ItemReusedWithDifferentKeyPath", T.untyped)
-  NON_RECOVERABLE_TRANSACTION = T.let("NonRecoverableTransaction", T.untyped)
-  STORE_IN_USE = T.let("StoreInUse", T.untyped)
-  STORE_REQUEST_LIMIT_EXCEEDED = T.let("StoreRequestLimitExceeded", T.untyped)
-  STORE_THROUGHPUT_EXCEEDED = T.let("StoreThroughputExceeded", T.untyped)
 end

data/sig/statelydb.rbs

@@ -130,7 +130,7 @@ module StatelyDB
     # _@param_ `namespace`
     # 
     # _@param_ `identifier`
-    def with: (String namespace, ?(String | StatelyDB::UUID | _ToS)? identifier) -> KeyPath
+    def with: (String namespace, ?(String | StatelyDB::UUID | _ToS)? identifier) -> StatelyDB::KeyPath
 
     def to_str: () -> String
 
@@ -147,7 +147,7 @@ module StatelyDB
     # ```ruby
     # keypath = KeyPath.with("genres", "rock").with("artists", "the-beatles")
     # ```
-    def self.with: (String namespace, ?(String | StatelyDB::UUID | _ToS)? identifier) -> KeyPath
+    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.
     # 
@@ -175,7 +175,7 @@ module StatelyDB
     def initialize: (
                       store_id: Integer,
                       schema: Module,
-                      ?token_provider: Common::Auth::TokenProvider?,
+                      ?token_provider: StatelyDB::Common::Auth::TokenProvider?,
                       ?endpoint: String?,
                       ?region: String?,
                       ?no_auth: bool
@@ -464,7 +464,7 @@ module StatelyDB
       # 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: TokenProvider) -> void
+        def initialize: (?token_provider: StatelyDB::Common::Auth::TokenProvider) -> void
 
         # gRPC client unary interceptor
         # 
@@ -571,7 +571,7 @@ module StatelyDB
         # Get the current access token
         # 
         # _@return_ — The fetched TokenResult
-        def fetch: () -> TokenResult
+        def fetch: () -> StatelyDB::Common::Auth::TokenResult
 
         # Close the token provider and kill any background operations
         def close: () -> void
@@ -592,7 +592,7 @@ module StatelyDB
         # Fetch a new token from the StatelyDB API
         # 
         # _@return_ — The fetched TokenResult
-        def fetch: () -> TokenResult
+        def fetch: () -> StatelyDB::Common::Auth::TokenResult
 
         # Close the token provider and kill any background operations
         def close: () -> void
@@ -747,8 +747,8 @@ module StatelyDB
       # 
       # _@param_ `store_id` — the StatelyDB Store to transact against
       # 
-      # _@param_ `schema` — the schema to use for marshalling and unmarshalling Items
-      def initialize: (stub: ::Stately::Db::DatabaseService::Stub, store_id: Integer, schema: ::StatelyDB::Schema) -> void
+      # _@param_ `schema` — the generated Schema module to use for mapping StatelyDB Items.
+      def initialize: (stub: ::Stately::Db::DatabaseService::Stub, store_id: Integer, schema: Module) -> void
 
       # Send a request and wait for a response
       # 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
@@ -107,6 +107,25 @@ files:
 - lib/transaction/queue.rb
 - lib/transaction/transaction.rb
 - lib/uuid.rb
+- rbi/auth/get_auth_token_pb.rbi
+- rbi/auth/service_pb.rbi
+- rbi/auth/service_services_pb.rbi
+- rbi/db/continue_list_pb.rbi
+- rbi/db/continue_scan_pb.rbi
+- rbi/db/delete_pb.rbi
+- rbi/db/get_pb.rbi
+- rbi/db/item_pb.rbi
+- rbi/db/item_property_pb.rbi
+- rbi/db/list_pb.rbi
+- rbi/db/list_token_pb.rbi
+- rbi/db/put_pb.rbi
+- rbi/db/scan_pb.rbi
+- rbi/db/scan_root_paths_pb.rbi
+- rbi/db/service_pb.rbi
+- rbi/db/service_services_pb.rbi
+- rbi/db/sync_list_pb.rbi
+- rbi/db/transaction_pb.rbi
+- rbi/errors/error_details_pb.rbi
 - rbi/statelydb.rbi
 - sig/statelydb.rbs
 homepage: https://docs.stately.cloud/clients/ruby/