@tdxvolt/volt-client-grpc 0.20.18 → 0.20.19

package/lib/index.cjs

@@ -991,11 +991,11 @@ import "tdx/volt_api/volt/v1/volt.proto";
 // The Drive API allows clients to create and manage Volt Drive resources.
 service DriveAPI {
   // Create or update a drive connection resource.
-  // This is a privileged API call and requires volt:api-call / volt:save-drive permission.
-  rpc SaveDrive(SaveDriveRequest) returns (SaveDriveResponse);
+  // This is a privileged API call and requires volt:api-call / volt:save-drive-instance permission.
+  rpc SaveDriveInstance(SaveDriveInstanceRequest) returns (SaveDriveInstanceResponse);
 }
 
-message SaveDriveRequest {
+message SaveDriveInstanceRequest {
   // Details of the drive to save.
   Resource resource = 1;
 
@@ -1013,7 +1013,7 @@ message SaveDriveRequest {
   bool purge_attributes = 4;
 
   // The id of the synapse resource that stores the drive data.
-  string source_synapse_id = 5;
+  string synapse_id = 5;
 
   // The local path of the folder to sync.
   string target_folder = 6;
@@ -1029,7 +1029,7 @@ message SaveDriveRequest {
   string identity_did = 9;
 
   // The DID of the remote Volt.
-  string remote_volt_identity = 10;
+  string remote_volt_did = 10;
 
   // Optional address of the remote Volt. Either this or the relay address must be provided.
   string remote_volt_address = 11;
@@ -1050,7 +1050,7 @@ message SaveDriveRequest {
   string relay_challenge = 16;
 }
 
-message SaveDriveResponse {
+message SaveDriveInstanceResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
@@ -1662,14 +1662,13 @@ const status = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 message Status {
-  // A simple error code that can be easily handled by the client.
-  // Mirrors the grpc StatusCode enum, 0 => OK
+  // Mirrors the grpc StatusCode enum, 0 => OK, see https://grpc.github.io/grpc/core/md_doc_statuscodes.html
   int32 code = 1;
 
-  // A developer-facing human-readable error message in English. It should both explain the error and offer an actionable resolution to it.
+  // A developer-facing human-readable error message, e.g. 'invalidArguments'.
   string message = 2;
 
-  // Long form error description.
+  // A description of the error, e.g. 'The \`database_id\` is missing'.
   string description = 3;
 }
 `;
@@ -1687,6 +1686,9 @@ service SyncAPI {
   // 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(CreateSynapseConnectionRequest) returns (CreateSynapseConnectionResponse);
+
+  // Delete a synapse connection. This will terminate any ongoing syncronisation between the two synapses and delete the connection resource.
+  rpc DeleteSynapseConnection(DeleteSynapseConnectionRequest) returns (DeleteSynapseConnectionResponse);
   
   // Delete a document from the synapse.
   rpc DeleteSynapseDocumentMetadata(DeleteSynapseDocumentMetadataRequest) returns (DeleteSynapseDocumentMetadataResponse);
@@ -1760,10 +1762,23 @@ message CreateSynapseConnectionRequest {
 }
 
 message CreateSynapseConnectionResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
+
+  // The created synapse connection resource.
   Resource resource = 2;
 }
 
+message DeleteSynapseConnectionRequest {
+  // The id of the synapse connection to delete.
+  string synapse_connection_id = 1;
+}
+
+message DeleteSynapseConnectionResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 message DeleteSynapseDocumentMetadataRequest {
   // DEPRECATED: Use synapse_id instead.
   string database_id = 1;
@@ -6265,6 +6280,10 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "CreateSynapseConnection", request);
   }
 
+  DeleteSynapseConnection(request) {
+    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
+  }
+
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.20.18",
+  "version": "0.20.19",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -33,7 +33,7 @@
   "author": "toby.ealden@gmail.com",
   "license": "ISC",
   "dependencies": {
-    "@tdxvolt/volt-client-web": "^0.20.18",
+    "@tdxvolt/volt-client-web": "^0.20.19",
     "@tdxvolt/volt-utility": "^0.20.18",
     "debug": "^4.1.1",
     "ip": "^1.1.5",

package/src/volt-client.js

@@ -415,6 +415,10 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "CreateSynapseConnection", request);
   }
 
+  DeleteSynapseConnection(request) {
+    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
+  }
+
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }

package/src/volt-proto-literals.js

@@ -443,11 +443,11 @@ import "tdx/volt_api/volt/v1/volt.proto";
 // The Drive API allows clients to create and manage Volt Drive resources.
 service DriveAPI {
   // Create or update a drive connection resource.
-  // This is a privileged API call and requires volt:api-call / volt:save-drive permission.
-  rpc SaveDrive(SaveDriveRequest) returns (SaveDriveResponse);
+  // This is a privileged API call and requires volt:api-call / volt:save-drive-instance permission.
+  rpc SaveDriveInstance(SaveDriveInstanceRequest) returns (SaveDriveInstanceResponse);
 }
 
-message SaveDriveRequest {
+message SaveDriveInstanceRequest {
   // Details of the drive to save.
   Resource resource = 1;
 
@@ -465,7 +465,7 @@ message SaveDriveRequest {
   bool purge_attributes = 4;
 
   // The id of the synapse resource that stores the drive data.
-  string source_synapse_id = 5;
+  string synapse_id = 5;
 
   // The local path of the folder to sync.
   string target_folder = 6;
@@ -481,7 +481,7 @@ message SaveDriveRequest {
   string identity_did = 9;
 
   // The DID of the remote Volt.
-  string remote_volt_identity = 10;
+  string remote_volt_did = 10;
 
   // Optional address of the remote Volt. Either this or the relay address must be provided.
   string remote_volt_address = 11;
@@ -502,7 +502,7 @@ message SaveDriveRequest {
   string relay_challenge = 16;
 }
 
-message SaveDriveResponse {
+message SaveDriveInstanceResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
@@ -1114,14 +1114,13 @@ export const status = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 message Status {
-  // A simple error code that can be easily handled by the client.
-  // Mirrors the grpc StatusCode enum, 0 => OK
+  // Mirrors the grpc StatusCode enum, 0 => OK, see https://grpc.github.io/grpc/core/md_doc_statuscodes.html
   int32 code = 1;
 
-  // A developer-facing human-readable error message in English. It should both explain the error and offer an actionable resolution to it.
+  // A developer-facing human-readable error message, e.g. 'invalidArguments'.
   string message = 2;
 
-  // Long form error description.
+  // A description of the error, e.g. 'The \`database_id\` is missing'.
   string description = 3;
 }
 `;
@@ -1139,6 +1138,9 @@ service SyncAPI {
   // 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(CreateSynapseConnectionRequest) returns (CreateSynapseConnectionResponse);
+
+  // Delete a synapse connection. This will terminate any ongoing syncronisation between the two synapses and delete the connection resource.
+  rpc DeleteSynapseConnection(DeleteSynapseConnectionRequest) returns (DeleteSynapseConnectionResponse);
   
   // Delete a document from the synapse.
   rpc DeleteSynapseDocumentMetadata(DeleteSynapseDocumentMetadataRequest) returns (DeleteSynapseDocumentMetadataResponse);
@@ -1212,10 +1214,23 @@ message CreateSynapseConnectionRequest {
 }
 
 message CreateSynapseConnectionResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
+
+  // The created synapse connection resource.
   Resource resource = 2;
 }
 
+message DeleteSynapseConnectionRequest {
+  // The id of the synapse connection to delete.
+  string synapse_connection_id = 1;
+}
+
+message DeleteSynapseConnectionResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 message DeleteSynapseDocumentMetadataRequest {
   // DEPRECATED: Use synapse_id instead.
   string database_id = 1;