@tdxvolt/volt-client-grpc 0.20.29 → 0.20.31

package/lib/index.cjs

@@ -1784,6 +1784,15 @@ service SyncAPI {
 
   // Revert a document in a sync database to a stored version.
   rpc RevertSyncDocumentVersion(RevertSyncDocumentVersionRequest) returns (RevertSyncDocumentVersionResponse);
+
+  // Check whether a content-addressed blob exists in a synapse.
+  rpc HasSynapseBlob(HasSynapseBlobRequest) returns (HasSynapseBlobResponse);
+
+  // Upload a content-addressed blob. The first message must be \`start\` with the expected sha256 (base64url) hash and size; subsequent messages carry payload chunks. Idempotent if the hash is already stored. The server verifies the received bytes match \`hash\` before committing.
+  rpc PutSynapseBlob(stream PutSynapseBlobRequest) returns (stream PutSynapseBlobResponse);
+
+  // Download a content-addressed blob by hash.
+  rpc GetSynapseBlob(GetSynapseBlobRequest) returns (stream GetSynapseBlobResponse);
 }
 
 message CreateSynapseConnectionRequest {
@@ -1951,36 +1960,31 @@ 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".
+  // The type of the document root. Yjs shared types are "map", "array" or "text". The "blob" type means the payload is a content-addressed object in the synapse blob store (PutSynapseBlob / GetSynapseBlob). There is no Yjs shared type for a blob document. A blob document's schema must be a single entry of type "blob"; it cannot be mixed with map, array, or text roots. The server writes \`__hash\` when the document is bound to a stored blob (see SetSynapseDocumentMetadata.blob_hash).
   string type = 2;
 
-  // The JSON schema that describes the data that is stored in this shared type.
+  // The JSON schema that describes the data stored in this shared type.
   string json_schema = 3;
 }
 
 message SetSynapseDocumentMetadataRequest {
-  // DEPRECATED: Use synapse_id instead.
-  string database_id = 1;
-
   // The id of the synapse that contains the document.
   string synapse_id = 5;
 
   // The id of the document to set the metadata for.
   string document_id = 2;
 
-  // The metadata to set for the document.
+  // The metadata to set for the document. Each entry names a top-level shared type (map/array/text). For a blob document this must contain exactly one entry with type "blob".
   repeated SynapseDocumentMetadata metadata = 3;
 
   // Any additional application-specific JSON to attach to the document.
   string json = 4;
 
-  // Set to true when the caller intends to write the document's content
-  // separately, after this metadata call (a metadata-first create). The sync
-  // server uses this to defer __hash bootstrapping until the content actually
-  // arrives, so the hash is not computed over an empty document. Leave false
-  // (the default) for empty documents or content-first flows where the content
-  // is already present.
-  bool content_pending = 6;
+  // Set to true when the document content is already present (content-first) or the document is intentionally empty, so the server bootstraps \`__hash\` immediately. Leave false (the default) when content will be written after this call.
+  bool content_ready = 6;
+
+  // For blob documents, the content hash to bind. The server verifies the blob is stored (or the hash is sha256 of empty bytes) and writes \`__hash\`. Omit for a metadata-first create. Must not be set for map/array/text documents; the server computes those hashes from Yjs content.
+  string blob_hash = 7;
 }
 
 message SetSynapseDocumentMetadataResponse {
@@ -2213,6 +2217,64 @@ message RevertSyncDocumentVersionResponse {
   string version_id = 2;
 }
 
+message HasSynapseBlobRequest {
+  // The id of the synapse that stores the blob.
+  string synapse_id = 1;
+
+  // sha256 of the raw file bytes, encoded as unpadded base64url (same family
+  // as VoltDrive content hashes).
+  string hash = 2;
+}
+
+message HasSynapseBlobResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // True if a blob with this hash is already stored.
+  bool exists = 2;
+}
+
+message PutSynapseBlobStart {
+  string synapse_id = 1;
+
+  // Expected sha256 (base64url) of the concatenated payload bytes.
+  string hash = 2;
+
+  // Total payload size in bytes. Zero means no blob row (empty file).
+  uint64 size = 3;
+}
+
+message PutSynapseBlobRequest {
+  oneof payload {
+    // Must be sent as the first message.
+    PutSynapseBlobStart start = 1;
+
+    // The next chunk of blob data.
+    bytes block = 2;
+  }
+}
+
+message PutSynapseBlobResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // Number of payload blocks received. Zero until the stream finishes.
+  uint32 ack = 2;
+
+  // True if the hash was already present (put is a no-op).
+  bool exists = 3;
+}
+
+message GetSynapseBlobRequest {
+  string synapse_id = 1;
+  string hash = 2;
+}
+
+message GetSynapseBlobResponse {
+  oneof payload {
+    bytes block = 1;
+    tdx.volt_api.volt.v1.Status status = 2;
+  }
+}
+
 `;
 const terminal_api = `syntax = "proto3";
 
