@tdxvolt/volt-client-grpc 0.20.10 → 0.20.12

package/src/volt-proto-literals.js

@@ -718,128 +718,6 @@ message RemoteResponse {
     HttpRequest http_request = 5;
   }
 }
-`;
-export const spark_api = `syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-
-// The Spark API allows clients to start and communicate with Spark VMs.
-service SparkAPI {
-  // Start or connect to a spark VM and establish a long-lived communication channel.
-  rpc Spark(stream SparkRequest) returns (stream SparkResponse);
-
-  // Get details of running spark VMs.
-  rpc GetSpark(GetSparkRequest) returns (GetSparkResponse);
-}
-
-// Start a resource-hosted spark.
-// Provenance is determined from the resource owner.
-message StartSparkResource {
-  // The id of the resource containing the VM byte code.
-  string resource_id = 1;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 2;
-
-  // Envelope signature.
-  string signature = 3;
-}
-
-// Start a spark from byte code included in the payload, along with issuer/developer claims and signature.
-message StartSparkAdhoc {
-  // Ad-hoc byte code of VM to run.
-  bytes byte_code = 1;
-
-  // Verifiable credentials associated with this spark.
-  repeated string credential = 2;
-
-  // Envelope signature.
-  string signature = 3;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 4;
-}
-
-// Send commands and payloads to communicate with a running spark.
-message SparkCommand {
-  // Optional id to associate with this command.
-  // If this is omitted, an id will be assigned and returned in the command acknowledgement.
-  string command_id = 1;
-
-  // The command to send to the spark.
-  string command = 2;
-
-  // The command payload.
-  string payload = 3;
-
-  // Command verifiable credential.
-  string credential = 4;
-
-  // Command signature.
-  string signature = 5;
-}
-
-// The request must contain one of the messages indicated below.
-message SparkRequest {
-  oneof payload {
-    StartSparkResource start_resource = 1;
-    StartSparkAdhoc start_adhoc = 2;
-    SparkCommand command = 3;
-  }
-}
-
-// Receive events and payload from a running spark.
-message SparkData {
-  // The command id to which this data corresponds.
-  string command_id = 1;
-
-  oneof payload {
-    // Acknowledges receipt of a spark command.
-    bool acknowledge = 2;
-
-    // Indicates the command has completed.
-    bool ended = 3;
-
-    // Will contain error details on command failure.
-    string error = 4;
-
-    // Data emitted by a command, usually in stringified JSON format.
-    string data = 5;
-  }
-}
-
-// Details of a spark instance.
-message SparkInstance {
-  // The UUID assigned to the spark instance.
-  string spark_id = 1;
-}
-
-// The response will contain one of the messages indicated below.
-message SparkResponse {
-  oneof payload {
-    // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status status = 1;
-
-    // Details of the spark instance, sent in response to a start command.
-    SparkInstance spark_instance = 2;
-
-    // Payload data emitted by the spark.
-    SparkData spark_data = 3;
-  }
-}
-
-message GetSparkRequest {
-  string spark_id = 1;
-}
-
-// One of the following fields will be present in the response.
-message GetSparkResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
 `;
 export const ssi = `syntax = "proto3";
 
@@ -915,12 +793,12 @@ export const ssi_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
 
-import "tdx/volt_api/volt/v1/status.proto";
 import "tdx/volt_api/volt/v1/ssi.proto";
+import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
-  // Get a short-lived, one-time token that can be used to authenticate with the Volt and potentially create verifiable credential(s).
-  rpc CreateExchangeToken(CreateExchangeTokenRequest) returns (CreateExchangeTokenResponse);
+  // Creates a verifiable credential binding an email address to an identity.
+  rpc CreateEmailCredential(CreateEmailCredentialRequest) returns (CreateEmailCredentialResponse);
 
   // Delete a DID document or all DID documents originating from a given Volt.
   // Requires \`volt:delete-did\` API privilege.
