@tdxvolt/volt-client-grpc 0.20.11 → 0.20.12

package/lib/index.cjs

@@ -1345,7 +1345,8 @@ import "tdx/volt_api/volt/v1/ssi.proto";
 import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
-  rpc CacheEmailCredential(CacheEmailCredentialRequest) returns (CacheEmailCredentialResponse);
+  // Creates a verifiable credential binding an email address to an identity.
+  rpc CreateEmailCredential(CreateEmailCredentialRequest) returns (CreateEmailCredentialResponse);
 
   // Delete a DID document or all DID documents originating from a given Volt.
   // Requires \`volt:delete-did\` API privilege.
@@ -1376,20 +1377,21 @@ service SsiAPI {
   rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message CacheEmailCredentialRequest {
+message CreateEmailCredentialRequest {
+  // The DID of the identity to bind to. If not specified the DID of the currently authenticated account is used.
   string identity_did = 1;
 
+  // The email address to bind to the identity.
   string email_address = 2;
 
+  // The identity provider to use.
   string identity_provider = 3;
 
+  // The passphrase for the identity key, if required (i.e. the key is encrypted).
   string key_passphrase = 4;
-
-  // The time to live for the token, in seconds.
-  uint32 ttl = 5;
 }
 
-message CacheEmailCredentialResponse {
+message CreateEmailCredentialResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
@@ -1596,14 +1598,57 @@ const sync_api = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 import "tdx/volt_api/volt/v1/status.proto";
+import "tdx/volt_api/volt/v1/volt_api.proto";
 
 // The Sync API allows clients to collaboratively read and write JSON data to a shared resource.
 service SyncAPI {
+  // Create a synapse connection resource.
+  // A synapse connection defines a bi-directional syncronisation between two Volt databases. The connection is created as a child of the local synapse resource, and a symbolic link is also placed in the system-wide 'connection' folder.
+  // 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(SaveResourceRequest) returns (SaveResourceResponse);
+
+  // Set the metadata for a synapse document.
+  rpc SetSynapseDocumentMetadata(SetSynapseDocumentMetadataRequest) returns (SetSynapseDocumentMetadataResponse);
+
   // 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);
+  // Watch synapse paths for changes.
+  rpc WatchSynapsePath(stream WatchSynapsePathRequest) returns (stream WatchSynapsePathResponse);
+
+  // Write a single value to a given synapse JSON path.
+  rpc WriteSynapsePath(WriteSynapsePathRequest) returns (WriteSynapsePathResponse);
+}
+
+
+message SynapseDocumentMetadata {
+  // The name of the top-level shared type in the document.
+  string name = 1;
+
+  // The type of the shared type, e.g. "map", "array" or "text".
+  string type = 2;
+
+  // The JSON schema that describes the data that is stored in this shared type.
+  string json_schema = 3;
+}
+
+message SetSynapseDocumentMetadataRequest {
+  // The id of the synapse.
+  string database_id = 1;
+
+  // The id of the document to set the metadata for.
+  string document_id = 2;
+
+  // The metadata to set for the document.
+  repeated SynapseDocumentMetadata metadata = 3;
+
+  // Any additional application-specific JSON to attach to the document.
+  string json = 4;
+}
+
+message SetSynapseDocumentMetadataResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
 }
 
 enum SyncState {
@@ -1667,20 +1712,88 @@ message SyncDocumentResponse {
   bool is_read_only = 5;
 }
 
-message GetDocumentJSONRequest {
+// Parameters to start watching synapse paths. Sent as the first message.
+message WatchSynapsePathStart {
+  // The id of the database that contains the document.
   string database_id = 1;
+
+  // The id of the document to watch.
   string document_id = 2;
+
+  // The JSON paths to watch.
+  repeated string path = 3;
+}
+
+message WatchSynapsePathRequest {
+  oneof payload {
+    // Start watching the given paths; must be sent as the first message.
+    WatchSynapsePathStart start = 1;
+    
+    // Request to stop the watch.
+    bool stop = 2;
+  }
+}
+
+enum SynapsePathUpdateType {
+  SYNAPSE_PATH_UPDATE_TYPE_UNKNOWN = 0;
+  SYNAPSE_PATH_UPDATE_TYPE_ADD = 1;
+  SYNAPSE_PATH_UPDATE_TYPE_UPDATE = 2;
+  SYNAPSE_PATH_UPDATE_TYPE_DELETE = 3;
 }
 
-message GetDocumentJSONResponse {
+message WatchSynapsePathUpdate {
+  // The JSON path that was updated.
+  string watch_path = 1;
+
+  // The actual JSON path for this match (e.g. $.content["Atlantic Star"].lat).
+  // Enables clients to identify which array element or map key the update refers to when using wildcard matches such as $.content[*]
+  string event_path = 2;
+
+  // The type of update.
+  SynapsePathUpdateType update_type = 3;
+
+  // The JSON value that was updated.
+  string value = 4;
+
+  // The previous JSON value before the update.
+  string previous_value = 5;
+
+  // The zero-based index of the update.
+  uint32 index = 6;
+
+  // The total number of updates.
+  uint32 total = 7;
+}
+
+message WatchSynapsePathResponse {
   oneof result {
     // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status error = 1;
+    tdx.volt_api.volt.v1.Status status = 1;
 
-    // The current JSON snapshot of the document
-    string json = 2;
+    // The update to the path.
+    WatchSynapsePathUpdate update = 2;
   }
 }
+
+message WriteSynapsePathRequest {
+  // The id of the database that contains the document.
+  string database_id = 1;
+
+  // The id of the document to write to.
+  string document_id = 2;
+
+  // The JSON path to write to.
+  string path = 3;
+
+  // The JSON value to write.
+  string json = 4;
+}
+
+message WriteSynapsePathResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 `;
 const terminal_api = `syntax = "proto3";
 
@@ -2438,6 +2551,9 @@ import "tdx/volt_api/volt/v1/volt.proto";
 // A client certificate can be obtained from the \`Authenticate\` method.
 // All methods include a \`tdx.volt_api.volt.v1.Status\` in the response. If the status contains a non-OK error code the client should assume the remainder of the message is invalid, unless otherwise indicated in the response documentation.
 service VoltAPI {
+  // Add a relay connection resource to this volt.
+  rpc AddRelay(SaveResourceRequest) returns (SaveResourceResponse);
+
   // Issues a request to authenticate on the volt.
   // All clients must successfully authenticate in order to gain any kind of access.
   // A client certificate is optional for this RPC, if omitted a JWT must be provided in the call metadata.
@@ -2527,17 +2643,35 @@ service VoltAPI {
   rpc SaveAccess(SaveAccessRequest) returns (SaveAccessResponse);
 
   // Create or update a static file HTTP server.
-  rpc SaveHttpFileServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpFileServer(SaveHttpFileServerRequest) returns (SaveHttpFileServerResponse);
+
+  // Create or update an HTTP forwarder resource.
+  rpc SaveHttpForwarder(SaveHttpForwarderRequest) returns (SaveHttpForwarderResponse);
 
   // Create or update an HTTP REST API server.
-  rpc SaveHttpApiServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpRestApiServer(SaveHttpRestApiServerRequest) returns (SaveHttpRestApiServerResponse);
+
+  // Create or update an HTTP REST API node.
+  rpc SaveHttpRestApiNode(SaveHttpRestApiNodeRequest) returns (SaveHttpRestApiNodeResponse);
 
   // Create or update an identity.
   rpc SaveIdentity(SaveIdentityRequest) returns (SaveIdentityResponse);
 
+  // Create or update a database resource.
+  rpc SaveDatabase(SaveDatabaseRequest) returns (SaveDatabaseResponse);
+
   // Create or update a mirrored link resource.
   rpc SaveMirroredLink(SaveResourceRequest) returns (SaveResourceResponse);
 
+  // Create or update a sync database resource.
+  rpc SaveSyncDatabase(SaveSyncDatabaseRequest) returns (SaveSyncDatabaseResponse);
+
+  // Create or update a synapse resource.
+  rpc SaveSynapse(SaveSynapseRequest) returns (SaveSynapseResponse);
+
+  // Create a synapse connection resource.
+  rpc CreateSynapseConnection(CreateSynapseConnectionRequest) returns (CreateSynapseConnectionResponse);
+
   // Update Volt parameters.
   // This is a privileged call that requires Volt root access.
   rpc SaveParameters(SaveParametersRequest) returns (SaveParametersResponse);
@@ -3454,6 +3588,143 @@ message SaveResourceResponse {
   Resource resource = 2;
 }
 
+message SaveDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+}
+
+message SaveDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSyncDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSyncDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSynapseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSynapseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpForwarderRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string domain = 5;
+  string host = 6;
+  int32 port = 7;
+  bool forward_host = 8;
+}
+
+message SaveHttpForwarderResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpFileServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string path = 5;
+  string host = 6;
+  int32 port = 7;
+  bool enabled = 8;
+  int32 cache_timeout = 9;
+  bool catch_all_enabled = 10;
+  string catch_all = 11;
+}
+
+message SaveHttpFileServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string host = 5;
+  int32 port = 6;
+  bool enabled = 7;
+  bool cors_enabled = 8;
+}
+
+message SaveHttpRestApiServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiNodeRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool is_literal = 5;
+  string literal_json = 6;
+  string database_id = 7;
+  string sql = 8;
+  repeated string parameter = 9;
+}
+
+message SaveHttpRestApiNodeResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message CreateSynapseConnectionRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string local_synapse_id = 5;
+  string remote_synapse_id = 6;
+  string remote_volt_identity = 7;
+  string remote_volt_address = 8;
+  string remote_volt_http_address = 9;
+  string remote_volt_ca = 10;
+  string remote_identity = 11;
+  string relay_address = 12;
+  string relay_ca = 13;
+  string relay_challenge = 14;
+}
+
+message CreateSynapseConnectionResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
 message SaveSessionRequest {
   Session session = 1;
 }
@@ -3560,17 +3831,47 @@ const wire_api = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 import "tdx/volt_api/volt/v1/status.proto";
+import "tdx/volt_api/volt/v1/volt.proto";
 
 // The Wire API allows clients to subscribe and publish to Volt wire resources.
 service WireAPI {
+
   // Establishes a client-streaming call to the wire resource.
   rpc PublishWire(stream PublishWireRequest) returns (stream PublishWireResponse);
 
+  // Saves a wire resource.
+  rpc SaveWire(SaveWireRequest) returns (SaveWireResponse);
+
   // Establishes a bi-directional streaming call to the wire resource.
   // Although we're only really interested in receiving data from the wire, a bi-directional stream is required so that we can gracefully stop the subscription.
   rpc SubscribeWire(stream SubscribeWireRequest) returns (stream SubscribeWireResponse);
 }
 
+message SaveWireRequest {
+  // The wire resource to save.
+  Resource resource = 1;
+  
+  // Set to create a new wire resource.
+  bool create = 2;
+
+  // The id of the folder resource in which to create the wire resource.
+  string create_in_parent_id = 3;
+
+  // Set to purge the wire resource attributes before saving.
+  bool purge_attributes = 4;
+
+  // Set to persist the wire messages.
+  bool persist = 5;
+
+  // The table to persist the wire messages to.
+  string persist_table = 6;
+}
+
+message SaveWireResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  tdx.volt_api.volt.v1.Resource resource = 2;
+}
+
 // Because the publish RPC is streaming, the policy will not be checked until the first message arrives. This can mean that the \`PublishWire\` call appears to succeed but then fails after the first attempt to publish a message.
 // To avoid this, clients can immediately send a message with the \`wire_id\` set and no \`chunk\` set. This will establish that the correct permissions are in place and fail fast if not.
 message PublishWireRequest {
@@ -5672,10 +5973,18 @@ class VoltClient extends EventEmitter__default["default"] {
    * VoltAPI - resource management
    */
 
+  AddRelay(request) {
+    return unaryCallInternal.call(this, "AddRelay", request);
+  }
+
   CanAccessResource(request) {
     return unaryCallInternal.call(this, "CanAccessResource", request);
   }
 
+  CopyResource(request) {
+    return unaryCallInternal.call(this, "CopyResource", request);
+  }
+
   DeleteResource(request) {
     return unaryCallInternal.call(this, "DeleteResource", request);
   }
@@ -5700,6 +6009,10 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "GetResourceDescendants", request);
   }
 
