@tdxvolt/volt-client-grpc 0.18.3 → 0.18.4

package/protobuf/README.md

@@ -1,4 +0,0 @@
-# tdx Volt protobuf
-
-**WARNING** - this is a duplication of the protobuf defined in https://github.com/tdxvolt/tdxvolt-core, which is the
-source of truth.

package/protobuf/tdx/volt_api/data/v1/sqlite.proto

@@ -1,43 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.data.v1;
-
-// Just reflect SQLite types for now.
-enum DataType {
-  DATA_TYPE_UNKNOWN = 0;
-  DATA_TYPE_TEXT = 1;
-  DATA_TYPE_INTEGER = 2;
-  DATA_TYPE_REAL = 3;
-  DATA_TYPE_BLOB = 4;
-  DATA_TYPE_NULL = 5;
-}
-
-message Column {
-  string name = 1;
-  string description = 2;
-  DataType type = 3;
-}
-
-message Schema {
-  string name = 1;
-  string description = 2;
-  repeated Column column = 3;
-}
-
-message Variant {
-  oneof data {
-    string text = 1;
-    int64 integer = 2;
-    double real = 3;
-    bytes blob = 4;
-    bool null = 5;
-  }
-}
-
-message RowHeader {
-  repeated Column column = 1;
-}
-
-message VariantRow {
-  repeated Variant column = 1;
-}

package/protobuf/tdx/volt_api/data/v1/sqlite_database_api.proto

