@aepstore-dev/contracts 1.31.0 → 1.33.0

package/proto/products.proto

@@ -1,393 +1,404 @@
-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 RemoveMedia(RemoveMediaRequest) returns (ProductResponse);
-    rpc RemoveAttachment(RemoveAttachmentRequest) 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);
-    // Single presigned GET URL for one attachment (after purchase/access check).
-    // Bytes never traverse the backend — see upload-service.
-    rpc GetAttachmentDownloadUrl(GetAttachmentDownloadUrlRequest) returns (AttachmentDownloadUrlResponse);
-
-    rpc GetTopProduct(TopProductRequest) returns (ProductResponse);
-    rpc GetPopularProducts(QueryProductsRequest) returns (ProductsListResponse);
-}
-
-// =================================================================
-// Enums
-// =================================================================
-
-// Member names match the DB enum string values exactly (enums: String on the
-// wire) so values pass straight through with no mapping. UNSPECIFIED=0 covers
-// null/optional (e.g. nullable moderation_status, missing list filters).
-enum ProductStatus {
-    PRODUCT_STATUS_UNSPECIFIED = 0;
-    ACTIVE = 1;
-    DRAFT = 2;
-}
-
-enum ModerationStatus {
-    MODERATION_STATUS_UNSPECIFIED = 0;
-    PENDING = 1;
-    APPROVED = 2;
-    REJECTED = 3;
-}
-
-enum MediaType {
-    MEDIA_TYPE_UNSPECIFIED = 0;
-    IMAGE = 1;
-    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;
-}
-
-// Moderation block — null on the product while it's a DRAFT / never submitted.
-// status is one of PENDING | APPROVED | REJECTED (never UNSPECIFIED here).
-message ProductModeration {
-    ModerationStatus status = 1;
-    string comment = 2;       // moderator note (mainly on REJECTED)
-    string moderated_by = 3;  // moderator user id
-    string moderated_at = 4;  // ISO 8601
-}
-
-message Product {
-    reserved 9, 10, 11, 12; // retired flat moderation fields → see `moderation`
-    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;
-    ProductModeration moderation = 32; // null while DRAFT / not yet submitted
-    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;
-
-    // Aggregate counts (populated where the query includes _count).
-    int32 favorites_count = 22;
-    int32 views_count = 23;
-    int32 reviews_count = 24;
-
-    // Viewer-contextual flags (populated by FindOne when a viewer is known).
-    bool owner = 25;
-    bool is_favorite = 26;
-    bool is_viewed = 27;
-    string revenue = 28; // owner-only, current-month revenue (Decimal as string)
-    bool is_buyed = 30;  // viewer has a COMPLETED purchase of this product
-    bool is_reviewed = 31; // viewer has already left a review on this product
-
-    // Popularity (populated by GetTopProduct / GetPopularProducts).
-    string popularity_score = 29; // double as string
-}
-
-// Compact product shape for "related products" — only the fields a card needs.
-message RelatedProduct {
-    string id = 1;
-    string name = 2;
-    string price = 3;            // Decimal as string
-    string discount_percent = 4; // Decimal as string
-    string final_price = 5;      // Decimal as string
-    string preview = 6;
-    ProductUser user = 7;
-    repeated Category categories = 8;
-}
-
-message ProductResponse {
-    Product product = 1;
-    // Populated only by FindOne: up to 2 other approved products by the same author.
-    repeated RelatedProduct related_products = 2;
-}
-
-message TopProductRequest {
-    // Optional. If set, the top product is searched only among this seller's products.
-    string user_id = 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;
-    repeated string category_ids = 9;
-    repeated string application_ids = 10;
-}
-
-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.
-    string viewer_key = 3;     // dedup key for view counting (userId or hashed ip+ua)
-}
-
-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;
-}
-
-message RemoveMediaRequest {
-    string id = 1;       // product id
-    string user_id = 2;
-    string media_id = 3;
-}
-
-message RemoveAttachmentRequest {
-    string id = 1;       // product id
-    string user_id = 2;
-    string attachment_id = 3;
-}
-
-// =================================================================
-// 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 GetAttachmentDownloadUrlRequest {
-    string product_id = 1;
-    string attachment_id = 2;
-    string user_id = 3;
-}
-
-message AttachmentDownloadUrlResponse {
-    string download_url = 1;
-    int32 expires_in = 2;
-    string file_name = 3;
-    double file_size = 4;
-}
+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 RemoveMedia(RemoveMediaRequest) returns (ProductResponse);
+    rpc RemoveAttachment(RemoveAttachmentRequest) 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);
+    // Single presigned GET URL for one attachment (after purchase/access check).
+    // Bytes never traverse the backend — see upload-service.
+    rpc GetAttachmentDownloadUrl(GetAttachmentDownloadUrlRequest) returns (AttachmentDownloadUrlResponse);
+
+    rpc GetTopProduct(TopProductRequest) returns (ProductResponse);
+    rpc GetPopularProducts(QueryProductsRequest) returns (ProductsListResponse);
+}
+
+// =================================================================
+// Enums
+// =================================================================
+
+// Member names match the DB enum string values exactly (enums: String on the
+// wire) so values pass straight through with no mapping. UNSPECIFIED=0 covers
+// null/optional (e.g. nullable moderation_status, missing list filters).
+enum ProductStatus {
+    PRODUCT_STATUS_UNSPECIFIED = 0;
+    ACTIVE = 1;
+    DRAFT = 2;
+}
+
+enum ModerationStatus {
+    MODERATION_STATUS_UNSPECIFIED = 0;
+    PENDING = 1;
+    APPROVED = 2;
+    REJECTED = 3;
+}
+
+enum MediaType {
+    MEDIA_TYPE_UNSPECIFIED = 0;
+    IMAGE = 1;
+    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;
+}
+
+// Moderation block — null on the product while it's a DRAFT / never submitted.
+// status is one of PENDING | APPROVED | REJECTED (never UNSPECIFIED here).
+message ProductModeration {
+    ModerationStatus status = 1;
+    string comment = 2;       // moderator note (mainly on REJECTED)
+    string moderated_by = 3;  // moderator user id
+    string moderated_at = 4;  // ISO 8601
+}
+
+message Product {
+    reserved 9, 10, 11, 12; // retired flat moderation fields → see `moderation`
+    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;
+    ProductModeration moderation = 32; // null while DRAFT / not yet submitted
+    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;
+
+    // Aggregate counts (populated where the query includes _count).
+    int32 favorites_count = 22;
+    int32 views_count = 23;
+    int32 reviews_count = 24;
+
+    // Viewer-contextual flags (populated by FindOne when a viewer is known).
+    bool owner = 25;
+    bool is_favorite = 26;
+    bool is_viewed = 27;
+    string revenue = 28; // owner-only, current-month revenue (Decimal as string)
+    bool is_buyed = 30;  // viewer has a COMPLETED purchase of this product
+    bool is_reviewed = 31; // viewer has already left a review on this product
+
+    // Popularity (populated by GetTopProduct / GetPopularProducts).
+    string popularity_score = 29; // double as string
+
+    // OWNER-ONLY: the product's deliverable files. Populated by FindOne only
+    // when the viewer is the product owner; empty for everyone else (never
+    // exposes private attachment metadata to non-owners).
+    repeated ProductAttachment attachments = 33;
+}
+
+message ProductAttachment {
+    string id = 1;
+    string file_name = 2;
+    double file_size = 3;
+}
+
+// Compact product shape for "related products" — only the fields a card needs.
+message RelatedProduct {
+    string id = 1;
+    string name = 2;
+    string price = 3;            // Decimal as string
+    string discount_percent = 4; // Decimal as string
+    string final_price = 5;      // Decimal as string
+    string preview = 6;
+    ProductUser user = 7;
+    repeated Category categories = 8;
+}
+
+message ProductResponse {
+    Product product = 1;
+    // Populated only by FindOne: up to 2 other approved products by the same author.
+    repeated RelatedProduct related_products = 2;
+}
+
+message TopProductRequest {
+    // Optional. If set, the top product is searched only among this seller's products.
+    string user_id = 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;
+    repeated string category_ids = 9;
+    repeated string application_ids = 10;
+}
+
+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.
+    string viewer_key = 3;     // dedup key for view counting (userId or hashed ip+ua)
+}
+
+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;
+}
+
+message RemoveMediaRequest {
+    string id = 1;       // product id
+    string user_id = 2;
+    string media_id = 3;
+}
+
+message RemoveAttachmentRequest {
+    string id = 1;       // product id
+    string user_id = 2;
+    string attachment_id = 3;
+}
+
+// =================================================================
+// 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 GetAttachmentDownloadUrlRequest {
+    string product_id = 1;
+    string attachment_id = 2;
+    string user_id = 3;
+}
+
+message AttachmentDownloadUrlResponse {
+    string download_url = 1;
+    int32 expires_in = 2;
+    string file_name = 3;
+    double file_size = 4;
+}