+  MoveResource(request) {
+    return unaryCallInternal.call(this, "MoveResource", request);
+  }
+
   RequestAccess(request) {
     return unaryCallInternal.call(this, "RequestAccess", request);
   }
@@ -5708,8 +6021,44 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "SaveResource", request);
   }
 
-  SaveResourceAttribute(request) {
-    return unaryCallInternal.call(this, "SaveResourceAttribute", request);
+  SaveDatabase(request) {
+    return unaryCallInternal.call(this, "SaveDatabase", request);
+  }
+
+  SaveHttpFileServer(request) {
+    return unaryCallInternal.call(this, "SaveHttpFileServer", request);
+  }
+
+  SaveHttpForwarder(request) {
+    return unaryCallInternal.call(this, "SaveHttpForwarder", request);
+  }
+
+  SaveHttpRestApiServer(request) {
+    return unaryCallInternal.call(this, "SaveHttpRestApiServer", request);
+  }
+
+  SaveHttpRestApiNode(request) {
+    return unaryCallInternal.call(this, "SaveHttpRestApiNode", request);
+  }
+
+  SaveMirroredLink(request) {
+    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);
   }
 
   SetServiceStatus(request) {
@@ -5724,26 +6073,18 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "Authenticate", request);
   }
 
-  Bind(request) {
-    return unaryCallInternal.call(this, "Bind", request);
+  CheckCompatibility(request) {
+    return unaryCallInternal.call(this, "CheckCompatibility", request);
   }
 
   DeleteAccess(request) {
     return unaryCallInternal.call(this, "DeleteAccess", request);
   }
 
-  DeleteVolt(request) {
-    return unaryCallInternal.call(this, "DeleteVolt", request);
-  }
-
   GetAccess(request) {
     return unaryCallInternal.call(this, "GetAccess", request);
   }
 
-  GetBindings(request) {
-    return unaryCallInternal.call(this, "GetBindings", request);
-  }
-
   GetIdentities(request) {
     return unaryCallInternal.call(this, "GetIdentities", request);
   }
@@ -5752,40 +6093,44 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "GetIdentity", request);
   }
 
