statelydb 0.22.0 → 0.24.0

data/rbi/db/service_services_pb.rbi

@@ -0,0 +1,184 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: db/service.proto
+# typed: strict
+
+module Stately::Db::DatabaseService
+  class Service
+    include ::GRPC::GenericService
+  end
+
+  class Stub < ::GRPC::ClientStub
+    sig do
+      params(
+        host: String,
+        creds: T.any(::GRPC::Core::ChannelCredentials, Symbol),
+        kw: T.untyped,
+      ).void
+    end
+    def initialize(host, creds, **kw)
+    end
+
+    # Put adds one or more Items to the Store, or replaces the Items if they
+# already exist. This will fail if the caller does not have permission to
+# create or update Items, if there is no schema registered for the provided
+# item type, or if an item is invalid. All puts are applied atomically;
+# either all will fail or all will succeed. If an item's schema specifies an
+# `initialValue` for one or more properties used in its key paths, and the
+# item is new, you should not provide those values - the database will choose
+# them for you, and Data must be provided as either serialized binary
+# protobuf or JSON.
+    sig do
+      params(
+        request: Stately::Db::PutRequest
+      ).returns(Stately::Db::PutResponse)
+    end
+    def put(request)
+    end
+
+    # Get retrieves one or more Items by their key paths. This will return any of
+# the Items that exist. It will fail if the caller does not have permission
+# to read Items. Use the List APIs if you want to retrieve multiple items but
+# don't already know the full key paths of the items you want to get.
+    sig do
+      params(
+        request: Stately::Db::GetRequest
+      ).returns(Stately::Db::GetResponse)
+    end
+    def get(request)
+    end
+
+    # Delete removes one or more Items from the Store by their key paths. This
+# will fail if the caller does not have permission to delete Items.
+# Tombstones will be saved for deleted items for some time, so
+# that SyncList can return information about deleted items. Deletes are
+# always applied atomically; all will fail or all will succeed.
+    sig do
+      params(
+        request: Stately::Db::DeleteRequest
+      ).returns(Stately::Db::DeleteResponse)
+    end
+    def delete(request)
+    end
+
+    # BeginList retrieves Items that start with a specified key path prefix. The
+# key path prefix must minimally contain a Group Key (a single key segment
+# with a namespace and an ID). BeginList will return an empty result set if
+# there are no items matching that key prefix. This API returns a token that
+# you can pass to ContinueList to expand the result set, or to SyncList to
+# get updates within the result set. This can fail if the caller does not
+# have permission to read Items.
+# buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+    sig do
+      params(
+        request: Stately::Db::BeginListRequest
+      ).returns(T::Enumerable[Stately::Db::ListResponse])
+    end
+    def begin_list(request)
+    end
+
+    # ContinueList takes the token from a BeginList call and returns more results
+# based on the original query parameters and pagination options. It has very
+# few options of its own because it is a continuation of a previous list
+# operation. It will return a new token which can be used for another
+# ContinueList call, and so on. The token is the same one used by SyncList -
+# each time you call either ContinueList or SyncList, you should pass the
+# latest version of the token, and then use the new token from the result in
+# subsequent calls. You may interleave ContinueList and SyncList calls
+# however you like, but it does not make sense to make both calls in
+# parallel. Calls to ContinueList are tied to the authorization of the
+# original BeginList call, so if the original BeginList call was allowed,
+# ContinueList with its token should also be allowed.
+# buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+    sig do
+      params(
+        request: Stately::Db::ContinueListRequest
+      ).returns(T::Enumerable[Stately::Db::ListResponse])
+    end
+    def continue_list(request)
+    end
+
+    # BeginScan initiates a scan request which will scan over the entire store
+# and apply the provided filters. This API returns a token that you can pass
+# to ContinueScan to paginate through the result set. This can fail if the
+# caller does not have permission to read Items.
+# WARNING: THIS API CAN BE EXTREMELY EXPENSIVE FOR STORES WITH A LARGE NUMBER
+# OF ITEMS.
+# buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+    sig do
+      params(
+        request: Stately::Db::BeginScanRequest
+      ).returns(T::Enumerable[Stately::Db::ListResponse])
+    end
+    def begin_scan(request)
+    end
+
+    # ContinueScan takes the token from a BeginScan call and returns more results
+# based on the original request parameters and pagination options. It has
+# very few options of its own because it is a continuation of a previous list
+# operation. It will return a new token which can be used for another
+# ContinueScan call, and so on. Calls to ContinueScan are tied to the
+# authorization of the original BeginScan call, so if the original BeginScan
+# call was allowed, ContinueScan with its token should also be allowed.
+# WARNING: THIS API CAN BE EXTREMELY EXPENSIVE FOR STORES WITH A LARGE NUMBER OF ITEMS.
+# buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
+    sig do
+      params(
+        request: Stately::Db::ContinueScanRequest
+      ).returns(T::Enumerable[Stately::Db::ListResponse])
+    end
+    def continue_scan(request)
+    end
+
+    # SyncList returns all changes to Items within the result set of a previous
+# List operation. For all Items within the result set that were modified, it
+# returns the full Item at in its current state. It also returns a list of
+# Item key paths that were deleted since the last SyncList, which you should
+# reconcile with your view of items returned from previous
+# BeginList/ContinueList calls. Using this API, you can start with an initial
+# set of items from BeginList, and then stay up to date on any changes via
+# repeated SyncList requests over time. The token is the same one used by
+# ContinueList - each time you call either ContinueList or SyncList, you
+# should pass the latest version of the token, and then use the new token
+# from the result in subsequent calls. Note that if the result set has
+# already been expanded to the end (in the direction of the original
+# BeginList request), SyncList will return newly created Items. You may
+# interleave ContinueList and SyncList calls however you like, but it does
+# not make sense to make both calls in parallel. Calls to SyncList are tied
+# to the authorization of the original BeginList call, so if the original
+# BeginList call was allowed, SyncList with its token should also be allowed.
+    sig do
+      params(
+        request: Stately::Db::SyncListRequest
+      ).returns(T::Enumerable[Stately::Db::SyncListResponse])
+    end
+    def sync_list(request)
+    end
+
+    # Transaction performs a transaction, within which you can issue writes
+# (Put/Delete) and reads (Get/List) in any order, followed by a commit
+# message. Reads are guaranteed to reflect the state as of when the
+# transaction started, and writes are committed atomically. This method may
+# fail if another transaction commits before this one finishes - in that
+# case, you should retry your transaction.
+    sig do
+      params(
+        request: T::Enumerable[Stately::Db::TransactionRequest]
+      ).returns(T::Enumerable[Stately::Db::TransactionResponse])
+    end
+    def transaction(request)
+    end
+
+    # ScanRootPaths lists root paths (Groups) in the Store. This is a very
+# expensive operation, as it must consult multiple partitions and it reads
+# and ignores a lot of data. It is provided for use in the web console's data
+# browser and is not exposed to customers. This operation will fail if the
+# caller does not have permission to read Items.
+    sig do
+      params(
+        request: Stately::Db::ScanRootPathsRequest
+      ).returns(Stately::Db::ScanRootPathsResponse)
+    end
+    def scan_root_paths(request)
+    end
+  end
+end

