@aepstore-dev/contracts 1.103.0 → 1.104.0

package/proto/upload.proto

@@ -1,171 +1,171 @@
-syntax = "proto3";
-
-package upload.v1;
-
-// Thin signing service. File bytes NEVER pass through this service — clients
-// upload/download directly to/from S3 (Yandex Object Storage) using presigned
-// URLs this service mints. Memory/bandwidth flat regardless of file size.
-//
-// Large files (product deliverables, up to ~1GB) use the multipart flow:
-//   CreateMultipartUpload → (SignPart × N, client PUTs each part to S3) →
-//   CompleteMultipartUpload   (or AbortMultipartUpload on failure)
-//
-// Small files (preview images, avatars) use the single-PUT flow: CreateUploadUrl.
-//
-// Downloads are gated elsewhere (products-service verifies purchase, then calls
-// GenerateSignedUrl). This service does not know about purchases.
-service UploadService {
-    rpc CreateMultipartUpload(CreateMultipartUploadRequest) returns (CreateMultipartUploadResponse);
-    rpc SignPart(SignPartRequest) returns (SignPartResponse);
-    rpc CompleteMultipartUpload(CompleteMultipartUploadRequest) returns (CompleteMultipartUploadResponse);
-    rpc AbortMultipartUpload(AbortMultipartUploadRequest) returns (Ok);
-
-    rpc CreateUploadUrl(CreateUploadUrlRequest) returns (CreateUploadUrlResponse);
-
-    rpc GenerateSignedUrl(SignedUrlRequest) returns (SignedUrlResponse);
-
-    // Verify an object actually exists (and read its size/type). Used by
-    // products-service to confirm a client-echoed fileKey points at a real
-    // uploaded object before persisting attachment metadata.
-    rpc HeadObject(HeadObjectRequest) returns (HeadObjectResponse);
-
-    rpc DeleteObject(DeleteObjectRequest) returns (Ok);
-
-    // List objects under a prefix (paginated) — for GC/reconciliation jobs
-    // (e.g. tasks-service sweeping orphaned uploads). Not for user traffic.
-    rpc ListObjects(ListObjectsRequest) returns (ListObjectsResponse);
-}
-
-message ListObjectsRequest {
-    string prefix = 1;
-    string continuation_token = 2; // empty for the first page
-}
-
-message StoredObject {
-    string key = 1;
-    string last_modified = 2; // ISO 8601
-}
-
-message ListObjectsResponse {
-    repeated StoredObject objects = 1;
-    string next_continuation_token = 2; // empty when there are no more pages
-}
-
-// Determines the object key prefix (and future ACL/privacy policy).
-// ATTACHMENT = paid product deliverable (private; presigned GET only after purchase).
-// MEDIA / AVATAR / BANNER = preview assets.
-enum UploadKind {
-    UPLOAD_KIND_UNSPECIFIED = 0;
-    UPLOAD_KIND_ATTACHMENT = 1;
-    UPLOAD_KIND_MEDIA = 2;
-    UPLOAD_KIND_AVATAR = 3;
-    UPLOAD_KIND_BANNER = 4;
-    UPLOAD_KIND_ICON = 5; // taxonomy program/app brand icons → public/icons/
-}
-
-message Ok {
-    bool ok = 1;
-}
-
-// ---------------------------------------------------------------------------
-// Multipart upload (large files)
-// ---------------------------------------------------------------------------
-
-message CreateMultipartUploadRequest {
-    string file_name = 1;
-    string mime_type = 2;
-    int64 file_size = 3;
-    UploadKind kind = 4;
-    string owner_id = 5; // user initiating, for key namespacing + audit
-}
-
-message CreateMultipartUploadResponse {
-    string upload_id = 1; // S3 multipart UploadId
-    string file_key = 2;  // object key this service generated
-    int64 part_size = 3;  // recommended part size (bytes) the client should slice with
-    int32 part_count = 4; // number of parts for file_size at part_size
-}
-
-message SignPartRequest {
-    string file_key = 1;
-    string upload_id = 2;
-    int32 part_number = 3; // 1-based
-}
-
-message SignPartResponse {
-    string url = 1;       // presigned PUT URL for this single part
-    int32 expires_in = 2;
-}
-
-message CompletedPart {
-    int32 part_number = 1;
-    string etag = 2; // ETag the client received in the S3 PUT response header for this part
-}
-
-message CompleteMultipartUploadRequest {
-    string file_key = 1;
-    string upload_id = 2;
-    repeated CompletedPart parts = 3;
-}
-
-message CompleteMultipartUploadResponse {
-    string file_key = 1;
-    string location = 2; // final object location (internal reference)
-    int64 file_size = 3;
-}
-
-message AbortMultipartUploadRequest {
-    string file_key = 1;
-    string upload_id = 2;
-}
-
-// ---------------------------------------------------------------------------
-// Single-PUT upload (small files)
-// ---------------------------------------------------------------------------
-
-message CreateUploadUrlRequest {
-    string file_name = 1;
-    string mime_type = 2;
-    UploadKind kind = 3;
-    string owner_id = 4;
-}
-
-message CreateUploadUrlResponse {
-    string url = 1;        // presigned PUT URL (client PUTs the whole file)
-    string file_key = 2;
-    int32 expires_in = 3;
-    string public_url = 4; // final object URL (only meaningful for public kinds)
-}
-
-// ---------------------------------------------------------------------------
-// Download
-// ---------------------------------------------------------------------------
-
-message SignedUrlRequest {
-    string file_key = 1;
-    int32 expires_in = 2;          // optional, default 3600
-    string download_file_name = 3; // optional: forces Content-Disposition attachment filename
-}
-
-message SignedUrlResponse {
-    string signed_url = 1;
-    int32 expires_in = 2;
-}
-
-message HeadObjectRequest {
-    string file_key = 1;
-}
-
-message HeadObjectResponse {
-    bool exists = 1;       // false only when the object is definitively absent (404)
-    double size = 2;       // bytes (0 when absent)
-    string content_type = 3;
-}
-
-// ---------------------------------------------------------------------------
-// Cleanup
-// ---------------------------------------------------------------------------
-
-message DeleteObjectRequest {
-    string file_key = 1;
-}
+syntax = "proto3";
+
+package upload.v1;
+
+// Thin signing service. File bytes NEVER pass through this service — clients
+// upload/download directly to/from S3 (Yandex Object Storage) using presigned
+// URLs this service mints. Memory/bandwidth flat regardless of file size.
+//
+// Large files (product deliverables, up to ~1GB) use the multipart flow:
+//   CreateMultipartUpload → (SignPart × N, client PUTs each part to S3) →
+//   CompleteMultipartUpload   (or AbortMultipartUpload on failure)
+//
+// Small files (preview images, avatars) use the single-PUT flow: CreateUploadUrl.
+//
+// Downloads are gated elsewhere (products-service verifies purchase, then calls
+// GenerateSignedUrl). This service does not know about purchases.
+service UploadService {
+    rpc CreateMultipartUpload(CreateMultipartUploadRequest) returns (CreateMultipartUploadResponse);
+    rpc SignPart(SignPartRequest) returns (SignPartResponse);
+    rpc CompleteMultipartUpload(CompleteMultipartUploadRequest) returns (CompleteMultipartUploadResponse);
+    rpc AbortMultipartUpload(AbortMultipartUploadRequest) returns (Ok);
+
+    rpc CreateUploadUrl(CreateUploadUrlRequest) returns (CreateUploadUrlResponse);
+
+    rpc GenerateSignedUrl(SignedUrlRequest) returns (SignedUrlResponse);
+
+    // Verify an object actually exists (and read its size/type). Used by
+    // products-service to confirm a client-echoed fileKey points at a real
+    // uploaded object before persisting attachment metadata.
+    rpc HeadObject(HeadObjectRequest) returns (HeadObjectResponse);
+
+    rpc DeleteObject(DeleteObjectRequest) returns (Ok);
+
+    // List objects under a prefix (paginated) — for GC/reconciliation jobs
+    // (e.g. tasks-service sweeping orphaned uploads). Not for user traffic.
+    rpc ListObjects(ListObjectsRequest) returns (ListObjectsResponse);
+}
+
+message ListObjectsRequest {
+    string prefix = 1;
+    string continuation_token = 2; // empty for the first page
+}
+
+message StoredObject {
+    string key = 1;
+    string last_modified = 2; // ISO 8601
+}
+
+message ListObjectsResponse {
+    repeated StoredObject objects = 1;
+    string next_continuation_token = 2; // empty when there are no more pages
+}
+
+// Determines the object key prefix (and future ACL/privacy policy).
+// ATTACHMENT = paid product deliverable (private; presigned GET only after purchase).
+// MEDIA / AVATAR / BANNER = preview assets.
+enum UploadKind {
+    UPLOAD_KIND_UNSPECIFIED = 0;
+    UPLOAD_KIND_ATTACHMENT = 1;
+    UPLOAD_KIND_MEDIA = 2;
+    UPLOAD_KIND_AVATAR = 3;
+    UPLOAD_KIND_BANNER = 4;
+    UPLOAD_KIND_ICON = 5; // taxonomy program/app brand icons → public/icons/
+}
+
+message Ok {
+    bool ok = 1;
+}
+
+// ---------------------------------------------------------------------------
+// Multipart upload (large files)
+// ---------------------------------------------------------------------------
+
+message CreateMultipartUploadRequest {
+    string file_name = 1;
+    string mime_type = 2;
+    int64 file_size = 3;
+    UploadKind kind = 4;
+    string owner_id = 5; // user initiating, for key namespacing + audit
+}
+
+message CreateMultipartUploadResponse {
+    string upload_id = 1; // S3 multipart UploadId
+    string file_key = 2;  // object key this service generated
+    int64 part_size = 3;  // recommended part size (bytes) the client should slice with
+    int32 part_count = 4; // number of parts for file_size at part_size
+}
+
+message SignPartRequest {
+    string file_key = 1;
+    string upload_id = 2;
+    int32 part_number = 3; // 1-based
+}
+
+message SignPartResponse {
+    string url = 1;       // presigned PUT URL for this single part
+    int32 expires_in = 2;
+}
+
+message CompletedPart {
+    int32 part_number = 1;
+    string etag = 2; // ETag the client received in the S3 PUT response header for this part
+}
+
+message CompleteMultipartUploadRequest {
+    string file_key = 1;
+    string upload_id = 2;
+    repeated CompletedPart parts = 3;
+}
+
+message CompleteMultipartUploadResponse {
+    string file_key = 1;
+    string location = 2; // final object location (internal reference)
+    int64 file_size = 3;
+}
+
+message AbortMultipartUploadRequest {
+    string file_key = 1;
+    string upload_id = 2;
+}
+
+// ---------------------------------------------------------------------------
+// Single-PUT upload (small files)
+// ---------------------------------------------------------------------------
+
+message CreateUploadUrlRequest {
+    string file_name = 1;
+    string mime_type = 2;
+    UploadKind kind = 3;
+    string owner_id = 4;
+}
+
+message CreateUploadUrlResponse {
+    string url = 1;        // presigned PUT URL (client PUTs the whole file)
+    string file_key = 2;
+    int32 expires_in = 3;
+    string public_url = 4; // final object URL (only meaningful for public kinds)
+}
+
+// ---------------------------------------------------------------------------
+// Download
+// ---------------------------------------------------------------------------
+
+message SignedUrlRequest {
+    string file_key = 1;
+    int32 expires_in = 2;          // optional, default 3600
+    string download_file_name = 3; // optional: forces Content-Disposition attachment filename
+}
+
+message SignedUrlResponse {
+    string signed_url = 1;
+    int32 expires_in = 2;
+}
+
+message HeadObjectRequest {
+    string file_key = 1;
+}
+
+message HeadObjectResponse {
+    bool exists = 1;       // false only when the object is definitively absent (404)
+    double size = 2;       // bytes (0 when absent)
+    string content_type = 3;
+}
+
+// ---------------------------------------------------------------------------
+// Cleanup
+// ---------------------------------------------------------------------------
+
+message DeleteObjectRequest {
+    string file_key = 1;
+}