-  GetIdentityToken(request) {
-    return unaryCallInternal.call(this, "GetIdentityToken", request);
+  GetOneTimeToken(request) {
+    return unaryCallInternal.call(this, "GetOneTimeToken", request);
+  }
+
+  GetParameters(request) {
+    return unaryCallInternal.call(this, "GetParameters", request);
   }
 
   GetPolicy(request) {
     return unaryCallInternal.call(this, "GetPolicy", request);
   }
 
-  GetSettings(request) {
-    return unaryCallInternal.call(this, "GetSettings", request);
+  GetSessions(request) {
+    return unaryCallInternal.call(this, "GetSessions", request);
   }
 
   SaveAccess(request) {
     return unaryCallInternal.call(this, "SaveAccess", request);
   }
 
-  SaveCloudConnection(request) {
-    return unaryCallInternal.call(this, "SaveCloudConnection", request);
-  }
-
   SaveIdentity(request) {
     return unaryCallInternal.call(this, "SaveIdentity", request);
   }
 
-  SaveSettings(request) {
-    return unaryCallInternal.call(this, "SaveSettings", request);
+  SaveParameters(request) {
+    return unaryCallInternal.call(this, "SaveParameters", request);
+  }
+
+  SaveSession(request) {
+    return unaryCallInternal.call(this, "SaveSession", request);
   }
 
   SetAccessRequestDecision(request) {
     return unaryCallInternal.call(this, "SetAccessRequestDecision", request);
   }
 
-  SetBindingDecision(request) {
-    return unaryCallInternal.call(this, "SetBindingDecision", request);
+  SetPolicy(request) {
+    return unaryCallInternal.call(this, "SetPolicy", request);
   }
 
   Shutdown(request) {
@@ -5796,6 +6141,16 @@ class VoltClient extends EventEmitter__default["default"] {
     return unaryCallInternal.call(this, "SignVerify", request);
   }
 
+  /**
+   * VoltAPI - streaming (bidi). Use connect() for Connect stream.
+   * Invoke is for relay proxying; returns a duplex stream of InvokeRequest/InvokeResponse.
+   */
+  Invoke(request) {
+    const grpcClient = this.getVoltAPIClient();
+    const invokeCall = new GRPCCall(this, "Invoke", "METHOD_TYPE_BIDI");
+    return invokeCall.start(grpcClient, request);
+  }
+
   /**
    * FileAPI
    */
@@ -6010,6 +6365,9 @@ class VoltClient extends EventEmitter__default["default"] {
     return subscribeCall.start(grpcClient, request);
   }
 
+  /**
+   * SyncAPI
+   */
   SyncDocument(request) {
     const grpcClient = this.getVoltAPIClient();
 
@@ -6020,6 +6378,25 @@ class VoltClient extends EventEmitter__default["default"] {
     );
     return syncDocumentCall.start(grpcClient, request);
   }
+  
+  SetSynapseDocumentMetadata(request) {
+    return unaryCallInternal.call(this, "SetSynapseDocumentMetadata", request);
+  }
+
+  WatchSynapsePath(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const watchPathCall = new GRPCCall(
+      this, 
+      "WatchSynapsePath", 
+      "METHOD_TYPE_BIDI"
+    );
+    return watchPathCall.start(grpcClient, request);
+  }
+
+  WriteSynapsePath(request) {
+    return unaryCallInternal.call(this, "WriteSynapsePath", request);
+  }
 }
 
 Object.defineProperty(exports, 'SyncProvider', {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.20.11",
+  "version": "0.20.12",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -43,4 +43,4 @@
     "protobufjs": "^7.4.0",
     "uuid": "^8.1.0"
   }
-}
+}

package/src/volt-client.js

@@ -331,10 +331,18 @@ export class VoltClient extends EventEmitter {
    * VoltAPI - resource management
    */
 
+  AddRelay(request) {
+    return unaryCallInternal.call(this, "AddRelay", request);
+  }
+
   CanAccessResource(request) {
     return unaryCallInternal.call(this, "CanAccessResource", request);
   }
 
+  CopyResource(request) {
+    return unaryCallInternal.call(this, "CopyResource", request);
+  }
+
   DeleteResource(request) {
     return unaryCallInternal.call(this, "DeleteResource", request);
   }
@@ -359,6 +367,10 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "GetResourceDescendants", request);
   }
 
+  MoveResource(request) {
+    return unaryCallInternal.call(this, "MoveResource", request);
+  }
+
   RequestAccess(request) {
     return unaryCallInternal.call(this, "RequestAccess", request);
   }
@@ -367,8 +379,44 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "SaveResource", request);
   }
 