@@ -7066,6 +7128,32 @@ class VoltClient extends EventEmitter__default["default"] {
   WriteSynapsePath(request) {
     return unaryCallInternal.call(this, "WriteSynapsePath", request);
   }
+
+  HasSynapseBlob(request) {
+    return unaryCallInternal.call(this, "HasSynapseBlob", request);
+  }
+
+  PutSynapseBlob(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const putBlobCall = new GRPCCall(
+      this,
+      "PutSynapseBlob",
+      "METHOD_TYPE_BIDI"
+    );
+    return putBlobCall.start(grpcClient, request);
+  }
+
+  GetSynapseBlob(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const getBlobCall = new GRPCCall(
+      this,
+      "GetSynapseBlob",
+      "METHOD_TYPE_SERVER_STREAM"
+    );
+    return getBlobCall.start(grpcClient, request);
+  }
 }
 
 Object.defineProperty(exports, 'SyncProvider', {

package/package.json

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

package/src/volt-client.js

@@ -788,4 +788,30 @@ export class VoltClient extends EventEmitter {
   WriteSynapsePath(request) {
     return unaryCallInternal.call(this, "WriteSynapsePath", request);
   }
+
+  HasSynapseBlob(request) {
+    return unaryCallInternal.call(this, "HasSynapseBlob", request);
+  }
+
+  PutSynapseBlob(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const putBlobCall = new GRPCCall(
+      this,
+      "PutSynapseBlob",
+      "METHOD_TYPE_BIDI"
+    );
+    return putBlobCall.start(grpcClient, request);
+  }
+
+  GetSynapseBlob(request) {
+    const grpcClient = this.getVoltAPIClient();
+
+    const getBlobCall = new GRPCCall(
+      this,
+      "GetSynapseBlob",
+      "METHOD_TYPE_SERVER_STREAM"
+    );
+    return getBlobCall.start(grpcClient, request);
+  }
 }

package/src/volt-proto-literals.js

@@ -1236,6 +1236,15 @@ service SyncAPI {
 
   // Revert a document in a sync database to a stored version.
   rpc RevertSyncDocumentVersion(RevertSyncDocumentVersionRequest) returns (RevertSyncDocumentVersionResponse);
+
+  // Check whether a content-addressed blob exists in a synapse.
+  rpc HasSynapseBlob(HasSynapseBlobRequest) returns (HasSynapseBlobResponse);
+
+  // Upload a content-addressed blob. The first message must be \`start\` with the expected sha256 (base64url) hash and size; subsequent messages carry payload chunks. Idempotent if the hash is already stored. The server verifies the received bytes match \`hash\` before committing.
+  rpc PutSynapseBlob(stream PutSynapseBlobRequest) returns (stream PutSynapseBlobResponse);
+
+  // Download a content-addressed blob by hash.
+  rpc GetSynapseBlob(GetSynapseBlobRequest) returns (stream GetSynapseBlobResponse);
 }
 
 message CreateSynapseConnectionRequest {
@@ -1403,36 +1412,31 @@ 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".
+  // The type of the document root. Yjs shared types are "map", "array" or "text". The "blob" type means the payload is a content-addressed object in the synapse blob store (PutSynapseBlob / GetSynapseBlob). There is no Yjs shared type for a blob document. A blob document's schema must be a single entry of type "blob"; it cannot be mixed with map, array, or text roots. The server writes \`__hash\` when the document is bound to a stored blob (see SetSynapseDocumentMetadata.blob_hash).
   string type = 2;
 
-  // The JSON schema that describes the data that is stored in this shared type.
+  // The JSON schema that describes the data stored in this shared type.
   string json_schema = 3;
 }
 
 message SetSynapseDocumentMetadataRequest {
-  // DEPRECATED: Use synapse_id instead.
-  string database_id = 1;
-
   // The id of the synapse that contains the document.
   string synapse_id = 5;
 
   // The id of the document to set the metadata for.
   string document_id = 2;
 
-  // The metadata to set for the document.
+  // The metadata to set for the document. Each entry names a top-level shared type (map/array/text). For a blob document this must contain exactly one entry with type "blob".
   repeated SynapseDocumentMetadata metadata = 3;
 
   // Any additional application-specific JSON to attach to the document.
   string json = 4;
 
-  // Set to true when the caller intends to write the document's content
-  // separately, after this metadata call (a metadata-first create). The sync
-  // server uses this to defer __hash bootstrapping until the content actually
-  // arrives, so the hash is not computed over an empty document. Leave false
-  // (the default) for empty documents or content-first flows where the content
-  // is already present.
-  bool content_pending = 6;
+  // Set to true when the document content is already present (content-first) or the document is intentionally empty, so the server bootstraps \`__hash\` immediately. Leave false (the default) when content will be written after this call.
+  bool content_ready = 6;
+
+  // For blob documents, the content hash to bind. The server verifies the blob is stored (or the hash is sha256 of empty bytes) and writes \`__hash\`. Omit for a metadata-first create. Must not be set for map/array/text documents; the server computes those hashes from Yjs content.
+  string blob_hash = 7;
 }
 
 message SetSynapseDocumentMetadataResponse {
@@ -1665,6 +1669,64 @@ message RevertSyncDocumentVersionResponse {
   string version_id = 2;
 }
 
+message HasSynapseBlobRequest {
+  // The id of the synapse that stores the blob.
+  string synapse_id = 1;
+
+  // sha256 of the raw file bytes, encoded as unpadded base64url (same family
+  // as VoltDrive content hashes).
+  string hash = 2;
+}
+
+message HasSynapseBlobResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // True if a blob with this hash is already stored.
+  bool exists = 2;
+}
+
+message PutSynapseBlobStart {
+  string synapse_id = 1;
+
+  // Expected sha256 (base64url) of the concatenated payload bytes.
+  string hash = 2;
+
+  // Total payload size in bytes. Zero means no blob row (empty file).
+  uint64 size = 3;
+}
+
+message PutSynapseBlobRequest {
+  oneof payload {
+    // Must be sent as the first message.
+    PutSynapseBlobStart start = 1;
+
+    // The next chunk of blob data.
+    bytes block = 2;
+  }
+}
+
+message PutSynapseBlobResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // Number of payload blocks received. Zero until the stream finishes.
+  uint32 ack = 2;
+
+  // True if the hash was already present (put is a no-op).
+  bool exists = 3;
+}
+
+message GetSynapseBlobRequest {
+  string synapse_id = 1;
+  string hash = 2;
+}
+
+message GetSynapseBlobResponse {
+  oneof payload {
+    bytes block = 1;
+    tdx.volt_api.volt.v1.Status status = 2;
+  }
+}
+
 `;
 export const terminal_api = `syntax = "proto3";