data/rbi/db/sync_list_pb.rbi

@@ -0,0 +1,452 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: db/sync_list.proto
+# typed: strict
+
+class Stately::Db::SyncListRequest
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      token_data: T.nilable(String),
+      schema_version_id: T.nilable(Integer),
+      schema_id: T.nilable(Integer)
+    ).void
+  end
+  def initialize(
+    token_data: "",
+    schema_version_id: 0,
+    schema_id: 0
+  )
+  end
+
+  # token_data is an opaque list continuation token returned by a previous call to
+# List, ContinueList, or SyncList.
+  sig { returns(String) }
+  def token_data
+  end
+
+  # token_data is an opaque list continuation token returned by a previous call to
+# List, ContinueList, or SyncList.
+  sig { params(value: String).void }
+  def token_data=(value)
+  end
+
+  # token_data is an opaque list continuation token returned by a previous call to
+# List, ContinueList, or SyncList.
+  sig { void }
+  def clear_token_data
+  end
+
+  # schema_version_id is the schema version id the client is using. This is
+# used to ensure a consistent schema version is used for all items in the result set.
+# If the version the token was created with is different from the client's
+# current version, the response will contain a SyncListReset response followed by
+# items in the client's current schema version. The returned list token can then
+# be used for further SyncList and ContinueList calls with the current schema
+# version, without having to start a new BeginList call.
+  sig { returns(Integer) }
+  def schema_version_id
+  end
+
+  # schema_version_id is the schema version id the client is using. This is
+# used to ensure a consistent schema version is used for all items in the result set.
+# If the version the token was created with is different from the client's
+# current version, the response will contain a SyncListReset response followed by
+# items in the client's current schema version. The returned list token can then
+# be used for further SyncList and ContinueList calls with the current schema
+# version, without having to start a new BeginList call.
+  sig { params(value: Integer).void }
+  def schema_version_id=(value)
+  end
+
+  # schema_version_id is the schema version id the client is using. This is
+# used to ensure a consistent schema version is used for all items in the result set.
+# If the version the token was created with is different from the client's
+# current version, the response will contain a SyncListReset response followed by
+# items in the client's current schema version. The returned list token can then
+# be used for further SyncList and ContinueList calls with the current schema
+# version, without having to start a new BeginList call.
+  sig { void }
+  def clear_schema_version_id
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { returns(Integer) }
+  def schema_id
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { params(value: Integer).void }
+  def schema_id=(value)
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { void }
+  def clear_schema_id
+  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::Db::SyncListRequest) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::SyncListRequest).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::SyncListRequest) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::SyncListRequest, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# These are stream messages, so multiple responses may be sent.
+class Stately::Db::SyncListResponse
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      reset: T.nilable(Stately::Db::SyncListReset),
+      result: T.nilable(Stately::Db::SyncListPartialResponse),
+      finished: T.nilable(Stately::Db::ListFinished)
+    ).void
+  end
+  def initialize(
+    reset: nil,
+    result: nil,
+    finished: nil
+  )
+  end
+
+  # SyncListReset is returned if the provided token is too far behind to be able to
+# report deleted items, or if the client is using a different schema version than
+# it started the list with. The following results will start over with a fresh
+# result set. Clients should discard any cached data from this result set and start
+# re-populating it from the rest of the sync response.
+  sig { returns(T.nilable(Stately::Db::SyncListReset)) }
+  def reset
+  end
+
+  # SyncListReset is returned if the provided token is too far behind to be able to
+# report deleted items, or if the client is using a different schema version than
+# it started the list with. The following results will start over with a fresh
+# result set. Clients should discard any cached data from this result set and start
+# re-populating it from the rest of the sync response.
+  sig { params(value: T.nilable(Stately::Db::SyncListReset)).void }
+  def reset=(value)
+  end
+
+  # SyncListReset is returned if the provided token is too far behind to be able to
+# report deleted items, or if the client is using a different schema version than
+# it started the list with. The following results will start over with a fresh
+# result set. Clients should discard any cached data from this result set and start
+# re-populating it from the rest of the sync response.
+  sig { void }
+  def clear_reset
+  end
+
+  # Result is a segment of sync results - multiple of these may be returned.
+  sig { returns(T.nilable(Stately::Db::SyncListPartialResponse)) }
+  def result
+  end
+
+  # Result is a segment of sync results - multiple of these may be returned.
+  sig { params(value: T.nilable(Stately::Db::SyncListPartialResponse)).void }
+  def result=(value)
+  end
+
+  # Result is a segment of sync results - multiple of these may be returned.
+  sig { void }
+  def clear_result
+  end
+
+  # Finished is sent when the sync is complete, and there will only be one.
+  sig { returns(T.nilable(Stately::Db::ListFinished)) }
+  def finished
+  end
+
+  # Finished is sent when the sync is complete, and there will only be one.
+  sig { params(value: T.nilable(Stately::Db::ListFinished)).void }
+  def finished=(value)
+  end
+
+  # Finished is sent when the sync is complete, and there will only be one.
+  sig { void }
+  def clear_finished
+  end
+
+  sig { returns(T.nilable(Symbol)) }
+  def response
+  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::Db::SyncListResponse) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::SyncListResponse).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::SyncListResponse) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::SyncListResponse, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# SyncListReset is returned if the provided token is too far behind to be able to
+# report deleted items, and subsequent results will start over with a fresh result
+# set. Clients should discard any cached data from this result set and start re-populating it.
+class Stately::Db::SyncListReset
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig {void}
+  def initialize; 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::Db::SyncListReset) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::SyncListReset).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::SyncListReset) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::SyncListReset, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+class Stately::Db::SyncListPartialResponse
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      changed_items: T.nilable(T::Array[T.nilable(Stately::Db::Item)]),
+      deleted_items: T.nilable(T::Array[T.nilable(Stately::Db::DeletedItem)]),
+      updated_item_keys_outside_list_window: T.nilable(T::Array[String])
+    ).void
+  end
+  def initialize(
+    changed_items: [],
+    deleted_items: [],
+    updated_item_keys_outside_list_window: []
+  )
+  end
+
+  # Items in the token window that were added or updated since the last
+# sync/list.
+  sig { returns(T::Array[T.nilable(Stately::Db::Item)]) }
+  def changed_items
+  end
+
+  # Items in the token window that were added or updated since the last
+# sync/list.
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def changed_items=(value)
+  end
+
+  # Items in the token window that were added or updated since the last
+# sync/list.
+  sig { void }
+  def clear_changed_items
+  end
+
+  # Items in the token window that were deleted since the last sync/list.
+  sig { returns(T::Array[T.nilable(Stately::Db::DeletedItem)]) }
+  def deleted_items
+  end
+
+  # Items in the token window that were deleted since the last sync/list.
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def deleted_items=(value)
+  end
+
+  # Items in the token window that were deleted since the last sync/list.
+  sig { void }
+  def clear_deleted_items
+  end
+
+  # Keys of items that were updated but Stately cannot tell if they were in the
+# sync window. Treat these as deleted in most cases. For more information
+# see: https://docs.stately.cloud/api/sync
+  sig { returns(T::Array[String]) }
+  def updated_item_keys_outside_list_window
+  end
+
+  # Keys of items that were updated but Stately cannot tell if they were in the
+# sync window. Treat these as deleted in most cases. For more information
+# see: https://docs.stately.cloud/api/sync
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def updated_item_keys_outside_list_window=(value)
+  end
+
+  # Keys of items that were updated but Stately cannot tell if they were in the
+# sync window. Treat these as deleted in most cases. For more information
+# see: https://docs.stately.cloud/api/sync
+  sig { void }
+  def clear_updated_item_keys_outside_list_window
+  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::Db::SyncListPartialResponse) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::SyncListPartialResponse).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::SyncListPartialResponse) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::SyncListPartialResponse, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+class Stately::Db::DeletedItem
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      key_path: T.nilable(String)
+    ).void
+  end
+  def initialize(
+    key_path: ""
+  )
+  end
+
+  # Since the item was deleted, only the key is provided.
+  sig { returns(String) }
+  def key_path
+  end
+
+  # Since the item was deleted, only the key is provided.
+  sig { params(value: String).void }
+  def key_path=(value)
+  end
+
+  # Since the item was deleted, only the key is provided.
+  sig { void }
+  def clear_key_path
+  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::Db::DeletedItem) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::DeletedItem).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::DeletedItem) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::DeletedItem, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end