@aepstore-dev/contracts 1.0.6 → 1.1.0

package/proto/products.proto

@@ -0,0 +1,327 @@
+syntax = "proto3";
+
+package products.v1;
+
+service ProductsService {
+    rpc Create(CreateProductRequest) returns (ProductResponse);
+    rpc FindAll(QueryProductsRequest) returns (ProductsListResponse);
+    rpc FindAllApproved(QueryProductsRequest) returns (ProductsListResponse);
+    rpc FindMy(FindMyRequest) returns (ProductsListResponse);
+    rpc FindOne(FindOneRequest) returns (ProductResponse);
+    rpc Update(UpdateProductRequest) returns (ProductResponse);
+    rpc Remove(RemoveProductRequest) returns (Ok);
+    rpc SubmitForModeration(SubmitForModerationRequest) returns (ProductResponse);
+    rpc GetPriceRange(Empty) returns (PriceRangeResponse);
+
+    rpc AddToFavorites(FavoriteRequest) returns (Ok);
+    rpc RemoveFromFavorites(FavoriteRequest) returns (Ok);
+
+    rpc SaveMediaMetadata(SaveMediaMetadataRequest) returns (ProductResponse);
+    rpc SaveAttachmentMetadata(SaveAttachmentMetadataRequest) returns (ProductResponse);
+
+    rpc GetProductsForModeration(ProductModerationQueryRequest) returns (ProductsListResponse);
+    rpc ModerateProduct(ModerateProductRequest) returns (ModerationResponse);
+    rpc ResubmitProduct(ResubmitProductRequest) returns (ProductResponse);
+
+    rpc GetSecureDownloadLinks(GetSecureDownloadLinksRequest) returns (SecureDownloadLinksResponse);
+    rpc GetAttachmentDownloadInfo(GetAttachmentDownloadInfoRequest) returns (AttachmentDownloadInfoResponse);
+    rpc GetAttachmentStream(GetAttachmentStreamRequest) returns (stream AttachmentChunk);
+
+    rpc GetTopProduct(Empty) returns (ProductResponse);
+    rpc GetPopularProducts(QueryProductsRequest) returns (ProductsListResponse);
+}
+
+// =================================================================
+// Enums
+// =================================================================
+
+enum ProductStatus {
+    PRODUCT_STATUS_UNSPECIFIED = 0;
+    PRODUCT_STATUS_ACTIVE = 1;
+    PRODUCT_STATUS_DRAFT = 2;
+}
+
+enum ModerationStatus {
+    MODERATION_STATUS_UNSPECIFIED = 0;
+    MODERATION_STATUS_PENDING = 1;
+    MODERATION_STATUS_APPROVED = 2;
+    MODERATION_STATUS_REJECTED = 3;
+}
+
+enum MediaType {
+    MEDIA_TYPE_UNSPECIFIED = 0;
+    MEDIA_TYPE_IMAGE = 1;
+    MEDIA_TYPE_VIDEO = 2;
+}
+
+// =================================================================
+// Nested entities
+// =================================================================
+
+message Category {
+    string id = 1;
+    string name = 2;
+}
+
+message Application {
+    string id = 1;
+    string name = 2;
+}
+
+message Tag {
+    string id = 1;
+    string name = 2;
+}
+
+message ProductMedia {
+    string id = 1;
+    string url = 2;
+    MediaType type = 3;
+}
+
+message Attachment {
+    string id = 1;
+    string url = 2;
+    string file_key = 3;
+    string file_name = 4;
+    double file_size = 5;
+    string created_at = 6;
+}
+
+message ProductUser {
+    string id = 1;
+    string username = 2;
+    string avatar_url = 3;
+}
+
+message Product {
+    string id = 1;
+    string name = 2;
+    string description = 3;
+    string price = 4;            // Decimal as string (D7)
+    string discount_percent = 5; // Decimal as string
+    string final_price = 6;      // Decimal as string
+    string average_rating = 7;   // double as string for consistency
+    ProductStatus status = 8;
+    ModerationStatus moderation_status = 9;
+    string moderation_comment = 10;
+    string moderated_by = 11;
+    string moderated_at = 12;
+    string created_at = 13;
+    string updated_at = 14;
+    string preview = 15;
+    string video = 16;
+    ProductUser user = 17;
+    repeated ProductMedia media = 18;
+    repeated Category categories = 19;
+    repeated Application applications = 20;
+    repeated Tag tags = 21;
+}
+
+message ProductResponse {
+    Product product = 1;
+}
+
+message ProductsListResponse {
+    repeated Product items = 1;
+    int32 total = 2;
+    int32 page = 3;
+    int32 limit = 4;
+}
+
+message Ok {
+    bool ok = 1;
+}
+
+message Empty {}
+
+// =================================================================
+// Create / Update / Query
+// =================================================================
+
+message CreateProductRequest {
+    string user_id = 1;
+    string name = 2;
+    string price = 3;            // Decimal as string
+    repeated string category_ids = 4;
+    repeated string application_ids = 5;
+    repeated string tags = 6;
+    string discount_percent = 7; // optional
+    string final_price = 8;      // optional
+    string video = 9;
+    string description = 10;
+    ProductStatus status = 11;
+}
+
+message UpdateProductRequest {
+    string user_id = 1;
+    string id = 2;
+    string name = 3;
+    string description = 4;
+    string price = 5;
+    string discount_percent = 6;
+    string final_price = 7;
+    repeated string tags = 8;
+}
+
+message QueryProductsRequest {
+    string search = 1;
+    repeated string category_ids = 2;
+    repeated string application_ids = 3;
+    repeated string tags = 4;
+    string min_price = 5;
+    string max_price = 6;
+    int32 page = 7;
+    int32 limit = 8;
+    string sort_by = 9;     // createdAt | price | name | updatedAt | finalPrice
+    string sort_order = 10; // asc | desc
+    ProductStatus status = 11;
+    ModerationStatus moderation_status = 12;
+}
+
+message FindMyRequest {
+    string user_id = 1;
+    QueryProductsRequest query = 2;
+}
+
+message FindOneRequest {
+    string id = 1;
+    string viewer_user_id = 2; // optional — to compute is_favorited etc.
+}
+
+message RemoveProductRequest {
+    string id = 1;
+    string user_id = 2;
+}
+
+message SubmitForModerationRequest {
+    string id = 1;
+    string user_id = 2;
+}
+
+message PriceRangeResponse {
+    string min = 1; // Decimal as string
+    string max = 2;
+}
+
+// =================================================================
+// Favorites
+// =================================================================
+
+message FavoriteRequest {
+    string user_id = 1;
+    string product_id = 2;
+}
+
+// =================================================================
+// Media / Attachments metadata
+// =================================================================
+
+message MediaFile {
+    string url = 1;
+    MediaType type = 2;
+}
+
+message SaveMediaMetadataRequest {
+    string id = 1;
+    string user_id = 2;
+    repeated MediaFile files = 3;
+    string upload_id = 4;
+}
+
+message AttachmentMeta {
+    string url = 1;
+    string file_key = 2;
+    string file_name = 3;
+    double file_size = 4;
+}
+
+message SaveAttachmentMetadataRequest {
+    string id = 1;
+    string user_id = 2;
+    AttachmentMeta attachment = 3;
+    string upload_id = 4;
+}
+
+// =================================================================
+// Moderation
+// =================================================================
+
+message ProductModerationQueryRequest {
+    ModerationStatus status = 1;
+    int32 page = 2;
+    int32 limit = 3;
+    string sort_by = 4;
+    string sort_order = 5;
+}
+
+message ModerateProductRequest {
+    string product_id = 1;
+    string moderator_id = 2;
+    string action = 3;  // 'approve' | 'reject'
+    string comment = 4;
+}
+
+message ModerationResponse {
+    bool success = 1;
+    string message = 2;
+    Product product = 3;
+    ModerationStatus moderation_status = 4;
+    string moderation_comment = 5;
+    string moderated_by = 6;
+    string moderated_at = 7;
+}
+
+message ResubmitProductRequest {
+    string product_id = 1;
+    string user_id = 2;
+    string comment = 3;
+    // Free-form payload of changes — serialized as JSON string to keep the
+    // legacy `any` shape without forcing a strict schema on a free-form patch.
+    string changes_json = 4;
+}
+
+// =================================================================
+// Secure downloads
+// =================================================================
+
+message GetSecureDownloadLinksRequest {
+    string product_id = 1;
+    string user_id = 2;
+    int32 expires_in = 3;
+}
+
+message SecureDownloadLink {
+    string download_url = 1;
+    int32 expires_in = 2;
+    string file_name = 3;
+    double file_size = 4;
+    string attachment_id = 5;
+}
+
+message SecureDownloadLinksResponse {
+    repeated SecureDownloadLink links = 1;
+}
+
+message GetAttachmentDownloadInfoRequest {
+    string product_id = 1;
+    string attachment_id = 2;
+    string user_id = 3;
+}
+
+message AttachmentDownloadInfoResponse {
+    string file_name = 1;
+    double file_size = 2;
+    string content_type = 3;
+}
+
+message GetAttachmentStreamRequest {
+    string product_id = 1;
+    string attachment_id = 2;
+    string user_id = 3;
+}
+
+message AttachmentChunk {
+    bytes data = 1;
+    bool last = 2;
+}