@@ -1,153 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.data.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/data/v1/sqlite.proto";
-import "tdx/volt_api/volt/v1/volt.proto";
-
-// The Sqlite Database API exposes functions that enable clients to manipulate data in a given Volt database.
-// Use the Sqlite Server API to create the database resource.
-service SqliteDatabaseAPI {
-  // Execute multiple SQL statements in a single transaction via a single RPC.
-  rpc BulkUpdate(SqlBulkUpdateRequest) returns (SqlBulkUpdateResponse);
-
-  // Execute a single SQL statement. Any valid SQL is accepted. In order to execute non-SELECT statements, the caller must have the "write" permission.
-  rpc Execute(stream SqlExecuteRequest) returns (stream SqlExecuteResponse);
-
-  // Import CSV data into a table.
-  // The import handler will inspect the incoming CSV data, infer the columns and data types required, and create and populate the SQL table.
-  // The CSV must contain a header row containing the column names and at least one row of data so that the types can be inferred.
-  // The importer assumes all data in any given CSV file relates to a single table.
-  // The data can either be streamed in chunks or retrieved from an existing resource.
-  // If the data is streamed in chunks, the client must call the Close() method on the stream to indicate that it has finished.
-  rpc ImportCSV(stream SqlImportCSVRequest) returns (stream SqlImportCSVResponse);
-}
-
-message SqlBulkUpdateRequest {
-  // The id of the database to update.
-  string database_id = 1;
-
-  // The SQL statements to execute. The statements will be executed within a transaction and will be committed if all statements succeed.
-  // Bear in mind the maximum size limit of a single message is 64MB, and around 1MB seems to be optimal in terms of performance.
-  repeated string statement = 2;
-}
-
-message SqlBulkUpdateResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
-message SqlExecuteStart {
-  // The id of the database to execute on.
-  string database_id = 1;
-
-  // Set to start a transaction. If not set, each statement will be executed in its own transaction.
-  bool transaction = 2;
-
-  // The SQL statement to execute.
-  string statement = 3;
-
-  // This can be used to limit the number of rows returned by `SELECT` statements to avoid overloading a client. It is similar to using 'LIMIT/OFFSET' clauses on the 'SELECT' statement, but this method is easier to manage and the entire result set will be prepared on the Volt, and the client can then page through it by sending successive messages.
-  uint32 page_size = 4;
-
-  // Set to indicate that the query will be cancelled if the client disconnects.
-  // This is useful for long running queries, where it might be desirable for the client to be able to cancel the request before all the data is received. However this requires a worker thread to be allocated to the query until it completes, which may affect performance and limit the number of concurrent queries that can be executed due to file handle limitations.
-  // Only applicable to `SELECT` statements, ignored otherwise.
-  bool can_cancel = 5;
-
-  //The values to set for each parameter defined in a database view.
-  //This field is only relevant to 'query' databases, i.e. those with kind `tdx:sqlite-view`.
-  //The values in the map should be keyed by parameter name.
-  // A query may have no parameters defined, in which case leave this field empty.
-  map<string, tdx.volt_api.volt.v1.AttributeValue> parameter = 6;
-}
-
-// Intentionally empty.
-message SqlExecuteNext {
-}
-
-// Ends the call.
-message SqlExecuteEnd {
-  // Set to commit the transaction. If not set, the transaction will be rolled back.
-  bool commit_transaction = 1;
-}
-
-message SqlExecuteRequest {
-  oneof payload {
-    // Initialise the request with the database id and whether to execute within a transaction.
-    // Also includes the SQL statement to execute.
-    SqlExecuteStart start = 2;
-
-    // To retrieve subsequent pages, send a `next` request.
-    SqlExecuteNext next = 3;
-
-    // To end the call, send an `end` request. Only really necessary for transaction-based calls, otherwise clients can just close the stream.
-    SqlExecuteEnd end = 4;
-  }
-}
-
-// One of the following fields will be present in any given message.
-message SqlExecuteResponse {
-  oneof payload {
-    // A status will be sent on error.
-    tdx.volt_api.volt.v1.Status status = 1;
-
-    // The initial response for SELECT statements will be a header containing the column names and types.
-    RowHeader header = 2;
-
-    // Each row in the result set will be sent as a VariantRow.
-    VariantRow row = 3;
-
-    // NYI - For INSERT/UPDATE statements the number of affected rows will be sent.
-    uint32 affected_rows = 4;
-  }
-}
-
-message SqlImportCSVConfiguration {
-  // The target database resource id, which must already exist, and the authenticated account must have write access to the resource.
-  string database_id = 1;
-
-  // The target table name.
-  string table_name = 2;
-
-  // Not yet implemented - flag indicating that data is to be inserted into an existing table.
-  bool create_table = 3;
-
-  // Optional - when not sending the data via this RPC, this should contain the id of a resource that contains the CSV data. If set, the authenticated account must have read access to the resource.
-  string source_resource_id = 4;
-
-  // Optional - the interval to receive progress updates, in number of rows. E.g. set to 1000 to receive progress updates every 1000 rows. Set to 0 to disable progress updates.
-  uint32 progress_interval = 5;
-
-  // The number of rows scanned to infer the schema. Set to 0 to scan the entire file.
-  uint32 schema_scan_limit = 6;
-}
-
-// Each message must contain one and only one of the following fields.
-message SqlImportCSVRequest {
-  oneof payload {
-    // The initial request must contain the configuration parameters for the import.
-    SqlImportCSVConfiguration configuration = 1;
-
-    // Set to indicate that the upload is complete.
-    bool upload_complete = 2;
-
-    // Subsequent requests may contain the data to be imported, unless importing from an existing resource that contains the CSV data. It is recommended that the block size is less than 1MB.
-    bytes block = 3;
-
-    // Set to abort the import.
-    bool abort = 4;
-  }
-}
-
-message SqlImportCSVResponse {
-  // The status will contain any error info.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The number of rows processed - this will be sent after every `progress_interval` rows.
-  int64 row_count = 2;
-
-  // The total number of rows to be imported.
-  int64 total_rows = 3;
-}

package/protobuf/tdx/volt_api/data/v1/sqlite_server_api.proto

@@ -1,50 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.data.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/volt/v1/volt.proto";
-
-// The Sqlite Server API provides database management functions.
-// Use the VoltAPI DeleteResource function to delete a database.
-service SqliteServerAPI {
-  // Create a new database resource.
-  rpc CreateDatabase(CreateDatabaseRequest) returns (CreateDatabaseResponse);
-}
-
-message CreateDatabaseRequest {
-  // The name of the database to create.
-  string name = 1;
-
-  // Optional - the id of the folder resource in which to create the database. If omitted, the callers home folder is used.
-  string create_in_parent_id = 2;
-
-  // Set to encrypt the database. The encryption key will be generated by the server, the internal Volt server uses the root volt key.
-  bool encrypted = 3;
-
-  // Set to audit all SELECT database operations.
-  bool read_audit = 4;
-
-  // Set to audit all INSERT, UPDATE, and DELETE database operations.
-  bool write_audit = 5;
-
-  // The discovery mode of the underlying Volt resource.
-  tdx.volt_api.volt.v1.DiscoveryMode discoverable = 6;
-
-  // Alias(es) that can be used to refer to the database rather than the id.
-  // Each alias must be unique to the Volt, this is enforced by the API.
-  // No format restrictions are currently applied to alias, but this may change in future, for the time being it makes sense to stick to alphanumeric characters and '_' or '-'.
-  repeated string alias = 7;
-
-  // Optional description of the database.
-  string description = 8;
-}
-
-message CreateDatabaseResponse {
-  // Any error message will be returned here.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The new database resource on success.
-  tdx.volt_api.volt.v1.Resource resource = 2;
-}
-