@@ -951,20 +829,26 @@ service SsiAPI {
   rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message CreateExchangeTokenRequest {
-  // The VC template to use to create a verifiable credential.
-  string vc_template = 1;
+message CreateEmailCredentialRequest {
+  // The DID of the identity to bind to. If not specified the DID of the currently authenticated account is used.
+  string identity_did = 1;
+
+  // The email address to bind to the identity.
+  string email_address = 2;
+
+  // The identity provider to use.
+  string identity_provider = 3;
 
-  // The time to live for the token, in seconds.
-  uint32 ttl = 2;
+  // The passphrase for the identity key, if required (i.e. the key is encrypted).
+  string key_passphrase = 4;
 }
 
-message CreateExchangeTokenResponse {
+message CreateEmailCredentialResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
-  // The one-time token.
-  string token = 2;
+  // The verifiable credential resource id.
+  string vc_id = 2;
 }
 
 message DeleteDIDRequest {
@@ -1166,14 +1050,57 @@ export const sync_api = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 import "tdx/volt_api/volt/v1/status.proto";
+import "tdx/volt_api/volt/v1/volt_api.proto";
 
 // The Sync API allows clients to collaboratively read and write JSON data to a shared resource.
 service SyncAPI {
+  // Create a synapse connection resource.
+  // A synapse connection defines a bi-directional syncronisation between two Volt databases. The connection is created as a child of the local synapse resource, and a symbolic link is also placed in the system-wide 'connection' folder.
+  // The remote Volt is identified by its DID or address. If a relay address is provided, the connection will be established via the relay.
+  // The authenticated account must have \`volt:resource-create\` access to the local synapse resource.
+  rpc CreateSynapseConnection(SaveResourceRequest) returns (SaveResourceResponse);
+
+  // Set the metadata for a synapse document.
+  rpc SetSynapseDocumentMetadata(SetSynapseDocumentMetadataRequest) returns (SetSynapseDocumentMetadataResponse);
+
   // Bidirectional streaming RPC for real-time document synchronization
   rpc SyncDocument(stream SyncDocumentRequest) returns (stream SyncDocumentResponse);
 
-  // Simple RPC to fetch current document state as JSON
-  rpc GetDocumentJSON(GetDocumentJSONRequest) returns (GetDocumentJSONResponse);
+  // Watch synapse paths for changes.
+  rpc WatchSynapsePath(stream WatchSynapsePathRequest) returns (stream WatchSynapsePathResponse);
+
+  // Write a single value to a given synapse JSON path.
+  rpc WriteSynapsePath(WriteSynapsePathRequest) returns (WriteSynapsePathResponse);
+}
+
+
+message SynapseDocumentMetadata {
+  // The name of the top-level shared type in the document.
+  string name = 1;
+
+  // The type of the shared type, e.g. "map", "array" or "text".
+  string type = 2;
+
+  // The JSON schema that describes the data that is stored in this shared type.
+  string json_schema = 3;
+}
+
+message SetSynapseDocumentMetadataRequest {
+  // The id of the synapse.
+  string database_id = 1;
+
+  // The id of the document to set the metadata for.
+  string document_id = 2;
+
+  // The metadata to set for the document.
+  repeated SynapseDocumentMetadata metadata = 3;
+
+  // Any additional application-specific JSON to attach to the document.
+  string json = 4;
+}
+
+message SetSynapseDocumentMetadataResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
 }
 
 enum SyncState {
@@ -1237,20 +1164,88 @@ message SyncDocumentResponse {
   bool is_read_only = 5;
 }
 
-message GetDocumentJSONRequest {
+// Parameters to start watching synapse paths. Sent as the first message.
+message WatchSynapsePathStart {
+  // The id of the database that contains the document.
   string database_id = 1;
+
+  // The id of the document to watch.
   string document_id = 2;
+
+  // The JSON paths to watch.
+  repeated string path = 3;
+}
+
+message WatchSynapsePathRequest {
+  oneof payload {
+    // Start watching the given paths; must be sent as the first message.
+    WatchSynapsePathStart start = 1;
+    
+    // Request to stop the watch.
+    bool stop = 2;
+  }
+}
+
+enum SynapsePathUpdateType {
+  SYNAPSE_PATH_UPDATE_TYPE_UNKNOWN = 0;
+  SYNAPSE_PATH_UPDATE_TYPE_ADD = 1;
+  SYNAPSE_PATH_UPDATE_TYPE_UPDATE = 2;
+  SYNAPSE_PATH_UPDATE_TYPE_DELETE = 3;
+}
+
+message WatchSynapsePathUpdate {
+  // The JSON path that was updated.
+  string watch_path = 1;
+
+  // The actual JSON path for this match (e.g. $.content["Atlantic Star"].lat).
+  // Enables clients to identify which array element or map key the update refers to when using wildcard matches such as $.content[*]
+  string event_path = 2;
+
+  // The type of update.
+  SynapsePathUpdateType update_type = 3;
+
+  // The JSON value that was updated.
+  string value = 4;
+
+  // The previous JSON value before the update.
+  string previous_value = 5;
+
+  // The zero-based index of the update.
+  uint32 index = 6;
+
+  // The total number of updates.
+  uint32 total = 7;
 }
 
-message GetDocumentJSONResponse {
+message WatchSynapsePathResponse {
   oneof result {
     // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status error = 1;
+    tdx.volt_api.volt.v1.Status status = 1;
 
-    // The current JSON snapshot of the document
-    string json = 2;
+    // The update to the path.
+    WatchSynapsePathUpdate update = 2;
   }
 }
+
+message WriteSynapsePathRequest {
+  // The id of the database that contains the document.
+  string database_id = 1;
+
+  // The id of the document to write to.
+  string document_id = 2;
+
+  // The JSON path to write to.
+  string path = 3;
+
+  // The JSON value to write.
+  string json = 4;
+}
+
+message WriteSynapsePathResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 `;
 export const terminal_api = `syntax = "proto3";
 
@@ -2008,6 +2003,9 @@ import "tdx/volt_api/volt/v1/volt.proto";
 // A client certificate can be obtained from the \`Authenticate\` method.
 // All methods include a \`tdx.volt_api.volt.v1.Status\` in the response. If the status contains a non-OK error code the client should assume the remainder of the message is invalid, unless otherwise indicated in the response documentation.
 service VoltAPI {
+  // Add a relay connection resource to this volt.
+  rpc AddRelay(SaveResourceRequest) returns (SaveResourceResponse);
+
   // Issues a request to authenticate on the volt.
   // All clients must successfully authenticate in order to gain any kind of access.
   // A client certificate is optional for this RPC, if omitted a JWT must be provided in the call metadata.
@@ -2097,17 +2095,35 @@ service VoltAPI {
   rpc SaveAccess(SaveAccessRequest) returns (SaveAccessResponse);
 
   // Create or update a static file HTTP server.
-  rpc SaveHttpFileServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpFileServer(SaveHttpFileServerRequest) returns (SaveHttpFileServerResponse);
+
+  // Create or update an HTTP forwarder resource.
+  rpc SaveHttpForwarder(SaveHttpForwarderRequest) returns (SaveHttpForwarderResponse);
 
   // Create or update an HTTP REST API server.
-  rpc SaveHttpApiServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpRestApiServer(SaveHttpRestApiServerRequest) returns (SaveHttpRestApiServerResponse);
+
+  // Create or update an HTTP REST API node.
+  rpc SaveHttpRestApiNode(SaveHttpRestApiNodeRequest) returns (SaveHttpRestApiNodeResponse);
 
   // Create or update an identity.
   rpc SaveIdentity(SaveIdentityRequest) returns (SaveIdentityResponse);
 
+  // Create or update a database resource.
+  rpc SaveDatabase(SaveDatabaseRequest) returns (SaveDatabaseResponse);
+
   // Create or update a mirrored link resource.
   rpc SaveMirroredLink(SaveResourceRequest) returns (SaveResourceResponse);
 
+  // Create or update a sync database resource.
+  rpc SaveSyncDatabase(SaveSyncDatabaseRequest) returns (SaveSyncDatabaseResponse);
+
+  // Create or update a synapse resource.
+  rpc SaveSynapse(SaveSynapseRequest) returns (SaveSynapseResponse);
+
+  // Create a synapse connection resource.
+  rpc CreateSynapseConnection(CreateSynapseConnectionRequest) returns (CreateSynapseConnectionResponse);
+
   // Update Volt parameters.
   // This is a privileged call that requires Volt root access.
   rpc SaveParameters(SaveParametersRequest) returns (SaveParametersResponse);
@@ -2166,7 +2182,7 @@ message AuthenticateRequest {
   // A human-readable name of the entity requesting to authenticate.
   string client_name = 6;
 
-  // Optional challenge code, hashed using SHA-256 and base64 encoded.
+  // Optional challenge code, hashed using SHA-256 and base64 URL encoded (no padding).
   string challenge = 7;
 
   // The host name to add as a SAN to the issued certificate.
@@ -3024,6 +3040,143 @@ message SaveResourceResponse {
   Resource resource = 2;
 }
 
+message SaveDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+}
+
+message SaveDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSyncDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSyncDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSynapseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSynapseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpForwarderRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string domain = 5;
+  string host = 6;
+  int32 port = 7;
+  bool forward_host = 8;
+}
+
+message SaveHttpForwarderResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpFileServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string path = 5;
+  string host = 6;
+  int32 port = 7;
+  bool enabled = 8;
+  int32 cache_timeout = 9;
+  bool catch_all_enabled = 10;
+  string catch_all = 11;
+}
+
+message SaveHttpFileServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string host = 5;
+  int32 port = 6;
+  bool enabled = 7;
+  bool cors_enabled = 8;
+}
+
+message SaveHttpRestApiServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiNodeRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool is_literal = 5;
+  string literal_json = 6;
+  string database_id = 7;
+  string sql = 8;
+  repeated string parameter = 9;
+}
+
+message SaveHttpRestApiNodeResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message CreateSynapseConnectionRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string local_synapse_id = 5;
+  string remote_synapse_id = 6;
+  string remote_volt_identity = 7;
+  string remote_volt_address = 8;
+  string remote_volt_http_address = 9;
+  string remote_volt_ca = 10;
+  string remote_identity = 11;
+  string relay_address = 12;
+  string relay_ca = 13;
+  string relay_challenge = 14;
+}
+
+message CreateSynapseConnectionResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
 message SaveSessionRequest {
   Session session = 1;
 }
@@ -3130,17 +3283,47 @@ export const wire_api = `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 Wire API allows clients to subscribe and publish to Volt wire resources.
 service WireAPI {
+
   // Establishes a client-streaming call to the wire resource.
   rpc PublishWire(stream PublishWireRequest) returns (stream PublishWireResponse);
 
+  // Saves a wire resource.
+  rpc SaveWire(SaveWireRequest) returns (SaveWireResponse);
+
   // Establishes a bi-directional streaming call to the wire resource.
   // Although we're only really interested in receiving data from the wire, a bi-directional stream is required so that we can gracefully stop the subscription.
   rpc SubscribeWire(stream SubscribeWireRequest) returns (stream SubscribeWireResponse);
 }
 
+message SaveWireRequest {
+  // The wire resource to save.
+  Resource resource = 1;
+  
+  // Set to create a new wire resource.
+  bool create = 2;
+
+  // The id of the folder resource in which to create the wire resource.
+  string create_in_parent_id = 3;
+
+  // Set to purge the wire resource attributes before saving.
+  bool purge_attributes = 4;
+
+  // Set to persist the wire messages.
+  bool persist = 5;
+
+  // The table to persist the wire messages to.
+  string persist_table = 6;
+}
+
+message SaveWireResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  tdx.volt_api.volt.v1.Resource resource = 2;
+}
+
 // Because the publish RPC is streaming, the policy will not be checked until the first message arrives. This can mean that the \`PublishWire\` call appears to succeed but then fails after the first attempt to publish a message.
 // To avoid this, clients can immediately send a message with the \`wire_id\` set and no \`chunk\` set. This will establish that the correct permissions are in place and fail fast if not.
 message PublishWireRequest {
@@ -3182,4 +3365,4 @@ message SubscribeWireResponse {
 }
 
 `;
-export const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, spark_api, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];
+export const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];