@tdxvolt/volt-client-grpc 0.20.19 → 0.20.21

package/lib/index.cjs

@@ -1018,12 +1018,6 @@ message SaveDriveInstanceRequest {
   // 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;
@@ -1048,6 +1042,7 @@ message SaveDriveInstanceRequest {
 
   // Optional challenge of the relay.
   string relay_challenge = 16;
+
 }
 
 message SaveDriveInstanceResponse {
@@ -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 {
@@ -1759,6 +1757,9 @@ 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 {
@@ -1822,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 {
@@ -2233,6 +2237,15 @@ enum SecureMode {
   SECURE_MODE_TLS = 2;
 }
 
+// Per-method gRPC rate limit (unary: each RPC; client/bidi streams: first client message only).
+message GrpcRpcRateLimit {
+  // Full gRPC method path, e.g. "/tdx.volt_api.volt.v1.VoltAPI/SendEmail"
+  string method_full_name = 1;
+
+  // Maximum requests allowed per rolling 60-second window per identity. Zero disables this rule.
+  uint32 max_requests_per_minute = 2;
+}
+
 // Encapsulates the various Volt parameters that are configurable by the Volt owner.
 message VoltParameters {
   string id = 1;
@@ -2400,6 +2413,17 @@ 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;
+
+  // Optional per-method gRPC rate limits (see GrpcRpcRateLimit). Keyed by peer identity or fingerprint.
+  repeated GrpcRpcRateLimit grpc_rpc_rate_limit = 57;
 }
 
 message VoltEndpoint {
@@ -2790,6 +2814,27 @@ message Session {
 
   SessionStatus status = 10;
 }
+
+message Email {
+  // The email address to send to.
+  repeated string to = 1;
+
+  // The email address to send cc to.
+  repeated string cc = 2;
+
+  // The email address to send bcc to.
+  repeated string bcc = 3;
+
+  // The subject of the email.
+  string subject = 4;
+
+  // The body of the email.
+  string body = 5;
+
+  // The email address to send from.
+  string from = 6;
+}
+
 `;
 const volt_api = `syntax = "proto3";
 
@@ -2938,6 +2983,10 @@ service VoltAPI {
   // Requires \`volt:session-write\` permission. Authenticated sessions have this privilege by default.
   rpc SaveSession(SaveSessionRequest) returns (SaveSessionResponse);
 
+  // Send an email.
+  // This is a privileged API call and requires volt:api-call / volt:send-email permission.
+  rpc SendEmail(SendEmailRequest) returns (SendEmailResponse);
+
   // Set Volt access request decision.
   // This is a privileged API call and requires volt:api-call / volt:set-access-request-decision permission.
   rpc SetAccessRequestDecision(SetAccessRequestDecisionRequest) returns (SetAccessRequestDecisionResponse);
@@ -3958,6 +4007,29 @@ message SaveSessionResponse {
   Session session = 2;
 }
 
+message SendEmailRequest {
+  // The email to send.
+  Email email = 1;
+}
+
+message SendEmailResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
+message SetAccessRequestDecisionRequest {
+  // The id of the access request.
+  string id = 1;
+
+  // The decision to save against the access request.
+  PolicyDecision decision = 2;
+}
+
+message SetAccessRequestDecisionResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 message SetPolicyRequest {
   // The id of the policy to set.
   // Should be either 00000000-0000-0000-0000-000000000000 or 00000000-0000-0000-0000-000000000001 for the first or last custom policy respectively.
@@ -3985,19 +4057,6 @@ message SetServiceStatusResponse {
   Resource resource = 2;
 }
 
-message SetAccessRequestDecisionRequest {
-  // The id of the access request.
-  string id = 1;
-
-  // The decision to save against the access request.
-  PolicyDecision decision = 2;
-}
-
-message SetAccessRequestDecisionResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
 // This message is emtpy.
 message ShutdownRequest {
 }
@@ -6268,22 +6327,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);
-  }
-
-  DeleteSynapseConnection(request) {
-    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
-  }
-
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }
@@ -6352,6 +6395,10 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "SaveSession", request);
   }
 
+  SendEmail(request) {
+    return unaryCallInternal.call(this, "SendEmail", request);
+  }
+
   SetAccessRequestDecision(request) {
     return unaryCallInternal.call(this, "SetAccessRequestDecision", request);
   }
@@ -6595,22 +6642,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) {
@@ -6621,10 +6665,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.19",
+  "version": "0.20.21",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -33,8 +33,8 @@
   "author": "toby.ealden@gmail.com",
   "license": "ISC",
   "dependencies": {
-    "@tdxvolt/volt-client-web": "^0.20.19",
-    "@tdxvolt/volt-utility": "^0.20.18",
+    "@tdxvolt/volt-client-web": "^0.20.21",
+    "@tdxvolt/volt-utility": "^0.20.21",
     "debug": "^4.1.1",
     "ip": "^1.1.5",
     "jsonwebtoken": "^8.5.1",

package/src/volt-client.js

@@ -403,22 +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);
-  }
-
-  DeleteSynapseConnection(request) {
-    return unaryCallInternal.call(this, "DeleteSynapseConnection", request);
-  }
-
   SaveSymbolicLink(request) {
     return unaryCallInternal.call(this, "SaveSymbolicLink", request);
   }
@@ -487,6 +471,10 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "SaveSession", request);
   }
 
