@aepstore-dev/contracts 1.0.6 → 1.2.0

package/proto/upload.proto

@@ -0,0 +1,135 @@
+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);
+
+    rpc DeleteObject(DeleteObjectRequest) returns (Ok);
+}
+
+// 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;
+}
+
+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;
+}
+
+// ---------------------------------------------------------------------------
+// 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;
+}
+
+// ---------------------------------------------------------------------------
+// Cleanup
+// ---------------------------------------------------------------------------
+
+message DeleteObjectRequest {
+    string file_key = 1;
+}

package/proto/users.proto

@@ -0,0 +1,222 @@
+syntax = "proto3";
+
+package users.v1;
+
+service UsersService {
+    rpc GetPublicProfile(GetPublicProfileRequest) returns (PublicProfileResponse);
+    rpc UpdateProfile(UpdateProfileRequest) returns (PublicProfileResponse);
+    rpc UpdateUser(UpdateUserRequest) returns (UserResponse);
+    rpc UpdateUserRole(UpdateUserRoleRequest) returns (UserResponse);
+    rpc GetUsers(GetUsersRequest) returns (GetUsersResponse);
+    rpc GetActiveDevices(GetActiveDevicesRequest) returns (GetActiveDevicesResponse);
+    rpc ManageDevices(ManageDevicesRequest) returns (ManageDevicesResponse);
+    rpc GetUserFields(GetUserFieldsRequest) returns (GetUserFieldsResponse);
+}
+
+// =================================================================
+// Common types
+// =================================================================
+
+message User {
+    string id = 1;
+    string email = 2;
+    string username = 3;
+    string avatar_url = 4;
+    repeated string roles = 5;
+    string role = 6; // primary role for backwards compat
+    string created_at = 7; // ISO 8601
+    string updated_at = 8;
+}
+
+message Country {
+    string id = 1;
+    string code = 2;
+    string name = 3;
+}
+
+message SocialMedia {
+    string id = 1;
+    string platform = 2;
+    string url = 3;
+}
+
+message CreateSocialMedia {
+    string platform = 1;
+    string url = 2;
+}
+
+message Product {
+    string id = 1;
+    string name = 2;
+    string description = 3;
+    string price = 4; // Decimal as string (D7)
+    string created_at = 5;
+    string updated_at = 6;
+}
+
+message Video {
+    string id = 1;
+    string title = 2;
+    string description = 3;
+    string url = 4;
+    string created_at = 5;
+    string updated_at = 6;
+}
+
+message ActiveDevice {
+    string id = 1;
+    string user_agent = 2;
+    string ip = 3;
+    string created_at = 4;
+    string last_used_at = 5;
+}
+
+message ProfileStats {
+    int32 subscribers_count = 1;
+    int32 subscriptions_count = 2;
+    int32 products_count = 3;
+    int32 videos_count = 4;
+}
+
+// =================================================================
+// GetPublicProfile
+// =================================================================
+
+message GetPublicProfileRequest {
+    string username = 1;
+    string viewer_user_id = 2; // optional — present when caller is authenticated
+}
+
+message PublicProfileResponse {
+    string id = 1;
+    string username = 2;
+    string full_name = 3;
+    string rating = 4; // Decimal as string
+    string about_me = 5;
+    repeated SocialMedia social_media = 6;
+    ProfileStats stats = 7;
+    repeated Video videos = 8;
+    repeated Product products = 9;
+    Country country = 10;
+    string avatar_url = 11;
+    string banner_url = 12;
+    string role = 13;
+    string created_at = 14;
+    bool hide_subscriptions = 15;
+    // Either populated lists or empty depending on hide_subscriptions
+    repeated User subscriptions = 16;
+    repeated User subscribers = 17;
+    bool is_owner = 18;
+}
+
+// =================================================================
+// UpdateProfile
+// =================================================================
+
+message UpdateProfileRequest {
+    string user_id = 1;
+    string full_name = 2;
+    string about_me = 3;
+    bool newsletter_subscription = 4;
+    bool hide_subscriptions = 5;
+    string avatar_url = 6;
+    string banner_url = 7;
+    string country_id = 8;
+    string timezone = 9;
+    repeated CreateSocialMedia social_media = 10;
+}
+
+// =================================================================
+// UpdateUser
+// =================================================================
+
+message UpdateUserRequest {
+    string user_id = 1;
+    string username = 2;
+    string email = 3;
+    string code = 4; // confirmation code when changing email/username
+}
+
+message UserResponse {
+    User user = 1;
+}
+
+// =================================================================
+// UpdateUserRole (admin)
+// =================================================================
+
+message UpdateUserRoleRequest {
+    string admin_id = 1;
+    string user_id = 2;
+    string role = 3;
+}
+
+// =================================================================
+// GetUsers (paginated)
+// =================================================================
+
+message GetUsersRequest {
+    string page = 1;
+    string limit = 2;
+    string search = 3;
+    string role_name = 4;
+}
+
+message GetUsersResponse {
+    repeated User items = 1;
+    int32 total = 2;
+    int32 page = 3;
+    int32 limit = 4;
+}
+
+// =================================================================
+// Active devices
+// =================================================================
+
+message GetActiveDevicesRequest {
+    string user_id = 1;
+}
+
+message GetActiveDevicesResponse {
+    repeated ActiveDevice devices = 1;
+}
+
+message ManageDevicesRequest {
+    string user_id = 1;
+    repeated string device_ids_to_remove = 2;
+}
+
+message ManageDevicesResponse {
+    bool ok = 1;
+    int32 removed_count = 2;
+}
+
+// =================================================================
+// GetUserFields — paginated dynamic field sets
+// =================================================================
+
+enum UserFieldsType {
+    USER_FIELDS_TYPE_UNSPECIFIED = 0;
+    USER_FIELDS_TYPE_VIDEOS = 1;
+    USER_FIELDS_TYPE_PRODUCTS = 2;
+    USER_FIELDS_TYPE_SUBSCRIPTIONS = 3;
+    USER_FIELDS_TYPE_SUBSCRIBERS = 4;
+}
+
+message GetUserFieldsRequest {
+    string username = 1;
+    UserFieldsType type = 2;
+    int32 page = 3;
+    int32 limit = 4;
+    string viewer_user_id = 5; // optional
+}
+
+message GetUserFieldsResponse {
+    repeated Video videos = 1;
+    repeated Product products = 2;
+    repeated User subscriptions = 3;
+    repeated User subscribers = 4;
+    int32 total = 5;
+    int32 page = 6;
+    int32 limit = 7;
+}