package/protobuf/tdx/volt_api/relay/v1/proxy_api.proto

@@ -1,9 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.relay.v1;
-
-// Placeholder API for the proxy.
-// Methods are injected into this service at runtime
-// when a remote volt connects via the RelayAPI.
-service ProxyAPI {
-}

package/protobuf/tdx/volt_api/relay/v1/relay_api.proto

@@ -1,78 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.relay.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/volt/v1/remote.proto";
-import "tdx/volt_api/volt/v1/volt.proto";
-
-service RelayAPI {
-  // Retrieve the list of Volts available on the Relay Volt.
-  rpc GetVoltEndpoint(GetVoltEndpointRequest) returns (GetVoltEndpointResponse);
-
-  // This is the actual tunnel stream.
-  // Note although this API semantically describes the tunnel stream, it isn't actually implemented anywhere. It is used by client libraries to easily serialise tunnel payloads.
-  rpc Tunnel(stream tdx.volt_api.volt.v1.RemoteRequest) returns (stream tdx.volt_api.volt.v1.RemoteResponse);
-
-  // This is the tunnel stream for cloud-based tunnels.
-  rpc CloudTunnel(stream TunnelRequest) returns (stream TunnelResponse);
-}
-
-message GetVoltEndpointRequest {
-  // Optional - if omitted a list of all volts known to the authenticated
-  // account will be returned.
-  oneof filter {
-    // Filter on the owning identity.
-    string owner_id = 2;
-    // Filter on volt id.
-    string volt_id = 1;
-  }
-}
-
-message GetVoltEndpointResponse {
-  tdx.volt_api.volt.v1.Status status = 1;
-  repeated tdx.volt_api.volt.v1.VoltEndpoint endpoint = 2;
-}
-
-message TunnelStart {
-  uint32 preferred_port = 1;
-  string address = 2;
-  string public_key = 3;
-  string fingerprint = 4;
-  string ca_pem = 5;
-  string volt_version = 6;
-}
-
-message TunnelServiceControl {
-  string resource_id = 1;
-  string service_name = 2;
-  tdx.volt_api.volt.v1.ServiceDescription service_description = 3;
-}
-
-message TunnelControl {
-  oneof msg {
-    TunnelStart start = 2;
-    TunnelServiceControl add_service = 3;
-    TunnelServiceControl remove_service = 4;
-  }
-}
-
-message TunnelRequest {
-  oneof payload {
-    tdx.volt_api.volt.v1.RemotePing ping = 1;
-    TunnelControl control = 2;
-    tdx.volt_api.volt.v1.MethodPayload method_payload = 3;
-    tdx.volt_api.volt.v1.MethodEnd method_end = 4;
-    tdx.volt_api.volt.v1.HttpResponse http_response = 5;
-  }
-}
-
-message TunnelResponse {
-  oneof payload {
-    tdx.volt_api.volt.v1.RemotePing ping = 1;
-    tdx.volt_api.volt.v1.MethodInvoke method_invoke = 2;
-    tdx.volt_api.volt.v1.MethodPayload method_payload = 3;
-    tdx.volt_api.volt.v1.MethodEnd method_end = 4;
-    tdx.volt_api.volt.v1.HttpRequest http_request = 5;
-  }
-}

package/protobuf/tdx/volt_api/sync/v1/sync.proto