package/proto/taxonomy.proto

@@ -0,0 +1,78 @@
+syntax = "proto3";
+
+package taxonomy.v1;
+
+service TaxonomyService {
+    rpc FindAllCategories(Empty) returns (CategoriesListResponse);
+    rpc FindAllApplications(Empty) returns (ApplicationsListResponse);
+    rpc FindAllTags(QueryTagsRequest) returns (TagsListResponse);
+
+    rpc CreateCategory(CreateCategoryRequest) returns (CategoryResponse);
+    rpc CreateApplication(CreateApplicationRequest) returns (ApplicationResponse);
+}
+
+message Category {
+    string id = 1;
+    string name = 2;
+    string description = 3;
+    string created_at = 4;
+    string updated_at = 5;
+}
+
+message Application {
+    string id = 1;
+    string name = 2;
+    string description = 3;
+    string created_at = 4;
+    string updated_at = 5;
+}
+
+message Tag {
+    string id = 1;
+    string name = 2;
+}
+
+// =================================================================
+// Requests / responses
+// =================================================================
+
+message Empty {}
+
+message CategoriesListResponse {
+    repeated Category items = 1;
+}
+
+message ApplicationsListResponse {
+    repeated Application items = 1;
+}
+
+message QueryTagsRequest {
+    string search = 1;
+    int32 page = 2;
+    int32 limit = 3;
+}
+
+message TagsListResponse {
+    repeated Tag items = 1;
+    int32 total = 2;
+    int32 page = 3;
+    int32 limit = 4;
+}
+
+message CreateCategoryRequest {
+    string name = 1;
+    string description = 2;
+}
+
+message CategoryResponse {
+    Category category = 1;
+}
+
+message CreateApplicationRequest {
+    string name = 1;
+    string description = 2;
+}
+
+message ApplicationResponse {
+    Application application = 1;
+}

