@tdxvolt/volt-client-grpc 0.18.7 → 0.18.9

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.18.7",
+  "version": "0.18.9",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {

package/src/constants.js

@@ -15,6 +15,7 @@ export const constants = {
     sqliteDatabaseAPI: "tdx.volt_api.data.v1.SqliteDatabaseAPI",
     ssiAPI: "tdx.volt_api.volt.v1.SsiAPI",
     relayAPI: "tdx.volt_api.relay.v1.RelayAPI",
+    syncAPI: "tdx.volt_api.volt.v1.SyncAPI",
     terminalAPI: "tdx.volt_api.volt.v1.TerminalAPI",
     voltAPI: "tdx.volt_api.volt.v1.VoltAPI",
     wireAPI: "tdx.volt_api.volt.v1.WireAPI"

package/src/grpc-call.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-underscore-dangle */
+import { voltUtils as voltClientUtils } from "@tdxvolt/volt-client-web/js";
 import debug from "debug";
 import EventEmitter from "events";
-import { voltUtils as voltClientUtils } from "@tdxvolt/volt-client-web/js";
 
 const {
   aesCreateKey,
@@ -328,6 +328,7 @@ export default class GRPCCall extends EventEmitter {
     this._keyExchangePending = false;
     this._pendingRequests = [];
     this._encryptionKey = null;
+    this._ended = false;
   }
 
   start(grpcClient, request, unary = false) {
@@ -360,6 +361,11 @@ export default class GRPCCall extends EventEmitter {
     );
 
     this._call.on("data", (streamResponse) => {
+      if (this._ended) {
+        log("ignoring data after end on %s", this._methodName);
+        return;
+      }
+
       try {
         const parsedResponse = _parseResponse.call(
           this,
@@ -454,6 +460,7 @@ export default class GRPCCall extends EventEmitter {
 
   end() {
     if (this._call) {
+      this._ended = true;
       return this._call.end();
     } else {
       throw new Error("call not initialised");

package/src/proto-utils.js

@@ -1,8 +1,8 @@
 import debug from "debug";
 import protobuf from "protobufjs";
+import { constants } from "./constants.js";
 import { createPackageDefinition } from "./proto-package-definition.js";
 import { voltProtos } from "./volt-proto-literals.js";
-import { constants } from "./constants.js";
 
 const log = debug("volt-client-grpc:proto-utils");
 
@@ -12,6 +12,7 @@ const voltServices = [
   constants.serviceType.sqliteDatabaseAPI,
   constants.serviceType.sqliteServerAPI,
   constants.serviceType.ssiAPI,
+  constants.serviceType.syncAPI,
   constants.serviceType.relayAPI,
   constants.serviceType.terminalAPI,
   constants.serviceType.wireAPI
@@ -56,4 +57,5 @@ function getBuiltInServiceDescriptors() {
   return getServiceDescriptors(voltServicePlaceholder);
 }
 
-export { getServiceDescriptors, getBuiltInServiceDescriptors };
+export { getBuiltInServiceDescriptors, getServiceDescriptors };
+

package/src/volt-client.js

@@ -1,20 +1,18 @@
 import debug from "debug";
 import EventEmitter from "events";
-import { VoltCredential } from "./volt-credential.js";
+import fs from "fs";
 import path from "path";
-import { getServiceDescriptors } from "./proto-utils.js";
-import { createClient as createGrpcClient } from "./grpc-utils.js";
+import GRPCCall from "./grpc-call.js";
 import {
   authenticateInternal,
   connectInternal,
   fetchVoltConfig,
   fetchVoltConfigFromDID,
   getVoltAPIClientInternal,
-  unaryCallInternal,
-  streamingCallInternal
+  streamingCallInternal,
+  unaryCallInternal
 } from "./volt-client-internal.js";
-import fs from "fs";
-import GRPCCall from "./grpc-call.js";
+import { VoltCredential } from "./volt-credential.js";
 
 const { readFile } = fs.promises;
 const log = debug("volt-client-grpc:volt-client");
@@ -99,9 +97,7 @@ export class VoltClient extends EventEmitter {
         log("Attempt to load config from file %s", configPath);
         try {
           if (fs.existsSync(configPath)) {
-            const configContents = await readFile(
-              new URL(configPath, import.meta.url)
-            );
+            const configContents = await readFile(configPath);
             configJSON = JSON.parse(configContents);
           } else {
             // There is currently no file at the given configuration path.
@@ -668,4 +664,15 @@ export class VoltClient extends EventEmitter {
     );
     return subscribeCall.start(grpcClient, request);
   }
+
+  SyncDocument(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const syncDocumentCall = new GRPCCall(
+      this,
+      "SyncDocument",
+      "METHOD_TYPE_BIDI"
+    );
+    return syncDocumentCall.start(grpcClient, request);
+  }
 }

package/src/volt-proto-literals.js

@@ -252,6 +252,63 @@ message CreateDatabaseResponse {
 }
 
 `;
+export const proto_db_sync = `syntax = "proto3";
+
+package tdx.volt_api.proto_db_sync.v1;
+
+// Wraps arbitrary protobuf messages, with an index into the \`ProtobufSyncConfigurationHeader\` to indicate the specific message type this message wraps.
+message ProtobufSyncWrapper {
+  oneof header_lookup {
+    // The index number of the header for this message type in the Volt logger configuration file.
+    uint32 header_index = 1;
+
+    // The name of the header for this message type, will be used to lookup against the \`id\` field in \`ProtobufSyncConfiguration\`.
+    // This will incur an overhead in terms of the packet size, but might be preferrable if volume is low or managing the header index is difficult.
+    string header_id = 2;
+  }
+
+  // The message payload, in serialised protobuf binary format.
+  // n.b. the serialisation should **not** be length-prefixed.
+  bytes payload = 3;
+}
+
+// Describes a single message type.
+// A set of one or more of these messages is specified in \`ProtobufSyncConfigurationHeader\`.
+message ProtobufSyncConfiguration {
+  // Optional id to associate with this configuration.
+  // This can be used in the \`header_id\` field of \`ProtobufSyncWrapper\` above to reference the configuration.
+  // If omitted the numerical index of the configuration in \`ProtobufSyncConfigurationHeader\` will be used instead.
+  string id = 1;
+
+  // The actual protobuf definition text.
+  // Copy and paste the source protobuf definition from the \`.proto\` file.
+  // Only simple protobuf structures are currently supported, e.g. no imports from other packages etc.
+  string message_proto = 2;
+
+  // The name of the message within \`message_proto\` above that represents the data to be sync'd, e.g. \`TCPDumpPacket\`.
+  string message_name = 3;
+
+  // The name of the table within the target database into which the message data for this type should be written.
+  string table_name = 4;
+}
+
+// This message is written at the beginning of every file to be ingested using the \`protoDbSync\` utility.
+// It contains a \`header\` entry for each message type that may appear in the file.
+// If the \`volt logger\` command is used, it will create this header automatically based on the configuration it's given.
+message ProtobufSyncConfigurationHeader {
+  // This should ideally be a persistent UUID, at minimum it must be unique within the set of types of file any given instance of \`protoDbSync\` is processing in a given folder.
+  // It is used to match up orphaned or split packets that might occur when receiving data from a wire, for example, if a log file is rotated midway through a packet arriving on the wire.
+  // This id should persist for the life time of the set of data it describes, i.e. if a wire publication is stopped and restarted at some later point, the same id should be used if possible.
+  string id = 1;
+
+  // The set of possible configurations that can appear in any given protobuf sync data file.
+  // A serialised instance of this message must appear at the top of each data file.
+  // Each subsequent serialised message in the data file must be an instance of \`ProtobufSyncWrapper\`, and the \`header_lookup\` field refers to an entry in this list.
+  repeated ProtobufSyncConfiguration configuration = 2;
+
+  // Optional maximum size of the serialised messages, this doesn't need to be exact and the default is 64K if omitted.
+  int32 maximum_message_size = 3;
+}`;
 export const proxy_api = `syntax = "proto3";
 
 package tdx.volt_api.relay.v1;
@@ -340,63 +397,6 @@ message TunnelResponse {
   }
 }
 `;
-export const sync = `syntax = "proto3";
-
-package tdx.volt_api.sync.v1;
-
-// Wraps arbitrary protobuf messages, with an index into the \`ProtobufSyncConfigurationHeader\` to indicate the specific message type this message wraps.
-message ProtobufSyncWrapper {
-  oneof header_lookup {
-    // The index number of the header for this message type in the Volt logger configuration file.
-    uint32 header_index = 1;
-
-    // The name of the header for this message type, will be used to lookup against the \`id\` field in \`ProtobufSyncConfiguration\`.
-    // This will incur an overhead in terms of the packet size, but might be preferrable if volume is low or managing the header index is difficult.
-    string header_id = 2;
-  }
-
-  // The message payload, in serialised protobuf binary format.
-  // n.b. the serialisation should **not** be length-prefixed.
-  bytes payload = 3;
-}
-
-// Describes a single message type.
-// A set of one or more of these messages is specified in \`ProtobufSyncConfigurationHeader\`.
-message ProtobufSyncConfiguration {
-  // Optional id to associate with this configuration.
-  // This can be used in the \`header_id\` field of \`ProtobufSyncWrapper\` above to reference the configuration.
-  // If omitted the numerical index of the configuration in \`ProtobufSyncConfigurationHeader\` will be used instead.
-  string id = 1;
-
-  // The actual protobuf definition text.
-  // Copy and paste the source protobuf definition from the \`.proto\` file.
-  // Only simple protobuf structures are currently supported, e.g. no imports from other packages etc.
-  string message_proto = 2;
-
-  // The name of the message within \`message_proto\` above that represents the data to be sync'd, e.g. \`TCPDumpPacket\`.
-  string message_name = 3;
-
-  // The name of the table within the target database into which the message data for this type should be written.
-  string table_name = 4;
-}
-
-// This message is written at the beginning of every file to be ingested using the \`protoDbSync\` utility.
-// It contains a \`header\` entry for each message type that may appear in the file.
-// If the \`volt logger\` command is used, it will create this header automatically based on the configuration it's given.
-message ProtobufSyncConfigurationHeader {
-  // This should ideally be a persistent UUID, at minimum it must be unique within the set of types of file any given instance of \`protoDbSync\` is processing in a given folder.
-  // It is used to match up orphaned or split packets that might occur when receiving data from a wire, for example, if a log file is rotated midway through a packet arriving on the wire.
-  // This id should persist for the life time of the set of data it describes, i.e. if a wire publication is stopped and restarted at some later point, the same id should be used if possible.
-  string id = 1;
-
-  // The set of possible configurations that can appear in any given protobuf sync data file.
-  // A serialised instance of this message must appear at the top of each data file.
-  // Each subsequent serialised message in the data file must be an instance of \`ProtobufSyncWrapper\`, and the \`header_lookup\` field refers to an entry in this list.
-  repeated ProtobufSyncConfiguration configuration = 2;
-
-  // Optional maximum size of the serialised messages, this doesn't need to be exact and the default is 64K if omitted.
-  int32 maximum_message_size = 3;
-}`;
 export const discovery_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
@@ -1130,6 +1130,89 @@ message Status {
   string description = 3;
 }
 `;
+export const sync_api = `syntax = "proto3";
+
+package tdx.volt_api.volt.v1;
+
+import "tdx/volt_api/volt/v1/status.proto";
+
+// The Sync API allows clients to collaboratively read and write JSON data to a shared resource.
+service SyncAPI {
+  // 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);
+}
+
+enum SyncState {
+  SYNC_STATE_UNKNOWN = 0;
+  SYNC_STATE_SYNCING = 1;
+  SYNC_STATE_DONE = 2;
+  SYNC_STATE_UPDATE = 3;
+}
+
+message SyncDocumentStart {
+  // The id of the database that contains the document.
+  string database_id = 1;
+
+  // The id of the document to sync.
+  string document_id = 2;
+
+  // The clients state vector. The Volt will respond with updates that should be applied to the local document.
+  bytes state_vector = 3;
+
+  // Set to true to only receive updates from other clients.
+  bool read_only = 4;
+}
+
+message SyncDocumentUpdate {
+  bytes chunk = 1;
+
+  bool complete = 2;
+}
+
+message SyncDocumentRequest {
+  oneof payload {
+    // Initial sync configuration, must be sent as first message.
+    SyncDocumentStart sync_start = 1;
+
+    // Updates to apply to the remote document.
+    SyncDocumentUpdate update = 2;
+  }
+
+  // The sync state of the local document
+  SyncState sync_state = 3;
+}
+
+message SyncDocumentResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // The state vector of the Volt (remote) document. Only present in the initial response.
+  bytes state_vector = 2;
+
+  // Updates to apply to client (local) document.
+  SyncDocumentUpdate update = 3;
+
+  // The sync state of the Volt (remote) document
+  SyncState sync_state = 4;
+}
+
+message GetDocumentJSONRequest {
+  string database_id = 1;
+  string document_id = 2;
+}
+
+message GetDocumentJSONResponse {
+  oneof result {
+    // Details of any error that occurred on the call.
+    tdx.volt_api.volt.v1.Status error = 1;
+
+    // The current JSON snapshot of the document
+    string json = 2;
+  }
+}`;
 export const terminal_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
@@ -2909,6 +2992,10 @@ message SignVerifyRequest {
     // Only valid if verifying.
     string digest_encoded = 5;
   }
+
+  // The DID of the identity used to sign or verify the message. If omitted, the authenticated identity will be used.
+  // When signing, the authenticated identity must have volt:sign permission for the given DID.
+  string identity_did = 6;
 }
 
 // Note that if verification was successful the response will be empty (there is no error and no digest is returned).
@@ -2973,7 +3060,7 @@ message SubscribeWireRequest {
 // One of the following fields will be present in the response.
 message SubscribeWireResponse {
   oneof payload {
-    // Details of any error that occured on the call.
+    // Details of any error that occurred on the call.
     tdx.volt_api.volt.v1.Status status = 1;
 
     // Data received from the wire.
@@ -2982,4 +3069,4 @@ message SubscribeWireResponse {
 }
 
 `;
-export const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proxy_api, relay_api, sync, discovery_api, file, file_api, remote, spark_api, ssi, ssi_api, status, 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, spark_api, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];