@@ -1,57 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.sync.v1;
-
-// Wraps arbitrary protobuf messages, with an index into the `ProtobufSyncConfigurationHeader` to indicate the specific message type this message wraps.
-message ProtobufSyncWrapper {
-  oneof header_lookup {
-    // The index number of the header for this message type in the Volt logger configuration file.
-    uint32 header_index = 1;
-
-    // The name of the header for this message type, will be used to lookup against the `id` field in `ProtobufSyncConfiguration`.
-    // This will incur an overhead in terms of the packet size, but might be preferrable if volume is low or managing the header index is difficult.
-    string header_id = 2;
-  }
-
-  // The message payload, in serialised protobuf binary format.
-  // n.b. the serialisation should **not** be length-prefixed.
-  bytes payload = 3;
-}
-
-// Describes a single message type.
-// A set of one or more of these messages is specified in `ProtobufSyncConfigurationHeader`.
-message ProtobufSyncConfiguration {
-  // Optional id to associate with this configuration.
-  // This can be used in the `header_id` field of `ProtobufSyncWrapper` above to reference the configuration.
-  // If omitted the numerical index of the configuration in `ProtobufSyncConfigurationHeader` will be used instead.
-  string id = 1;
-
-  // The actual protobuf definition text.
-  // Copy and paste the source protobuf definition from the `.proto` file.
-  // Only simple protobuf structures are currently supported, e.g. no imports from other packages etc.
-  string message_proto = 2;
-
-  // The name of the message within `message_proto` above that represents the data to be sync'd, e.g. `TCPDumpPacket`.
-  string message_name = 3;
-
-  // The name of the table within the target database into which the message data for this type should be written.
-  string table_name = 4;
-}
-
-// This message is written at the beginning of every file to be ingested using the `protoDbSync` utility.
-// It contains a `header` entry for each message type that may appear in the file.
-// If the `volt logger` command is used, it will create this header automatically based on the configuration it's given.
-message ProtobufSyncConfigurationHeader {
-  // This should ideally be a persistent UUID, at minimum it must be unique within the set of types of file any given instance of `protoDbSync` is processing in a given folder.
-  // It is used to match up orphaned or split packets that might occur when receiving data from a wire, for example, if a log file is rotated midway through a packet arriving on the wire.
-  // This id should persist for the life time of the set of data it describes, i.e. if a wire publication is stopped and restarted at some later point, the same id should be used if possible.
-  string id = 1;
-
-  // The set of possible configurations that can appear in any given protobuf sync data file.
-  // A serialised instance of this message must appear at the top of each data file.
-  // Each subsequent serialised message in the data file must be an instance of `ProtobufSyncWrapper`, and the `header_lookup` field refers to an entry in this list.
-  repeated ProtobufSyncConfiguration configuration = 2;
-
-  // Optional maximum size of the serialised messages, this doesn't need to be exact and the default is 64K if omitted.
-  int32 maximum_message_size = 3;
-}

package/protobuf/tdx/volt_api/volt/v1/discovery_api.proto

@@ -1,35 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/volt/v1/volt.proto";
-
-// The public Volt discovery service. 
-// This is exposed by the Volt battery over an INSECURE grpc channel.
-// This insecurity is ameliorated by the fact that discovered Volts return signatures of their challenge code and owner credential.
-// Note that only Volts that have explicitly set 'discoverable' in the Volt settings will be discovered.
-service DiscoveryAPI {
-  rpc Discover(DiscoverRequest) returns (DiscoverResponse) {};
-}
-
-message DiscoverRequest {
-  // Set to require that only Volts that expose a Relay be included in the response.
-  bool require_relay = 1;
-}
-
-message SignedEndpoint {
-  // The discovered Volt endpoint information.
-  tdx.volt_api.volt.v1.VoltEndpoint endpoint = 1;
-
-  // The discovered Volt's challenge code, signed by the Volt private key and base64 encoded.
-  // If a client knows the Volt challenge code by some out-of-band means, it can use the Volt public key (contained in the endpoint information above) to determine that the discovered Volt also knows the same challenge code.
-  string challenge_signature = 2;
-}
-
-message DiscoverResponse {
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // A list of endpoints that match the request criteria.
-  repeated SignedEndpoint endpoint = 2;
-}

package/protobuf/tdx/volt_api/volt/v1/file.proto

@@ -1,17 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-message File {
-  string file_path = 1;
-  string absolute_path = 2;
-  string file_name = 3;
-  string extension = 4;
-  uint64 size = 5;
-  string media_type = 6;
-  bool is_directory = 7;
-  uint64 modified = 8;
-
-  string resource_id = 100;
-  string owner_resource_id = 101;
-}

package/protobuf/tdx/volt_api/volt/v1/file_api.proto