-  SaveResourceAttribute(request) {
-    return unaryCallInternal.call(this, "SaveResourceAttribute", request);
+  SaveDatabase(request) {
+    return unaryCallInternal.call(this, "SaveDatabase", request);
+  }
+
+  SaveHttpFileServer(request) {
+    return unaryCallInternal.call(this, "SaveHttpFileServer", request);
+  }
+
+  SaveHttpForwarder(request) {
+    return unaryCallInternal.call(this, "SaveHttpForwarder", request);
+  }
+
+  SaveHttpRestApiServer(request) {
+    return unaryCallInternal.call(this, "SaveHttpRestApiServer", request);
+  }
+
+  SaveHttpRestApiNode(request) {
+    return unaryCallInternal.call(this, "SaveHttpRestApiNode", request);
+  }
+
+  SaveMirroredLink(request) {
+    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);
   }
 
   SetServiceStatus(request) {
@@ -383,26 +431,18 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "Authenticate", request);
   }
 
-  Bind(request) {
-    return unaryCallInternal.call(this, "Bind", request);
+  CheckCompatibility(request) {
+    return unaryCallInternal.call(this, "CheckCompatibility", request);
   }
 
   DeleteAccess(request) {
     return unaryCallInternal.call(this, "DeleteAccess", request);
   }
 
-  DeleteVolt(request) {
-    return unaryCallInternal.call(this, "DeleteVolt", request);
-  }
-
   GetAccess(request) {
     return unaryCallInternal.call(this, "GetAccess", request);
   }
 
-  GetBindings(request) {
-    return unaryCallInternal.call(this, "GetBindings", request);
-  }
-
   GetIdentities(request) {
     return unaryCallInternal.call(this, "GetIdentities", request);
   }
@@ -411,40 +451,44 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "GetIdentity", request);
   }
 
