@tdxvolt/volt-client-grpc 0.20.18 → 0.20.20

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,23 +1013,17 @@ 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;
 
-  // The comma-separated include patterns.
-  string include = 7;
-
-  // The comma-separated exclude patterns.
-  string exclude = 8;
-
   // The DID of the identity that should be used to authenticate with the remote Volt. If omitted, the authenticated identity will be used.
   // The identity must have a private key stored in the Volt key store.
   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;
@@ -1048,9 +1042,10 @@ message SaveDriveRequest {
 
   // Optional challenge of the relay.
   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;
 
@@ -1469,6 +1464,9 @@ message CreateEmailCredentialRequest {
 
   // The passphrase for the identity key, if required (i.e. the key is encrypted).
   string key_passphrase = 4;
+
+  // Optional description rendered in the verification email body.
+  string description = 5;
 }
 
 message CreateEmailCredentialResponse {
@@ -1662,14 +1660,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 +1684,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);
@@ -1757,13 +1757,29 @@ message CreateSynapseConnectionRequest {
 
   // Optional challenge of the relay.
   string relay_challenge = 14;
+
+  // Optional http address of the relay. If given, the relay_address and relay_ca will be ignored and the relay will be discovered at the given address.
+  string relay_http_address = 15;
 }
 
 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;
@@ -1807,6 +1823,9 @@ message SaveSyncDatabaseRequest {
 
   // By default, yjs updates are periodically compressed and stored as snapshots. Set this flag to disable snapshots. This will reduce the size of the database and improve performance, but will also reduce the ability to rollback to a previous state.
   bool no_snapshots = 8;
+
+  // The number of updates to batch before flushing to the database. Defaults to 100.
+  uint32 batch_size = 9;
 }
 
 message SaveSyncDatabaseResponse {
@@ -2385,6 +2404,14 @@ message VoltParameters {
 
   // If set, exposes a resource that gives the Volt owner read-only access the file system.
   bool enable_owner_file_system_access = 54;
+
+  // Maximum number of pending gRPC events per event thread queue.
+  // If unset or zero, the server default queue size is used.
+  uint32 grpc_event_queue_size = 55;
+
+  // Number of gRPC event processing threads.
+  // If unset or zero, the server default thread count is used.
+  uint32 grpc_num_event_threads = 56;
 }
 
 message VoltEndpoint {
@@ -6253,18 +6280,6 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "SaveMirroredLink", request);
   }
 
-  SaveSyncDatabase(request) {
-    return unaryCallInternal.call(this, "SaveSyncDatabase", request);
-  }
-
-  SaveSynapse(request) {
-    return unaryCallInternal.call(this, "SaveSynapse", request);
-  }
-
-  CreateSynapseConnection(request) {
-    return unaryCallInternal.call(this, "CreateSynapseConnection", request);
-  }
-
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }
@@ -6576,22 +6591,19 @@ class VoltClient extends EventEmitter__default["default"] {
   /**
    * DriveAPI
    */
-  SaveDrive(request) {
-    return unaryCallInternal.call(this, "SaveDrive", request);
+  SaveDriveInstance(request) {
+    return unaryCallInternal.call(this, "SaveDriveInstance", request);
   }
 
   /**
    * SyncAPI
    */
-  SyncDocument(request) {
-    const grpcClient = this.getVoltAPIClient();
+  CreateSynapseConnection(request) {
+    return unaryCallInternal.call(this, "CreateSynapseConnection", request);
+  }
 
-    const syncDocumentCall = new GRPCCall(
-      this,
-      "SyncDocument",
-      "METHOD_TYPE_BIDI"
-    );
-    return syncDocumentCall.start(grpcClient, request);
+  DeleteSynapseConnection(request) {
+    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
   }
 
   DeleteSynapseDocumentMetadata(request) {
@@ -6602,10 +6614,29 @@ class VoltClient extends EventEmitter__default["default"] {
     );
   }
 
+  SaveSynapse(request) {
+    return unaryCallInternal.call(this, "SaveSynapse", request);
+  }
+
+  SaveSyncDatabase(request) {
+    return unaryCallInternal.call(this, "SaveSyncDatabase", request);
+  }
+
   SetSynapseDocumentMetadata(request) {
     return unaryCallInternal.call(this, "SetSynapseDocumentMetadata", request);
   }
 
+  SyncDocument(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const syncDocumentCall = new GRPCCall(
+      this,
+      "SyncDocument",
+      "METHOD_TYPE_BIDI"
+    );
+    return syncDocumentCall.start(grpcClient, request);
+  }
+
   WatchSynapsePath(request) {
     const grpcClient = this.getVoltAPIClient();
 

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.20.18",
+  "version": "0.20.20",
   "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.20",
     "@tdxvolt/volt-utility": "^0.20.18",
     "debug": "^4.1.1",
     "ip": "^1.1.5",

package/src/volt-client.js

@@ -403,18 +403,6 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "SaveMirroredLink", request);
   }
 
-  SaveSyncDatabase(request) {
-    return unaryCallInternal.call(this, "SaveSyncDatabase", request);
-  }
-
-  SaveSynapse(request) {
-    return unaryCallInternal.call(this, "SaveSynapse", request);
-  }
-
-  CreateSynapseConnection(request) {
-    return unaryCallInternal.call(this, "CreateSynapseConnection", request);
-  }
-
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }
@@ -728,22 +716,19 @@ export class VoltClient extends EventEmitter {
   /**
    * DriveAPI
    */
-  SaveDrive(request) {
-    return unaryCallInternal.call(this, "SaveDrive", request);
+  SaveDriveInstance(request) {
+    return unaryCallInternal.call(this, "SaveDriveInstance", request);
   }
 
   /**
    * SyncAPI
    */
-  SyncDocument(request) {
-    const grpcClient = this.getVoltAPIClient();
+  CreateSynapseConnection(request) {
+    return unaryCallInternal.call(this, "CreateSynapseConnection", request);
+  }
 
-    const syncDocumentCall = new GRPCCall(
-      this,
-      "SyncDocument",
-      "METHOD_TYPE_BIDI"
-    );
-    return syncDocumentCall.start(grpcClient, request);
+  DeleteSynapseConnection(request) {
+    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
   }
 
   DeleteSynapseDocumentMetadata(request) {
@@ -754,10 +739,29 @@ export class VoltClient extends EventEmitter {
     );
   }
 
+  SaveSynapse(request) {
+    return unaryCallInternal.call(this, "SaveSynapse", request);
+  }
+
+  SaveSyncDatabase(request) {
+    return unaryCallInternal.call(this, "SaveSyncDatabase", request);
+  }
+
   SetSynapseDocumentMetadata(request) {
     return unaryCallInternal.call(this, "SetSynapseDocumentMetadata", request);
   }
 
+  SyncDocument(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const syncDocumentCall = new GRPCCall(
+      this,
+      "SyncDocument",
+      "METHOD_TYPE_BIDI"
+    );
+    return syncDocumentCall.start(grpcClient, request);
+  }
+
   WatchSynapsePath(request) {
     const grpcClient = this.getVoltAPIClient();
 

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,23 +465,17 @@ 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;
 
-  // The comma-separated include patterns.
-  string include = 7;
-
-  // The comma-separated exclude patterns.
-  string exclude = 8;
-
   // The DID of the identity that should be used to authenticate with the remote Volt. If omitted, the authenticated identity will be used.
   // The identity must have a private key stored in the Volt key store.
   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;
@@ -500,9 +494,10 @@ message SaveDriveRequest {
 
   // Optional challenge of the relay.
   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;
 
@@ -921,6 +916,9 @@ message CreateEmailCredentialRequest {
 
   // The passphrase for the identity key, if required (i.e. the key is encrypted).
   string key_passphrase = 4;
+
+  // Optional description rendered in the verification email body.
+  string description = 5;
 }
 
 message CreateEmailCredentialResponse {
@@ -1114,14 +1112,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 +1136,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);
@@ -1209,13 +1209,29 @@ message CreateSynapseConnectionRequest {
 
   // Optional challenge of the relay.
   string relay_challenge = 14;
+
+  // Optional http address of the relay. If given, the relay_address and relay_ca will be ignored and the relay will be discovered at the given address.
+  string relay_http_address = 15;
 }
 
 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;
@@ -1259,6 +1275,9 @@ message SaveSyncDatabaseRequest {
 
   // By default, yjs updates are periodically compressed and stored as snapshots. Set this flag to disable snapshots. This will reduce the size of the database and improve performance, but will also reduce the ability to rollback to a previous state.
   bool no_snapshots = 8;
+
+  // The number of updates to batch before flushing to the database. Defaults to 100.
+  uint32 batch_size = 9;
 }
 
 message SaveSyncDatabaseResponse {
@@ -1837,6 +1856,14 @@ message VoltParameters {
 
   // If set, exposes a resource that gives the Volt owner read-only access the file system.
   bool enable_owner_file_system_access = 54;
+
+  // Maximum number of pending gRPC events per event thread queue.
+  // If unset or zero, the server default queue size is used.
+  uint32 grpc_event_queue_size = 55;
+
+  // Number of gRPC event processing threads.
+  // If unset or zero, the server default thread count is used.
+  uint32 grpc_num_event_threads = 56;
 }
 
 message VoltEndpoint {