@@ -1,165 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/volt/v1/file.proto";
-
-// The File API exposes basic file management functions.
-service FileAPI {
-
-  // Download from file resource.
-  rpc DownloadFile(DownloadFileRequest) returns (stream DownloadFileResponse);
-
-  // Get file resource metadata.
-  rpc GetFile(GetFileRequest) returns (GetFileResponse);
-
-  // Get the content of a file.
-  // Note this rpc will fail if the size of the file content is greater than 64MB, in which case use DownloadFile instead.
-  rpc GetFileContent(GetFileContentRequest) returns (GetFileContentResponse);
-
-  // Get the file resource metadata of all descendants of a given file resource. 
-  rpc GetFileDescendants(GetFileDescendantsRequest) returns (GetFileDescendantsResponse);
-
-  // Set the content of a file.
-  // Note this rpc will fail if the size of the file content is greater than 64MB, in which case use UploadFile instead.
-  rpc SetFileContent(SetFileContentRequest) returns (SetFileContentResponse);
-
-  // Upload data to a file resource.
-  rpc UploadFile(stream UploadFileRequest) returns (stream UploadFileResponse);
-}
-
-message DownloadFileRequest {
-  // The id of the resource to download.
-  string resource_id = 1;
-
-  // This is required for linked folders, and represents the relative path to the source file from the base folder.
-  string file_path = 2;
-}
-
-// The response stream will contain one or more of the following messages.
-// Each response message will contain one of the following fields.
-message DownloadFileResponse {
-  oneof payload {
-    // A chunk of file data.
-    bytes block = 1;
-
-    // A status will be sent when the file is completely downloaded, or if an error occurs.
-    tdx.volt_api.volt.v1.Status status = 2;
-  }
-}
-
-message GetFileRequest {
-  // The resource id of the base folder.
-  string resource_id = 1;
-
-  // Optional - the path to the file, relative to the base folder. Required for linked folders.
-  string file_path = 2;
-}
-
-message GetFileResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The file metadata.
-  File file = 2;
-}
-
-message GetFileContentRequest {
-  // The resource id of the base folder.
-  string resource_id = 1;
-
-  // Optional - the path to the file, relative to the base folder. Required for linked folders.
-  string file_path = 2;
-}
-
-message GetFileContentResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The file content.
-  bytes content = 2;
-}
-
-message GetFileDescendantsRequest {
-  // The resource id of the base folder.
-  string resource_id = 1;
-
-  // For linked files, this is the relative path to the 'parent' file from the base folder.
-  string file_path = 2;
-
-  // Optional - only match descendants of the given kind.
-  string extension = 3;
-
-  // Optional - can be used to determine if a resource is a descendant.
-  string descendant_id = 5;
-}
-
-message GetFileDescendantsResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The list of descendants.
-  repeated File descendant = 2;
-}
-
-message SetFileContentRequest {
-  // The resource id of the base folder.
-  string resource_id = 1;
-
-  // Optional - the path to the file, relative to the base folder. Required for linked folders.
-  string file_path = 2;
-
-  // Optional store name to use.
-  // If specified, this will be used to extract the extension to set as a resource 'kind', e.g. tdx:ext:json.
-  // If not specified, the extension will be taken from the name of the target resource.
-  string store_name = 3;
-
-  bytes content = 4;
-}
-
-message SetFileContentResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
-message UploadFileStart {
-  // The resource to upload to, required.
-  string resource_id = 1;
-
-  // Optional store name to use.
-  // If specified, this will be used to extract the extension to set as a resource 'kind', e.g. tdx:ext:json.
-  // If not specified, the extension will be taken from the name of the target resource.
-  string store_name = 2;
-
-  // Optionally set streaming mode.
-  // When in streaming mode, data is written directly to the resource.
-  // Otherwise, data is written to a temporary file and then copied over once the upload completes successfully.
-  bool streaming_mode = 3;
-
-  // Optional, truncates the file prior to beginning the upload. This is only really relevant if 'streaming_mode' is set.
-  bool truncate = 4;
-
-  // Optional, buffer will flush after each write.
-  bool eager_flush = 5;
-}
-
-// One of the following fields must be present.
-message UploadFileRequest {
-  oneof payload {
-    // Describes the file upload, should only be sent as first message.
-    UploadFileStart start = 1;
-
-    // The next block of data.
-    bytes block = 2;
-  }
-}
-
-message UploadFileResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // Reserved for internal use.
-  bool back_off = 2;
-}
-