+  SendEmail(request) {
+    return unaryCallInternal.call(this, "SendEmail", request);
+  }
+
   SetAccessRequestDecision(request) {
     return unaryCallInternal.call(this, "SetAccessRequestDecision", request);
   }
@@ -732,22 +720,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) {
@@ -758,10 +743,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

@@ -470,12 +470,6 @@ message SaveDriveInstanceRequest {
   // 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;
@@ -500,6 +494,7 @@ message SaveDriveInstanceRequest {
 
   // Optional challenge of the relay.
   string relay_challenge = 16;
+
 }
 
 message SaveDriveInstanceResponse {
@@ -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 {
@@ -1211,6 +1209,9 @@ 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 {
@@ -1274,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 {
@@ -1685,6 +1689,15 @@ enum SecureMode {
   SECURE_MODE_TLS = 2;
 }
 
+// Per-method gRPC rate limit (unary: each RPC; client/bidi streams: first client message only).
+message GrpcRpcRateLimit {
+  // Full gRPC method path, e.g. "/tdx.volt_api.volt.v1.VoltAPI/SendEmail"
+  string method_full_name = 1;
+
+  // Maximum requests allowed per rolling 60-second window per identity. Zero disables this rule.
+  uint32 max_requests_per_minute = 2;
+}
+
 // Encapsulates the various Volt parameters that are configurable by the Volt owner.
 message VoltParameters {
   string id = 1;
@@ -1852,6 +1865,17 @@ 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;
+
+  // Optional per-method gRPC rate limits (see GrpcRpcRateLimit). Keyed by peer identity or fingerprint.
+  repeated GrpcRpcRateLimit grpc_rpc_rate_limit = 57;
 }
 
 message VoltEndpoint {
@@ -2242,6 +2266,27 @@ message Session {
 
   SessionStatus status = 10;
 }
+
+message Email {
+  // The email address to send to.
+  repeated string to = 1;
+
+  // The email address to send cc to.
+  repeated string cc = 2;
+
+  // The email address to send bcc to.
+  repeated string bcc = 3;
+
+  // The subject of the email.
+  string subject = 4;
+
+  // The body of the email.
+  string body = 5;
+
+  // The email address to send from.
+  string from = 6;
+}
+
 `;
 export const volt_api = `syntax = "proto3";
 
@@ -2390,6 +2435,10 @@ service VoltAPI {
   // Requires \`volt:session-write\` permission. Authenticated sessions have this privilege by default.
   rpc SaveSession(SaveSessionRequest) returns (SaveSessionResponse);
 
+  // Send an email.
+  // This is a privileged API call and requires volt:api-call / volt:send-email permission.
+  rpc SendEmail(SendEmailRequest) returns (SendEmailResponse);
+
   // Set Volt access request decision.
   // This is a privileged API call and requires volt:api-call / volt:set-access-request-decision permission.
   rpc SetAccessRequestDecision(SetAccessRequestDecisionRequest) returns (SetAccessRequestDecisionResponse);
@@ -3410,6 +3459,29 @@ message SaveSessionResponse {
   Session session = 2;
 }
 
+message SendEmailRequest {
+  // The email to send.
+  Email email = 1;
+}
+
+message SendEmailResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
+message SetAccessRequestDecisionRequest {
+  // The id of the access request.
+  string id = 1;
+
+  // The decision to save against the access request.
+  PolicyDecision decision = 2;
+}
+
+message SetAccessRequestDecisionResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 message SetPolicyRequest {
   // The id of the policy to set.
   // Should be either 00000000-0000-0000-0000-000000000000 or 00000000-0000-0000-0000-000000000001 for the first or last custom policy respectively.
@@ -3437,19 +3509,6 @@ message SetServiceStatusResponse {
   Resource resource = 2;
 }
 
-message SetAccessRequestDecisionRequest {
-  // The id of the access request.
-  string id = 1;
-
-  // The decision to save against the access request.
-  PolicyDecision decision = 2;
-}
-
-message SetAccessRequestDecisionResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
 // This message is emtpy.
 message ShutdownRequest {
 }