package/proto/upload.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package upload.v1;
+
+// Ported from legacy libs/shared/src/proto/upload.proto.
+// Bumped package to upload.v1 for consistency with the rest of the new stack.
+service UploadService {
+    rpc UploadFile(stream FileChunk) returns (UploadResponse);
+    rpc GetUploadStatus(UploadStatusRequest) returns (UploadStatusResponse);
+    rpc GenerateSignedUrl(SignedUrlRequest) returns (SignedUrlResponse);
+}
+
+message FileChunk {
+    string filename = 1;
+    bytes data = 2;
+    string mime_type = 3;
+    bool is_last = 4;
+    int32 chunk_index = 5;
+    string upload_id = 6;
+}
+
+message UploadResponse {
+    string file_url = 1;
+    bool success = 2;
+    string message = 3;
+    string upload_id = 4;
+    int64 file_size = 5;
+}
+
+message UploadStatusRequest {
+    string upload_id = 1;
+}
+
+message UploadStatusResponse {
+    string status = 1;
+    int32 progress_percent = 2;
+    string message = 3;
+}
+
+message SignedUrlRequest {
+    string file_key = 1;
+    int32 expires_in = 2;
+}
+
+message SignedUrlResponse {
+    string signed_url = 1;
+    bool success = 2;
+    string message = 3;
+}

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;
+}