-  GetIdentityToken(request) {
-    return unaryCallInternal.call(this, "GetIdentityToken", request);
+  GetOneTimeToken(request) {
+    return unaryCallInternal.call(this, "GetOneTimeToken", request);
+  }
+
+  GetParameters(request) {
+    return unaryCallInternal.call(this, "GetParameters", request);
   }
 
   GetPolicy(request) {
     return unaryCallInternal.call(this, "GetPolicy", request);
   }
 
-  GetSettings(request) {
-    return unaryCallInternal.call(this, "GetSettings", request);
+  GetSessions(request) {
+    return unaryCallInternal.call(this, "GetSessions", request);
   }
 
   SaveAccess(request) {
     return unaryCallInternal.call(this, "SaveAccess", request);
   }
 
-  SaveCloudConnection(request) {
-    return unaryCallInternal.call(this, "SaveCloudConnection", request);
-  }
-
   SaveIdentity(request) {
     return unaryCallInternal.call(this, "SaveIdentity", request);
   }
 
-  SaveSettings(request) {
-    return unaryCallInternal.call(this, "SaveSettings", request);
+  SaveParameters(request) {
+    return unaryCallInternal.call(this, "SaveParameters", request);
+  }
+
+  SaveSession(request) {
+    return unaryCallInternal.call(this, "SaveSession", request);
   }
 
   SetAccessRequestDecision(request) {
     return unaryCallInternal.call(this, "SetAccessRequestDecision", request);
   }
 
-  SetBindingDecision(request) {
-    return unaryCallInternal.call(this, "SetBindingDecision", request);
+  SetPolicy(request) {
+    return unaryCallInternal.call(this, "SetPolicy", request);
   }
 
   Shutdown(request) {
@@ -455,6 +499,16 @@ export class VoltClient extends EventEmitter {
     return unaryCallInternal.call(this, "SignVerify", request);
   }
 
+  /**
+   * VoltAPI - streaming (bidi). Use connect() for Connect stream.
+   * Invoke is for relay proxying; returns a duplex stream of InvokeRequest/InvokeResponse.
+   */
+  Invoke(request) {
+    const grpcClient = this.getVoltAPIClient();
+    const invokeCall = new GRPCCall(this, "Invoke", "METHOD_TYPE_BIDI");
+    return invokeCall.start(grpcClient, request);
+  }
+
   /**
    * FileAPI
    */
@@ -671,6 +725,9 @@ export class VoltClient extends EventEmitter {
     return subscribeCall.start(grpcClient, request);
   }
 
+  /**
+   * SyncAPI
+   */
   SyncDocument(request) {
     const grpcClient = this.getVoltAPIClient();
 
@@ -681,4 +738,23 @@ export class VoltClient extends EventEmitter {
     );
     return syncDocumentCall.start(grpcClient, request);
   }
+  
+  SetSynapseDocumentMetadata(request) {
+    return unaryCallInternal.call(this, "SetSynapseDocumentMetadata", request);
+  }
+
+  WatchSynapsePath(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const watchPathCall = new GRPCCall(
+      this, 
+      "WatchSynapsePath", 
+      "METHOD_TYPE_BIDI"
+    );
+    return watchPathCall.start(grpcClient, request);
+  }
+
+  WriteSynapsePath(request) {
+    return unaryCallInternal.call(this, "WriteSynapsePath", request);
+  }
 }

package/src/volt-proto-literals.js

@@ -797,7 +797,8 @@ import "tdx/volt_api/volt/v1/ssi.proto";
 import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
-  rpc CacheEmailCredential(CacheEmailCredentialRequest) returns (CacheEmailCredentialResponse);
+  // Creates a verifiable credential binding an email address to an identity.
+  rpc CreateEmailCredential(CreateEmailCredentialRequest) returns (CreateEmailCredentialResponse);
 
   // Delete a DID document or all DID documents originating from a given Volt.
   // Requires \`volt:delete-did\` API privilege.
@@ -828,20 +829,21 @@ service SsiAPI {
   rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message CacheEmailCredentialRequest {
+message CreateEmailCredentialRequest {
+  // The DID of the identity to bind to. If not specified the DID of the currently authenticated account is used.
   string identity_did = 1;
 
+  // The email address to bind to the identity.
   string email_address = 2;
 
+  // The identity provider to use.
   string identity_provider = 3;
 
+  // The passphrase for the identity key, if required (i.e. the key is encrypted).
   string key_passphrase = 4;
-
-  // The time to live for the token, in seconds.
-  uint32 ttl = 5;
 }
 
-message CacheEmailCredentialResponse {
+message CreateEmailCredentialResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
@@ -1048,14 +1050,57 @@ export const sync_api = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 import "tdx/volt_api/volt/v1/status.proto";
+import "tdx/volt_api/volt/v1/volt_api.proto";
 
 // The Sync API allows clients to collaboratively read and write JSON data to a shared resource.
 service SyncAPI {
+  // Create a synapse connection resource.
+  // A synapse connection defines a bi-directional syncronisation between two Volt databases. The connection is created as a child of the local synapse resource, and a symbolic link is also placed in the system-wide 'connection' folder.
+  // 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(SaveResourceRequest) returns (SaveResourceResponse);
+
+  // Set the metadata for a synapse document.
+  rpc SetSynapseDocumentMetadata(SetSynapseDocumentMetadataRequest) returns (SetSynapseDocumentMetadataResponse);
+
   // 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);
+  // Watch synapse paths for changes.
+  rpc WatchSynapsePath(stream WatchSynapsePathRequest) returns (stream WatchSynapsePathResponse);
+
+  // Write a single value to a given synapse JSON path.
+  rpc WriteSynapsePath(WriteSynapsePathRequest) returns (WriteSynapsePathResponse);
+}
+
+
+message SynapseDocumentMetadata {
+  // The name of the top-level shared type in the document.
+  string name = 1;
+
+  // The type of the shared type, e.g. "map", "array" or "text".
+  string type = 2;
+
+  // The JSON schema that describes the data that is stored in this shared type.
+  string json_schema = 3;
+}
+
+message SetSynapseDocumentMetadataRequest {
+  // The id of the synapse.
+  string database_id = 1;
+
+  // The id of the document to set the metadata for.
+  string document_id = 2;
+
+  // The metadata to set for the document.
+  repeated SynapseDocumentMetadata metadata = 3;
+
+  // Any additional application-specific JSON to attach to the document.
+  string json = 4;
+}
+
+message SetSynapseDocumentMetadataResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
 }
 
 enum SyncState {
@@ -1119,20 +1164,88 @@ message SyncDocumentResponse {
   bool is_read_only = 5;
 }
 
-message GetDocumentJSONRequest {
+// Parameters to start watching synapse paths. Sent as the first message.
+message WatchSynapsePathStart {
+  // The id of the database that contains the document.
   string database_id = 1;
+
+  // The id of the document to watch.
   string document_id = 2;
+
+  // The JSON paths to watch.
+  repeated string path = 3;
+}
+
+message WatchSynapsePathRequest {
+  oneof payload {
+    // Start watching the given paths; must be sent as the first message.
+    WatchSynapsePathStart start = 1;
+    
+    // Request to stop the watch.
+    bool stop = 2;
+  }
+}
+
+enum SynapsePathUpdateType {
+  SYNAPSE_PATH_UPDATE_TYPE_UNKNOWN = 0;
+  SYNAPSE_PATH_UPDATE_TYPE_ADD = 1;
+  SYNAPSE_PATH_UPDATE_TYPE_UPDATE = 2;
+  SYNAPSE_PATH_UPDATE_TYPE_DELETE = 3;
 }
 
-message GetDocumentJSONResponse {
+message WatchSynapsePathUpdate {
+  // The JSON path that was updated.
+  string watch_path = 1;
+
+  // The actual JSON path for this match (e.g. $.content["Atlantic Star"].lat).
+  // Enables clients to identify which array element or map key the update refers to when using wildcard matches such as $.content[*]
+  string event_path = 2;
+
+  // The type of update.
+  SynapsePathUpdateType update_type = 3;
+
+  // The JSON value that was updated.
+  string value = 4;
+
+  // The previous JSON value before the update.
+  string previous_value = 5;
+
+  // The zero-based index of the update.
+  uint32 index = 6;
+
+  // The total number of updates.
+  uint32 total = 7;
+}
+
+message WatchSynapsePathResponse {
   oneof result {
     // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status error = 1;
+    tdx.volt_api.volt.v1.Status status = 1;
 
-    // The current JSON snapshot of the document
-    string json = 2;
+    // The update to the path.
+    WatchSynapsePathUpdate update = 2;
   }
 }
+
+message WriteSynapsePathRequest {
+  // The id of the database that contains the document.
+  string database_id = 1;
+
+  // The id of the document to write to.
+  string document_id = 2;
+
+  // The JSON path to write to.
+  string path = 3;
+
+  // The JSON value to write.
+  string json = 4;
+}
+
+message WriteSynapsePathResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+}
+
 `;
 export const terminal_api = `syntax = "proto3";
 
@@ -1890,6 +2003,9 @@ import "tdx/volt_api/volt/v1/volt.proto";
 // A client certificate can be obtained from the \`Authenticate\` method.
 // All methods include a \`tdx.volt_api.volt.v1.Status\` in the response. If the status contains a non-OK error code the client should assume the remainder of the message is invalid, unless otherwise indicated in the response documentation.
 service VoltAPI {
+  // Add a relay connection resource to this volt.
+  rpc AddRelay(SaveResourceRequest) returns (SaveResourceResponse);
+
   // Issues a request to authenticate on the volt.
   // All clients must successfully authenticate in order to gain any kind of access.
   // A client certificate is optional for this RPC, if omitted a JWT must be provided in the call metadata.
@@ -1979,17 +2095,35 @@ service VoltAPI {
   rpc SaveAccess(SaveAccessRequest) returns (SaveAccessResponse);
 
   // Create or update a static file HTTP server.
-  rpc SaveHttpFileServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpFileServer(SaveHttpFileServerRequest) returns (SaveHttpFileServerResponse);
+
+  // Create or update an HTTP forwarder resource.
+  rpc SaveHttpForwarder(SaveHttpForwarderRequest) returns (SaveHttpForwarderResponse);
 
   // Create or update an HTTP REST API server.
-  rpc SaveHttpApiServer(SaveResourceRequest) returns (SaveResourceResponse);
+  rpc SaveHttpRestApiServer(SaveHttpRestApiServerRequest) returns (SaveHttpRestApiServerResponse);
+
+  // Create or update an HTTP REST API node.
+  rpc SaveHttpRestApiNode(SaveHttpRestApiNodeRequest) returns (SaveHttpRestApiNodeResponse);
 
   // Create or update an identity.
   rpc SaveIdentity(SaveIdentityRequest) returns (SaveIdentityResponse);
 
+  // Create or update a database resource.
+  rpc SaveDatabase(SaveDatabaseRequest) returns (SaveDatabaseResponse);
+
   // Create or update a mirrored link resource.
   rpc SaveMirroredLink(SaveResourceRequest) returns (SaveResourceResponse);
 
+  // Create or update a sync database resource.
+  rpc SaveSyncDatabase(SaveSyncDatabaseRequest) returns (SaveSyncDatabaseResponse);
+
+  // Create or update a synapse resource.
+  rpc SaveSynapse(SaveSynapseRequest) returns (SaveSynapseResponse);
+
+  // Create a synapse connection resource.
+  rpc CreateSynapseConnection(CreateSynapseConnectionRequest) returns (CreateSynapseConnectionResponse);
+
   // Update Volt parameters.
   // This is a privileged call that requires Volt root access.
   rpc SaveParameters(SaveParametersRequest) returns (SaveParametersResponse);
@@ -2906,6 +3040,143 @@ message SaveResourceResponse {
   Resource resource = 2;
 }
 
+message SaveDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+}
+
+message SaveDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSyncDatabaseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSyncDatabaseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveSynapseRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool encrypted = 5;
+  bool read_audit = 6;
+  bool write_audit = 7;
+  bool no_snapshots = 8;
+}
+
+message SaveSynapseResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpForwarderRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string domain = 5;
+  string host = 6;
+  int32 port = 7;
+  bool forward_host = 8;
+}
+
+message SaveHttpForwarderResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpFileServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string path = 5;
+  string host = 6;
+  int32 port = 7;
+  bool enabled = 8;
+  int32 cache_timeout = 9;
+  bool catch_all_enabled = 10;
+  string catch_all = 11;
+}
+
+message SaveHttpFileServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiServerRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string host = 5;
+  int32 port = 6;
+  bool enabled = 7;
+  bool cors_enabled = 8;
+}
+
+message SaveHttpRestApiServerResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message SaveHttpRestApiNodeRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  bool is_literal = 5;
+  string literal_json = 6;
+  string database_id = 7;
+  string sql = 8;
+  repeated string parameter = 9;
+}
+
+message SaveHttpRestApiNodeResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
+message CreateSynapseConnectionRequest {
+  Resource resource = 1;
+  bool create = 2;
+  string create_in_parent_id = 3;
+  bool purge_attributes = 4;
+  string local_synapse_id = 5;
+  string remote_synapse_id = 6;
+  string remote_volt_identity = 7;
+  string remote_volt_address = 8;
+  string remote_volt_http_address = 9;
+  string remote_volt_ca = 10;
+  string remote_identity = 11;
+  string relay_address = 12;
+  string relay_ca = 13;
+  string relay_challenge = 14;
+}
+
+message CreateSynapseConnectionResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  Resource resource = 2;
+}
+
 message SaveSessionRequest {
   Session session = 1;
 }
@@ -3012,17 +3283,47 @@ export const wire_api = `syntax = "proto3";
 package tdx.volt_api.volt.v1;
 
 import "tdx/volt_api/volt/v1/status.proto";
+import "tdx/volt_api/volt/v1/volt.proto";
 
 // The Wire API allows clients to subscribe and publish to Volt wire resources.
 service WireAPI {
+
   // Establishes a client-streaming call to the wire resource.
   rpc PublishWire(stream PublishWireRequest) returns (stream PublishWireResponse);
 
+  // Saves a wire resource.
+  rpc SaveWire(SaveWireRequest) returns (SaveWireResponse);
+
   // Establishes a bi-directional streaming call to the wire resource.
   // Although we're only really interested in receiving data from the wire, a bi-directional stream is required so that we can gracefully stop the subscription.
   rpc SubscribeWire(stream SubscribeWireRequest) returns (stream SubscribeWireResponse);
 }
 
+message SaveWireRequest {
+  // The wire resource to save.
+  Resource resource = 1;
+  
+  // Set to create a new wire resource.
+  bool create = 2;
+
+  // The id of the folder resource in which to create the wire resource.
+  string create_in_parent_id = 3;
+
+  // Set to purge the wire resource attributes before saving.
+  bool purge_attributes = 4;
+
+  // Set to persist the wire messages.
+  bool persist = 5;
+
+  // The table to persist the wire messages to.
+  string persist_table = 6;
+}
+
+message SaveWireResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  tdx.volt_api.volt.v1.Resource resource = 2;
+}
+
 // Because the publish RPC is streaming, the policy will not be checked until the first message arrives. This can mean that the \`PublishWire\` call appears to succeed but then fails after the first attempt to publish a message.
 // To avoid this, clients can immediately send a message with the \`wire_id\` set and no \`chunk\` set. This will establish that the correct permissions are in place and fail fast if not.
 message PublishWireRequest {