@tdxvolt/volt-client-grpc 0.19.8 → 0.19.10

package/lib/index.cjs

@@ -1709,6 +1709,9 @@ message SyncDocumentStart {
 
   // Set to true to only receive updates from other clients.
   bool read_only = 4;
+
+  // Set to true to downgrade to read-only access if the client does not have write access.
+  bool read_only_fallback = 5;
 }
 
 message SyncDocumentUpdate {
@@ -1742,6 +1745,9 @@ message SyncDocumentResponse {
 
   // The sync state of the Volt (remote) document
   SyncState sync_state = 4;
+
+  // Set to true if the client is in read-only mode. Only present in the initial response.
+  bool is_read_only = 5;
 }
 
 message GetDocumentJSONRequest {
@@ -1765,38 +1771,56 @@ package tdx.volt_api.volt.v1;
 import "tdx/volt_api/volt/v1/status.proto";
 
 service TerminalAPI {
+  // Bidirectional streaming RPC for real-time terminal control and data exchange.
   rpc CommandStream(stream CommandStreamRequest) returns (stream CommandStreamResponse);
 }
 
 message TerminalSize {
+  // The number of rows in the terminal.
   int32 rows = 1;
+  // The number of columns in the terminal.
   int32 cols = 2;
 }
 
 message Control {
+  // Optional command to execute on the terminal. If omitted, the default command is \`bash\` on linux and \`zsh\` on macos.
   string command = 1;
+  // Optional arguments to pass to the command.
   repeated string arg = 2;
+  // Not currently used.
   string stop = 3;
+  // Not currently used.
   string pause = 4;
+  // Not currently used.
   string resume = 5;
+  // Not currently used.
   string reset = 6;
+  // Optional terminal size to set.
   TerminalSize terminal_size = 7;
+  // If non-zero, a \`kill\` signal will be sent with this value to the running process.
   int32 interrupt = 8;
 }
 
 message Input {
+  // The data to send to the terminal.
   bytes data = 1;
 }
 
+// The request message must contain either a control message or an input message.
 message CommandStreamRequest {
   oneof payload {
+    // Control messages can be used to configure and control the terminal.
     Control control = 1;
+    // Input messages are used to send data to the terminal.
     Input input = 2;
   }
 }
 
+// The response message contains either a status message or stream of bytes.
 message CommandStreamResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
+  // Bytes received from the terminal.
   bytes data = 2;
 }
 
@@ -2745,6 +2769,9 @@ message ConnectHello {
   // Set to receive notification of resource events.
   bool subscribe_resource_events = 4;
 
+  // Optionally specify which resource events to subscribe to. Only valid if \`subscribe_resource_events\` is set. If omitted or empty, all resource events will be subscribed to.
+  repeated ConnectResourceEvent resource_event_list = 17;
+
   // Set this if you are connecting to a relay, i.e. the Volt you are sending to this message is a relay.
   // This indicates that you are happy to receive method invocations from clients of the Relay.
   // This will usually be set to the \`id\` of your Volt, but in theory any client could receive remote invocation requests in this way.
@@ -2937,6 +2964,9 @@ message CopyResourceResponse {
 message DeleteAccessRequest {
   // The id of the access rule to delete.
   string id = 1;
+
+  // Set to indicate all access rules for the resource should be deleted. The \`id\` field is ignored if this is set.
+  string resource_id = 2;
 }
 
 message DeleteAccessResponse {
@@ -3373,6 +3403,9 @@ message ResourceAttributeQuery {
 message SaveAccessRequest {
   // Omit \`id\` if creating new access.
   Access access = 1;
+
+  // Add multiple access rules in one request. The \`access\` field is ignored if this is non-empty.
+  repeated Access access_list = 2;
 }
 
 message SaveAccessResponse {
@@ -4606,7 +4639,7 @@ function _doConnect(connectHello) {
   this.call.on("data", (response) => {
     switch (response.payload) {
       case "ping": {
-        log$3("pinged");
+        log$3("received ping [%s]", this._voltClient.config.client_name);
 
         // Received ping response from server => clear timeout.
         if (this._pingTimeoutTimer) {
@@ -4678,7 +4711,7 @@ function _startPingTimer() {
     // Send next ping to server.
     const request = { ping: { timestamp: Date.now() } };
 
-    log$3("pinging Volt");
+    log$3("sending ping [%s]", this._voltClient.config.client_name);
     this.call.write(request);
 
     this._pingTimer = 0;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.19.8",
+  "version": "0.19.10",
   "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.19.8",
+    "@tdxvolt/volt-client-web": "^0.19.9",
     "debug": "^4.1.1",
     "ip": "^1.1.5",
     "jsonwebtoken": "^8.5.1",

package/src/volt-connection.js

@@ -69,7 +69,7 @@ function _doConnect(connectHello) {
   this.call.on("data", (response) => {
     switch (response.payload) {
       case "ping": {
-        log("pinged");
+        log("received ping [%s]", this._voltClient.config.client_name);
 
         // Received ping response from server => clear timeout.
         if (this._pingTimeoutTimer) {
@@ -141,7 +141,7 @@ function _startPingTimer() {
     // Send next ping to server.
     const request = { ping: { timestamp: Date.now() } };
 
-    log("pinging Volt");
+    log("sending ping [%s]", this._voltClient.config.client_name);
     this.call.write(request);
 
     this._pingTimer = 0;

package/src/volt-proto-literals.js

@@ -1164,6 +1164,9 @@ message SyncDocumentStart {
 
   // Set to true to only receive updates from other clients.
   bool read_only = 4;
+
+  // Set to true to downgrade to read-only access if the client does not have write access.
+  bool read_only_fallback = 5;
 }
 
 message SyncDocumentUpdate {
@@ -1197,6 +1200,9 @@ message SyncDocumentResponse {
 
   // The sync state of the Volt (remote) document
   SyncState sync_state = 4;
+
+  // Set to true if the client is in read-only mode. Only present in the initial response.
+  bool is_read_only = 5;
 }
 
 message GetDocumentJSONRequest {
@@ -1220,38 +1226,56 @@ package tdx.volt_api.volt.v1;
 import "tdx/volt_api/volt/v1/status.proto";
 
 service TerminalAPI {
+  // Bidirectional streaming RPC for real-time terminal control and data exchange.
   rpc CommandStream(stream CommandStreamRequest) returns (stream CommandStreamResponse);
 }
 
 message TerminalSize {
+  // The number of rows in the terminal.
   int32 rows = 1;
+  // The number of columns in the terminal.
   int32 cols = 2;
 }
 
 message Control {
+  // Optional command to execute on the terminal. If omitted, the default command is \`bash\` on linux and \`zsh\` on macos.
   string command = 1;
+  // Optional arguments to pass to the command.
   repeated string arg = 2;
+  // Not currently used.
   string stop = 3;
+  // Not currently used.
   string pause = 4;
+  // Not currently used.
   string resume = 5;
+  // Not currently used.
   string reset = 6;
+  // Optional terminal size to set.
   TerminalSize terminal_size = 7;
+  // If non-zero, a \`kill\` signal will be sent with this value to the running process.
   int32 interrupt = 8;
 }
 
 message Input {
+  // The data to send to the terminal.
   bytes data = 1;
 }
 
+// The request message must contain either a control message or an input message.
 message CommandStreamRequest {
   oneof payload {
+    // Control messages can be used to configure and control the terminal.
     Control control = 1;
+    // Input messages are used to send data to the terminal.
     Input input = 2;
   }
 }
 
+// The response message contains either a status message or stream of bytes.
 message CommandStreamResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
+  // Bytes received from the terminal.
   bytes data = 2;
 }
 
@@ -2200,6 +2224,9 @@ message ConnectHello {
   // Set to receive notification of resource events.
   bool subscribe_resource_events = 4;
 
+  // Optionally specify which resource events to subscribe to. Only valid if \`subscribe_resource_events\` is set. If omitted or empty, all resource events will be subscribed to.
+  repeated ConnectResourceEvent resource_event_list = 17;
+
   // Set this if you are connecting to a relay, i.e. the Volt you are sending to this message is a relay.
   // This indicates that you are happy to receive method invocations from clients of the Relay.
   // This will usually be set to the \`id\` of your Volt, but in theory any client could receive remote invocation requests in this way.
@@ -2392,6 +2419,9 @@ message CopyResourceResponse {
 message DeleteAccessRequest {
   // The id of the access rule to delete.
   string id = 1;
+
+  // Set to indicate all access rules for the resource should be deleted. The \`id\` field is ignored if this is set.
+  string resource_id = 2;
 }
 
 message DeleteAccessResponse {
@@ -2828,6 +2858,9 @@ message ResourceAttributeQuery {
 message SaveAccessRequest {
   // Omit \`id\` if creating new access.
   Access access = 1;
+
+  // Add multiple access rules in one request. The \`access\` field is ignored if this is non-empty.
+  repeated Access access_list = 2;
 }
 
 message SaveAccessResponse {